README
¶
What is Rook?
Rook is an open source orchestrator for distributed storage systems running in cloud native environments.
Rook turns distributed storage software into a self-managing, self-scaling, and self-healing storage services. It does this by automating deployment, bootstrapping, configuration, provisioning, scaling, upgrading, migration, disaster recovery, monitoring, and resource management. Rook uses the facilities provided by the underlying cloud-native container management, scheduling and orchestration platform to perform its duties.
Rook integrates deeply into cloud native environments leveraging extension points and providing a seamless experience for scheduling, lifecycle management, resource management, security, monitoring, and user experience.
Rook is currently in alpha state and has focused initially on orchestrating Ceph on-top of Kubernetes. Ceph is a distributed storage system that provides file, block and object storage and is deployed in large scale production clusters. Rook plans to add support for other storage systems beyond Ceph and other cloud native environments beyond Kubernetes in future releases. See our roadmap for more details.
Getting Started and Documentation
For installation, deployment, and administration, see our Documentation.
Contributing
We welcome contributions. See Contributing to get started.
Report a Bug
For filing bugs, suggesting improvements, or requesting new features, please open an issue.
Contact
Please use the following to reach members of the community:
- Slack: Join our slack channel
- Forums: rook-dev
- Twitter: @rook_io
- Email: info@rook.io
Licensing
Rook is under the Apache 2.0 license.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
pkg
|
|
|
agent
Package agent to manage Kubernetes storage attach events.
|
Package agent to manage Kubernetes storage attach events. |
|
agent/flexvolume
Package flexvolume to manage Kubernetes storage attach events.
|
Package flexvolume to manage Kubernetes storage attach events. |
|
agent/flexvolume/crd
Package crd to manage volume attachment custom resource.
|
Package crd to manage volume attachment custom resource. |
|
operator
Package operator to manage Kubernetes storage.
|
Package operator to manage Kubernetes storage. |
|
operator/agent
Package agent to manage Kubernetes storage attach events.
|
Package agent to manage Kubernetes storage attach events. |
|
operator/api
Package api for the operator api manager.
|
Package api for the operator api manager. |
|
operator/cluster
Package cluster to manage a rook cluster.
|
Package cluster to manage a rook cluster. |
|
operator/k8sutil
Package k8sutil for Kubernetes helpers.
|
Package k8sutil for Kubernetes helpers. |
|
operator/mds
Package mds to manage a rook file system.
|
Package mds to manage a rook file system. |
|
operator/mgr
Package mgr for the Ceph manager.
|
Package mgr for the Ceph manager. |
|
operator/mon
Package mon for the Ceph monitors.
|
Package mon for the Ceph monitors. |
|
operator/osd
Package osd for the Ceph OSDs.
|
Package osd for the Ceph OSDs. |
|
operator/pool
Package pool to manage a rook pool.
|
Package pool to manage a rook pool. |
|
operator/provisioner
Package provisioner to provision Rook volumes on Kubernetes.
|
Package provisioner to provision Rook volumes on Kubernetes. |
|
operator/rgw
Package rgw to manage a rook object store.
|
Package rgw to manage a rook object store. |
|
operator/test
Package test for the operator tests.
|
Package test for the operator tests. |
|
tests
|
|