|
1 | | -  |
2 | | - |
| 1 | + |
| 2 | + |
| 3 | +[](https://container-object-storage-interface.sigs.k8s.io/) |
3 | 4 |
|
4 | 5 | # Container Object Storage Interface |
5 | 6 |
|
6 | 7 | This repository hosts the Container Object Storage Interface (COSI) project. |
7 | 8 |
|
| 9 | +> [!IMPORTANT] |
| 10 | +> This `main` branch contains pre-alpha code and APIs for COSI `v1alpha2`.<br> |
| 11 | +> For `v1alpha1` APIs, code, or development, use branch `release-0.2` |
| 12 | +
|
8 | 13 | ## Documentation |
9 | 14 |
|
10 | 15 | To deploy, run `kubectl apply -k .` |
11 | 16 |
|
12 | | -## Developer Guide |
13 | | - |
14 | | -All API definitions are in [`client/apis/objectstorage`](./client/apis/objectstorage/). All API changes **_MUST_** satisfy the following requirements: |
15 | | - |
16 | | -- Must be backwards compatible |
17 | | -- Must be in-sync with the API definitions in [sigs.k8s.io/container-object-storage-interface-spec](https://sigs.k8s.io/container-object-storage-interface-spec) |
| 17 | +Documentation can be found under: https://container-object-storage-interface.sigs.k8s.io/ |
18 | 18 |
|
19 | | -### Build and Test |
| 19 | +## References |
20 | 20 |
|
21 | | -See `make help` for assistance |
| 21 | +- [Weekly meetings](https://www.kubernetes.dev/resources/calendar/): Thursdays from 13:30 to 14:00 US Eastern Time |
| 22 | +- [Roadmap](https://github.com/orgs/kubernetes-sigs/projects/63/) |
22 | 23 |
|
23 | | -## Adding new fields to protocols |
| 24 | +## Community, discussion, contribution, and support |
24 | 25 |
|
25 | | -Create a new issue raising a RFC for the changes following this format: |
| 26 | +You can reach the maintainers of this project at: |
26 | 27 |
|
27 | | -**Title:** [RFC] Changes to protocol xyz |
| 28 | +- [#sig-storage-cosi](https://kubernetes.slack.com/messages/sig-storage-cosi) Slack channel **(preferred)** |
| 29 | +- [GitHub Issues](https://github.com/kubernetes-sigs/container-object-storage-interface/issues) |
| 30 | +- [container-object-storage-interface](https://groups.google.com/g/container-object-storage-interface-wg) mailing list |
28 | 31 |
|
29 | | -**Description:** |
30 | | -> 1. Protocol: |
31 | | -> 2. Fields Added: |
32 | | -> 3. Why is this change necessary? |
33 | | -> ...(describe why here)... |
34 | | -> 4. Which other COSI projects are affected by this change? |
35 | | -> 5. Upgrade plan |
36 | | -> (ignore if it doesn't apply) |
| 32 | +### Code of conduct |
37 | 33 |
|
38 | | -## References |
| 34 | +Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md). |
39 | 35 |
|
40 | | - - Weekly Meetings: Thursdays from 13:30 to 14:00 US Eastern Time |
41 | | - - [Roadmap](https://github.com/orgs/kubernetes-sigs/projects/63/) |
| 36 | +## Developer Guide |
42 | 37 |
|
43 | | -## Community, discussion, contribution, and support |
| 38 | +Before contributing a Pull Request, ensure a [GitHub |
| 39 | +issue](https://github.com/kubernetes-sigs/container-object-storage-interface/issues) exists corresponding to the change. |
44 | 40 |
|
45 | | -You can reach the maintainers of this project at: |
| 41 | +All API definitions and behavior must follow the [`v1alpha2` KEP PR](https://github.com/kubernetes/enhancements/pull/4599). |
| 42 | +Minor deviation from the KEP is acceptable in order to fix bugs. |
46 | 43 |
|
47 | | - - [#sig-storage-cosi](https://kubernetes.slack.com/messages/sig-storage-cosi) slack channel |
48 | | - - [container-object-storage-interface](https://groups.google.com/g/container-object-storage-interface-wg?pli=1) mailing list |
| 44 | +`v1alpha2` is currently pre-release. |
| 45 | +Changes may break compatibility up until `v1alpha2` is released with a semver tag. |
| 46 | +After the first `v1alpha2` semver release (e.g., 0.3.0), all changes must be backwards compatible. |
49 | 47 |
|
50 | | -### Code of conduct |
| 48 | +### Build and Test |
51 | 49 |
|
52 | | -Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md). |
| 50 | +See `make help` for assistance |
0 commit comments