Managing Block Storage volumes with Scaleway CSI

The Scaleway Block Storage volume Container Storage Interface (CSI) driver is an implementation of the CSI interface to provide a way to manage Scaleway block volumes through a container orchestration system, like Kubernetes. It is installed by default on every Kubernetes Kapsule and Kosmos cluster.

Before you start

To complete the actions presented below, you must have:

• A Scaleway account logged into the console
• Owner status or IAM permissions allowing you to perform actions in the intended Organization
• A valid API key
• Your Scaleway Project or Organization ID
• Created a Kubernetes cluster running on Scaleway Instances (v1.21+)

Verification of CSI driver status

To verify if the driver is running, use the following command:

kubectl get csidriver

The output of this command provides a quick status update on the CSI plugin within your Kubernetes cluster. For the latest features and enhancements, consider upgrading to release 0.3, which supports Block Storage low latency volumes.

To identify your current CSI release version, navigate to the Cockpit interface, specifically the Kubernetes Cluster - Overview dashboard.

Upgrading to CSI version 0.3

The migration moves volumes from the Instances API to the Scaleway Block Storage API. No volume detachment is expected, only a control plane restart. Newer storage classes have been introduced, with sbs-default set as the new default. The existing scw-bssd and scw-bssd-retain storage classes will remain available for now.

Using the API with curl

You can trigger the migration to SBS-CSI using the following curl command:

curl "https://api.scaleway.com/k8s/v1/regions/$REGION/clusters/$CLUSTER_ID/migrate-to-sbs-csi" \
-X POST \
-H "X-Auth-Token: $TOKEN"

Replace the placeholders with the following:

• $REGION: Your cluster's region (e.g., fr-par, nl-ams).
• $CLUSTER_ID: Your cluster ID.
• $TOKEN: Your Scaleway API token.

This command will initiate the migration process for your cluster to the new SBS-CSI.

Using the Scaleway CLI

Alternatively, you can use the Scaleway CLI to perform the migration. Ensure the CLI is installed and configured with your API credentials.

1. Install and configure the Scaleway CLI, if you have not already:

   scw init

2. Run the migration command:

   scw k8s cluster migrate-to-sbs-csi $CLUSTER_ID region=$REGION

   Replace $REGION and $CLUSTER_ID with your cluster’s region and ID, respectively.

Post-migration verification

After initiating the migration, the cluster status will change to updating. Once the migration completes, you can verify that the CSI driver has been updated and that the new driver properly handles Persistent Volume Claims (PVCs).

kubectl get csidriver

This command will confirm that the migration was successful.

Going further

• Creating persistent volumes with Scaleway Block Storage
• Creating raw block volumes
• Importing existing Scaleway volumes
• Creating volume snapshots
• Importing volume snapshots
• How to create a storage class
• How to choose a zone for the volumes
• How to choose the number of IOPS
  Tip

  • sbs-5k and sbs-15k are pre-configured storage classes designed to meet your IOPS requirements. You can achieve the equivalent of setting iops:5k in your custom class.
• Encrypting volumes