Scality COSI Driver

The Scality COSI Driver integrates Scality RING Object Storage with Kubernetes, leveraging the Kubernetes Container Object Storage Interface (COSI) to enable seamless object storage provisioning and management. This repository provides all necessary resources to deploy, use, and contribute to the Scality COSI Driver.

---

Features

Category	Feature	Notes
Bucket Provisioning	Greenfield bucket provisioning	Creates a new S3 Bucket with default settings.
	Brownfield bucket provisioning	Leverages an existing bucket in S3 storage within Kubernetes workflows.
	Delete Bucket	Deletes an S3 Bucket, but only if it is empty.
Access Management	Grant Bucket Access	Provides full access to a bucket by creating new IAM credentials with access and secret keys.
	Revoke Bucket Access	Removes access by deleting IAM credentials associated with the bucket.

---

Getting Started

Installation

Use Quickstart or follow the installation guide to deploy the Scality COSI Driver using Helm.

Quickstart Guide

To quickly deploy and test the Scality COSI Driver:

1. Ensure your Kubernetes cluster is properly configured, and Helm v3+ is installed. The COSI specification was introduced in Kubernetes 1.25. We recommend using one of the latest supported Kubernetes versions.

2. Create namespace container-object-storage-system and install the COSI controller deployment and COSI CRDs:

   kubectl create -k github.com/kubernetes-sigs/container-object-storage-interface
   

3. Deploy the driver: Namespace container-object-storage-system will be created in step 2.

   helm install scality-cosi-driver oci://ghcr.io/scality/cosi-driver/helm-charts/scality-cosi-driver \
       --namespace container-object-storage-system
   

4. Verify the deployment:

   kubectl get pods -n container-object-storage-system
   

   There should be 2 pods Running in the container-object-storage-system namespace:

   $ kubectl get pods -n container-object-storage-system
   NAME                                                   READY   STATUS    RESTARTS   AGE
   container-object-storage-controller-7f9f89fd45-h7jtn   1/1     Running   0          25h
   scality-cosi-driver-67d96bf8ff-9f59l                   2/2     Running   0          20h
   

To learn how to use the COSI driver, refer to the Usage documentation

---

Documentation

The following sections provide detailed documentation for deploying, configuring, and developing with the Scality COSI Driver:

• Installation Guide: Step-by-step instructions for deploying the driver.
• Driver Parameters: Configuration options for bucket classes and access credentials.
• Metrics Overview: Prometheus metrics exposed by the driver.
• Feature Usage: Detailed guides on bucket provisioning and access control with the COSI driver.
• Development Documentation:
  • Dev Container Setup
  • Remote Debugging
  • Running Locally

---

Support

For issues, please create a ticket in the GitHub Issues section.