mirrors/ceph-csi
1
0
Fork 0
mirror of https://github.com/ceph/ceph-csi.git synced 2024-12-18 11:00:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
CSI driver for Ceph
3,824 Commits 30 Branches 40 Tags 154 MiB
Go 95.1%
Shell 2.8%
Python 1%
Makefile 0.7%
Smarty 0.3%
Other 0.1%
93f2ed681f
Go to file
Praveen M 93f2ed681f util: added RunsOnKubernetes() function 
Signed-off-by: Praveen M <m.praveen@ibm.com>
2023-11-08 21:17:00 +00:00
.github ci: run tickgit after merging a PR in the devel branch 2023-11-08 08:29:10 +00:00
actions/retest rebase: Bump golang.org/x/net from 0.16.0 to 0.17.0 in /actions/retest 2023-10-12 07:13:43 +00:00
api cleanup: fix spellcheck errors 2023-11-08 12:32:06 +00:00
assets feat: Adds Ceph logo as icon for Helm charts 2019-08-20 05:34:28 +00:00
charts e2e: added test to verify read affinity functionality 2023-09-26 07:02:21 +00:00
cmd util: remove deprecated grpc metrics 2023-11-03 10:04:50 +00:00
deploy deploy: update CSI sidecars to latest versions available 2023-09-20 08:20:38 +00:00
docs doc: Add initial design notes for the Health Checker 2023-11-03 13:41:44 +00:00
e2e cleanup: fix spellcheck errors 2023-11-08 12:32:06 +00:00
examples doc: improve comments in StorageClass example 2023-10-20 10:05:51 +00:00
internal util: added RunsOnKubernetes() function 2023-11-08 21:17:00 +00:00
scripts ci: run tickgit after merging a PR in the devel branch 2023-11-08 08:29:10 +00:00
tools deploy: move cephfs/csidriver to API 2023-05-25 12:24:28 +00:00
troubleshooting/tools ci: fix shell check failures 2023-04-20 15:24:35 +00:00
vendor rebase: bump the github-dependencies group with 1 update 2023-10-31 10:40:03 +00:00
.commitlintrc.yml ci: add "nfs" as allowed commit prefix 2022-03-28 11:23:17 +00:00
.gitignore build: ignore generated go-tags file 2022-04-04 12:59:12 +00:00
.mergify.yml ci: skip testing on k1.28 for the current releases 2023-08-28 13:38:34 +02:00
.pre-commit-config.yaml cleanup: fix the pre-commit-golang repo link 2023-04-20 15:38:12 +00:00
build.env deploy: update CSI sidecars to latest versions available 2023-09-20 08:20:38 +00:00
deploy.sh doc: remove use of XXX in example descriptions 2023-11-03 10:22:08 +00:00
go.mod ci: remove unwated go-ceph tags 2023-11-04 08:14:51 +00:00
go.sum rebase: bump the github-dependencies group with 1 update 2023-10-31 10:40:03 +00:00
LICENSE Removing appendix from license. 2019-08-09 15:16:46 +00:00
Makefile ci: run tickgit after merging a PR in the devel branch 2023-11-08 08:29:10 +00:00
PendingReleaseNotes.md doc: update release notes for grpc metrics 2023-11-07 12:26:24 +00:00
README.md doc: update documentation for v3.8.1 release 2023-07-21 17:23:59 +00:00

README.md

Ceph CSI

