ceph-csi/README.md
Madhu Rajanna 8ec5aae932 Update readme for resize metrics
Signed-off-by: Madhu Rajanna <madhupr007@gmail.com>
2020-01-17 13:45:20 +00:00

7.0 KiB

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

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 >= v1.13.0
Dynamically provision, de-provision Block mode RWX volume GA >=v1.0.0 >=v1.0.0 >= Mimic >= v1.13.0
Dynamically provision, de-provision File mode RWO volume GA >=v1.0.0 >=v1.0.0 >= Mimic >= v1.13.0
Creating and deleting snapshot Alpha >=v1.0.0 >=v1.0.0 >= Mimic >= v1.13.0
Provision volume from snapshot Alpha >=v1.0.0 >=v1.0.0 >= Mimic >= v1.13.0
Provision volume from another volume - - - - -
Resize volume Beta >=v2.0.0 >=v1.1.0 >= Mimic >=v1.15.0
Metrics Support - - - - -
CephFS Dynamically provision, de-provision File mode RWO volume Alpha >=v1.1.0 >=v1.0.0 Nautilus (>=14.2.2) >=v1.13.0
Dynamically provision, de-provision File mode RWX volume Alpha >=v1.1.0 >=v1.0.0 Nautilus (>=v14.2.2) >=v1.13.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 - - - - -

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

Contact

Please use the following to reach members of the community: