Files
my-rook-config/Documentation
Joshua Hoblitt e32ea6cbab docs: document the CI checks that gate a pull request
The development flow guide described running unit tests and `make lint`, but
several other checks also gate every pull request and were documented nowhere:
`make golangci-lint`, `make codegen`, `make crds`, and commitlint. A contributor
had no way to learn about them short of pushing and reading a red CI run.

Add a table of the gating checks and the command that runs each one locally,
and document the parts that are easy to get wrong:

- Any change under `pkg/apis` requires regenerating the client, deepcopy
  functions, CRD manifests, and CRD reference docs, and the regenerated files
  belong in the same commit. This includes editing a godoc comment, since those
  comments are copied verbatim into the CRD description fields.
- Commitlint infers a trailer from the shape of a line, so a body line that
  begins with a word followed by a colon is read as one, and the commit is
  rejected with `footer-leading-blank`.
- The commit prefix must come from the type list in `.commitlintrc.json`.

Also note that `make test` only covers `cmd/` and `pkg/`, so test files under
`tests/framework/` are compiled but never run by the unit test CI.

Signed-off-by: Joshua Hoblitt <josh@hoblitt.com>
2026-07-27 16:25:27 -07:00
..
2026-07-09 19:31:22 +02:00
2026-07-09 19:31:22 +02:00
2024-03-06 23:17:45 +05:30
2026-07-09 19:30:43 +02:00

title
title
Rook

Rook

Rook is an open source cloud-native storage orchestrator, providing the platform, framework, and support for Ceph storage to natively integrate with cloud-native environments.

Ceph is a distributed storage system that provides file, block and object storage and is deployed in large scale production clusters.

Rook automates deployment and management of Ceph to provide self-managing, self-scaling, and self-healing storage services. The Rook operator does this by building on Kubernetes resources to deploy, configure, provision, scale, upgrade, and monitor Ceph.

The Ceph operator was declared stable in December 2018 in the Rook v0.9 release, providing a production storage platform for many years. Rook is hosted by the Cloud Native Computing Foundation (CNCF) as a graduated level project.

Quick Start Guide

Starting Ceph in your cluster is as simple as a few kubectl commands. See our Quickstart guide to get started with the Ceph operator!

Designs

Ceph is a highly scalable distributed storage solution for block storage, object storage, and shared filesystems with years of production deployments. See the Ceph overview.

For detailed design documentation, see also the design docs.

Need help? Be sure to join the Rook Slack

If you have any questions along the way, don't hesitate to ask in our Slack channel. Sign up for the Rook Slack here.