Go to file

Sheng Yang 6d9f02a8c7 Longhorn v1.0.0 release See https://github.com/longhorn/longhorn/releases/tag/v1.0.0 for the release note. Signed-off-by: Sheng Yang <sheng.yang@rancher.com>		2020-05-30 10:03:43 -07:00
.github	Update issue templates	2020-02-27 13:55:30 -08:00
chart	Update version to v1.0.0	2020-05-30 10:03:43 -07:00
deploy	Update version to v1.0.0	2020-05-30 10:03:43 -07:00
dev/scripts	dev: Add lm-update.sh script	2019-10-10 16:26:31 -07:00
enhancements	enhancement: Add `API Changes` in the template	2020-03-31 16:45:38 -07:00
examples	Sync with Longhorn manager	2020-02-29 18:42:08 -08:00
scripts	Sync with manager	2020-04-24 15:07:05 -07:00
uninstall	Update version to v1.0.0	2020-05-30 10:03:43 -07:00
CODE_OF_CONDUCT.md	Update to CNCF code of conduct	2019-12-04 11:10:13 -08:00
CONTRIBUTING.md	Update CONTRIBUTING.md	2019-08-20 10:13:21 -10:00
LICENSE	Initial commit	2017-04-14 12:57:02 -07:00
longhorn-ui.png	Add the new Longhorn UI PNG	2019-11-08 11:20:19 -08:00
MAINTAINERS	Add community section in the README.md	2019-08-20 09:36:36 -10:00
README.md	Longhorn v1.0.0 release	2020-05-30 10:03:43 -07:00

README.md

Longhorn

Build Status

Engine:
Instance Manager:
Manager:
UI:
Test:

Overview

Longhorn is a distributed block storage system for Kubernetes.

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.

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:

Enterprise-grade distributed storage with no single point of failure
Incremental snapshot of block storage
Backup to secondary storage (NFS or S3-compatible object storage) built on efficient change block detection
Recurring snapshot and backup
Automated non-disruptive upgrade. You can upgrade the entire Longhorn software stack without disrupting running volumes!
Intuitive GUI dashboard

You can read more technical details of Longhorn here.

Current status

Longhorn is beta-quality software. We appreciate your willingness to deploy Longhorn and provide feedback.

The latest release of Longhorn is v1.0.0.

Source code

Longhorn is 100% open source software. Project source code is spread across a number of repos:

Longhorn engine -- Core controller/replica logic https://github.com/longhorn/longhorn-engine
Longhorn manager -- Longhorn orchestration https://github.com/longhorn/longhorn-manager
Longhorn UI -- Dashboard https://github.com/longhorn/longhorn-ui

Requirements

For the installation requirements, refer to the Longhorn documentation.

Install

Longhorn can be installed on a Kubernetes cluster in several ways:

Documentation

The official Longhorn documentation is here.

Community

Longhorn is an open source software, so contribution are greatly welcome. Please read Code of Conduct and Contributing Guideline 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 and talk to the developers at the CNCF #longhorn slack channel.

License

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

http://www.apache.org/licenses/LICENSE-2.0

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.