Joshua Hoblitt
e32ea6cbab
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>
What is Rook?
Rook is an open source cloud-native storage orchestrator for Kubernetes, providing the platform, framework, and support for Ceph storage to natively integrate with Kubernetes.
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 status of the Ceph storage provider is Stable. Features and improvements will be planned for many future versions. Upgrades between versions are provided to ensure backward compatibility between releases.
Rook is hosted by the Cloud Native Computing Foundation (CNCF) as a graduated 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 and QuickStart Guide.
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.
Reporting Security Vulnerabilities
If you find a vulnerability or a potential vulnerability in Rook please let us know immediately at cncf-rook-security@lists.cncf.io. We'll send a confirmation email to acknowledge your report, and we'll send an additional email when we've identified the issues positively or negatively.
For further details, please see the complete security release process.
Contact
Please use the following to reach members of the community:
- Slack: Join our slack channel
- GitHub: Start a discussion or open an issue
- Twitter: @rook_io
- Security topics: cncf-rook-security@lists.cncf.io
- Events: Join community events on the public calendar
Community Meeting
A regular community meeting takes place the 2nd Tuesday of every month 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.
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-lfx.platform.linuxfoundation.org/meeting/91717550604?password=00364872-d5f3-440e-9c59-eca74d04ca51
- Current agenda and past meeting notes
- Past meeting recordings
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.
