Skip to content
This repository was archived by the owner on Dec 3, 2024. It is now read-only.

Commit 7a8eb25

Browse files
updated README.md and added spec.md
1 parent afa665f commit 7a8eb25

File tree

2 files changed

+40
-2
lines changed

2 files changed

+40
-2
lines changed

Diff for: README.md

+22-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,32 @@
1-
# DRAFT ONLY : UNTIL KEP IS MERGED
2-
https://github.com/kubernetes/enhancements/pull/1383
1+
COSI repos:
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) \
6+
[Provisioner Sidecar](https://github.com/kubernetes-sigs/container-object-storage-interface-provisioner-sidecar) \
7+
[CSI Adapter](https://github.com/kubernetes-sigs/container-object-storage-interface-csi-adapter)
8+
9+
COSI deprecated repos:
10+
11+
[Spec](https://github.com/container-object-storage-interface/spec) \
12+
[API](https://github.com/container-object-storage-interface/api) \
13+
[Manager (i.e. Controller)](https://github.com/container-object-storage-interface/cosi-controller-manager) \
14+
[Provisioner Sidecar](https://github.com/container-object-storage-interface/cosi-provisioner-sidecar) \
15+
[Ephemeral CSI Driver](https://github.com/container-object-storage-interface/ephemeral-csi-driver)
16+
17+
318

419
# Container Object Storage Specification
520

621
Kubernetes specific Container Object Storage Interface (COSI) components.
722

823
## Community, discussion, contribution, and support
924

25+
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)
26+
and the [community page](https://github.com/kubernetes/community/tree/master/sig-storage).
27+
28+
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/8#card-40949963).
29+
1030
Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/).
1131

1232
You can reach the maintainers of this project at:

Diff for: 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)