https://github.com/ceph/ceph-cosi
COSI driver for Ceph Object Store aka RGW
https://github.com/ceph/ceph-cosi
bucket-requests ceph cosi kubernetes rgw
Last synced: 2 months ago
JSON representation
COSI driver for Ceph Object Store aka RGW
- Host: GitHub
- URL: https://github.com/ceph/ceph-cosi
- Owner: ceph
- License: apache-2.0
- Created: 2021-05-05T14:16:34.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-10T05:24:52.000Z (7 months ago)
- Last Synced: 2025-03-27T08:45:08.346Z (6 months ago)
- Topics: bucket-requests, ceph, cosi, kubernetes, rgw
- Language: Go
- Homepage:
- Size: 145 KB
- Stars: 42
- Watchers: 11
- Forks: 18
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
# cosi-driver-ceph
Sample Driver that provides reference implementation for Container Object Storage Interface (COSI) API for [Ceph Object Store aka RADOS Gateway (RGW)](https://docs.ceph.com/en/latest/man/8/radosgw/)
## Installing CRDs, COSI controller, Node adapter
```console
kubectl create -k github.com/kubernetes-sigs/container-object-storage-interface-api
kubectl create -k github.com/kubernetes-sigs/container-object-storage-interface-controller
```
Following pods will running in the default namespace :
```console
NAME READY STATUS RESTARTS AGE
objectstorage-controller-6fc5f89444-4ws72 1/1 Running 0 2d6h
```
## Building, Installing, Setting Up
Code can be compiled using:
```bash
make build
```
Now build docker image and provide tag as `ceph/ceph-cosi-driver:latest`
```console
make container
Sending build context to Docker daemon 41.95MB
Step 1/5 : FROM gcr.io/distroless/static:latest
---> 1d9948f921db
Step 2/5 : LABEL maintainers="Ceph COSI Authors"
---> Using cache
---> 8659e9813ec5
Step 3/5 : LABEL description="Ceph COSI driver"
---> Using cache
---> 0c55b21ff64f
Step 4/5 : COPY ./cmd/ceph-cosi-driver/ceph-cosi-driver ceph-cosi-driver
---> a21275402998
Step 5/5 : ENTRYPOINT ["/ceph-cosi-driver"]
---> Running in 620bfa992683
Removing intermediate container 620bfa992683
---> 09575229056e
Successfully built 09575229056e
docker tag ceph-cosi-driver:latest ceph/ceph-cosi-driver:latest
```
Now start the sidecar and cosi driver with:
```console
kubectl apply -k .
kubectl -n ceph-cosi-driver get pods
NAME READY STATUS RESTARTS AGE
objectstorage-provisioner-6c8df56cc6-lqr26 2/2 Running 0 26h
```
## Create Bucket Requests, Bucket Access Request and consuming it in App
```console
kubectl create -f examples/bucketclass.yaml
kubectl create -f examples/bucketclaim.yaml
kubectl create -f examples/bucketaccessclass.yaml
kubectl create -f examples/bucketaccess.yaml
```
Need to provide access details for RGW server via secret and it needs to be referenced in BucketAccessClass and BucketClass.
```yaml
parameters:
objectStoreUserSecretName:
objectStoreUserSecretNamespace:
```
In the app, credentials can be consumed as secret volume mount using the secret name specified in the BucketAccess:
```yaml
spec:
containers:
volumeMounts:
- name: cosi-secrets
mountPath: /data/cosi
volumes:
- name: cosi-secrets
secret:
secretName: sample-access-secret
```
An example for awscli pods can be found at `examples/awscliapppod.yaml`. Credentials will be in json format in the file.
```json
{
apiVersion: "v1alpha1",
kind: "BucketInfo",
metadata: {
name: "ba-$uuid"
},
spec: {
bucketName: "ba-$uuid",
authenticationType: "KEY",
endpoint: "https://rook-ceph-my-store:443",
accessKeyID: "AKIAIOSFODNN7EXAMPLE",
accessSecretKey: "wJalrXUtnFEMI/K...",
region: "us-east-1",
protocols: [
"s3"
]
}
}
```
## Known limitations
1. Handle access policies for Bucket Access Request
## Configuration Options
| Option | Default value | Description |
| ------------------------- | -------------------------------------- | -------------------------------------------------------------------|
| `--driver-address` | `unix:///var/lib/cosi/cosi.sock` | COSI driver address, must be a UNIX socket |
| `--driver-prefix` | _empty_ | prefix added before name, e.g, `.ceph.objectstorage.k8s.io`|
## Integration with Rook
The ceph cosi driver integrates with [Rook](https://rook.io/) from v1.12 onwards to provide object storage for Kubernetes applications. More details can be found [here](https://rook.io/docs/rook/v1.12/Storage-Configuration/Object-Storage-RGW/cosi/).
## Community, discussion, contribution, and support
You can reach the maintainers of this project at:
- [Slack](https://kubernetes.slack.com/messages/sig-storage)
- [Mailing List](https://groups.google.com/forum/#!forum/kubernetes-sig-storage)
## Code of conduct
Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).