|
1 | 1 | # Scality COSI driver |
| 2 | + |
| 3 | +The Scality COSI Driver integrates Scality RING Object Storage (and AWS S3-and-IAM compatible storage solutions) 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. |
| 4 | + |
| 5 | +## Overview |
| 6 | + |
| 7 | +The Scality COSI Driver allows Kubernetes users to: |
| 8 | + |
| 9 | +- **Dynamically Provision Buckets**: Create and delete object storage buckets on-demand. |
| 10 | +- **Manage Access Policies**: Control bucket access through Kubernetes CRDs. |
| 11 | +- **Integrate with S3 and IAM compatible Object Storage**: Leverage Scality's robust and scalable storage backends. |
| 12 | +- **Utilize Standard Kubernetes Tools**: Manage object storage using familiar Kubernetes APIs and tooling. |
| 13 | + |
| 14 | + |
| 15 | + |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +## Documentation |
| 20 | + |
| 21 | +Comprehensive documentation is available in the [`docs/`](docs/README.md) directory. It includes detailed guides and references. |
| 22 | + |
| 23 | + |
| 24 | +### Installation Guides |
| 25 | + |
| 26 | +- [Install with Helm from OCI](docs/installation/install-helm-oci.md) |
| 27 | +- [Install with Helm Locally](docs/installation/install-helm-local.md) |
| 28 | +- [Install with Kustomize on Minikube](docs/installation/install-kustomize.md) |
| 29 | +- [Setup with Development Containers](docs/installation/install-dev-containers.md) |
| 30 | + |
| 31 | +### Testing Procedures |
| 32 | + |
| 33 | +- [Run End-to-End Tests Locally](docs/testing/test-e2e-local.md) |
| 34 | +- [Testing on Minikube with Helm](docs/testing/test-minikube-helm.md) |
| 35 | +- [Testing on Minikube with Kustomize](docs/testing/test-minikube-kustomize.md) |
| 36 | + |
| 37 | +### Configuration Guides |
| 38 | + |
| 39 | +- [Customization Guide](docs/configuration/config-customization.md) |
| 40 | +- [Values.yaml Reference](docs/configuration/config-values-reference.md) |
| 41 | + |
| 42 | +### Development Resources |
| 43 | + |
| 44 | +- [Development Container Setup](docs/development/dev-container-setup.md) |
| 45 | +- [Developer Guide](docs/development/dev-guide.md) |
| 46 | + |
| 47 | +## Quick Start |
| 48 | + |
| 49 | +To quickly install the Scality COSI Driver using Helm from an OCI registry, follow these steps: |
| 50 | + |
| 51 | +### Prerequisites |
| 52 | + |
| 53 | +- **Kubernetes Cluster**: Running version 1.23 or later. |
| 54 | +- **Helm**: Version 3.8.0 or later. |
| 55 | + |
| 56 | +### Installation Steps |
| 57 | + |
| 58 | +1. **Ensure Helm is Installed** |
| 59 | + |
| 60 | + Verify your Helm installation: |
| 61 | + |
| 62 | + ```bash |
| 63 | + helm version --short |
| 64 | + # Expected output: v3.8.0+ or later |
| 65 | + ``` |
| 66 | + |
| 67 | +2. **Install the COSI Driver** |
| 68 | + |
| 69 | + Install the driver using the OCI registry: |
| 70 | + |
| 71 | + ```bash |
| 72 | + helm install scality-cosi-driver oci://registry.scality.com/charts/cosi-driver |
| 73 | + ``` |
| 74 | + |
| 75 | +3. **Verify the Installation** |
| 76 | + |
| 77 | + Check that the driver pods are running: |
| 78 | + |
| 79 | + ```bash |
| 80 | + kubectl get pods -n scality-cosi |
| 81 | + ``` |
| 82 | + |
| 83 | + Confirm the COSI driver is registered: |
| 84 | + |
| 85 | + ```bash |
| 86 | + kubectl get csidrivers |
| 87 | + ``` |
| 88 | + |
| 89 | +For more detailed instructions and alternative installation methods, please refer to the [Installation Guides](docs/installation/). |
| 90 | + |
0 commit comments