CSI driver for Ceph
Go to file
Niels de Vos ea3d9e941f ci: automatically merge PRs in ci/centos
Merge PRs for the ci/centos branch when they have sufficient approvals
and the tests have passed. Using the same rules as the master branch.

Signed-off-by: Niels de Vos <ndevos@redhat.com>
2020-05-28 12:27:44 +05:30
.github ci: Enable stale bot on issues 2020-05-22 09:09:06 +00:00
assets feat: Adds Ceph logo as icon for Helm charts 2019-08-20 05:34:28 +00:00
charts deploy: add retry-interval-start for attacher & resizer helm charts 2020-05-27 15:52:08 +00:00
cmd cleanup: move pkg/ to internal/ 2020-04-23 11:00:59 +00:00
deploy deploy: add --retry-interval-start arg for attacher & resizer 2020-05-27 15:52:08 +00:00
docs doc: Add prefix for naming subvolumes and snapshots 2020-05-27 05:54:10 +00:00
e2e cleanup: fix golint warnings in util, e2e 2020-05-20 13:18:41 +00:00
examples doc: Add prefix for naming subvolumes and snapshots 2020-05-27 05:54:10 +00:00
internal journal: In mount failure case, suggest to check the kernel logs 2020-05-27 10:52:37 +00:00
scripts ci: install commitlint in the test container-image 2020-05-15 18:20:29 +00:00
troubleshooting/tools Trace backend volume from pvc 2019-08-26 14:42:12 +00:00
vendor vendor: Vendor changes to add external-snapshotter 2020-05-15 08:19:32 +00:00
.commitlintrc.yml ci: add .commitlintrc.yml for forcing commitlint CI checks 2020-05-15 18:20:29 +00:00
.gitignore build: add an option to compile in a container 2020-03-26 08:45:53 +00:00
.mergify.yml ci: automatically merge PRs in ci/centos 2020-05-28 12:27:44 +05:30
.travis.yml ci: Add commitlint to travis CI 2020-05-27 12:51:26 +00:00
deploy.sh create temp directory to push helm charts 2020-04-28 11:45:56 +00:00
go.mod vendor: Vendor changes to add external-snapshotter 2020-05-15 08:19:32 +00:00
go.sum vendor: Vendor changes to add external-snapshotter 2020-05-15 08:19:32 +00:00
LICENSE Removing appendix from license. 2019-08-09 15:16:46 +00:00
Makefile build: prevent error message when 'go' is unavailable 2020-05-19 07:31:58 +00:00
README.md doc: add v2.1.1 release to the release matrix 2020-05-13 09:20:37 +00:00

Ceph CSI

Go Report
Card Build
Status

This repo contains Ceph Container Storage Interface (CSI) driver for RBD, CephFS and kubernetes sidecar deployment yamls of provisioner, attacher, node-driver-registrar and snapshotter for supporting CSI functionalities.

Overview

Ceph CSI plugins implement an interface between CSI enabled Container Orchestrator (CO) and Ceph cluster. It allows 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 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

Supported CO platforms

Ceph CSI drivers are currently developed and tested exclusively on Kubernetes environments. There is work in progress to make this CO independent and thus support other orchestration environments in the future.

NOTE:

  • csiv0.3 is deprecated with release of csi v1.1.0

Support Matrix

Ceph-CSI features and available versions

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 Mimic (>=v13.0.0) >= v1.14.0
Dynamically provision, de-provision Block mode RWX volume GA >= v1.0.0 >= v1.0.0 Mimic (>=v13.0.0) >= v1.14.0
Dynamically provision, de-provision File mode RWO volume GA >= v1.0.0 >= v1.0.0 Mimic (>=v13.0.0) >= v1.14.0
Creating and deleting snapshot Alpha >= v1.0.0 >= v1.0.0 Mimic (>=v13.0.0) >= v1.14.0
Provision volume from snapshot Alpha >= v1.0.0 >= v1.0.0 Mimic (>=v13.0.0) >= v1.14.0
Provision volume from another volume - - - - -
Resize volume Beta >= v2.0.0 >= v1.1.0 Mimic (>=v13.0.0) >= v1.15.0
Metrics Support Beta >= v1.2.0 >= v1.1.0 Mimic (>=v13.0.0) >= v1.15.0
Topology Aware Provisioning Support Alpha >= v2.1.0 >= v1.1.0 Mimic (>=v13.0.0) >= v1.14.0
CephFS Dynamically provision, de-provision File mode RWO volume Beta >= v1.1.0 >= v1.0.0 Nautilus (>=14.2.2) >= v1.14.0
Dynamically provision, de-provision File mode RWX volume Beta >= v1.1.0 >= v1.0.0 Nautilus (>=v14.2.2) >= v1.14.0
Creating and deleting snapshot - - - - -
Provision volume from snapshot - - - - -
Provision volume from another volume - - - - -
Resize volume Beta >= v2.0.0 >= v1.1.0 Nautilus (>=v14.2.2) >= v1.15.0
Metrics Beta >= v1.2.0 >= v1.1.0 Nautilus (>=v14.2.2) >= v1.15.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
Master (Branch) quay.io/cephcsi/cephcsi canary
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 other Monday,Tuesday,Thursday at 2:00 PM UTC. Convert to your local timezone by executing command date -d 14: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: