Skip to content

Commit

Permalink
Add migration instructions in README
Browse files Browse the repository at this point in the history
  • Loading branch information
mugdha-adhav committed Aug 15, 2024
1 parent 3e4cf18 commit 91b1a91
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,18 @@ git branch -u main main
git remote set-head origin -a
```

### Migration of CSI driver
In release `v2.0.0`, we are updating the CSI driver name from `csi-image.warm-metal.tech` to `container-image.warm-metal.tech`. This change may cause disruptions to your existing workloads if the driver name is not updated.

**To ensure a smooth transition:**
1. **Install Both Versions**: To avoid any breaking changes, you can install both the old and new versions of the CSI driver simultaneously. Both versions are compatible and have been tested to work side-by-side, as verified in our integration tests.

1. **Update Your Workloads**: Migrate your workloads to use the new driver name `container-image.warm-metal.tech`. This process will involve updating your storage class definitions and any other configurations that reference the old driver name.

1. **Remove the Old Driver**: Once all workloads have been successfully migrated and verified with the new driver, you can safely remove the older version of the driver from your cluster.

1. **Testing**: It is highly recommended to test the migration process in a staging environment before applying changes to production.

We appreciate your cooperation and understanding as we work to improve our repository.

# container-image-csi-driver (previously csi-driver-image)
Expand Down
2 changes: 1 addition & 1 deletion test/integration/backward-compatability.sh
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ kubectl delete --ignore-not-found -f "${TestBase}/compatible-manifests/pre-provi

export VALUE_FILE=$(dirname "${BASH_SOURCE[0]}")/../../charts/warm-metal-csi-driver/values.yaml
export IMAGE_TAG=$(git rev-parse --short HEAD)
export HELM_NAME="wm-csi-integration-tests"
export HELM_NAME="container-image-integration-tests"
export NAMESPACE="container-image-compatibility-test-ns"

trap "kubectl -n kube-system describe po" ERR
Expand Down

0 comments on commit 91b1a91

Please sign in to comment.