Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: document SBS migration in README.md #70

Merged
merged 1 commit into from
Sep 10, 2024
Merged

docs: document SBS migration in README.md #70

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 6 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Scaleway Block Volume CSI driver

> **Important**
> [!CAUTION]
> ⚠️ **Please read this first before doing anything else!** ⚠️
>
> You are currently on a branch which corresponds to the `v0.3` release of the Scaleway CSI.
Expand All @@ -10,14 +10,8 @@
> snapshots.
>
> If you are currently using the `v0.2.x` or `v0.1.x` versions of the Scaleway CSI:
> please do not use this release until we provide a tool to migrate from `v0.2` to the `v0.3` release.
>
> Not sure what to do?
>
> ➡️ Use the [release-0.2](https://github.com/scaleway/scaleway-csi/tree/release-0.2)
> branch for now.
>
> ➡️ Reach us on the *#k8s* channel on the [Scaleway Slack community](https://www.scaleway.com/en/docs/tutorials/scaleway-slack-community/).
> please make sure you migrate your volumes using the [sbs-migration](./cmd/sbs-migration/)
> tool. Your volumes will automatically be migrated if you use the Helm Chart.

The [Scaleway Block Volume](https://www.scaleway.com/en/block-storage/)
Container Storage Interface (CSI) driver is an implementation of the
Expand All @@ -44,10 +38,10 @@ A Block Volume or Snapshot currently managed by the *Instance API* **cannot** be
*Scaleway Block Storage API* and vice versa.

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

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

| Scaleway CSI Driver \ Scaleway Storage API compatibility | Instance API | Scaleway Block Storage API |
| -------------------------------------------------------- | ------------ | -------------------------- |
Expand Down
Loading