Merge pull request #2498 from humblec/readme
Markdown linter corrections.
This commit is contained in:
1 file changed
+18
-17
@@ -9,7 +9,7 @@
|
||||
[](https://slack.rook.io/badge.svg)
|
||||
[](https://twitter.com/intent/follow?screen_name=rook_io&user_id=788180534543339520)
|
||||
|
||||
## What is Rook?
|
||||
# What is Rook?
|
||||
|
||||
Rook is an open source **cloud-native storage orchestrator** for Kubernetes, providing the platform, framework, and support for a diverse set of storage solutions to natively integrate with cloud-native environments.
|
||||
|
||||
@@ -44,15 +44,17 @@ Please use the following to reach members of the community:
|
||||
- Email: [info@rook.io](mailto:info@rook.io)
|
||||
|
||||
### Community Meeting
|
||||
|
||||
A regular community meeting takes place every other [Tuesday at 9:00 AM PT (Pacific Time)](https://zoom.us/j/392602367).
|
||||
Convert to your [local timezone](http://www.thetimezoneconverter.com/?t=9:00&tz=PT%20%28Pacific%20Time%29).
|
||||
|
||||
Any changes to the meeting schedule will be added to the [agenda doc](https://docs.google.com/document/d/1exd8_IG6DkdvyA0eiTtL2z5K2Ra-y68VByUUgwP7I9A/edit?usp=sharing) and posted to [Slack #announcements](https://rook-io.slack.com/messages/C76LLCEE7/) and the [rook-dev mailing list](https://groups.google.com/forum/#!forum/rook-dev).
|
||||
|
||||
Anyone who wants to discuss the direction of the project, design and implementation reviews, or general questions with the broader community is welcome and encouraged to join.
|
||||
* Meeting link: https://zoom.us/j/392602367
|
||||
* [Current agenda and past meeting notes](https://docs.google.com/document/d/1exd8_IG6DkdvyA0eiTtL2z5K2Ra-y68VByUUgwP7I9A/edit?usp=sharing)
|
||||
* [Past meeting recordings](https://www.youtube.com/playlist?list=PLP0uDo-ZFnQP6NAgJWAtR9jaRcgqyQKVy)
|
||||
|
||||
- Meeting link: <https://zoom.us/j/392602367>
|
||||
- [Current agenda and past meeting notes](https://docs.google.com/document/d/1exd8_IG6DkdvyA0eiTtL2z5K2Ra-y68VByUUgwP7I9A/edit?usp=sharing)
|
||||
- [Past meeting recordings](https://www.youtube.com/playlist?list=PLP0uDo-ZFnQP6NAgJWAtR9jaRcgqyQKVy)
|
||||
|
||||
## Project Status
|
||||
|
||||
@@ -60,20 +62,19 @@ The status of each storage provider supported by Rook can be found in the table
|
||||
Each API group is assigned its own individual status to reflect their varying maturity and stability.
|
||||
More details about API versioning and status in Kubernetes can be found on the Kubernetes [API versioning page](https://kubernetes.io/docs/concepts/overview/kubernetes-api/#api-versioning), but the key difference between the statuses are summarized below:
|
||||
|
||||
* **Alpha:** The API may change in incompatible ways in a later software release without notice, recommended for use only in short-lived testing clusters, due to increased risk of bugs and lack of long-term support.
|
||||
* **Beta:** Support for the overall features will not be dropped, though details may change. Support for upgrading or migrating between versions will be provided, either through automation or manual steps.
|
||||
* **Stable:** Features will appear in released software for many subsequent versions and support for upgrading between versions will be provided with software automation in the vast majority of scenarios.
|
||||
- **Alpha:** The API may change in incompatible ways in a later software release without notice, recommended for use only in short-lived testing clusters, due to increased risk of bugs and lack of long-term support.
|
||||
- **Beta:** Support for the overall features will not be dropped, though details may change. Support for upgrading or migrating between versions will be provided, either through automation or manual steps.
|
||||
- **Stable:** Features will appear in released software for many subsequent versions and support for upgrading between versions will be provided with software automation in the vast majority of scenarios.
|
||||
|
||||
|
||||
Name | Details | API Group | Status
|
||||
-----|---------|-----------|-------
|
||||
Rook Framework|The framework for common storage specs and logic used to support other storage providers.|rook.io/v1alpha2|Alpha
|
||||
Ceph|[Ceph](https://ceph.com/) is a distributed storage system that provides file, block and object storage and is deployed in large scale production clusters.|ceph.rook.io/v1|Stable
|
||||
CockroachDB|[CockroachDB](https://www.cockroachlabs.com/product/cockroachdb/) is a cloud-native SQL database for building global, scalable cloud services that survive disasters.|cockroachdb.rook.io/v1alpha1|Alpha
|
||||
Cassandra| [Cassandra](http://cassandra.apache.org/) is a highly available NoSQL database featuring lightning fast performance, tunable consistency and massive scalability. [Scylla](https://www.scylladb.com) is a close-to-the-hardware rewrite of Cassandra in C++, which enables much lower latencies and higher throughput.|cassandra.rook.io/v1alpha1|Alpha
|
||||
EdgeFS|[EdgeFS](http://edgefs.io) is high-performance and fault-tolerant object storage system with Geo-Transparent data access to file, block or object.|edgefs.rook.io/v1alpha1|Alpha
|
||||
Minio|[Minio](https://www.minio.io/) is a high performance distributed object storage server, designed for large-scale private cloud infrastructure.|minio.rook.io/v1alpha1|Alpha
|
||||
NFS|[Network File System (NFS)](https://github.com/nfs-ganesha/nfs-ganesha/wiki) allows remote hosts to mount file systems over a network and interact with those file systems as though they are mounted locally.|nfs.rook.io/v1alpha1|Alpha
|
||||
Name | Details | API Group | Status
|
||||
---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|-------
|
||||
Rook Framework | The framework for common storage specs and logic used to support other storage providers. | rook.io/v1alpha2 | Alpha
|
||||
Ceph | [Ceph](https://ceph.com/) is a distributed storage system that provides file, block and object storage and is deployed in large scale production clusters. | ceph.rook.io/v1 | Stable
|
||||
CockroachDB | [CockroachDB](https://www.cockroachlabs.com/product/cockroachdb/) is a cloud-native SQL database for building global, scalable cloud services that survive disasters. | cockroachdb.rook.io/v1alpha1 | Alpha
|
||||
Cassandra | [Cassandra](http://cassandra.apache.org/) is a highly available NoSQL database featuring lightning fast performance, tunable consistency and massive scalability. [Scylla](https://www.scylladb.com) is a close-to-the-hardware rewrite of Cassandra in C++, which enables much lower latencies and higher throughput. | cassandra.rook.io/v1alpha1 | Alpha
|
||||
EdgeFS | [EdgeFS](http://edgefs.io) is high-performance and fault-tolerant object storage system with Geo-Transparent data access to file, block or object. | edgefs.rook.io/v1alpha1 | Alpha
|
||||
Minio | [Minio](https://www.minio.io/) is a high performance distributed object storage server, designed for large-scale private cloud infrastructure. | minio.rook.io/v1alpha1 | Alpha
|
||||
NFS | [Network File System (NFS)](https://github.com/nfs-ganesha/nfs-ganesha/wiki) allows remote hosts to mount file systems over a network and interact with those file systems as though they are mounted locally. | nfs.rook.io/v1alpha1 | Alpha
|
||||
|
||||
### Official Releases
|
||||
|
||||
|
||||
Reference in new issue
Block a user