GitHub release Mergify Status Go Report Card TODOs CII Best Practices

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
v3.9.0 Kubernetes v1.25, v1.26, v1.27
v3.8.1 Kubernetes v1.25, v1.26, v1.27
v3.8.0 Kubernetes v1.24, v1.25, v1.26, v1.27

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 Octopus (>=15.0.0) >= v1.14.0
Dynamically provision, de-provision Block mode RWX volume GA >= v1.0.0 >= v1.0.0 Octopus (>=15.0.0) >= v1.14.0
Dynamically provision, de-provision Block mode RWOP volume Alpha >= v3.5.0 >= v1.5.0 Octopus (>=15.0.0) >= v1.22.0
Dynamically provision, de-provision File mode RWO volume GA >= v1.0.0 >= v1.0.0 Octopus (>=15.0.0) >= v1.14.0
Dynamically provision, de-provision File mode RWOP volume Alpha >= v3.5.0 >= v1.5.0 Octopus (>=15.0.0) >= v1.22.0
Provision File Mode ROX volume from snapshot Alpha >= v3.0.0 >= v1.0.0 Octopus (>=v15.0.0) >= v1.17.0
Provision File Mode ROX volume from another volume Alpha >= v3.0.0 >= v1.0.0 Octopus (>=v15.0.0) >= v1.16.0
Provision Block Mode ROX volume from snapshot Alpha >= v3.0.0 >= v1.0.0 Octopus (>=v15.0.0) >= v1.17.0
Provision Block Mode ROX volume from another volume Alpha >= v3.0.0 >= v1.0.0 Octopus (>=v15.0.0) >= v1.16.0
Creating and deleting snapshot GA >= v1.0.0 >= v1.0.0 Octopus (>=15.0.0) >= v1.17.0
Provision volume from snapshot GA >= v1.0.0 >= v1.0.0 Octopus (>=15.0.0) >= v1.17.0
Provision volume from another volume GA >= v1.0.0 >= v1.0.0 Octopus (>=15.0.0) >= v1.16.0
Expand volume Beta >= v2.0.0 >= v1.1.0 Octopus (>=15.0.0) >= v1.15.0
Volume/PV Metrics of File Mode Volume GA >= v1.2.0 >= v1.1.0 Octopus (>=15.0.0) >= v1.15.0
Volume/PV Metrics of Block Mode Volume GA >= v1.2.0 >= v1.1.0 Octopus (>=15.0.0) >= v1.21.0
Topology Aware Provisioning Support Alpha >= v2.1.0 >= v1.1.0 Octopus (>=15.0.0) >= v1.14.0
CephFS Dynamically provision, de-provision File mode RWO volume GA >= v1.1.0 >= v1.0.0 Octopus (>=15.0.0) >= v1.14.0
Dynamically provision, de-provision File mode RWX volume GA >= v1.1.0 >= v1.0.0 Octopus (>=v15.0.0) >= v1.14.0
Dynamically provision, de-provision File mode ROX volume Alpha >= v3.0.0 >= v1.0.0 Octopus (>=v15.0.0) >= v1.14.0
Dynamically provision, de-provision File mode RWOP volume Alpha >= v3.5.0 >= v1.5.0 Octopus (>=15.0.0) >= v1.22.0
Creating and deleting snapshot GA >= v3.1.0 >= v1.0.0 Octopus (>=v15.2.4) >= v1.17.0
Provision volume from snapshot GA >= v3.1.0 >= v1.0.0 Octopus (>=v15.2.4) >= v1.17.0
Provision volume from another volume GA >= v3.1.0 >= v1.0.0 Octopus (>=v15.2.4) >= v1.16.0
Expand volume Beta >= v2.0.0 >= v1.1.0 Octopus (>=v15.0.0) >= v1.15.0
Volume/PV Metrics of File Mode Volume GA >= v1.2.0 >= v1.1.0 Octopus (>=v15.0.0) >= v1.15.0
NFS Dynamically provision, de-provision File mode RWO volume Alpha >= v3.6.0 >= v1.0.0 Pacific (>=16.2.0) >= v1.14.0
Dynamically provision, de-provision File mode RWX volume Alpha >= v3.6.0 >= v1.0.0 Pacific (>=16.2.0) >= v1.14.0
Dynamically provision, de-provision File mode ROX volume Alpha >= v3.6.0 >= v1.0.0 Pacific (>=16.2.0) >= v1.14.0
Dynamically provision, de-provision File mode RWOP volume Alpha >= v3.6.0 >= v1.5.0 Pacific (>=16.2.0) >= v1.22.0
Expand volume Alpha >= v3.7.0 >= v1.1.0 Pacific (>=16.2.0) >= v1.15.0
Creating and deleting snapshot Alpha >= v3.7.0 >= v1.1.0 Pacific (>=16.2.0) >= v1.17.0
Provision volume from snapshot Alpha >= v3.7.0 >= v1.1.0 Pacific (>=16.2.0) >= v1.17.0
Provision volume from another volume Alpha >= v3.7.0 >= v1.1.0 Pacific (>=16.2.0) >= v1.16.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.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
Deprecated Ceph CSI Release/Branch Container image name Image Tag
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

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 Tuesday 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.

Contact

Please use the following to reach members of the community: