{"id":13645544,"url":"https://github.com/outscale/osc-bsu-csi-driver","last_synced_at":"2026-01-21T10:13:01.324Z","repository":{"id":36958515,"uuid":"219992205","full_name":"outscale/osc-bsu-csi-driver","owner":"outscale","description":"The OSC BSU CSI Driver is a CSI driver for Kubernetes allowing the use of Outscale Block Storage Units (BSU) volumes","archived":false,"fork":false,"pushed_at":"2026-01-20T14:30:04.000Z","size":17901,"stargazers_count":10,"open_issues_count":5,"forks_count":17,"subscribers_count":7,"default_branch":"main","last_synced_at":"2026-01-20T22:53:20.257Z","etag":null,"topics":["maturity-graduated","renovate"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/outscale.png","metadata":{"files":{"readme":"docs/README.md","changelog":"CHANGELOG-0.x.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSES/Apache-2.0.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":"NOTICE","maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2019-11-06T12:31:21.000Z","updated_at":"2026-01-20T14:32:34.000Z","dependencies_parsed_at":"2023-10-13T00:42:01.045Z","dependency_job_id":"a19e24f3-2ba5-4e36-afee-af68ae69b9ac","html_url":"https://github.com/outscale/osc-bsu-csi-driver","commit_stats":null,"previous_names":["outscale-dev/osc-bsu-csi-driver"],"tags_count":49,"template":false,"template_full_name":null,"purl":"pkg:github/outscale/osc-bsu-csi-driver","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fosc-bsu-csi-driver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fosc-bsu-csi-driver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fosc-bsu-csi-driver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fosc-bsu-csi-driver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/outscale","download_url":"https://codeload.github.com/outscale/osc-bsu-csi-driver/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fosc-bsu-csi-driver/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28631936,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-21T04:47:28.174Z","status":"ssl_error","status_checked_at":"2026-01-21T04:47:22.943Z","response_time":86,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["maturity-graduated","renovate"],"created_at":"2024-08-02T01:02:36.932Z","updated_at":"2026-01-21T10:13:01.309Z","avatar_url":"https://github.com/outscale.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"[![Project Graduated](https://docs.outscale.com/fr/userguide/_images/Project-Graduated-green.svg)](https://docs.outscale.com/en/userguide/Open-Source-Projects.html) [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/osc-bsu-csi-driver)](https://artifacthub.io/packages/search?repo=osc-bsu-csi-driver) [![](https://dcbadge.limes.pink/api/server/HUVtY5gT6s?style=flat\\\u0026theme=default-inverted)](https://discord.gg/HUVtY5gT6s)\n\n# Outscale Block Storage Unit (BSU) CSI Driver\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Kubernetes Logo\" src=\"https://upload.wikimedia.org/wikipedia/commons/3/39/Kubernetes_logo_without_workmark.svg\" width=\"120px\"\u003e\n\u003c/p\u003e\n\n\u003e NEW: Helm chart rewrite. See [migration guide](./helm/osc-bsu-csi-driver/migration.md) for more information.\n\n---\n\n## 🌐 Links\n\n* Project repo: [github.com/outscale/osc-bsu-csi-driver](https://github.com/outscale/osc-bsu-csi-driver)\n* Helm chart: [osc-bsu-csi-driver](https://artifacthub.io/packages/helm/osc-bsu-csi-driver/osc-bsu-csi-driver)\n* 🤝 Contribution Guide: [CONTRIBUTING.md](../CONTRIBUTING.md)\n* Join our community on [Discord](https://discord.gg/HUVtY5gT6s)\n\n---\n\n## 📄 Table of Contents\n\n* [Overview](#-overview)\n* [Compatibility](#-compatibility)\n* [Features](#-features)\n* [Kubernetes Usage](#-kubernetes-usage)\n* [Configuration (StorageClass Parameters)](#-configuration-storageclass-parameters)\n* [Installation](#-installation)\n* [Troubleshooting](#-troubleshooting)\n* [Upgrade Notes](#-upgrade-notes)\n* [Examples](#-examples)\n* [Development](#-development)\n* [Contributing](#-contributing)\n* [License](#-license)\n\n---\n\n## 🧭 Overview\n\nThe **Outscale Block Storage Unit (BSU) CSI Driver** implements the Container Storage Interface ([CSI](https://github.com/container-storage-interface/spec/blob/master/spec.md)) for OUTSCALE BSU volumes. It allows container orchestrators (e.g., Kubernetes) to provision, attach, mount, snapshot, modify and expand BSU volumes.\n\n\u003e We currently maintain two branches: **v1.x** (`main`) and **v0.x** (`OSC-MIGRATION`). If you use **v0.x**, see the migration guide: [Upgrading from v0.x to v1.0.0](#upgrading-from-v0x-to-v100).\n\u003e v0.x will continue to receive bug and CVE fixes while in use, but **no new features** will be added.\n\n---\n\n## 🔗 Compatibility\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eCSI Specification Compatibility Matrix\u003c/strong\u003e\u003c/summary\u003e\n\n| Plugin Version  | Compatible CSI Version                                                              | Minimum K8s version |\n| --------------- | ----------------------------------------------------------------------------------- | ------------------- |\n| \u003c= v0.0.14beta  | [v1.3.0](https://github.com/container-storage-interface/spec/releases/tag/v1.3.0)   | 1.16                |\n| v0.0.15         | [v1.5.0](https://github.com/container-storage-interface/spec/releases/tag/v1.5.0)   | 1.20                |\n| v0.1.0 – v1.3.0 | [v1.5.0](https://github.com/container-storage-interface/spec/releases/tag/v1.5.0)   | 1.20                |\n| v0.1.0 – v1.6.x | [v1.8.0](https://github.com/container-storage-interface/spec/releases/tag/v1.8.0)   | 1.20                |\n| v1.7.x - v1.8.x | [v1.10.0](https://github.com/container-storage-interface/spec/releases/tag/v1.10.0) | 1.20                |\n| v1.9.x          | [v1.10.0](https://github.com/container-storage-interface/spec/releases/tag/v1.10.0) | 1.20                |\n| v1.10.x         | [v1.12.0](https://github.com/container-storage-interface/spec/releases/tag/v1.12.0) | 1.25                |\n\n\u003c/details\u003e\n\n---\n\n## ✨ Features\n\nThe CSI driver is based on two services:\n\n* **Controller service**: runs as a `Deployment` on control-plane nodes; calls the Outscale API to create, modify, attach/detach and delete volumes and snapshots,\n* **Node service**: runs as a `DaemonSet` on all nodes requiring volumes; mounts, formats and resize filesystems.\n\nThe following CSI capabilities are supported by the driver:\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003ePlugin capabilities\u003c/strong\u003e\u003c/summary\u003e\n\n| Service | Support | Comments |\n| ---------- | ------- | -------- |\n| CONTROLLER_SERVICE | ✅ | implements the controller service, handling calls the Outscale API to create/modify/attach/detach/delete volumes and snapshots |\n| VOLUME_ACCESSIBILITY_CONSTRAINTS | ✅ | There are constraints limiting which volumes can be mounted on a specific node (e.g. belonging to the same subregion) |\n| GROUP_CONTROLLER_SERVICE | ❌ | Volume and snapshot groups are not supported |\n| SNAPSHOT_METADATA_SERVICE | ❌ | Snapshot metadata are not available |\n\n| VolumeExpansion | Support | Comments |\n| ---------- | ------- | -------- |\n| ONLINE | ✅ | Volumes can be resized while mounted |\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eController capabilities\u003c/strong\u003e\u003c/summary\u003e\n\n| Capability | Support | Comments |\n| ---------- | ------- | -------- |\n| CREATE_DELETE_VOLUME | ✅ | Volumes can be created |\n| PUBLISH_UNPUBLISH_VOLUME | ✅ | Volumes need to be published on nodes |\n| LIST_VOLUMES | ❌ | Volumes cannot be listed |\n| GET_CAPACITY | ❌ | Total storage capacity is unknown |\n| CREATE_DELETE_SNAPSHOT | ✅ | Snapshots can be created and used as a source for new volumes |\n| LIST_SNAPSHOTS | ✅ | Snapshots can be listed |\n| CLONE_VOLUME | ❌ | Volumes cannot be cloned |\n| PUBLISH_READONLY | ❌ | Volumes cannot be published as read-only |\n| EXPAND_VOLUME | ✅ | Volumes can be resized |\n| LIST_VOLUMES_PUBLISHED_NODES | ❌ | LIST_VOLUME/GET_VOLUME additional capability |\n| VOLUME_CONDITION | ❌ | The volume condition is not known |\n| GET_VOLUME (alpha) | ❌ | The status of a volume is not reported |\n| SINGLE_NODE_MULTI_WRITER | ❌ | Volumes cannot be accessed from multiple sources |\n| MODIFY_VOLUME | ✅ | Volumes can be modified |\n| GET_SNAPSHOT (alpha) | ❌ | The status of a snapshot is not reported |\n\n**Notes**\n\n* **EXPAND_VOLUME**: offline (cold/detached) and online (hot/attached) volumes can be resized.\n* **MODIFY_VOLUME**: `volumeType` and `iopsPerGB` can be updated via VolumeAttributeClasses on both offline and online volumes.\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eNode capabilities\u003c/strong\u003e\u003c/summary\u003e\n\n| Capability | Support | Comments |\n| ---------- | ------- | -------- |\n| STAGE_UNSTAGE_VOLUME | ✅ | Volumes need to be staged on a node |\n| GET_VOLUME_STATS | ✅ | The status of a volume is not reported |\n| EXPAND_VOLUME | ✅ | Volumes can be resized |\n| VOLUME_CONDITION | ❌ | The volume condition is not known |\n| SINGLE_NODE_MULTI_WRITER | ❌ | Volumes cannot be accessed from multiple sources |\n| VOLUME_MOUNT_GROUP | ❌ | Volumes mount groups are not supported |\n\n**Notes**\n\n* **EXPAND_VOLUME**: offline (cold/detached) and online (hot/attached) volumes can be resized.\n\n\u003c/details\u003e\n\n---\n\n## ☸️ Kubernetes Usage\n\n* **Static provisioning**: import existing BSU volumes and mount via PVCs.\n* **Dynamic provisioning**: create on-demand volumes via PVCs.\n* **Block volumes**: raw block device support for latency-sensitive apps (e.g., MySQL).\n* **Volume snapshots**: create and restore from snapshots.\n* **Volume encryption**: LUKS + `cryptsetup`.\n\n**Prerequisites**\n\n* A Kubernetes cluster within a compatible version range (see [Compatibility](#-compatibility)).\n* Driver access to OUTSCALE APIs using AK/SK credentials (for example via an EIM user with an appropriate policy such as [`example-eim-policy.json`](./example-eim-policy.json)).\n\n---\n\n## 🛠 Configuration (StorageClass Parameters)\n\nThese parameters are passed via the StorageClass to `CreateVolumeRequest.parameters`:\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eStorageClass parameters\u003c/strong\u003e\u003c/summary\u003e\n\n| Parameter                                        | Values                   | Default | Description                                                        |\n| ------------------------------------------------ | ------------------------ | ------- | ------------------------------------------------------------------ |\n| `csi.storage.k8s.io/fstype`                      | `xfs`, `ext2/3/4`        | `ext4`  | Filesystem to format the volume with.                              |\n| `type`                                           | `io1`, `gp2`, `standard` | `gp2`   | BSU volume type.                                                   |\n| `iopsPerGB`                                      | integer                  | —       | Required when `type=io1`; IOPS per GiB.                            |\n| `encrypted`                                      | `true`, `false`          | `false` | Enable LUKS encryption.                                            |\n| `csi.storage.k8s.io/node-stage-secret-name`      | string                   | —       | Name of the node-stage secret (see CSI docs).                      |\n| `csi.storage.k8s.io/node-stage-secret-namespace` | string                   | —       | Namespace of the node-stage secret (see CSI docs).                 |\n| `kmsKeyId`                                       | string                   | —       | Not yet supported.                                                 |\n| `luks-cipher`                                    | string                   | —       | LUKS cipher; default depends on `cryptsetup` version.              |\n| `luks-hash`                                      | string                   | —       | Password derivation hash; default depends on `cryptsetup` version. |\n| `luks-key-size`                                  | string                   | —       | Encryption key size; default depends on `cryptsetup` version.      |\n\n**Notes**\n\n* Parameter names are **case-sensitive**.\n\n\u003c/details\u003e\n\n---\n\n## 📦 Installation\n\nSee **[Deploy](./deploy.md)** for step-by-step installation (Helm/Manifests) and cluster-specific notes.\n\n**Chart configuration**: see **[Helm Chart Configuration](./helm.md)**.\n\n---\n\n## 🐞 Troubleshooting\n\nCommon issues and diagnostics are covered in **[Troubleshooting](./troubleshooting.md)**.\n\n---\n\n## ⬆️ Upgrade Notes\n\n### Upgrading from v0.x to v1.0.0\n\nFollow the [migration guide](./migration.md).\n\n### Upgrading from v1.6 to v1.7\n\n`maxBsuVolumes` is now computed automatically at driver startup. Manual configuration is usually unnecessary, even when multiple BSU volumes are mounted by the OS.\n\n### Upgrading to Helm chart v2\n\nMost values have been renamed, and need to be set again using the new names during the upgrade. Please refer to the [upgrade guide](../helm/osc-bsu-csi-driver/migration.md).\n\n---\n\n## 💡 Examples\n\n* [Dynamic Provisioning](../examples/kubernetes/dynamic-provisioning)\n* [Block Volume](../examples/kubernetes/block-volume)\n* [Volume Snapshot](../examples/kubernetes/snapshot)\n* [StorageClasses](../examples/kubernetes/storageclass)\n* [Volume Resizing](../examples/kubernetes/resizing)\n* [Volume Updates (VolumeAttributeClasses)](../examples/kubernetes/volume-attribute-class)\n* [Encryption](../examples/kubernetes/encryption/)\n\n---\n\n## 🧪 Development\n\nSee **[Development Process](./development.md)**.\n\n---\n\n## 🤝 Contributing\n\nContributions are welcome!\nPlease read our **[Contributing Guidelines](../CONTRIBUTING.md)** and **[Code of Conduct](../CODE_OF_CONDUCT.md)** before opening a pull request.\n\n---\n\n## 📜 License\n\n© 2025 Outscale SAS\n\nThis project complies with the [REUSE Specification](https://reuse.software/).\n\nSee [LICENSES/](../LICENSES) directory for full license information.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutscale%2Fosc-bsu-csi-driver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foutscale%2Fosc-bsu-csi-driver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutscale%2Fosc-bsu-csi-driver/lists"}