2022-12-17 12:58:17 +00:00
< h1 align = "center" style = "border-bottom: none" >
< a href = "https://longhorn.io/" target = "_blank" > < img alt = "Longhorn" width = "120px" src = "https://github.com/longhorn/website/blob/master/static/img/icon-longhorn.svg" > < / a > < br > Longhorn
< / h1 >
< p align = "center" > A CNCF Incubating Project. Visit < a href = "https://longhorn.io/" target = "_blank" > longhorn.io< / a > for the full documentation.< / p >
< div align = "center" >
[](https://github.com/longhorn/longhorn/releases)
2022-12-17 13:13:41 +00:00
[](https://github.com/longhorn/longhorn/blob/master/LICENSE)
2022-12-17 12:58:17 +00:00
< / div >
2017-04-14 23:16:53 +00:00
2022-12-17 13:08:35 +00:00
Longhorn is a distributed block storage system for Kubernetes. Longhorn is cloud native storage built using Kubernetes and container primitives.
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
2020-05-28 14:00:43 +00:00
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
2020-07-31 20:12:05 +00:00
You can read more technical details of Longhorn [here ](https://longhorn.io/ ).
2017-04-21 07:17:27 +00:00
2022-12-17 13:07:25 +00:00
# Releases
2022-12-17 12:58:17 +00:00
https://github.com/longhorn/longhorn/releases
| Release | Version | Type |
|---------|---------|--------|
| 1.3 | 1.3.2 | Stable |
| 1.2 | 1.2.6 | Stable |
| 1.1 | 1.1.3 | Stable |
2022-12-17 13:07:25 +00:00
# Roadmap
2022-12-17 12:58:17 +00:00
https://github.com/longhorn/longhorn/wiki/Roadmap
2020-11-14 02:55:22 +00:00
2022-12-17 13:07:25 +00:00
# Components
Longhorn is 100% open source software. Project source code is spread across a number of repos:
2021-05-26 05:29:52 +00:00
2021-12-17 07:30:38 +00:00
* Engine: [](https://drone-publish.longhorn.io/longhorn/longhorn-engine)[](https://goreportcard.com/report/github.com/longhorn/longhorn-engine)[](https://app.fossa.com/projects/custom%2B25850%2Fgithub.com%2Flonghorn%2Flonghorn-engine?ref=badge_shield)
* Manager: [](https://drone-publish.longhorn.io/longhorn/longhorn-manager)[](https://goreportcard.com/report/github.com/longhorn/longhorn-manager)[](https://app.fossa.com/projects/custom%2B25850%2Fgithub.com%2Flonghorn%2Flonghorn-manager?ref=badge_shield)
* Instance Manager: [](http://drone-publish.longhorn.io/longhorn/longhorn-instance-manager)[](https://goreportcard.com/report/github.com/longhorn/longhorn-instance-manager)[](https://app.fossa.com/projects/custom%2B25850%2Fgithub.com%2Flonghorn%2Flonghorn-instance-manager?ref=badge_shield)
* Share Manager: [](http://drone-publish.longhorn.io/longhorn/longhorn-share-manager)[](https://goreportcard.com/report/github.com/longhorn/longhorn-share-manager)[](https://app.fossa.com/projects/custom%2B25850%2Fgithub.com%2Flonghorn%2Flonghorn-share-manager?ref=badge_shield)
* Backing Image Manager: [](http://drone-publish.longhorn.io/longhorn/backing-image-manager)[](https://goreportcard.com/report/github.com/longhorn/backing-image-manager)[](https://app.fossa.com/projects/custom%2B25850%2Fgithub.com%2Flonghorn%2Fbacking-image-manager?ref=badge_shield)
* UI: [](https://drone-publish.longhorn.io/longhorn/longhorn-ui)[](https://app.fossa.com/projects/custom%2B25850%2Fgithub.com%2Flonghorn%2Flonghorn-ui?ref=badge_shield)
2018-08-23 22:08:22 +00:00
2021-07-08 05:53:21 +00:00
| Component | What it does | GitHub repo |
| :----------------------------- | :--------------------------------------------------------------------- | :------------------------------------------------------------------------------------------ |
| Longhorn Backing Image Manager | Backing image download, sync, and deletion in a disk | [longhorn/backing-image-manager ](https://github.com/longhorn/backing-image-manager ) |
| Longhorn Engine | Core controller/replica logic | [longhorn/longhorn-engine ](https://github.com/longhorn/longhorn-engine ) |
| Longhorn Instance Manager | Controller/replica instance lifecycle management | [longhorn/longhorn-instance-manager ](https://github.com/longhorn/longhorn-instance-manager ) |
| Longhorn Manager | Longhorn orchestration, includes CSI driver for Kubernetes | [longhorn/longhorn-manager ](https://github.com/longhorn/longhorn-manager ) |
| Longhorn Share Manager | NFS provisioner that exposes Longhorn volumes as ReadWriteMany volumes | [longhorn/longhorn-share-manager ](https://github.com/longhorn/longhorn-share-manager ) |
| Longhorn UI | The Longhorn dashboard | [longhorn/longhorn-ui ](https://github.com/longhorn/longhorn-ui ) |
2017-04-27 23:33:49 +00:00
2019-11-08 19:21:15 +00:00
2018-03-26 22:11:48 +00:00
2022-12-17 13:07:25 +00:00
# Get Started
2021-12-17 07:30:38 +00:00
## Requirements
2017-04-27 23:33:49 +00:00
2021-05-26 15:38:31 +00:00
For the installation requirements, refer to the [Longhorn documentation. ](https://longhorn.io/docs/latest/deploy/install/#installation-requirements )
2017-04-27 23:33:49 +00:00
2021-12-17 07:30:38 +00:00
## Installation
2018-09-14 00:47:44 +00:00
2022-03-02 08:28:35 +00:00
> **NOTE**: Please note that the master branch is for the upcoming feature release development.
> For an official release installation or upgrade, please refer to the below ways.
2020-04-14 03:15:49 +00:00
Longhorn can be installed on a Kubernetes cluster in several ways:
2019-04-03 16:30:11 +00:00
2022-12-17 12:58:17 +00:00
- [Rancher App Marketplace ](https://longhorn.io/docs/latest/deploy/install/install-with-rancher/ )
2021-05-26 15:38:31 +00:00
- [kubectl ](https://longhorn.io/docs/latest/deploy/install/install-with-kubectl/ )
- [Helm ](https://longhorn.io/docs/latest/deploy/install/install-with-helm/ )
2018-08-02 03:38:51 +00:00
2021-12-17 07:30:38 +00:00
## Documentation
2019-04-03 16:30:11 +00:00
2020-04-14 03:15:49 +00:00
The official Longhorn documentation is [here. ](https://longhorn.io/docs )
2018-03-23 01:20:50 +00:00
2022-12-17 13:07:25 +00:00
# Get Involved
2021-12-17 07:30:38 +00:00
2022-12-17 13:07:25 +00:00
## Discussion, Feedback
2021-12-17 07:30:38 +00:00
If having any discussions or feedbacks, feel free to [file a discussion ](https://github.com/longhorn/longhorn/discussions ).
2022-12-17 13:07:25 +00:00
## Features Request, Bug Reporting
2021-12-17 07:30:38 +00:00
2022-03-02 08:28:35 +00:00
If having any issues, feel free to [file an issue ](https://github.com/longhorn/longhorn/issues/new/choose ).
2021-12-17 07:30:38 +00:00
We have a weekly community issue review meeting to review all reported issues or enhancement requests.
When creating a bug issue, please help upload the support bundle to the issue or send to
2022-03-02 08:28:35 +00:00
[longhorn-support-bundle ](mailto:longhorn-support-bundle@suse.com ).
2021-05-26 05:29:52 +00:00
2022-03-02 08:28:35 +00:00
## Report Vulnerabilities
2019-08-20 19:30:02 +00:00
2021-12-17 07:30:38 +00:00
If having any vulnerabilities found, please report to [longhorn-security ](mailto:longhorn-security@suse.com ).
2019-08-20 19:30:02 +00:00
2022-12-17 13:07:25 +00:00
# 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/choose ) and talk to the developers at the [CNCF ](https://slack.cncf.io/ ) [#longhorn ](https://cloud-native.slack.com/messages/longhorn ) Slack channel.
If having any discussion, feedbacks, requests, issues or security reports, please follow below ways.
We also have a [CNCF Slack channel: longhorn ](https://cloud-native.slack.com/messages/longhorn ) for discussion.
## Community Meeting and Office Hours
Hosted by the core maintainers of Longhorn: 4th Friday of the every month at 09:00 (CET) or 16:00 (CST) at https://community.cncf.io/longhorn-community/.
## Longhorn Mailing List
Stay up to date on the latest news and events: https://lists.cncf.io/g/cncf-longhorn
You can read more about the community and its events here: https://github.com/longhorn/community
2021-12-17 07:30:38 +00:00
# License
2017-04-16 07:25:39 +00:00
2022-12-17 13:07:25 +00:00
Copyright (c) 2014-2022 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.
2019-11-08 19:10:35 +00:00
2021-12-17 07:30:38 +00:00
## Longhorn is a [CNCF Incubating Project](https://www.cncf.io/projects/)
2019-11-08 19:10:35 +00:00
2021-12-14 21:49:08 +00:00
