Skip to content

Commit 8cbf84d

Browse files
authored
Merge pull request kubernetes-retired#15 from somersbmatthews/update-readme-spec
updated README.md and added spec.md
2 parents afa665f + 2958448 commit 8cbf84d

File tree

2 files changed

+47
-4
lines changed

2 files changed

+47
-4
lines changed

README.md

+29-4
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,43 @@
1-
# DRAFT ONLY : UNTIL KEP IS MERGED
2-
https://github.com/kubernetes/enhancements/pull/1383
1+
COSI repos and images:
2+
3+
[Spec](https://github.com/kubernetes-sigs/container-object-storage-interface-spec) \
4+
[API](https://github.com/kubernetes-sigs/container-object-storage-interface-api) \
5+
[Controller](https://github.com/kubernetes-sigs/container-object-storage-interface-controller) <br/>
6+
&emsp; - [images: cosi-controller](https://quay.io/repository/containerobjectstorage/objectstorage-controller?tab=tags) \
7+
[Provisioner Sidecar](https://github.com/kubernetes-sigs/container-object-storage-interface-provisioner-sidecar) <br />
8+
&emsp; - images: cosi-provisioner \
9+
[CSI Adapter](https://github.com/kubernetes-sigs/container-object-storage-interface-csi-adapter) <br />
10+
&emsp; - images: cosi-node-adapter
11+
12+
COSI deprecated repos:
13+
14+
15+
16+
[Spec](https://github.com/container-object-storage-interface/spec) \
17+
[API](https://github.com/container-object-storage-interface/api) \
18+
[Manager (i.e. Controller)](https://github.com/container-object-storage-interface/cosi-controller-manager) \
19+
[Provisioner Sidecar](https://github.com/container-object-storage-interface/cosi-provisioner-sidecar) \
20+
[Ephemeral CSI Driver](https://github.com/container-object-storage-interface/ephemeral-csi-driver)
21+
22+
323

424
# Container Object Storage Specification
525

626
Kubernetes specific Container Object Storage Interface (COSI) components.
727

828
## Community, discussion, contribution, and support
929

30+
If you are new to a SIG Storage project, check out this [contributing guide](https://github.com/kubernetes/community/blob/master/sig-storage/CONTRIBUTING.md)
31+
and the [community page](https://github.com/kubernetes/community/tree/master/sig-storage).
32+
33+
If you are new to the SIG Storage COSI project, check out the [spec](https://github.com/kubernetes-sigs/container-object-storage-interface-spec/blob/master/spec.md), [KEP](https://github.com/kubernetes/enhancements/tree/master/keps/sig-storage/1979-object-storage-support), and [project board](https://github.com/orgs/kubernetes-sigs/projects/).
34+
1035
Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/).
1136

1237
You can reach the maintainers of this project at:
1338

14-
- [Slack](https://kubernetes.slack.com/messages/sig-storage)
15-
- [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-sig-storage)
39+
- [Slack](https://kubernetes.slack.com/messages/sig-storage-cosi)
40+
- [Mailing List](https://groups.google.com/g/container-object-storage-interface-wg?pli=1)
1641

1742
### Code of conduct
1843

spec.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
#Container Object Storage Interface (COSI)
2+
3+
<!-- Based on https://github.com/container-storage-interface/spec -->
4+
5+
Authors:
6+
7+
TODO put authors' names and emails here.
8+
9+
##Notational Conventions
10+
11+
The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119) (Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997).
12+
13+
The key words "unspecified", "undefined", and "implementation-defined" are to be interpreted as described in the [rationale for the C99 standard](http://www.open-std.org/jtc1/sc22/wg14/www/C99RationaleV5.10.pdf#page=18).
14+
15+
An implementation is not compliant if it fails to satisfy one or more of the MUST, REQUIRED, or SHALL requirements for the protocols it implements.
16+
An implementation is compliant if it satisfies all the MUST, REQUIRED, and SHALL requirements for the protocols it implements.
17+
18+

0 commit comments

Comments
 (0)