Skip to content
This repository was archived by the owner on Jan 30, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/community/support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Your Title Here
---
11 changes: 11 additions & 0 deletions docs/community/team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Team
---

## Tech Leads

## Active Contributors

## Honorary Alumni

## Acknowledgements
3 changes: 3 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Contributing
---
25 changes: 0 additions & 25 deletions docs/create-a-blog-post.md

This file was deleted.

38 changes: 0 additions & 38 deletions docs/create-a-document.md

This file was deleted.

45 changes: 0 additions & 45 deletions docs/create-a-page.md

This file was deleted.

77 changes: 77 additions & 0 deletions docs/deployment-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
title: Deploying COSI
# slug: /
---

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
```
28 changes: 0 additions & 28 deletions docs/getting-started.md

This file was deleted.

4 changes: 4 additions & 0 deletions docs/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Introduction
slug: /
---
3 changes: 3 additions & 0 deletions docs/roadmap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Roadmap
---
3 changes: 3 additions & 0 deletions docs/template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Support
---
17 changes: 0 additions & 17 deletions docs/thank-you.md

This file was deleted.

3 changes: 3 additions & 0 deletions docs/user-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Using COSI
---
3 changes: 3 additions & 0 deletions docs/write-driver/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Your Title Here
---
29 changes: 17 additions & 12 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,23 @@ module.exports = {
src: 'img/logo.svg',
},
items: [
// {
// to: 'docs/',
// activeBasePath: 'docs',
// label: 'Docs',
// position: 'left',
// },
// {to: 'blog', label: 'Blog', position: 'left'},
// {
// href: 'https://github.com/facebook/docusaurus',
// label: 'GitHub',
// position: 'right',
// },
{
to: 'docs/',
activeBasePath: 'docs',
label: 'Docs',
position: 'left',
},
{
type: 'doc',
position: 'left',
docId: 'community/team',
label: 'Community',
},
{
href: 'https://github.com/facebook/docusaurus',
label: 'GitHub',
position: 'right',
},
],
},
footer: {
Expand Down
Loading