CSI driver for Ceph
Go to file
Yug 94b745d573 ci: disable goerr113 linter
goerr113 linter checks the errors handling expressions.
It warns about using wrapped static errors in place
of dynamic at multiple places.

Disabled the linter as of now to avoid regression,
and this need to be handled in a seperate issue.
Tracker Issue: #1227

Signed-off-by: Yug <yuggupta27@gmail.com>
2020-07-21 08:36:24 +00:00
.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 cleanup: Remove support for Delete and Unmounting v1.1.0 PVC 2020-07-10 16:07:13 +00:00
cmd cleanup: Remove support for Delete and Unmounting v1.1.0 PVC 2020-07-10 16:07:13 +00:00
deploy cleanup: Remove support for Delete and Unmounting v1.1.0 PVC 2020-07-10 16:07:13 +00:00
docs doc: add document for rbd snapshot and clone 2020-07-20 12:56:23 +00:00
e2e cleanup: address godot warnings 2020-07-21 08:36:24 +00:00
examples rbd: Add support for smart cloning 2020-07-10 14:02:12 +00:00
internal cleanup: address godot warnings 2020-07-21 08:36:24 +00:00
scripts ci: disable goerr113 linter 2020-07-21 08:36:24 +00:00
troubleshooting/tools util: fix tracevol.py to work with volumeNamePrefix in storageclass 2020-07-08 14:33:15 +00:00
vendor rebase: update k8s.io/klog to v2.3.0 2020-07-10 07:41:23 +00:00
.commitlintrc.yml ci: add .commitlintrc.yml for forcing commitlint CI checks 2020-05-15 18:20:29 +00:00
.gitignore ci: generate golangci.yml with correct CEPH_VERSION 2020-07-02 14:24:02 +00:00
.mergify.yml ci: enable containerized test job in mergify 2020-07-20 14:15:47 +05:30
.travis.yml ci: update kubernetes v1.17 to latest patch release 2020-07-10 09:47:21 +00:00
build.env ci: update golang-ci to v1.27 2020-07-21 08:36:24 +00:00
deploy.sh build: Fix docker permission issue during manifest create 2020-07-16 16:37:36 +00:00
go.mod rebase: update k8s.io/klog to v2.3.0 2020-07-10 07:41:23 +00:00
go.sum rebase: update k8s.io/klog to v2.3.0 2020-07-10 07:41:23 +00:00
LICENSE Removing appendix from license. 2019-08-09 15:16:46 +00:00
Makefile build: Build and push multi architecture images to dockerhub 2020-07-16 08:57:38 +00:00
README.md doc: update readme for ROX PVC 2020-06-30 17:43:41 +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, resizer, 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
Dynamically provision(from snapshot or volume), de-provision File mode ROX volume Alpha >= v3.0.0 >= v1.0.0 Mimic (>=v13.0.0) >= v1.14.0
Dynamically provision(from snapshot or volume), de-provision Block mode ROX volume Alpha >= v3.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 - - - - -
Expand 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
Dynamically provision, de-provision File mode ROX volume Alpha >= v3.0.0 >= v1.0.0 Nautilus (>=v14.2.2) >= v1.14.0
Creating and deleting snapshot - - - - -
Provision volume from snapshot - - - - -
Provision volume from another volume - - - - -
Expand 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.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 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: