Skip to content

Commit d9185ab

Browse files
shanduurshanduur
committed
docs: initial boilerplate for COSI docs website
Signed-off-by: Mateusz Urbanek <[email protected]>
1 parent a70bf11 commit d9185ab

File tree

9 files changed

+49
-0
lines changed

9 files changed

+49
-0
lines changed

‎docs/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
book

‎docs/book.toml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[book]
2+
title = "Container Object Storage Interface"
3+
description = "This site documents how to develop and deploy a Container Object Storage Interface (COSI) driver on Kubernetes."
4+
authors = ["The Kubernetes Authors"]

‎docs/src/SUMMARY.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Summary
2+
3+
- [Introduction](./introduction.md)
4+
- [Developing a COSI Driver for Kubernetes](developing/developing.md)
5+
- [Deploying a COSI Driver on Kubernetes](operations/deployment.md)
6+
- [Troubleshooting](operations/troubleshooting.md)
7+
- [Drivers](drivers.md)
8+
- [API Reference](api.md)

‎docs/src/api.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# API Reference
2+
3+
// TODO

‎docs/src/developing/developing.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Developing a COSI Driver for Kubernetes
2+
3+
// TODO

‎docs/src/drivers.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Drivers
2+
3+
| Name | COSI Driver Name | Description | Compatible with COSI Version(s) |
4+
| ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------- |
5+
| [Akamai Cloud Object Storage](https://www.linode.com/products/object-storage/) | [`objectstorage.cosi.linode.com`](https://github.com/linode/linode-cosi-driver) | A Kubernetes Container Object Storage Interface (COSI) Driver for Linode | `v1alpha1` |
6+
| [Azure Blob](https://azure.microsoft.com/en-us/products/storage/blobs) | [`blob.cosi.azure.com`](https://github.com/Azure/azure-cosi-driver) | This driver allows Kubernetes to use Azure Blob Storage using the Container Storage Object Interface (COSI) infrastructure. | `v1alpha1` |
7+
| [Ceph Rados Gateway](https://docs.ceph.com/en/latest/radosgw/) | [`ceph.objectstorage.k8s.io`](https://github.com/ceph/ceph-cosi) | COSI driver for Ceph Object Store aka RGW | `v1alpha1` |
8+
| [Dell ObjectScale](https://www.dell.com/en-us/dt/storage/objectscale.htm) | [`cosi.dellemc.com`](https://github.com/dell/cosi) | COSI Driver for Dell ObjectScale | `v1alpha1` |
9+
| [Seaweedfs](https://seaweedfs.github.io) | [`seaweedfs.objectstorage.k8s.io`](https://github.com/seaweedfs/seaweedfs-cosi-driver) | COSI driver implementation for SeaweedFS. | `v1alpha1` |
10+
11+
## Deprecated drivers
12+
13+
Deprecated drivers are no longer maintained or recommended for use with COSI; users should migrate to supported alternatives to ensure compatibility and security.
14+
15+
| Name | COSI Driver Name | Description | Compatible with COSI Version(s) |
16+
| ------------------------- | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------- |
17+
| [S3GW](https://s3gw.tech) | [`s3gw.objectstorage.k8s.io`](https://github.com/s3gw-tech/s3gw-cosi-driver) | COSI driver for s3gw | `v1alpha1` |
18+
| [MinIO](https://min.io) | [`minio.objectstorage.k8s.io`](https://github.com/kubernetes-retired/cosi-driver-minio) | Sample Driver that provides reference implementation for Container Object Storage Interface (COSI) API. | `pre-alpha` |

‎docs/src/introduction.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Introduction
2+
3+
// TODO

‎docs/src/operations/deployment.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Deploying a COSI Driver on Kubernetes
2+
3+
## Prerequisites
4+
5+
1. Install COSI Custom Resource Definitions and COSI Controller.
6+
```sh
7+
kubectl create -k 'https://github.com/kubernetes-sigs/container-object-storage-interface//?ref=v0.2.0'
8+
```

‎docs/src/operations/troubleshooting.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Troubleshooting

0 commit comments

Comments
 (0)