Merge pull request #106 from scality/docs/COSI-21-add-readme-and-usag…

…e-docs

COSI-21: Add/improve docs and update versions to 1.0.0

README.md

@@ -1 +1,79 @@
-# Scality COSI driver
+# 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](#quickstart-guide) or follow the [installation guide](docs/installation/install-helm.md) 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](https://helm.sh/docs/intro/install/). The COSI specification was introduced in Kubernetes 1.25. We recommend using [one of the latest supported Kubernetes versions](https://kubernetes.io/releases/).
+2. Create namespace `container-object-storage-system` and install the COSI controller deployment and COSI CRDs:
+
+   ```bash
+   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.
+
+   ```bash
+   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:
+
+   ```bash
+   kubectl get pods -n container-object-storage-system
+   ```
+
+   There should be 2 pods `Running` in the `container-object-storage-system` namespace:
+
+   ```sh
+   $ 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](./docs/Usage.md)
+
+---
+
+## Documentation
+
+The following sections provide detailed documentation for deploying, configuring, and developing with the Scality COSI Driver:
+
+- **[Installation Guide](docs/installation/install-helm.md):** Step-by-step instructions for deploying the driver.
+- **[Driver Parameters](docs/driver-params.md):** Configuration options for bucket classes and access credentials.
+- **[Metrics Overview](docs/metrics-overview.md):** Prometheus metrics exposed by the driver.
+- **[Feature Usage](docs/Usage.md):** Detailed guides on bucket provisioning and access control with the COSI driver.
+- **[Development Documentation](docs/development):**
+  - [Dev Container Setup](docs/development/dev-container-setup.md)
+  - [Remote Debugging](docs/development/remote-debugging-golang-on-kubernetes.md)
+  - [Running Locally](docs/development/run-cosi-driver-locally.md)
+
+---
+
+## Support
+
+For issues, please create a ticket in the [GitHub Issues](https://github.com/scality/cosi-driver/issues) section.