Ceph CSI

- Ceph CSI
- Overview
- Project status
- Known to work CO platforms
- Support Matrix
- Ceph-CSI features and available versions
- CSI spec and Kubernetes version compatibility
- Ceph CSI Container images and release compatibility
- Contributing to this repo
- Troubleshooting
- Weekly Bug Triage call
- Dev standup
- Contact
This repo contains the Ceph
Container Storage Interface (CSI)
driver for RBD, CephFS and Kubernetes sidecar deployment YAMLs to support CSI
functionality: provisioner, attacher, resizer, driver-registrar and snapshotter.
Overview
Ceph CSI plugins implement an interface between a CSI-enabled Container Orchestrator
(CO) and Ceph clusters. They enable dynamically provisioning Ceph volumes and
attaching them to workloads.
Independent CSI plugins are provided to support RBD and CephFS backed volumes,
- For details about configuration and deployment of RBD plugin, please refer
rbd doc and
for CephFS plugin configuration and deployment please
refer cephFS doc.
- For example usage of the RBD and CephFS CSI plugins, see examples in
examples/.
- Stale resource cleanup, please refer cleanup doc.
NOTE:
- Ceph CSI
Arm64 support is experimental.
Project status
Status: GA
Known to work CO platforms
Ceph CSI drivers are currently developed and tested exclusively in Kubernetes
environments.
| Ceph CSI Version | Container Orchestrator Name | Version Tested |
|---|
| devel (v3.19.0) | Kubernetes | v1.36, v1.37 |
| v3.18.2 | Kubernetes | v1.34, v1.35, v1.36 |
| v3.18.1 | Kubernetes | v1.34, v1.35, v1.36 |
| v3.18.0 | Kubernetes | v1.34, v1.35, v1.36 |
| v3.17.1 | Kubernetes | v1.34, v1.35, v1.36 |
| v3.17.0 | Kubernetes | v1.33, v1.34, v1.35 |
| v3.16.3 | Kubernetes | v1.32, v1.33, v1.34 |
| v3.16.2 | Kubernetes | v1.32, v1.33, v1.34 |
| v3.16.1 | Kubernetes | v1.32, v1.33, v1.34 |
| v3.16.0 | Kubernetes | v1.32, v1.33, v1.34 |
There is work in progress to make this CO-independent and thus
support other orchestration environments (Nomad, Mesos..etc).
NOTE:
The supported window of Ceph CSI versions is "N.(x-1)":
(N (Latest major release) . (x (Latest minor release) - 1)).
For example, if the Ceph CSI latest major version is 3.9.0 today, support is
provided for the versions above 3.8.0. If users are running an unsupported
Ceph CSI version, they will be asked to upgrade when requesting support.
Support Matrix
Ceph-CSI features and available versions
Please refer rbd nbd mounter
for its support details.
| Plugin | Features | Feature Status | CSI Driver Version | CSI Spec Version | Ceph Cluster Version | Kubernetes Version |
|---|
| RBD | Dynamically provision, de-provision Block mode RWO volume | GA | >= v1.0.0 | >= v1.0.0 | Pacific (>=v16.2.0) | >= v1.14.0 |
| Dynamically provision, de-provision Block mode RWX volume | GA | >= v1.0.0 | >= v1.0.0 | Pacific (>=v16.2.0) | >= v1.14.0 |
| Dynamically provision, de-provision Block mode RWOP volume | Alpha | >= v3.5.0 | >= v1.5.0 | Pacific (>=v16.2.0) | >= v1.22.0 |
| Dynamically provision, de-provision File mode RWO volume | GA | >= v1.0.0 | >= v1.0.0 | Pacific (>=v16.2.0) | >= v1.14.0 |
| Dynamically provision, de-provision File mode RWOP volume | Alpha | >= v3.5.0 | >= v1.5.0 | Pacific (>=v16.2.0) | >= v1.22.0 |
| Provision File Mode ROX volume from snapshot | Alpha | >= v3.0.0 | >= v1.0.0 | Pacific (>=v16.2.0) | >= v1.17.0 |
| Provision File Mode ROX volume from another volume | Alpha | >= v3.0.0 | >= v1.0.0 | Pacific (>=v16.2.0) | >= v1.16.0 |
| Provision Block Mode ROX volume from snapshot | Alpha | >= v3.0.0 | >= v1.0.0 | Pacific (>=v16.2.0) | >= v1.17.0 |
| Provision Block Mode ROX volume from another volume | Alpha | >= v3.0.0 | >= v1.0.0 | Pacific (>=v16.2.0) | >= v1.16.0 |
| Creating and deleting snapshot | GA | >= v1.0.0 | >= v1.0.0 | Pacific (>=v16.2.0) | >= v1.17.0 |
| Provision volume from snapshot | GA | >= v1.0.0 | >= v1.0.0 | Pacific (>=v16.2.0) | >= v1.17.0 |
| Provision volume from another volume | GA | >= v1.0.0 | >= v1.0.0 | Pacific (>=v16.2.0) | >= v1.16.0 |
| Expand volume | Beta | >= v2.0.0 | >= v1.1.0 | Pacific (>=v16.2.0) | >= v1.15.0 |
| Volume/PV Metrics of File Mode Volume | GA | >= v1.2.0 | >= v1.1.0 | Pacific (>=v16.2.0) | >= v1.15.0 |
| Volume/PV Metrics of Block Mode Volume | GA | >= v1.2.0 | >= v1.1.0 | Pacific (>=v16.2.0) | >= v1.21.0 |
| Topology Aware Provisioning Support | Alpha | >= v2.1.0 | >= v1.1.0 | Pacific (>=v16.2.0) | >= v1.14.0 |
| RBD-NBD QoS by VolumeAttributesClass | Alpha | >= v3.17.0 | >= v1.12.0 | Pacific (>=v16.2.0) | >= v1.34.0 |
| CephFS | Dynamically provision, de-provision File mode RWO volume | GA | >= v1.1.0 | >= v1.0.0 | Pacific (>=v16.2.0) | >= v1.14.0 |
| Dynamically provision, de-provision File mode RWX volume | GA | >= v1.1.0 | >= v1.0.0 | Pacific (>=v16.2.0) | >= v1.14.0 |
| Dynamically provision, de-provision File mode ROX volume | Alpha | >= v3.0.0 | >= v1.0.0 | Pacific (>=v16.2.0) | >= v1.14.0 |
| Dynamically provision, de-provision File mode RWOP volume | Alpha | >= v3.5.0 | >= v1.5.0 | Pacific (>=v16.2.0) | >= v1.22.0 |
| Creating and deleting snapshot | GA | >= v3.1.0 | >= v1.0.0 | Pacific (>=v16.2.0) | >= v1.17.0 |
| Creating and deleting volume group snapshot | Alpha | >= v3.11.0 | >= v1.9.0 | Squid (>=v19.0.0) | >= v1.31.0 |
| Provision volume from snapshot | GA | >= v3.1.0 | >= v1.0.0 | Pacific (>=v16.2.0) | >= v1.17.0 |
| Provision volume from another volume | GA | >= v3.1.0 | >= v1.0.0 | Pacific (>=v16.2.0) | >= v1.16.0 |
| Expand volume | Beta | >= v2.0.0 | >= v1.1.0 | Pacific (>=v16.2.0) | >= v1.15.0 |
| Volume/PV Metrics of File Mode Volume | GA | >= v1.2.0 | >= v1.1.0 | Pacific (>=v16.2.0) | >= v1.15.0 |
| NFS | Dynamically provision, de-provision File mode RWO volume | Alpha | >= v3.6.0 | >= v1.0.0 | Pacific (>=v16.2.0) | >= v1.14.0 |
| Dynamically provision, de-provision File mode RWX volume | Alpha | >= v3.6.0 | >= v1.0.0 | Pacific (>=v16.2.0) | >= v1.14.0 |
| Dynamically provision, de-provision File mode ROX volume | Alpha | >= v3.6.0 | >= v1.0.0 | Pacific (>=v16.2.0) | >= v1.14.0 |
| Dynamically provision, de-provision File mode RWOP volume | Alpha | >= v3.6.0 | >= v1.5.0 | Pacific (>=v16.2.0) | >= v1.22.0 |
| Expand volume | Alpha | >= v3.7.0 | >= v1.1.0 | Pacific (>=v16.2.0) | >= v1.15.0 |
| Creating and deleting snapshot | Alpha | >= v3.7.0 | >= v1.1.0 | Pacific (>=v16.2.0) | >= v1.17.0 |
| Provision volume from snapshot | Alpha | >= v3.7.0 | >= v1.1.0 | Pacific (>=v16.2.0) | >= v1.17.0 |
| Provision volume from another volume | Alpha | >= v3.7.0 | >= v1.1.0 | Pacific (>=v16.2.0) | >= v1.16.0 |
| Modify volume parameters with ControllerModifyVolume | Alpha | >= v3.17.0 | >= v1.12.0 | Pacific (>=v16.2.0) | >= v1.34.0 |
| NVMe-oF | Dynamically provision, de-provision Block mode RWO volume | Alpha | >= v3.16.0 | >= v1.0.0 | Tentacle (>=v20.2.0) | >= v1.14.0 |
| Dynamically provision, de-provision Block mode RWX volume | Alpha | >= v3.16.0 | >= v1.0.0 | Tentacle (>=v20.2.0) | >= v1.14.0 |
| Dynamically provision, de-provision Block mode RWOP volume | Alpha | >= v3.16.0 | >= v1.5.0 | Tentacle (>=v20.2.0) | >= v1.22.0 |
| Dynamically provision, de-provision File mode RWO volume | Alpha | >= v3.16.0 | >= v1.0.0 | Tentacle (>=v20.2.0) | >= v1.14.0 |
| Dynamically provision, de-provision File mode RWOP volume | Alpha | >= v3.16.0 | >= v1.5.0 | Tentacle (>=v20.2.0) | >= v1.22.0 |
| Provision File Mode ROX volume from snapshot | Alpha | >= v3.16.0 | >= v1.0.0 | Tentacle (>=v20.2.0) | >= v1.17.0 |
| Provision File Mode ROX volume from another volume | Alpha | >= v3.16.0 | >= v1.0.0 | Tentacle (>=v20.2.0) | >= v1.16.0 |
| Provision Block Mode ROX volume from snapshot | Alpha | >= v3.16.0 | >= v1.0.0 | Tentacle (>=v20.2.0) | >= v1.17.0 |
| Provision Block Mode ROX volume from another volume | Alpha | >= v3.16.0 | >= v1.0.0 | Tentacle (>=v20.2.0) | >= v1.16.0 |
| Expand volume | Alpha | >= v3.16.0 | >= v1.1.0 | Tentacle (>=v20.2.0) | >= v1.33.0 |
| Creating and deleting snapshot | Alpha | >= v3.16.1 | >= v1.1.0 | Tentacle (>=v20.2.0) | >= v1.33.0 |
| Provision volume from snapshot | Alpha | >= v3.16.1 | >= v1.1.0 | Tentacle (>=v20.2.0) | >= v1.33.0 |
| Modify volume parameters with ControllerModifyVolume | Alpha | >= v3.16.0 | >= v1.12.0 | Tentacle (>=v20.2.0) | >= v1.34.0 |
| Secure authentication between host and gateway (DH-CHAP) | Alpha | >= v3.17.0 | >= v1.0.0 | Tentacle (>=v20.2.0) | >= v1.34.0 |
NOTE: The Alpha status reflects possible non-backward
compatible changes in the future, and is thus not recommended
for production use.
CSI spec and Kubernetes version compatibility
Please refer to the matrix
in the Kubernetes documentation.
Ceph CSI Container images and release compatibility
Standard images
| Ceph CSI Release/Branch | Container image name | Image Tag |
|---|
| devel (Branch) | quay.io/cephcsi/cephcsi | canary |
| v3.18.2 (Release) | quay.io/cephcsi/cephcsi | v3.18.2 |
| v3.18.1 (Release) | quay.io/cephcsi/cephcsi | v3.18.1 |
| v3.18.0 (Release) | quay.io/cephcsi/cephcsi | v3.18.0 |
| v3.17.1 (Release) | quay.io/cephcsi/cephcsi | v3.17.1 |
| v3.17.0 (Release) | quay.io/cephcsi/cephcsi | v3.17.0 |
| v3.16.3 (Release) | quay.io/cephcsi/cephcsi | v3.16.3 |
| v3.16.2 (Release) | quay.io/cephcsi/cephcsi | v3.16.2 |
| v3.16.1 (Release) | quay.io/cephcsi/cephcsi | v3.16.1 |
| v3.16.0 (Release) | quay.io/cephcsi/cephcsi | v3.16.0 |
| Deprecated Ceph CSI Release/Branch | Container image name | Image Tag |
|---|
| v3.15.1 (Release) | quay.io/cephcsi/cephcsi | v3.15.1 |
| v3.15.0 (Release) | quay.io/cephcsi/cephcsi | v3.15.0 |
| v3.14.2 (Release) | quay.io/cephcsi/cephcsi | v3.14.2 |
| v3.14.1 (Release) | quay.io/cephcsi/cephcsi | v3.14.1 |
| v3.14.0 (Release) | quay.io/cephcsi/cephcsi | v3.14.0 |
| v3.13.1 (Release) | quay.io/cephcsi/cephcsi | v3.13.1 |
| v3.13.0 (Release) | quay.io/cephcsi/cephcsi | v3.13.0 |
| v3.12.3 (Release) | quay.io/cephcsi/cephcsi | v3.12.3 |
| v3.12.2 (Release) | quay.io/cephcsi/cephcsi | v3.12.2 |
| v3.12.1 (Release) | quay.io/cephcsi/cephcsi | v3.12.1 |
| v3.12.0 (Release) | quay.io/cephcsi/cephcsi | v3.12.0 |
| v3.11.0 (Release) | quay.io/cephcsi/cephcsi | v3.11.0 |
| v3.10.2 (Release) | quay.io/cephcsi/cephcsi | v3.10.2 |
| v3.10.1 (Release) | quay.io/cephcsi/cephcsi | v3.10.1 |
| v3.10.0 (Release) | quay.io/cephcsi/cephcsi | v3.10.0 |
| v3.9.0 (Release) | quay.io/cephcsi/cephcsi | v3.9.0 |
| v3.8.1 (Release) | quay.io/cephcsi/cephcsi | v3.8.1 |
| v3.8.0 (Release) | quay.io/cephcsi/cephcsi | v3.8.0 |
| v3.7.2 (Release) | quay.io/cephcsi/cephcsi | v3.7.2 |
| v3.7.1 (Release) | quay.io/cephcsi/cephcsi | v3.7.1 |
| v3.7.0 (Release) | quay.io/cephcsi/cephcsi | v3.7.0 |
| v3.6.1 (Release) | quay.io/cephcsi/cephcsi | v3.6.1 |
| v3.6.0 (Release) | quay.io/cephcsi/cephcsi | v3.6.0 |
| v3.5.1 (Release) | quay.io/cephcsi/cephcsi | v3.5.1 |
| v3.5.0 (Release) | quay.io/cephcsi/cephcsi | v3.5.0 |
| v3.4.0 (Release) | quay.io/cephcsi/cephcsi | v3.4.0 |
| v3.3.1 (Release) | quay.io/cephcsi/cephcsi | v3.3.1 |
| v3.3.0 (Release) | quay.io/cephcsi/cephcsi | v3.3.0 |
| v3.2.2 (Release) | quay.io/cephcsi/cephcsi | v3.2.2 |
| v3.2.1 (Release) | quay.io/cephcsi/cephcsi | v3.2.1 |
| v3.2.0 (Release) | quay.io/cephcsi/cephcsi | v3.2.0 |
| v3.1.2 (Release) | quay.io/cephcsi/cephcsi | v3.1.2 |
| v3.1.1 (Release) | quay.io/cephcsi/cephcsi | v3.1.1 |
| v3.1.0 (Release) | quay.io/cephcsi/cephcsi | v3.1.0 |
| v3.0.0 (Release) | quay.io/cephcsi/cephcsi | v3.0.0 |
| v2.1.2 (Release) | quay.io/cephcsi/cephcsi | v2.1.2 |
| v2.1.1 (Release) | quay.io/cephcsi/cephcsi | v2.1.1 |
| v2.1.0 (Release) | quay.io/cephcsi/cephcsi | v2.1.0 |
| v2.0.1 (Release) | quay.io/cephcsi/cephcsi | v2.0.1 |
| v2.0.0 (Release) | quay.io/cephcsi/cephcsi | v2.0.0 |
| v1.2.2 (Release) | quay.io/cephcsi/cephcsi | v1.2.2 |
| v1.2.1 (Release) | quay.io/cephcsi/cephcsi | v1.2.1 |
| v1.2.0 (Release) | quay.io/cephcsi/cephcsi | v1.2.0 |
| v1.1.0 (Release) | quay.io/cephcsi/cephcsi | v1.1.0 |
| v1.0.0 (Branch) | quay.io/cephcsi/cephfsplugin | v1.0.0 |
| v1.0.0 (Branch) | quay.io/cephcsi/rbdplugin | v1.0.0 |
Alternative images for older CPUs
Starting with Ceph-CSI v3.17, the base image moved to Rocky Linux 10 (RHEL 10).
Since RHEL 10 dropped support for old x86-64-v2 CPUs, that means the image will no
longer run on some older systems. For compatibility with v2 CPUs, alternative images
based on Rocky Linux 9 (RHEL 9) are published under the tag name <image-tag>-rocky9
(e.g. v3.18.0-rocky9 or canary-rocky9). These images are built alongside the
standard images on tag releases, but are not tested to the same standard as the
newer Rocky Linux 10 images.
Contributing to this repo
Please follow development-guide
and coding style guidelines
if you are interested to contribute to this repo.
Troubleshooting
Please submit an issue at: Issues
Weekly Bug Triage call
We conduct weekly bug triage calls at our slack channel on Tuesdays.
More details are available here
Dev standup
A regular dev standup takes place every Monday at
12:00 PM UTC Convert to your local
timezone by executing command date -d "12:00 UTC" on terminal
Any changes to the meeting schedule will be added to the agenda
doc.
Anyone who wants to discuss the direction of the project, design and
implementation reviews, or general questions with the broader community is
welcome and encouraged to join.
- Meeting link: https://meet.google.com/vit-qdhw-nyh
- Current agenda
Contact
Please use the following to reach members of the community:
- Slack: Join the
#ceph-csi channel
on the ceph Slack to discuss anything
related to this project. You can join the Slack by this
invite link