Update README.md
This commit is contained in:
parent
604acd1870
commit
ca36721b81
60
README.md
60
README.md
@ -26,7 +26,7 @@ Longhorn implements distributed block storage using containers and microservices
|
|||||||
|
|
||||||
You can read more technical details of Longhorn [here](https://longhorn.io/).
|
You can read more technical details of Longhorn [here](https://longhorn.io/).
|
||||||
|
|
||||||
## Releases
|
# Releases
|
||||||
|
|
||||||
https://github.com/longhorn/longhorn/releases
|
https://github.com/longhorn/longhorn/releases
|
||||||
|
|
||||||
@ -36,11 +36,13 @@ https://github.com/longhorn/longhorn/releases
|
|||||||
| 1.2 | 1.2.6 | Stable |
|
| 1.2 | 1.2.6 | Stable |
|
||||||
| 1.1 | 1.1.3 | Stable |
|
| 1.1 | 1.1.3 | Stable |
|
||||||
|
|
||||||
## Roadmap
|
# Roadmap
|
||||||
|
|
||||||
https://github.com/longhorn/longhorn/wiki/Roadmap
|
https://github.com/longhorn/longhorn/wiki/Roadmap
|
||||||
|
|
||||||
## Component Build Status
|
# Components
|
||||||
|
|
||||||
|
Longhorn is 100% open source software. Project source code is spread across a number of repos:
|
||||||
|
|
||||||
* 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)
|
* 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)
|
* 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)
|
||||||
@ -49,20 +51,6 @@ https://github.com/longhorn/longhorn/wiki/Roadmap
|
|||||||
* 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)
|
* 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)
|
* UI: [](https://drone-publish.longhorn.io/longhorn/longhorn-ui)[](https://app.fossa.com/projects/custom%2B25850%2Fgithub.com%2Flonghorn%2Flonghorn-ui?ref=badge_shield)
|
||||||
|
|
||||||
## 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 |
|
| 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 Backing Image Manager | Backing image download, sync, and deletion in a disk | [longhorn/backing-image-manager](https://github.com/longhorn/backing-image-manager) |
|
||||||
@ -74,6 +62,8 @@ Longhorn is 100% open source software. Project source code is spread across a nu
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
# Get Started
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
For the installation requirements, refer to the [Longhorn documentation.](https://longhorn.io/docs/latest/deploy/install/#installation-requirements)
|
For the installation requirements, refer to the [Longhorn documentation.](https://longhorn.io/docs/latest/deploy/install/#installation-requirements)
|
||||||
@ -93,22 +83,13 @@ Longhorn can be installed on a Kubernetes cluster in several ways:
|
|||||||
|
|
||||||
The official Longhorn documentation is [here.](https://longhorn.io/docs)
|
The official Longhorn documentation is [here.](https://longhorn.io/docs)
|
||||||
|
|
||||||
# Community
|
# Get Involved
|
||||||
|
|
||||||
Longhorn is open source software, so contributions are greatly welcome.
|
## Discussion, Feedback
|
||||||
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.
|
|
||||||
|
|
||||||
## Discussions or Feedbacks
|
|
||||||
|
|
||||||
If having any discussions or feedbacks, feel free to [file a discussion](https://github.com/longhorn/longhorn/discussions).
|
If having any discussions or feedbacks, feel free to [file a discussion](https://github.com/longhorn/longhorn/discussions).
|
||||||
|
|
||||||
## Requests or Issues
|
## Features Request, Bug Reporting
|
||||||
|
|
||||||
If having any issues, feel free to [file an issue](https://github.com/longhorn/longhorn/issues/new/choose).
|
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.
|
We have a weekly community issue review meeting to review all reported issues or enhancement requests.
|
||||||
@ -120,9 +101,28 @@ When creating a bug issue, please help upload the support bundle to the issue or
|
|||||||
|
|
||||||
If having any vulnerabilities found, please report to [longhorn-security](mailto:longhorn-security@suse.com).
|
If having any vulnerabilities found, please report to [longhorn-security](mailto:longhorn-security@suse.com).
|
||||||
|
|
||||||
|
# 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
|
||||||
|
|
||||||
# License
|
# License
|
||||||
|
|
||||||
Copyright (c) 2014-2021 The Longhorn Authors
|
Copyright (c) 2014-2022 The Longhorn Authors
|
||||||
|
|
||||||
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
|
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
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user