NOTE: We are currently maintaining two versions of the plugin: v1.X (
masterbranch) and v0.X (OSC-MIGRATIONbranch). If you are using the v0.X, we provide a guide to migrate to the new version here. The version v0.X will still receive bug and CVE fixes for as long it is used but no more features should be added.
The Outscale Block Storage Unit Container Storage Interface (CSI) Driver provides a CSI interface used by Container Orchestrators to manage the lifecycle of 3DS outscale BSU volumes.
To use the XFS file system with this CSI driver, ensure your system meets the following requirements:
Minimum Linux Kernel Version
- Recommended Minimum Kernel Version 3.13 Required Packages
- xfsprogs (Version: 5.10.0-r0): Provides utilities for managing XFS file systems. Kernel support for XFS is required.
- e2fsprogs (Version: 1.45.7-r0): Utilities for managing ext2, ext3, and ext4 file systems. While not directly related to XFS, it is useful for various disk operations.
- cryptsetup (Version: 2.3.7-r0): Required for disk encryption, which can be used in conjunction with XFS.
You can verify your kernel version and XFS module support with the following commands:
uname -r
lsmod | grep xfs
sudo modprobe xfs
| Plugin Version | Compatible with CSI Version | Min K8s Version | Recommended K8s Version |
|---|---|---|---|
| <= v0.0.14beta | v1.3.0 | 1.16 | 1.22 |
| v0.0.15 | v1.5.0 | 1.20 | 1.23 |
| v0.1.0 - v1.3.0 | v1.5.0 | 1.20 | 1.23 |
| v0.1.0 - v1.4.0 | v1.8.0 | 1.20 | 1.30 |
The following CSI gRPC calls are implemented:
- Controller Service: CreateVolume, DeleteVolume, ControllerPublishVolume, ControllerUnpublishVolume, ControllerGetCapabilities, ControllerExpandVolume, ValidateVolumeCapabilities, CreateSnapshot, DeleteSnapshot, ListSnapshots
- Node Service: NodeStageVolume, NodeUnstageVolume, NodePublishVolume, NodeUnpublishVolume, NodeExpandVolume, NodeGetCapabilities, NodeGetInfo, NodeGetVolumeStats
- Identity Service: GetPluginInfo, GetPluginCapabilities, Probe
The following CSI gRPC calls are not yet implemented:
- Controller Service: GetCapacity, ListVolumes, ControllerGetVolume
- Node Service: N/A
- Identity Service: N/A
There are several optional parameters that could be passed into CreateVolumeRequest.parameters map:
| Parameters | Values | Default | Description |
|---|---|---|---|
| "csi.storage.k8s.io/fstype" | xfs, ext2, ext3, ext4 | ext4 | File system type that will be formatted during volume creation |
| "type" | io1, gp2, standard | gp2 | BSU volume type |
| "iopsPerGB" | I/O operations per second per GiB. Required when io1 volume type is specified | ||
| "encrypted" | "true", "false" | "false" | Specify if we want to encrypt te disk or not |
| "csi.storage.k8s.io/node-stage-secret-name" | string | The name of the secret (See template) | |
| "csi.storage.k8s.io/node-stage-secret-namespace" | string | The namespace of the secret (See template) | |
| "kmsKeyId" | string | Not yet supported | |
| "luks-cipher" | string | LUKS encryption cipher to use (See doc or cryptsetup --help). Default value depends on the cryptsetup version. |
|
| "luks-hash" | string | Derivation Password hash algorithm (See doc or cryptsetup --help). Default value depends on the cryptsetup version. |
|
| "luks-key-size" | string | Size of the encryption key (See doc or cryptsetup --help). Default value depends on the cryptsetup version. |
Notes:
- The parameters are case sensitive.
Following sections are Kubernetes specific. If you are Kubernetes user, use followings for driver features, installation steps and examples.
- Static Provisioning - create a new or migrating existing BSU volumes, then create persistence volume (PV) from the BSU volume and consume the PV from container using persistence volume claim (PVC).
- Dynamic Provisioning - uses persistence volume claim (PVC) to request the Kuberenetes to create the BSU volume on behalf of user and consumes the volume from inside container.
- Mount Option - mount options could be specified in persistence volume (PV) to define how the volume should be mounted.
- Block Volume (beta since 1.14) - consumes the BSU volume as a raw block device for latency sensitive application eg. MySql
- Volume Snapshot - creating volume snapshots and restore volume from snapshot.
- Volume Encryption - Not supported yet.
- Cluster K8S with compatible version (See Version)
- The plugin needs AK/SK to interact with Outscale BSU API, so you can create an AK/SK using an eim user, for example, with a proper permission by attaching a policy like
See Deploy
Make sure you follow the Prerequisites before the examples: