longhorn/README.md

73 lines
5.0 KiB
Markdown
Raw Normal View History

# Longhorn
2017-04-14 23:16:53 +00:00
### Build Status
* Engine: [![Build Status](https://drone-publish.longhorn.io/api/badges/longhorn/longhorn-engine/status.svg)](https://drone-publish.longhorn.io/longhorn/longhorn-engine) [![Go Report Card](https://goreportcard.com/badge/github.com/longhorn/longhorn-engine)](https://goreportcard.com/report/github.com/longhorn/longhorn-engine)
* Instance Manager: [![Build Status](http://drone-publish.longhorn.io/api/badges/longhorn/longhorn-instance-manager/status.svg)](http://drone-publish.longhorn.io/longhorn/longhorn-instance-manager)[![Go Report Card](https://goreportcard.com/badge/github.com/longhorn/longhorn-instance-manager)](https://goreportcard.com/report/github.com/longhorn/longhorn-instance-manager)
* Manager: [![Build Status](https://drone-publish.longhorn.io/api/badges/longhorn/longhorn-manager/status.svg)](https://drone-publish.longhorn.io/longhorn/longhorn-manager)[![Go Report Card](https://goreportcard.com/badge/github.com/longhorn/longhorn-manager)](https://goreportcard.com/report/github.com/longhorn/longhorn-manager)
* UI: [![Build Status](https://drone-publish.longhorn.io/api/badges/longhorn/longhorn-ui/status.svg)](https://drone-publish.longhorn.io/longhorn/longhorn-ui)
* Test: [![Build Status](http://drone-publish.longhorn.io/api/badges/longhorn/longhorn-tests/status.svg)](http://drone-publish.longhorn.io/longhorn/longhorn-tests)
### Overview
2019-04-03 16:30:11 +00:00
Longhorn is a distributed block storage system for Kubernetes.
2017-04-16 07:25:39 +00:00
2019-04-03 16:30:11 +00:00
Longhorn is lightweight, reliable, and powerful. You can install Longhorn on an existing Kubernetes cluster with one `kubectl apply` command or using Helm charts. Once Longhorn is installed, it adds persistent volume support to the Kubernetes cluster.
2019-04-02 18:43:13 +00:00
2019-04-05 20:09:50 +00:00
Longhorn implements distributed block storage using containers and microservices. Longhorn creates a dedicated storage controller for each block device volume and synchronously replicates the volume across multiple replicas stored on multiple nodes. The storage controller and replicas are themselves orchestrated using Kubernetes. Here are some notable features of Longhorn:
2017-04-14 23:16:53 +00:00
2019-04-03 16:30:11 +00:00
1. Enterprise-grade distributed storage with no single point of failure
2. Incremental snapshot of block storage
3. Backup to secondary storage (NFSv4 or S3-compatible object storage) built on efficient change block detection
2019-04-05 20:09:50 +00:00
4. Recurring snapshot and backup
2019-04-03 16:30:11 +00:00
5. Automated non-disruptive upgrade. You can upgrade the entire Longhorn software stack without disrupting running volumes!
6. Intuitive GUI dashboard
You can read more technical details of Longhorn [here](https://longhorn.io/).
2017-04-21 07:17:27 +00:00
2018-08-23 22:08:22 +00:00
## Current status
The latest release of Longhorn is **v1.0.2**.
2017-04-14 23:16:53 +00:00
2018-08-23 00:28:06 +00:00
## Source code
2017-04-27 20:15:23 +00:00
Longhorn is 100% open source software. Project source code is spread across a number of repos:
2017-04-27 20:12:32 +00:00
1. Longhorn engine -- Core controller/replica logic https://github.com/longhorn/longhorn-engine
1. Longhorn manager -- Longhorn orchestration https://github.com/longhorn/longhorn-manager
1. Longhorn UI -- Dashboard https://github.com/longhorn/longhorn-ui
![Longhorn UI](./longhorn-ui.png)
2018-03-26 22:11:48 +00:00
2018-08-02 03:38:51 +00:00
# Requirements
For the installation requirements, refer to the [Longhorn documentation.](https://longhorn.io/docs/install/requirements)
2019-04-02 02:23:24 +00:00
# Install
2018-09-14 00:47:44 +00:00
Longhorn can be installed on a Kubernetes cluster in several ways:
2019-04-03 16:30:11 +00:00
- [kubectl](https://longhorn.io/docs/install/install-with-kubectl/)
- [Helm](https://longhorn.io/docs/install/install-with-helm/)
- [Rancher catalog app](https://longhorn.io/docs/install/install-with-rancher/)
2018-08-02 03:38:51 +00:00
2019-04-03 16:30:11 +00:00
# Documentation
The official Longhorn documentation is [here.](https://longhorn.io/docs)
## Community
Longhorn is open source software, so contributions are greatly welcome. Please read [Code of Conduct](./CODE_OF_CONDUCT.md) and [Contributing Guideline](./CONTRIBUTING.md) before contributing.
Contributing code is not the only way of contributing. We value feedbacks very much and many of the Longhorn features are originated from users' feedback. If you have any feedbacks, feel free to [file an issue](https://github.com/longhorn/longhorn/issues/new?title=*Summarize%20your%20issue%20here*&body=*Describe%20your%20issue%20here*%0A%0A---%0AVersion%3A%20``) and talk to the developers at the [CNCF](https://slack.cncf.io/) [#longhorn](https://cloud-native.slack.com/messages/longhorn) slack channel.
2017-04-16 07:25:39 +00:00
## License
Copyright (c) 2014-2020 The Longhorn Authors
2018-08-02 03:38:51 +00:00
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
2017-04-16 07:25:39 +00:00
[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
2018-08-02 03:38:51 +00:00
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
### Longhorn is a [CNCF Sandbox Project](https://www.cncf.io/sandbox-projects/)
![Longhorn is a CNCF Sandbox Project](https://github.com/cncf/artwork/blob/master/other/cncf/horizontal/color/cncf-color.png)