Document COSI API, resources, and add a simple getting started section #17

wlan0 · 2021-01-26T06:40:32Z

tparikh · 2021-01-26T16:53:38Z

README.md


+For more information about COSI, visit our [documentation](https://github.com/kubernetes-sigs/container-object-storage-interface-api/tree/master/docs/index.md).


documentation link returns 404

same issue with link

tparikh · 2021-01-26T16:55:36Z

README.md


-API definitions for Container Object Storage.
+All API definitions are in [`apis/objectstorage.k8s.io/` ](./apis/objectstorage.k8s.io/). All API changes **_MUST_** satisfy the following requirements:


[apis/objectstorage.k8s.io/ ] has an extra space after /

tparikh · 2021-01-26T16:58:21Z

README.md

+make codegen
+```
+
+## Adding new fields to protocols


We should make this an issue template in the repository.

I agree, template is already in place.

tparikh · 2021-01-26T17:00:31Z

README.md

+ - [Deployment Guide](https://github.com/kubernetes-sigs/container-object-storage-interface-api/tree/master/docs/deployment-guide.md) 
+ - [Project Board](https://github.com/orgs/kubernetes-sigs/projects/8)
+ - [Weekly Meetings](https://github.com/kubernetes-sigs/container-object-storage-interface-api/tree/master/docs/meetings.md)
+ - [Roadmap](https://github.com/orgs/kubernetes-sigs/projects/8)


Project Board & Roadmap point to same board. Might want to consider just one Project Roadmap link instead.

Roadmap and Work in Progress

tparikh · 2021-01-26T17:06:48Z

docs/meetings.md

+----------------
+
+### Engineering meeting
+ - Monday at 11:00 - 11:30 AM PST


Can we replace the date/time with something like Monday at 11:00AM - 11:30AM PT. Make it easy for folks not in PT time zone and avoid confusion around Daylight Savings Time

tparikh · 2021-01-26T17:19:28Z

docs/meetings.md

@@ -0,0 +1,21 @@
+---


Replace with # Weekly Community Meetings

I thought doc purely technical. I prefer meeting.md can be merged into the top level readme.

tparikh · 2021-01-26T17:19:53Z

docs/meetings.md

+Weekly Meetings
+----------------
+
+### Engineering meeting


change from ### to ##

tparikh · 2021-01-26T17:20:00Z

docs/meetings.md

+ - [SIG Storage Zoom Meeting Room](https://zoom.us/s/614261834)
+ - Password is ```77777```
+
+### Community Meeting


change from ### to ##

tparikh · 2021-01-26T17:20:07Z

docs/meetings.md

+ - [SIG Storage Zoom Meeting Room](https://zoom.us/s/614261834)
+ - Password is ```77777```
+
+### Organizers


change from ### to ##

tparikh · 2021-01-26T17:22:17Z

docs/meetings.md

+ - [SIG Storage Zoom Meeting Room](https://zoom.us/s/614261834)
+ - Password is ```77777```
+
+### Community Meeting


Include link to meeting minutes and recordings.

tparikh · 2021-01-26T17:26:00Z

docs/meetings.md

+Weekly Meetings
+----------------
+
+### Engineering meeting


Include link to meeting minutes and recordings.

tparikh · 2021-01-26T18:42:15Z

docs/meetings.md

@@ -0,0 +1,23 @@
+---
+title: Weekly Community Meetings
+---


Remove this block? I don't think it is needed.

--- title: Weekly Community Meetings ---

tparikh · 2021-01-26T18:42:46Z

docs/meetings.md

+---
+
+# Weekly Meetings
+----------------


Delete this line ----------------

This is a part of markdown

tparikh · 2021-01-26T18:45:44Z

docs/meetings.md

+----------------
+
+## Engineering meeting
+ - Monday at 11:00AM - 11:30AM PT


Add link to calendar event similar to community meeting here as well.

I dont have a public link for now. We'll have to move forward with this for now

k8s-ci-robot · 2021-01-26T18:48:36Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tparikh, wlan0

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [wlan0]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

tparikh · 2021-01-26T18:49:24Z

LGTM

jeffvance · 2021-01-26T19:05:07Z

README.md

+
+# Container Object Storage Interface Spec
+
+This repository hosts the API defintion of the Custom Resource Definitions (CRD) used for the Container Object Storage Interface (COSI) project. The provisioned unit of storage is a `Bucket`. The following CRDs are defined for managing the lifecycle of Buckets:


typo: Definition

brahmaroutu · 2021-01-26T19:00:35Z

README.md

+make codegen
+```
+
+## Adding new fields to protocols


I agree, template is already in place.

brahmaroutu · 2021-01-26T19:02:00Z

README.md


-## Community, discussion, contribution, and support
+ - Must be backwards compatible
+ - Must be in-sync with the API definitions in [sigs.k8s.io/container-object-storage-interface-spec](https://github.com/kubernetes-sigs/container-object-storage-interface-spec)


Should we detail a bit more here, not all of the API but only the protocol structure right?

might be overkill for inital doc PR

brahmaroutu · 2021-01-26T19:04:14Z

docs/meetings.md

@@ -0,0 +1,21 @@
+---


I thought doc purely technical. I prefer meeting.md can be merged into the top level readme.

jeffvance · 2021-01-26T19:10:50Z

README.md

+## References
+
+ - [Documentation](docs/index.md)
+ - [Deployment Guide](docs/deployment-guide.md) 


@tparikh is working on the deployment guide

brahmaroutu · 2021-01-26T19:12:09Z

/lgtm

jeffvance · 2021-01-26T19:12:40Z

README.md

This link is one level more direct: https://github.com/kubernetes/community/blob/master/code-of-conduct.md

but maybe you prefer the link to be inside the repo here?

jeffvance · 2021-01-26T19:18:26Z

docs/index.md

+
+ - Automate object storage provisioning, access and management
+ - Provide a common layer of abstraction for consuming object storage
+ - Facilitate lift and shift of workloads across object storage providers (i.e. prevent vendor lock-in)


Instead of "lift and shift", or in addition to this goal, I would include the important goal of app portability across the same protocols.

do you have a one-liner that i could just add to that list?

jeffvance · 2021-01-26T19:20:13Z

docs/index.md

+ - No common protocol for consumption across various implementations of object storage. 
+ - Management policies and primitives - for instance, mounting and unmounting do not apply to object storage.
+
+The existing primitives in CSI do not apply to objectstorage. Thus the need for a new standard to automate the management of objectstorage.


"objectstorage" -> "object storage"

You mention POSIX but do you want to also mention that, unlike POSIX and iSCSI, there is no standard defining bucket provisioning?

It is implicitly assumed at the beginning of this section. Should we mention this though?

jeffvance · 2021-01-26T19:22:32Z

docs/index.md

+
+## Links
+
+ - [User Guide](user-guide.md) <!-- this should explain all use cases of COSI, and include a section for best pratices -->


yeah, @tparikh needs to get working fast to add these docs

jeffvance · 2021-01-26T19:22:43Z

docs/index.md

+## Links
+
+ - [User Guide](user-guide.md) <!-- this should explain all use cases of COSI, and include a section for best pratices -->
+ - [Deployment Guide](deployment-guide.md)


jeffvance · 2021-01-26T19:22:59Z

docs/index.md

+
+ - [User Guide](user-guide.md) <!-- this should explain all use cases of COSI, and include a section for best pratices -->
+ - [Deployment Guide](deployment-guide.md)
+ - [How to write a COSI driver](how-to-write-a-cosi-driver.md)


jeffvance · 2021-01-26T19:23:12Z

docs/index.md

+ - [User Guide](user-guide.md) <!-- this should explain all use cases of COSI, and include a section for best pratices -->
+ - [Deployment Guide](deployment-guide.md)
+ - [How to write a COSI driver](how-to-write-a-cosi-driver.md)
+ - [How to make your application COSI-compatible](how-to-make-your-application-cosi-compatible.md) 


jeffvance · 2021-01-26T19:23:24Z

docs/index.md

+
+## Advanced
+
+ - [Protocols](protocols.md) <!-- cosi protocols as the API between COSI and applications  -->


jeffvance · 2021-01-26T19:23:36Z

docs/index.md

+## Advanced
+
+ - [Protocols](protocols.md) <!-- cosi protocols as the API between COSI and applications  -->
+ - [Architecture](architecture.md) <!-- components, object lifecycles, and [sidecar <-> driver] swimlane diagram etc. -->


jeffvance · 2021-01-26T19:23:47Z

docs/index.md

+
+ - [Protocols](protocols.md) <!-- cosi protocols as the API between COSI and applications  -->
+ - [Architecture](architecture.md) <!-- components, object lifecycles, and [sidecar <-> driver] swimlane diagram etc. -->
+ - [Internals](internals.md) <!-- implementation details such as finalizers, bucket naming scheme etc. -->


k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 26, 2021

k8s-ci-robot requested review from jsafrane and rrati January 26, 2021 06:40

k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 26, 2021

tparikh reviewed Jan 26, 2021

View reviewed changes

docs/meetings.md Outdated

Weekly Meetings

----------------

### Engineering meeting

Copy link

Contributor

tparikh Jan 26, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

change from ### to ##

tparikh reviewed Jan 26, 2021

View reviewed changes

wlan0 force-pushed the master branch 3 times, most recently from db3995b to 528bd2a Compare January 26, 2021 18:11

documentation updates

d80c752

wlan0 force-pushed the master branch from 528bd2a to d80c752 Compare January 26, 2021 18:12

tparikh reviewed Jan 26, 2021

View reviewed changes

tparikh approved these changes Jan 26, 2021

View reviewed changes

jeffvance reviewed Jan 26, 2021

View reviewed changes

brahmaroutu reviewed Jan 26, 2021

View reviewed changes

jeffvance reviewed Jan 26, 2021

View reviewed changes

k8s-ci-robot assigned brahmaroutu Jan 26, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 26, 2021

k8s-ci-robot merged commit 321abab into kubernetes-retired:master Jan 26, 2021

jeffvance reviewed Jan 26, 2021

View reviewed changes

docs/index.md

## Advanced

- [Protocols](protocols.md) 

Copy link

jeffvance Jan 26, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

404

jeffvance reviewed Jan 26, 2021

View reviewed changes


		For more information about COSI, visit our [documentation](https://github.com/kubernetes-sigs/container-object-storage-interface-api/tree/master/docs/index.md).


		API definitions for Container Object Storage.
		All API definitions are in [`apis/objectstorage.k8s.io/` ](./apis/objectstorage.k8s.io/). All API changes _MUST_ satisfy the following requirements:


		# Container Object Storage Interface Spec

		This repository hosts the API defintion of the Custom Resource Definitions (CRD) used for the Container Object Storage Interface (COSI) project. The provisioned unit of storage is a `Bucket`. The following CRDs are defined for managing the lifecycle of Buckets:


		## Links

		- [User Guide](user-guide.md) <!-- this should explain all use cases of COSI, and include a section for best pratices -->


		## Advanced

		- [Protocols](protocols.md) <!-- cosi protocols as the API between COSI and applications -->

Document COSI API, resources, and add a simple getting started section #17

Document COSI API, resources, and add a simple getting started section #17

Conversation

wlan0 commented Jan 26, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tparikh Jan 26, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jan 26, 2021

tparikh commented Jan 26, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brahmaroutu commented Jan 26, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeffvance Jan 26, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeffvance Jan 26, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tparikh Jan 26, 2021 •

edited

Loading

jeffvance Jan 26, 2021 •

edited

Loading

jeffvance Jan 26, 2021 •

edited

Loading