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

Commit 0006e98

Browse files
committed
cosi deployment doc for setting up CRDs
1 parent 321abab commit 0006e98

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

Diff for: docs/deployment-guide.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Deploying Container Object Storage Interface (COSI) On Kubernetes
2+
3+
This document describes steps for Kubernetes administrators to setup Container Object Storage Interface (COSI) onto a Kubernetes cluster.
4+
5+
## Overview
6+
7+
There are four components that need to be deployed in Kubernetes to setup COSI.
8+
9+
- CustomResourceDefinitions (CRDs)
10+
- Controller
11+
- Provisioner Sidecar
12+
- Node Adapter
13+
14+
### CustomResourceDefinitions
15+
16+
COSI acts on following [custom resource definitions (CRDs)](https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/):
17+
18+
- [BucketClass](https://github.com/kubernetes/enhancements/tree/master/keps/sig-storage/1979-object-storage-support#bucketclass), which is an immutable, cluster-scoped, custom resource to provide admins control over the handling of bucket provisioning.
19+
- [BucketRequest](https://github.com/kubernetes/enhancements/tree/master/keps/sig-storage/1979-object-storage-support#bucketrequest), which is a user facing, namespaced custom resource requesting provisioning of a new bucket, or requesting access to an existing bucket.
20+
- [Bucket](https://github.com/kubernetes/enhancements/tree/master/keps/sig-storage/1979-object-storage-support#bucket), which is a cluster-scoped custom resource representing the abstraction of a single backend bucket.
21+
- [BucketAccessRequest](https://github.com/kubernetes/enhancements/tree/master/keps/sig-storage/1979-object-storage-support#bucketaccessrequest), which is a user namespaced custom resource representing an object store user and an access policy defining the user’s relation to that storage.
22+
- [BucketAccessClass](https://github.com/kubernetes/enhancements/tree/master/keps/sig-storage/1979-object-storage-support#bucketaccessclass), which is an immutable, cluster-scoped, custom resource providing a way for admins to specify policies that may be used to access buckets.
23+
- [BucketAccess](https://github.com/kubernetes/enhancements/tree/master/keps/sig-storage/1979-object-storage-support#bucketaccess), which is a cluster-scoped administrative custom resource which encapsulates fields from the `BucketAccessRequest (BAR)` and the `BucketAccessClass (BAC)`.
24+
25+
All [COSI custom resource definitions](../crds) can be installed using the [Kustomize](https://kustomize.io/) template and kubectl with following command:
26+
27+
```sh
28+
kubectl create -k github.com/kubernetes-sigs/container-object-storage-api
29+
```

0 commit comments

Comments
 (0)