From 2958448df64ac440427c6377fa4c7a04264d7292 Mon Sep 17 00:00:00 2001 From: Somers B Matthews Date: Mon, 14 Dec 2020 11:06:40 -0600 Subject: [PATCH] updated README.md and added spec.md fixed spacing typo in README.md added repo/images table to README.md added images to README.md changed name of adapter image in README.md changed urls in README.md attempt to fix newline after table in README.md added newline in README.md added headers to README.md removed html break in README.md removed table from README.md reformated repos and images added hyphen in README.md removed punctuation in README.md --- README.md | 33 +++++++++++++++++++++++++++++---- spec.md | 18 ++++++++++++++++++ 2 files changed, 47 insertions(+), 4 deletions(-) create mode 100644 spec.md diff --git a/README.md b/README.md index b0de48e..624d468 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,25 @@ -# DRAFT ONLY : UNTIL KEP IS MERGED - https://github.com/kubernetes/enhancements/pull/1383 +COSI repos and images: + +[Spec](https://github.com/kubernetes-sigs/container-object-storage-interface-spec) \ +[API](https://github.com/kubernetes-sigs/container-object-storage-interface-api) \ +[Controller](https://github.com/kubernetes-sigs/container-object-storage-interface-controller)
+  - [images: cosi-controller](https://quay.io/repository/containerobjectstorage/objectstorage-controller?tab=tags) \ + [Provisioner Sidecar](https://github.com/kubernetes-sigs/container-object-storage-interface-provisioner-sidecar)
+   - images: cosi-provisioner \ + [CSI Adapter](https://github.com/kubernetes-sigs/container-object-storage-interface-csi-adapter)
+   - images: cosi-node-adapter + +COSI deprecated repos: + + + +[Spec](https://github.com/container-object-storage-interface/spec) \ +[API](https://github.com/container-object-storage-interface/api) \ +[Manager (i.e. Controller)](https://github.com/container-object-storage-interface/cosi-controller-manager) \ +[Provisioner Sidecar](https://github.com/container-object-storage-interface/cosi-provisioner-sidecar) \ +[Ephemeral CSI Driver](https://github.com/container-object-storage-interface/ephemeral-csi-driver) + + # Container Object Storage Specification @@ -7,12 +27,17 @@ Kubernetes specific Container Object Storage Interface (COSI) components. ## Community, discussion, contribution, and support +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) +and the [community page](https://github.com/kubernetes/community/tree/master/sig-storage). + +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/). + Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/). You can reach the maintainers of this project at: -- [Slack](https://kubernetes.slack.com/messages/sig-storage) -- [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-sig-storage) +- [Slack](https://kubernetes.slack.com/messages/sig-storage-cosi) +- [Mailing List](https://groups.google.com/g/container-object-storage-interface-wg?pli=1) ### Code of conduct diff --git a/spec.md b/spec.md new file mode 100644 index 0000000..5adef41 --- /dev/null +++ b/spec.md @@ -0,0 +1,18 @@ +#Container Object Storage Interface (COSI) + + + +Authors: + +TODO put authors' names and emails here. + +##Notational Conventions + +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). + +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). + +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. +An implementation is compliant if it satisfies all the MUST, REQUIRED, and SHALL requirements for the protocols it implements. + +