From 9bb7e33c53248c17eb0b0911f4cd2823b6776660 Mon Sep 17 00:00:00 2001 From: Niraj Yadav Date: Tue, 3 Dec 2024 16:03:19 +0530 Subject: [PATCH] doc: Format README using prettier Signed-off-by: Niraj Yadav --- README.md | 194 +++++++++++++++++++++++++++--------------------------- 1 file changed, 97 insertions(+), 97 deletions(-) diff --git a/README.md b/README.md index 07d5825b3fc..5f6c339b150 100644 --- a/README.md +++ b/README.md @@ -8,23 +8,23 @@ Card](https://goreportcard.com/badge/github.com/ceph/ceph-csi)](https://goreport [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5940/badge)](https://bestpractices.coreinfrastructure.org/projects/5940) - [Ceph CSI](#ceph-csi) - - [Overview](#overview) - - [Project status](#project-status) - - [Known to work CO platforms](#known-to-work-co-platforms) - - [Support Matrix](#support-matrix) - - [Ceph-CSI features and available versions](#ceph-csi-features-and-available-versions) - - [CSI spec and Kubernetes version compatibility](#csi-spec-and-kubernetes-version-compatibility) - - [Ceph CSI Container images and release compatibility](#ceph-csi-container-images-and-release-compatibility) - - [Contributing to this repo](#contributing-to-this-repo) - - [Troubleshooting](#troubleshooting) - - [Weekly Bug Triage call](#weekly-bug-triage-call) - - [Dev standup](#dev-standup) - - [Contact](#contact) + - [Overview](#overview) + - [Project status](#project-status) + - [Known to work CO platforms](#known-to-work-co-platforms) + - [Support Matrix](#support-matrix) + - [Ceph-CSI features and available versions](#ceph-csi-features-and-available-versions) + - [CSI spec and Kubernetes version compatibility](#csi-spec-and-kubernetes-version-compatibility) + - [Ceph CSI Container images and release compatibility](#ceph-csi-container-images-and-release-compatibility) + - [Contributing to this repo](#contributing-to-this-repo) + - [Troubleshooting](#troubleshooting) + - [Weekly Bug Triage call](#weekly-bug-triage-call) + - [Dev standup](#dev-standup) + - [Contact](#contact) This repo contains the Ceph [Container Storage Interface (CSI)](https://github.com/container-storage-interface/) driver for RBD, CephFS and Kubernetes sidecar deployment YAMLs to support CSI -functionality: provisioner, attacher, resizer, driver-registrar and snapshotter. +functionality: provisioner, attacher, resizer, driver-registrar and snapshotter. ## Overview @@ -54,10 +54,10 @@ Status: **GA** Ceph CSI drivers are currently developed and tested **exclusively** in Kubernetes environments. -| Ceph CSI Version | Container Orchestrator Name | Version Tested | -| -----------------| --------------------------- | -------------------| -| v3.12.0 | Kubernetes | v1.29, v1.30, v1.31| -| v3.11.0 | Kubernetes | v1.26, v1.27, v1.28, v1.29| +| Ceph CSI Version | Container Orchestrator Name | Version Tested | +| ---------------- | --------------------------- | -------------------------- | +| v3.12.0 | Kubernetes | v1.29, v1.30, v1.31 | +| v3.11.0 | Kubernetes | v1.26, v1.27, v1.28, v1.29 | There is work in progress to make this CO-independent and thus support other orchestration environments (Nomad, Mesos..etc). @@ -78,42 +78,42 @@ Ceph CSI version, they will be asked to upgrade when requesting support. Please refer [rbd nbd mounter](./docs/design/proposals/rbd-nbd.md#support-matrix) 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 | +| 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 @@ -126,53 +126,53 @@ 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.12.0 (Release) | quay.io/cephcsi/cephcsi | v3.12.0 | -| v3.11.0 (Release) | quay.io/cephcsi/cephcsi | v3.11.0 | - -| Deprecated Ceph CSI Release/Branch | Container image name | Image Tag | -| ----------------------- | --------------------------------| --------- | -| 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 | +| Ceph CSI Release/Branch | Container image name | Image Tag | +| ----------------------- | ----------------------- | --------- | +| devel (Branch) | quay.io/cephcsi/cephcsi | canary | +| v3.12.0 (Release) | quay.io/cephcsi/cephcsi | v3.12.0 | +| v3.11.0 (Release) | quay.io/cephcsi/cephcsi | v3.11.0 | + +| Deprecated Ceph CSI Release/Branch | Container image name | Image Tag | +| ---------------------------------- | ---------------------------- | --------- | +| 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]() +Please follow [development-guide](https://github.com/ceph/ceph-csi/tree/devel/docs/development-guide.md) +and [coding style guidelines](https://github.com/ceph/ceph-csi/tree/devel/docs/coding.md) if you are interested to contribute to this repo. ## Troubleshooting