hub / github.com/ceph/ceph-csi
github.com/ceph/ceph-csi @v3.17.0
Chat with this repo
2,588 symbols
10,290 edges
316 files
1,549 documented · 60%
1 cross-repo links
What it actually does AI analysis from the code graph — generated when you open this
loading…
README
Ceph CSI
- Ceph CSI
- Overview
- Project status
- Known to work CO platforms
- Support Matrix
- 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
Arm64support 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 |
|---|---|---|
| v3.17.0 | Kubernetes | v1.33, v1.34, v1.35 |
| 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
| Ceph CSI Release/Branch | Container image name | Image Tag |
|---|---|---|
| devel (Branch) | quay.io/cephcsi/cephcsi | canary |
| v3.17.0 (Release) | quay.io/cephcsi/cephcsi | v3.17.0 |
| 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 |
Extension points exported contracts — how you extend this code
DEKStore (Interface)DEKStore allows KMS instances to implement a modular backend for DEK storage. This can be used to store the DEK in a dif [7 …
internal/kms/kms.go
CSIAddonsService (Interface)
CSIAddonsService is the interface that is required to be implemented so that the CSIAddonsServer can register the servic [10 …
internal/csi-addons/server/server.go
Driver (Interface)
Driver is the interface that all driver types should implement. [4 implementers]
internal/driver/driver.go
MirrorInfo (Interface)
MirrorImage is the interface for managing mirroring on an RBD image or group of images. This will be used to get the sta [2 …
internal/rbd/types/mirror.go
IOContextW (Interface)
These interfaces are just wrappers around some of go-ceph's rados pkg structures and functions. They have two implementa [2 …
internal/util/reftracker/radoswrapper/interface.go
VolumeGroupSnapshotter (Interface)
VolumeGroupSnapshotter defines validation operations specific to each driver. [2 implementers]
e2e/volumegroupsnapshot_base.go
ResourceDeployer (Interface)
ResourceDeployer provides a generic interface for deploying different resources. [2 implementers]
e2e/deployment.go
SecurityKeyManager (Interface)
SecurityKeyManager defines the interface for managing NVMe-oF security keys. It provides encrypted storage and retrieval [1 …
internal/nvmeof/crypto.go
Core symbols most depended-on inside this repo
logAndFailcalled by 1352
e2e/utils.go
ErrorLog
called by 505
internal/util/log/log.go
DebugLog
called by 295
internal/util/log/log.go
validateOmapCount
called by 233
e2e/utils.go
validateRBDImageCount
called by 180
e2e/rbd.go
deleteResource
called by 161
e2e/utils.go
Run
called by 144
internal/driver/driver.go
loadPVC
called by 132
e2e/pvc.go
Shape
Languages
Go99%
Python1%
Modules by API surface
internal/rbd/rbd_util.go90 symbols
e2e/utils.go78 symbols
e2e/rbd_helper.go60 symbols
internal/util/reftracker/radoswrapper/fakerados.go59 symbols
internal/util/cryptsetup/cryptsetup.go54 symbols
internal/rbd/nodeserver.go37 symbols
internal/nvmeof/controller/controllerserver.go34 symbols
internal/rbd/mirror.go33 symbols
internal/rbd/controllerserver.go32 symbols
e2e/pod.go32 symbols
internal/cephfs/store/volumeoptions.go31 symbols
e2e/cephfs_helper.go31 symbols
Used by 1 indexed graphs manifest dependencies, hub-wide
For agents
$ claude mcp add ceph-csi \
-- python -m otcore.mcp_server <graph>