Go Shell Makefile Other
Clone or download
travisn Merge pull request #1908 from galexrt/fix_1907
osd: Truncate too long name for prepare job
Latest commit cd3d85e Jul 20, 2018
Permalink
Failed to load latest commit information.
.github github: Separated bug and feature issue templates Jun 25, 2018
Documentation docs: clear pending release notes and update upgrade guide to 0.8 Jul 19, 2018
build Define release criteria and checklist Jul 12, 2018
cluster Merge pull request #1896 from cedadev/master Jul 17, 2018
cmd tests: enable osds on devices Jul 5, 2018
design docs: update docs, guides and examples for ceph.rook.io/v1beta1 types Jul 11, 2018
images fix arm64 image builds Jul 13, 2018
pkg Merge pull request #1908 from galexrt/fix_1907 Jul 20, 2018
tests ceph: migration logic for ceph.rook.io/v1alpha1 to ceph.rook.io/v1bet… Jul 11, 2018
.gitignore prepare osd in a job per node. Once all osds are prepared, store osd … Jul 5, 2018
CODE_OF_CONDUCT.md use cncf code of conduct Jan 30, 2018
CONTRIBUTING.md add DCO sign requirement to contributing.md Jan 30, 2018
DCO initial docs and licensing Nov 8, 2016
Gopkg.lock update the go dependencies Jul 9, 2018
Gopkg.toml update dependencies for dep Dec 12, 2017
INSTALL.md images: Use ceph daemon-base as rook base May 23, 2018
Jenkinsfile prepare osd in a job per node. Once all osds are prepared, store osd … Jul 5, 2018
LICENSE initial docs and licensing Nov 8, 2016
MAINTAINERS update the maintainers email Mar 8, 2018
MAINTAINERS_RULES.md Make markdown table look better Jun 24, 2018
Makefile Disable the 'cross' build on AArch64 Apr 26, 2018
PendingReleaseNotes.md docs: clear pending release notes and update upgrade guide to 0.8 Jul 19, 2018
README.md docs: update docs, guides and examples for ceph.rook.io/v1beta1 types Jul 11, 2018
ROADMAP.md docs: User docs/guides updates for multiple storage type support May 18, 2018

README.md

logo

Build Status GitHub release Docker Pulls Go Report Card FOSSA Status Slack Twitter Follow

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.

Rook turns storage software into 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.

For more details about the storage solutions currently supported by Rook, please refer to the project status section below. We plan to continue adding support for other storage systems and environments based on community demand and engagement in future releases. See our roadmap for more details.

Rook is hosted by the Cloud Native Computing Foundation (CNCF) as sandbox level project. If you are a company that wants to help shape the evolution of technologies that are container-packaged, dynamically-scheduled and microservices-oriented, consider joining the CNCF. For details about who's involved and how Rook plays a role, read the CNCF announcement.

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:

Community Meeting

A regular community meeting takes place every other Tuesday at 9:00 AM PT (Pacific Time). Convert to your local timezone.

Any changes to the meeting schedule will be added to the agenda doc and posted to Slack #announcements and the rook-dev mailing list.

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.

Project Status

The status of each storage provider supported by Rook can be found in the table below. 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, 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.
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 is a distributed storage system that provides file, block and object storage and is deployed in large scale production clusters. ceph.rook.io/v1beta1 Beta
CockroachDB CockroachDB is a cloud-native SQL database for building global, scalable cloud services that survive disasters. cockroachdb.rook.io/v1alpha1 Alpha
Minio Minio is a high performance distributed object storage server, designed for large-scale private cloud infrastructure. minio.rook.io/v1alpha1 Alpha

Official Releases

Official releases of Rook can be found on the releases page. Please note that it is strongly recommended that you use official releases of Rook, as unreleased versions from the master branch are subject to changes and incompatibilities that will not be supported in the official releases. Builds from the master branch can have functionality changed and even removed at any time without compatibility support and without prior notice.

Licensing

Rook is under the Apache 2.0 license.

FOSSA Status