Update readme
Signed-off-by: David Ko <dko@suse.com>
This commit is contained in:
David Ko
parent
9b8ac7e91c
commit
fb9d64ce50
93
README.md
93
README.md
@ -1,23 +1,6 @@
|
||||
# Longhorn
|
||||
|
||||
## Build Status
|
||||
* 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)
|
||||
* Test: [](http://drone-publish.longhorn.io/longhorn/longhorn-tests)
|
||||
|
||||
## Release Status
|
||||
|
||||
| Release | Version | Type |
|
||||
| --------|---------|-----------------|
|
||||
| 1.1 | 1.1.2 | Latest & Stable |
|
||||
| 1.2 | 1.2.2 | Latest |
|
||||
|
||||
## Overview
|
||||
Longhorn is a distributed block storage system for Kubernetes. Longhorn is cloud native storage because it is built using Kubernetes and container primitives.
|
||||
Longhorn is a distributed block storage system for Kubernetes. Longhorn is cloud native storage because it is built using Kubernetes and container primitives.
|
||||
|
||||
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.
|
||||
|
||||
@ -32,19 +15,38 @@ Longhorn implements distributed block storage using containers and microservices
|
||||
|
||||
You can read more technical details of Longhorn [here](https://longhorn.io/).
|
||||
|
||||
|
||||
## Get Involved
|
||||
**Community Meeting and Office Hours**!: Hosted by the core maintainers of Longhorn: 2nd Friday of the every month at 09:00 Pacific Time (PT)/12:00 Eastern Time (ET) on Zoom: http://bit.ly/longhorn-community-meeting. Gcal event: http://bit.ly/longhorn-events
|
||||
|
||||
**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
|
||||
|
||||
## Current status
|
||||
## Current Status
|
||||
|
||||
The latest release of Longhorn is [](https://github.com/longhorn/longhorn/releases)
|
||||
|
||||
## Build Status
|
||||
* 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)
|
||||
* Test: [](http://drone-publish.longhorn.io/longhorn/longhorn-tests)
|
||||
|
||||
## Release Status
|
||||
|
||||
| Release | Version | Type |
|
||||
| --------|---------|----------------|
|
||||
| 1.2 | 1.2.3 | Stable, Latest |
|
||||
| 1.1 | 1.1.3 | Stable, Latest |
|
||||
|
||||
## Get Involved
|
||||
|
||||
### 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
|
||||
|
||||
## Source code
|
||||
|
||||
Longhorn is 100% open source software. Project source code is spread across a number of repos:
|
||||
|
||||
| Component | What it does | GitHub repo |
|
||||
@ -58,11 +60,11 @@ Longhorn is 100% open source software. Project source code is spread across a nu
|
||||
|
||||
|
||||
|
||||
# Requirements
|
||||
## Requirements
|
||||
|
||||
For the installation requirements, refer to the [Longhorn documentation.](https://longhorn.io/docs/latest/deploy/install/#installation-requirements)
|
||||
|
||||
# Installation
|
||||
## Installation
|
||||
|
||||
Longhorn can be installed on a Kubernetes cluster in several ways:
|
||||
|
||||
@ -70,17 +72,38 @@ Longhorn can be installed on a Kubernetes cluster in several ways:
|
||||
- [kubectl](https://longhorn.io/docs/latest/deploy/install/install-with-kubectl/)
|
||||
- [Helm](https://longhorn.io/docs/latest/deploy/install/install-with-helm/)
|
||||
|
||||
# Documentation
|
||||
## Documentation
|
||||
|
||||
The official Longhorn documentation is [here.](https://longhorn.io/docs)
|
||||
|
||||
## Community
|
||||
# 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.
|
||||
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.
|
||||
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.
|
||||
|
||||
## License
|
||||
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.
|
||||
|
||||
## Discussions or Feedbacks
|
||||
|
||||
If having any discussions or feedbacks, feel free to [file a discussion](https://github.com/longhorn/longhorn/discussions).
|
||||
|
||||
## Requests or Issues
|
||||
|
||||
If having any issues, feel free to [file an issue](https://github.com/longhorn/longhorn/issues/new/choose).
|
||||
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
|
||||
[longhorn-support-bundle](mailto:longhorn-support-bundle@suse.com).
|
||||
|
||||
## Report Vulnerabilities
|
||||
|
||||
If having any vulnerabilities found, please report to [longhorn-security](mailto:longhorn-security@suse.com).
|
||||
|
||||
# License
|
||||
|
||||
Copyright (c) 2014-2021 The Longhorn Authors
|
||||
|
||||
@ -90,6 +113,6 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use
|
||||
|
||||
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 Incubating Project](https://www.cncf.io/projects/)
|
||||
## Longhorn is a [CNCF Incubating Project](https://www.cncf.io/projects/)
|
||||
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user