From 83caca76558cdd838d504772c4fcedadbabe73f7 Mon Sep 17 00:00:00 2001 From: Praveen M Date: Wed, 17 Apr 2024 14:52:57 +0530 Subject: [PATCH 1/2] csi: remove the out-dated prerequisites Signed-off-by: Praveen M (cherry picked from commit 0467eb8a4c7f865317cd9e9db378d077e073ab59) --- .../Ceph-CSI/ceph-csi-drivers.md | 15 +-------------- .../Ceph-CSI/ceph-csi-snapshot.md | 7 ------- .../Ceph-CSI/ceph-csi-volume-clone.md | 5 ----- .../Monitoring/ceph-monitoring.md | 4 ++++ 4 files changed, 5 insertions(+), 26 deletions(-) diff --git a/Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-drivers.md b/Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-drivers.md index 89b24a4bd..11d041d26 100644 --- a/Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-drivers.md +++ b/Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-drivers.md @@ -18,7 +18,7 @@ namespace as the operator when the first CephCluster CR is created. ## Supported Versions -The supported Ceph CSI version is 3.3.0 or greater with Rook. Refer to ceph csi [releases](https://github.com/ceph/ceph-csi/releases) +The two most recent Ceph CSI version are supported with Rook. Refer to ceph csi [releases](https://github.com/ceph/ceph-csi/releases) for more information. ## Static Provisioning @@ -92,19 +92,6 @@ volumesnapshotclass, search for: `# csi-provisioner-name` All CSI pods are deployed with a sidecar container that provides a Prometheus metric for tracking whether the CSI plugin is alive and running. -These metrics are meant to be scraped (collected) by Prometheus but can also be -accessed through a GET request to a specific node as follows: - -`curl -X get http://[pod ip]:[liveness-port][liveness-path] 2>/dev/null | grep csi` - -For example: - -```console -$ curl -X GET http://10.109.65.142:9080/metrics 2>/dev/null | grep csi -# HELP csi_liveness Liveness Probe -# TYPE csi_liveness gauge -csi_liveness 1 -``` Check the [monitoring documentation](../Monitoring/ceph-monitoring.md) to see how to integrate CSI liveness and GRPC metrics into Ceph monitoring. diff --git a/Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-snapshot.md b/Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-snapshot.md index cf3c21be6..2b0475971 100644 --- a/Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-snapshot.md +++ b/Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-snapshot.md @@ -4,15 +4,8 @@ title: Snapshots ## Prerequisites -- Rook officially supports v1 snapshots for Kubernetes v1.20+. - - Install the snapshot controller and snapshot v1 CRD as required. More info can be found [here](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.0.1#usage). -!!! note - If only Alpha snapshots are available, enable snapshotter in `rook-ceph-operator-config` or helm chart `values.yaml`, change the external-snapshotter image to `registry.k8s.io/sig-storage/csi-snapshotter:v1.2.2` and refer to the [alpha snapshots documentation](https://github.com/rook/rook/blob/release-1.3/Documentation/ceph-csi-drivers.md#rbd-snapshots) - - VolumeSnapshot betav1 is deprecated in Kubernetes 1.20+ and removed in 1.24.0. If you still require betav1 snapshots, change the external-snapshotter image to `registry.k8s.io/sig-storage/csi-snapshotter:v5.0.1` and refer to the [betav1 snapshots documentation](https://rook.github.io/docs/rook/v1.8/ceph-csi-snapshot.html#rbd-snapshots) - - We also need a `VolumeSnapshotClass` for volume snapshot to work. The purpose of a `VolumeSnapshotClass` is defined in [the kubernetes documentation](https://kubernetes.io/docs/concepts/storage/volume-snapshot-classes/). diff --git a/Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-volume-clone.md b/Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-volume-clone.md index 9e2d4f325..23841070f 100644 --- a/Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-volume-clone.md +++ b/Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-volume-clone.md @@ -15,11 +15,6 @@ for more info. ## RBD Volume Cloning -### Volume Clone Prerequisites - - 1. Requires Kubernetes v1.16+ which supports volume clone. - 2. Ceph-csi diver v3.0.0+ which supports volume clone. - ### Volume Cloning In diff --git a/Documentation/Storage-Configuration/Monitoring/ceph-monitoring.md b/Documentation/Storage-Configuration/Monitoring/ceph-monitoring.md index eb5167b77..61adf8a2f 100644 --- a/Documentation/Storage-Configuration/Monitoring/ceph-monitoring.md +++ b/Documentation/Storage-Configuration/Monitoring/ceph-monitoring.md @@ -273,6 +273,10 @@ kubectl create -f csi-metrics-service-monitor.yaml This will create the service monitor to have prometheus monitor CSI +!!! note + Please note that the liveness sidecar is disabled by default. + To enable it set `CSI_ENABLE_LIVENESS` to `true` in the Rook operator settings (operator.yaml). + ### Collecting RBD per-image IO statistics RBD per-image IO statistics collection is disabled by default. This can be enabled by setting `enableRBDStats: true` in the CephBlockPool spec. From 5d51cdd76eca03db6dad2d8ec33d294370852198 Mon Sep 17 00:00:00 2001 From: Praveen M Date: Wed, 17 Apr 2024 20:13:06 +0530 Subject: [PATCH 2/2] doc: update snapshot version Signed-off-by: Praveen M (cherry picked from commit da8518095dae23af0dfc68fd3f54b085003f558f) --- .../Storage-Configuration/Ceph-CSI/ceph-csi-snapshot.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-snapshot.md b/Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-snapshot.md index 2b0475971..900e36a61 100644 --- a/Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-snapshot.md +++ b/Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-snapshot.md @@ -4,7 +4,7 @@ title: Snapshots ## Prerequisites -- Install the snapshot controller and snapshot v1 CRD as required. More info can be found [here](https://github.com/kubernetes-csi/external-snapshotter/tree/v6.0.1#usage). +- Install the [snapshot controller and snapshot v1 CRD](https://github.com/kubernetes-csi/external-snapshotter/tree/master#usage). - We also need a `VolumeSnapshotClass` for volume snapshot to work. The purpose of a `VolumeSnapshotClass` is defined in [the kubernetes @@ -17,10 +17,6 @@ In short, as the documentation describes it: VolumeSnapshotClass provides a way to describe the "classes" of storage when provisioning a volume snapshot. -## Upgrade Snapshot API - -If your Kubernetes version is updated to a newer version of the snapshot API, follow the upgrade guide [here](https://github.com/kubernetes-csi/external-snapshotter/tree/v4.0.0#upgrade) to upgrade from v1alpha1 to v1beta1, or v1beta1 to v1. - ## RBD Snapshots ### VolumeSnapshotClass