README
¶
Container Object Storage Interface
This repository hosts the Container Object Storage Interface (COSI) project.
[!IMPORTANT] This
mainbranch contains pre-alpha code and APIs for COSIv1alpha2.
Forv1alpha1APIs, code, or development, use branchrelease-0.2
Documentation
To deploy, run kubectl apply -k .
Documentation can be found under: https://container-object-storage-interface.sigs.k8s.io/
References
- Weekly meetings: Thursdays from 13:30 to 14:00 US Eastern Time
- Roadmap
Community, discussion, contribution, and support
You can reach the maintainers of this project at:
- #sig-storage-cosi Slack channel (preferred)
- GitHub Issues
- container-object-storage-interface mailing list
Code of conduct
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.
Developer Guide
All API definitions and behavior must follow the v1alpha2 KEP PR.
Minor deviation from the KEP is acceptable in order to fix bugs.
v1alpha2 is currently pre-release.
Changes may break compatibility up until v1alpha2 is released with a semver tag.
After the first v1alpha2 semver release (e.g., 0.3.0), all changes must be backwards compatible.
Before making a COSI contribution, please read and follow the core developer guide.
Directories
¶
| Path | Synopsis |
|---|---|
|
client
module
|
|
|
controller
module
|
|
|
cmd
command
|
|
|
internal
module
|
|
|
errors
COSI internal error types.
|
COSI internal error types. |
|
handoff
Package handoff defines logic needed for handing off control of resources between Controller and Sidecar.
|
Package handoff defines logic needed for handing off control of resources between Controller and Sidecar. |
|
predicate
Package predicate defines controller-runtime Predicates that are re-used by COSI controllers to filter resource events before controller reconcile.
|
Package predicate defines controller-runtime Predicates that are re-used by COSI controllers to filter resource events before controller reconcile. |
|
protocol
Package protocol contains definitions and functions for transforming COSI gRPC spec definitions into COSI Kubernetes definitions.
|
Package protocol contains definitions and functions for transforming COSI gRPC spec definitions into COSI Kubernetes definitions. |
|
proto
module
|
|
|
sidecar
module
|
|
|
cmd
command
|
|