From 6e1a8a1139f039069ed53c69b4ed8c72d7d59bee Mon Sep 17 00:00:00 2001 From: Tejas Parikh Date: Tue, 25 May 2021 17:56:39 -0400 Subject: [PATCH] updated links in README.md --- README.md | 6 ++-- docs/deployment-guide.md | 75 ---------------------------------------- docs/index.md | 40 --------------------- docs/meetings.md | 23 ------------ 4 files changed, 3 insertions(+), 141 deletions(-) delete mode 100644 docs/deployment-guide.md delete mode 100644 docs/index.md delete mode 100644 docs/meetings.md diff --git a/README.md b/README.md index ce2ea336..c57c260a 100644 --- a/README.md +++ b/README.md @@ -55,9 +55,9 @@ Title: [RFC] Changes to protocol xyz ## References - - [Documentation](docs/index.md) - - [Deployment Guide](docs/deployment-guide.md) - - [Weekly Meetings](docs/meetings.md) + - [Documentation](https://container-object-storage-interface.github.io/) + - [Deployment Guide](https://container-object-storage-interface.github.io/docs/deployment-guide) + - [Weekly Meetings](https://container-object-storage-interface.github.io/docs/community/weekly-meetings) - [Roadmap](https://github.com/orgs/kubernetes-sigs/projects/8) ## Community, discussion, contribution, and support diff --git a/docs/deployment-guide.md b/docs/deployment-guide.md deleted file mode 100644 index 1100103c..00000000 --- a/docs/deployment-guide.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: Deploying Container Object Storage Interface (COSI) On Kubernetes ---- -# Deploying Container Object Storage Interface (COSI) On Kubernetes - -This document describes steps for Kubernetes administrators to setup Container Object Storage Interface (COSI) onto a Kubernetes cluster. -## Overview - -Following components that need to be deployed in Kubernetes to setup COSI. - -- CustomResourceDefinitions (CRDs) -- Controller -- Driver -- Sidecar for the driver -- Node Adapter - -### Quick Start - -Execute following commands to setup COSI: - -```sh -# Install CRDs -kubectl create -k github.com/kubernetes-sigs/container-object-storage-interface-api - -# Install controller -kubectl create -k github.com/kubernetes-sigs/container-object-storage-interface-controller - -# Sample Provisioner and Sidecar -kubectl create -k github.com/kubernetes-sigs/container-object-storage-interface-provisioner-sidecar - -# Node Adapter -kubectl create -k github.com/kubernetes-sigs/container-object-storage-interface-csi-adapter -``` - -### CustomResourceDefinitions - -COSI acts on following custom resource definitions (CRDs): - -- `BucketRequest` - Represents a request to provision a Bucket -- `BucketClass` - Represents a class of Buckets with similar characteristics -- `Bucket` - Represents a Bucket or its equivalent in the storage backend -- `BucketAccessRequest` - Represents a request to access a Bucket -- `BucketAccessClass` - Represents a class of accessors with similar access requirements -- `BucketAccess` - Represents a access token or service account in the storage backend - -All [COSI custom resource definitions](../crds) can be installed using [kustomization file](../kustomization.yaml) and `kubectl` with following command: - -```sh -kubectl create -k github.com/kubernetes-sigs/container-object-storage-interface-api -``` - -### Controller - -COSI controller can be setup using the [kustomization file](https://github.com/kubernetes-sigs/container-object-storage-interface-controller/blob/master/kustomization.yaml) from the [container-object-storage-interface-controller](https://github.com/kubernetes-sigs/container-object-storage-interface-controller) repository with following command: - -```sh -kubectl create -k github.com/kubernetes-sigs/container-object-storage-interface-controller -``` - -The controller will be deployed in the `default` namespace. - -### Sample Driver & Sidecar - -Sample Driver & Sidecar can be setup using the [kustomization file](https://github.com/kubernetes-sigs/container-object-storage-interface-provisioner-sidecar/blob/master/kustomization.yaml) from the [container-object-storage-interface-provisioner-sidecar](https://github.com/kubernetes-sigs/container-object-storage-interface-provisioner-sidecar) repository with following command: - -```sh -kubectl create -k github.com/kubernetes-sigs/container-object-storage-interface-provisioner-sidecar -``` -### Node Adapter - -Node adapter can be setup using the [kustomization file](https://github.com/kubernetes-sigs/container-object-storage-interface-csi-adapter/blob/master/kustomization.yaml) from the [container-object-storage-interface-csi-adapter](https://github.com/kubernetes-sigs/container-object-storage-interface-csi-adapter) repository with following command: - -```sh -kubectl create -k github.com/kubernetes-sigs/container-object-storage-interface-csi-adapter -``` diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 3e80eb93..00000000 --- a/docs/index.md +++ /dev/null @@ -1,40 +0,0 @@ -Container Object Storage Interface (COSI) ------------------------------------------- - -Container Object Storage Interface (COSI) is a set of abstractions for provisioning and management of object storage. It aims to be a common layer of abstraction across multiple object storage vendors, such that workloads can request and automatically be provisioned object storage buckets. - -The goals of this project are: - - - 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) - -## Why another standard? - -Kubernetes abstracts file/block storage via the CSI standard. The primitives for file/block storage do not extend well to object storage. Here is the **_extremely_** concise and incomplete list of reasons why: - - - Unit of provisioned storage - Bucket instead of filesystem mount or blockdevice. - - Access is over the network instead of local POSIX calls. - - 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. - -## Links - - - [User Guide](user-guide.md) - - [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) - -## Advanced - - - [Protocols](protocols.md) - - [Architecture](architecture.md) - - [Internals](internals.md) - -## Other - - - [Project Board](https://github.com/orgs/kubernetes-sigs/projects/8) - - [Weekly Meetings](https://sigs.k8s.io/container-object-storage-interface-api/tree/master/docs/meetings.md) - - [Roadmap](https://github.com/orgs/kubernetes-sigs/projects/8) diff --git a/docs/meetings.md b/docs/meetings.md deleted file mode 100644 index 86fc7d7e..00000000 --- a/docs/meetings.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Weekly Community Meetings ---- - -# Weekly Meetings ----------------- - -## Engineering meeting - - Monday at 11:00AM - 11:30AM PT - - [SIG Storage Zoom Meeting Room](https://zoom.us/s/614261834) (Password is ```77777```) - - [Meeting Recordings](https://www.youtube.com/channel/UCiOeuJ6L4rYNC1jwZFRmC5Q/search?query=object+bucket+standup) - - [Meeting Notes](https://docs.google.com/document/d/1KTh1y9klby64t7btNULtxLWDkRC9SAWE-SZnJeFZqug/edit?usp=sharing) - -## Community Meeting - - [Thursday at 10:00AM - 11:00AM PT](https://calendar.google.com/calendar/event?eid=MmM5bzU5bWtjaG41Z2dlcXViaWtmNGxpbmZfMjAyMTAxMjhUMTgwMDAwWiB2dnZvNDhyNmNwcmNjaWkxbHNhdmE2cDJ1Y0Bn&ctz=America/Los_Angeles) - - [SIG Storage Zoom Meeting Room](https://zoom.us/s/614261834) (Password is ```77777```) - - [Meeting Recordings](https://www.youtube.com/channel/UCiOeuJ6L4rYNC1jwZFRmC5Q/search?query=object+bucket+review) - - [Meeting Notes](https://docs.google.com/document/d/1KTh1y9klby64t7btNULtxLWDkRC9SAWE-SZnJeFZqug/edit?usp=sharing) - -## Organizers - - - Sidhartha Mani (@wlan0) - - Jeff Vance (@jeffvance)