Merge pull request #14149 from rook/mergify/bp/release-1.14/pr-14083

csi: remove out-dated prerequisites (backport #14083)
2024-05-01 13:52:07 -06:00
commit a4b4e7d319
@@ -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.
@@ -4,14 +4,7 @@ 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)
+- 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
@@ -24,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
@@ -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
@@ -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.