Documentation

    PLEASE NOTE: This document applies to an unreleased version of Rook. It is strongly recommended that you only use official releases of Rook, as unreleased versions are subject to changes and incompatibilities that will not be supported in the official releases.

    If you are using an official release version of Rook, you should refer to the documentation for your specific version.

    Documentation for other releases can be found by using the version selector in the bottom left of any doc page.

    Rook

    Rook is an open source cloud-native storage orchestrator, 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 status of storage solutions currently supported by Rook, please refer to the project status section of the Rook repository. We plan to continue adding support for other storage systems and environments based on community demand and engagement in future releases.

    Quick Start Guides

    Starting Rook in your cluster is as simple as a few kubectl commands depending on the storage provider. See our Quickstart guide list for the detailed instructions for each storage provider.

    Storage Provider Designs

    High-level Storage Provider design documents:

    Storage Provider Status Description
    Ceph Stable Ceph is a highly scalable distributed storage solution for block storage, object storage, and shared filesystems with years of production deployments.
    EdgeFS Stable EdgeFS is high-performance and fault-tolerant object storage system with Geo-Transparent data access to file, block or object.

    Low level design documentation for supported list of storage systems collected at design docs section.

    Need help? Be sure to join the Rook Slack

    If you have any questions along the way, please don’t hesitate to ask us in our Slack channel. You can sign up for our Slack here.