Skip to content

Commit c359bc2

Browse files
authored
docs: document SBS migration in README.md (#70)
1 parent 7ac5443 commit c359bc2

File tree

1 file changed

+6
-12
lines changed

1 file changed

+6
-12
lines changed

README.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Scaleway Block Volume CSI driver
22

3-
> **Important**
3+
> [!CAUTION]
44
> ⚠️ **Please read this first before doing anything else!** ⚠️
55
>
66
> You are currently on a branch which corresponds to the `v0.3` release of the Scaleway CSI.
@@ -10,14 +10,8 @@
1010
> snapshots.
1111
>
1212
> If you are currently using the `v0.2.x` or `v0.1.x` versions of the Scaleway CSI:
13-
> please do not use this release until we provide a tool to migrate from `v0.2` to the `v0.3` release.
14-
>
15-
> Not sure what to do?
16-
>
17-
> ➡️ Use the [release-0.2](https://github.com/scaleway/scaleway-csi/tree/release-0.2)
18-
> branch for now.
19-
>
20-
> ➡️ Reach us on the *#k8s* channel on the [Scaleway Slack community](https://www.scaleway.com/en/docs/tutorials/scaleway-slack-community/).
13+
> please make sure you migrate your volumes using the [sbs-migration](./cmd/sbs-migration/)
14+
> tool. Your volumes will automatically be migrated if you use the Helm Chart.
2115
2216
The [Scaleway Block Volume](https://www.scaleway.com/en/block-storage/)
2317
Container Storage Interface (CSI) driver is an implementation of the
@@ -44,10 +38,10 @@ A Block Volume or Snapshot currently managed by the *Instance API* **cannot** be
4438
*Scaleway Block Storage API* and vice versa.
4539

4640
In the future, all Block Volumes and Snapshots will be managed by the *Scaleway Block Storage API*.
47-
In order to use newer versions of the CSI (v0.3+), it is needed to migrate Block Volumes and Snapshots
48-
from the *Instance API* to the *Scaleway Block Storage API* (currently not possible).
4941

50-
A tool will be made available later to facilitate upgrades from older CSI releases to v0.3+.
42+
In order to use newer versions of the CSI (v0.3+), it is needed to migrate Block Volumes and Snapshots
43+
from the *Instance API* to the *Scaleway Block Storage API* using the [sbs-migration](./cmd/sbs-migration/) tool.
44+
Your volumes will automatically be migrated if you use the Helm Chart.
5145

5246
| Scaleway CSI Driver \ Scaleway Storage API compatibility | Instance API | Scaleway Block Storage API |
5347
| -------------------------------------------------------- | ------------ | -------------------------- |

0 commit comments

Comments
 (0)