Container Object Storage Interface

This repository hosts the Container Object Storage Interface (COSI) project.

Important

This main branch contains pre-alpha code and APIs for COSI v1alpha2.
For v1alpha1 APIs, code, or development, use branch release-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

Before contributing a Pull Request, ensure a GitHub issue exists corresponding to the change.

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.

Build and Test

See make help for assistance