mirrors/ceph-csi
1
0
Fork 0
mirror of https://github.com/ceph/ceph-csi.git synced 2024-12-25 06:20:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
CSI driver for Ceph
4,420 Commits 31 Branches 40 Tags 155 MiB
Go 95.1%
Shell 2.8%
Python 1%
Makefile 0.7%
Smarty 0.3%
Other 0.1%
4774a82e88
Go to file
Yite Gu 4774a82e88 rbd: support QoS based on capacity for rbd volume 
1. QoS provides settings for rbd volume read/write iops
   and read/write bandwidth.
2. All QoS parameters are placed in the SC,
   send QoS parameters from SC to Cephcsi through PVC create request.
3. We need provide QoS parameters in the SC as below:
   - BaseReadIops
   - BaseWriteIops
   - BaseReadBytesPerSecond
   - BaseWriteBytesPerSecond
   - ReadIopsPerGB
   - WriteIopsPerGB
   - ReadBpsPerGB
   - WriteBpsPerGB
   - BaseVolSizeBytes
   There are 4 base qos parameters among them, when users apply for
   a volume capacity equal to or less than BaseVolSizebytes, use base
   qos limit. For the portion of capacity exceeding BaseVolSizebytes,
   QoS will be increased in steps set per GB. If the step size parameter
   per GB is not provided, only base QoS limit will be used and not associated
   with capacity size.
4. If PVC has resize request, adjust the QoS limit
   according to the QoS parameters after resizing.

Signed-off-by: Yite Gu <guyite@bytedance.com>
2024-12-20 13:05:06 +08:00
.github rebase: bump github/codeql-action from 3.27.5 to 3.27.6 2024-12-12 05:47:23 +00:00
actions/retest rebase: bump golang.org/x/oauth2 in /actions/retest 2024-11-12 10:06:07 +00:00
api rebase: bump k8s.io/api in /api in the k8s-dependencies group 2024-11-28 06:59:03 +00:00
assets feat: Adds Ceph logo as icon for Helm charts 2019-08-20 05:34:28 +00:00
charts helm: add least privileges logic for secrets on ceph-csi-cephfs chart 2024-11-18 15:28:23 +00:00
cmd util: added logs for slow gRPC calls 2024-09-20 08:55:17 +00:00
deploy build: refactor dockerfile to simplify selinux config directory creation 2024-12-09 14:39:34 +00:00
docs rbd: support QoS based on capacity for rbd volume 2024-12-20 13:05:06 +08:00
e2e rbd: support QoS based on capacity for rbd volume 2024-12-20 13:05:06 +08:00
examples rbd: support QoS based on capacity for rbd volume 2024-12-20 13:05:06 +08:00
internal rbd: support QoS based on capacity for rbd volume 2024-12-20 13:05:06 +08:00
scripts build: include --nobest while upgrading the devel container packages 2024-12-10 14:27:19 +00:00
tools build: add NFS provisioner RBAC to generated artifacts 2024-03-14 09:27:07 +00:00
troubleshooting/tools ci: fix shell check failures 2023-04-20 15:24:35 +00:00
vendor rebase: bump google.golang.org/grpc from 1.68.0 to 1.68.1 2024-12-11 10:55:31 +00:00
.commitlintrc.yml ci: replace csi-addons with csiaddons 2024-06-25 05:14:58 +00:00
.gitignore build: ignore generated go-tags file 2022-04-04 12:59:12 +00:00
.mergify.yml ci: update mergify rules 2024-12-03 15:34:13 +00:00
.pre-commit-config.yaml helm: Support setting annotations for nodePlugin and provisioner 2024-10-15 11:35:56 +00:00
build.env ci: update to Minikube v1.34.0 2024-09-12 16:12:47 +00:00
deploy.sh doc: remove use of XXX in example descriptions 2023-11-03 10:22:08 +00:00
go.mod rebase: bump google.golang.org/grpc from 1.68.0 to 1.68.1 2024-12-11 10:55:31 +00:00
go.sum rebase: bump google.golang.org/grpc from 1.68.0 to 1.68.1 2024-12-11 10:55:31 +00:00
LICENSE Removing appendix from license. 2019-08-09 15:16:46 +00:00
Makefile ci: add test for uncommitted changes in deploy directory 2024-08-13 12:17:43 +00:00
PendingReleaseNotes.md cephfs: support omap store in radosnamespace 2024-10-21 14:11:27 +00:00
README.md doc: update the document for 3.13 release 2024-12-03 15:34:13 +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.13.0 Kubernetes v1.29, v1.30, v1.31
v3.12.3 Kubernetes v1.29, v1.30, v1.31

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

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.13.0 (Release) quay.io/cephcsi/cephcsi v3.13.0
v3.12.3 (Release) quay.io/cephcsi/cephcsi v3.12.3
Deprecated Ceph CSI Release/Branch Container image name Image Tag
v3.11.0 (Release) quay.io/cephcsi/cephcsi v3.11.0
v3.10.2 (Release) quay.io/cephcsi/cephcsi v3.10.2
v3.10.1 (Release) quay.io/cephcsi/cephcsi v3.10.1
v3.10.0 (Release) quay.io/cephcsi/cephcsi v3.10.0
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
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 Monday 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: