Skip to content

Commit 829e243

Browse files
committed
COSI-98: Pin COSI install to v1alpha1 (v0.2.2)
The upstream kustomize URL github.com/kubernetes-sigs/container-object-storage-interface tracks main, which now ships v1alpha2 CRDs. This driver only speaks v1alpha1 (see proto/cosi.proto and cosi-examples/**), so following the install docs produces a broken setup: CRDs on the cluster do not match what the driver emits, and every Bucket / BucketClaim / BucketAccess reconcile fails. Pin the kustomize ref to v0.2.2 (the last v1alpha1 release) everywhere the command appears: install docs (README.md, docs/installation/install-helm.md) and CI (.github/scripts/setup_cosi_resources.sh, cleanup_cosi_resources.sh, .github/workflows/helm-validation.yml). Also add a short compatibility note to the docs warning users off upstream main.
1 parent b50a646 commit 829e243

5 files changed

Lines changed: 8 additions & 6 deletions

File tree

.github/scripts/cleanup_cosi_resources.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ log_and_run echo "Deleting s3-secret-for-cosi secret..."
6363
log_and_run kubectl delete secret s3-secret-for-cosi --namespace=default || { echo "Secret s3-secret-for-cosi not found." | tee -a "$LOG_FILE"; }
6464

6565
log_and_run echo "Deleting COSI CRD..."
66-
log_and_run kubectl delete -k github.com/kubernetes-sigs/container-object-storage-interface || { echo "COSI API CRDs or controller not found." | tee -a "$LOG_FILE"; }
66+
log_and_run kubectl delete -k github.com/kubernetes-sigs/container-object-storage-interface?ref=v0.2.2 || { echo "COSI API CRDs or controller not found." | tee -a "$LOG_FILE"; }
6767

6868
log_and_run echo "Verifying COSI CRDs deletion..."
6969
if kubectl get crd | grep 'container-object-storage-interface' &>/dev/null; then

.github/scripts/setup_cosi_resources.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ log_and_run() {
2626

2727
# Step 1: Install COSI CRDs
2828
log_and_run echo "Installing COSI CRD..."
29-
log_and_run kubectl create -k github.com/kubernetes-sigs/container-object-storage-interface
29+
log_and_run kubectl create -k github.com/kubernetes-sigs/container-object-storage-interface?ref=v0.2.2
3030
log_and_run kubectl get pods --namespace container-object-storage-system
3131

3232
# Step 2: Verify COSI Controller Pod Status

.github/workflows/helm-validation.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ jobs:
7777
set -e -o pipefail
7878
(
7979
echo "=== Setup COSI Controller, CRDs and Driver ==="
80-
kubectl create -k github.com/kubernetes-sigs/container-object-storage-interface
80+
kubectl create -k github.com/kubernetes-sigs/container-object-storage-interface?ref=v0.2.2
8181
make container
8282
kind load docker-image ghcr.io/scality/cosi-driver:latest --name helm-test-cluster
8383
) &

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ Use [Quickstart](#quickstart-guide) or follow the [installation guide](docs/inst
2727
To quickly deploy and test the Scality COSI Driver:
2828

2929
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/).
30-
2. Create namespace `container-object-storage-system` and install the COSI controller deployment and COSI CRDs:
30+
2. Create namespace `container-object-storage-system` and install the COSI controller deployment and COSI CRDs. The Scality COSI Driver supports only COSI **v1alpha1** — the command below pins upstream to tag `v0.2.2` (the last v1alpha1 release). Do not install from upstream `main`, which now ships v1alpha2 and is incompatible with this driver.
3131

3232
```bash
33-
kubectl create -k github.com/kubernetes-sigs/container-object-storage-interface
33+
kubectl create -k github.com/kubernetes-sigs/container-object-storage-interface?ref=v0.2.2
3434
```
3535

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

docs/installation/install-helm.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,10 @@ Its recommended to deploy COSI controller first which creates the `container-obj
2121

2222
### Deploy COSI controller and related CRDs
2323

24+
The Scality COSI Driver supports only COSI **v1alpha1**. The command below pins the upstream controller and CRDs to tag `v0.2.2` (the last v1alpha1 release) — do not install from upstream `main`, which now ships v1alpha2 and is incompatible with this driver.
25+
2426
```bash
25-
kubectl create -k github.com/kubernetes-sigs/container-object-storage-interface
27+
kubectl create -k github.com/kubernetes-sigs/container-object-storage-interface?ref=v0.2.2
2628
```
2729

2830

0 commit comments

Comments
 (0)