README
¶
provider-rook
Overview
This provider-rook repository is the Crossplane infrastructure provider for
Rook. The provider that is built from the source code in
this repository can be installed into a Crossplane control plane and adds the
following new functionality:
- Custom Resource Definitions (CRDs) that model Rook infrastructure and services (e.g. Yugabyte, CockroachDB, etc.)
- Controllers to provision these resources in a Rook Kubernetes cluster based on the users desired state captured in CRDs they create
- Implementations of Crossplane's portable resource abstractions, enabling Rook resources to fulfill a user's general need for cloud services
Getting Started and Documentation
For getting started guides, installation, deployment, and administration, see our Documentation.
Contributing
provider-rook is a community driven project and we welcome contributions. See the Crossplane Contributing guidelines 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: crossplane-dev
- Twitter: @crossplane_io
- Email: info@crossplane.io
Roadmap
provider-rook goals and milestones are currently tracked in the Crossplane repository. More information can be found in ROADMAP.md.
Governance and Owners
provider-rook is run according to the same Governance and Ownership structure as the core Crossplane project.
Code of Conduct
provider-rook adheres to the same Code of Conduct as the core Crossplane project.
Licensing
provider-rook is under the Apache 2.0 license.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package apis contains Kubernetes API for Rook.
|
Package apis contains Kubernetes API for Rook. |
|
database
Package database contains Rook database API versions
|
Package database contains Rook database API versions |
|
database/v1alpha1
Package v1alpha1 contains database service resources for Rook +kubebuilder:object:generate=true +groupName=database.rook.crossplane.io +versionName=v1alpha1
|
Package v1alpha1 contains database service resources for Rook +kubebuilder:object:generate=true +groupName=database.rook.crossplane.io +versionName=v1alpha1 |
|
v1alpha1
Package v1alpha1 contains database service resources for Rook +kubebuilder:object:generate=true +groupName=rook.crossplane.io +versionName=v1alpha1
|
Package v1alpha1 contains database service resources for Rook +kubebuilder:object:generate=true +groupName=rook.crossplane.io +versionName=v1alpha1 |
|
v1beta1
Package v1beta1 contains core Rook resources.
|
Package v1beta1 contains core Rook resources. |
|
cmd
|
|
|
pkg
|
|