From 156f9edf3ccd33ab4709f034ed681a0c52476a1b Mon Sep 17 00:00:00 2001 From: geoffrey1330 Date: Wed, 2 Sep 2026 15:59:22 +0100 Subject: [PATCH] docs: remove compression, replicate and lvol_priority_class StorageClass parameters from documentation --- .../data-protection/asynchronous-replication.md | 5 ----- docs/kubernetes/usage/storage-class.md | 6 ------ docs/reference/kubernetes/index.md | 1 - docs/reference/operator/reference.md | 12 ------------ 4 files changed, 24 deletions(-) diff --git a/docs/kubernetes/operations/data-protection/asynchronous-replication.md b/docs/kubernetes/operations/data-protection/asynchronous-replication.md index 40b799dc..4f0d7c9c 100644 --- a/docs/kubernetes/operations/data-protection/asynchronous-replication.md +++ b/docs/kubernetes/operations/data-protection/asynchronous-replication.md @@ -148,11 +148,6 @@ The annotation is honored on a new PVC and on an already-bound one. A `Replicati is `Bound` and the named policy is ready, and it is named `-`. The slot is owned by its PVC, so deleting the PVC deletes the slot and stops replication for that volume. -!!! note - The `replicate` StorageClass parameter is unrelated to this mechanism. It is a backend volume property and does - not attach a volume to a `ReplicationPolicy`. See - [Storage Class: Available Parameters](../../usage/storage-class.md#available-parameters). - ### Changing or Removing the Policy Pointing the annotation at a different policy is carried out as a detach followed by a fresh attach, which means the diff --git a/docs/kubernetes/usage/storage-class.md b/docs/kubernetes/usage/storage-class.md index 134b6a96..cb0c3220 100644 --- a/docs/kubernetes/usage/storage-class.md +++ b/docs/kubernetes/usage/storage-class.md @@ -41,10 +41,7 @@ The CRD fields carry camel case names and are written to the StorageClass under | `qosRwMbytes` | `qos_rw_mbytes` | | `qosRMbytes` | `qos_r_mbytes` | | `qosWMbytes` | `qos_w_mbytes` | -| `compression` | `compression` | | `encryption` | `encryption` | -| `replicate` | `replicate` | -| `lvolPriorityClass` | `lvol_priority_class` | | `fabric` | `fabric` | | `maxNamespacePerSubsys` | `max_namespace_per_subsys` | | `tune2fsReservedBlocks` | `tune2fs_reserved_blocks` | @@ -123,10 +120,7 @@ hand-written StorageClass that omits the parameter leaves the choice to the cont | qos_rw_mbytes | int | Defines the maximum total throughput in megabytes reserved for a logical volume of this storage class. A zero (0) means no maximum. | true | 0 | | qos_r_mbytes | int | Defines the maximum read throughput in megabytes reserved for a logical volume of this storage class. A zero (0) means no maximum. | true | 0 | | qos_w_mbytes | int | Defines the maximum write throughput in megabytes reserved for a logical volume of this storage class. A zero (0) means no maximum. | true | 0 | -| compression | bool | Defines if the logical volume of this storage class will be stored compressed or not. | true | false | | encryption | bool | Defines if the logical volume of this storage class will be encrypted or not. | true | false | -| replicate | bool | Defines if the logical volume of this storage class will be replicated or not. | true | false | -| lvol_priority_class | int | Defines the priority class of a logical volume of this storage class. | true | 0 | | max_namespace_per_subsys | int | Defines the number of namespaces per NVMe subsystem. | true | 1 | | tune2fs_reserved_blocks | int | Reserved-blocks percentage applied through `tune2fs -m` when the volume is staged. Left unset, tune2fs is skipped entirely. | true | | | dhchap_node_label | string | Node label key carried by the allowed nodes of a DHCHAP pool, restricting volumes of this class to those nodes. Set by the operator from a `StoragePool`'s `dhchap` and `allowedNodes` fields. | true | | diff --git a/docs/reference/kubernetes/index.md b/docs/reference/kubernetes/index.md index f8668b9f..5500193d 100644 --- a/docs/reference/kubernetes/index.md +++ b/docs/reference/kubernetes/index.md @@ -29,7 +29,6 @@ Commonly configured CSI driver parameters: | `logicalVolume.qos_w_mbytes` | Sets the maximum write Mbps. Zero means unlimited. | `0` | | `logicalVolume.numDataChunks` | Sets the number of Erasure coding schema parameter k (distributed RAID). | `1` | | `logicalVolume.numParityChunks` | Sets the number of Erasure coding schema parameter n (distributed RAID). | `1` | -| `logicalVolume.lvol_priority_class` | Sets the logical volume priority class. | `0` | | `logicalVolume.fabric` | Sets the NVMe-oF transport type. | `tcp` | | `logicalVolume.tune2fs_reserved_blocks` | Sets the percentage of disk blocks reserved for system. | `0` | | `logicalVolume.max_namespace_per_subsys` | Sets the maximum namespace per subsystem. | `1` | diff --git a/docs/reference/operator/reference.md b/docs/reference/operator/reference.md index 07867591..3203c1d0 100644 --- a/docs/reference/operator/reference.md +++ b/docs/reference/operator/reference.md @@ -1707,10 +1707,7 @@ qosRwIops: string qosRwMbytes: string qosRMbytes: string qosWMbytes: string -compression: string encryption: boolean -replicate: boolean -lvolPriorityClass: string fabric: string maxNamespacePerSubsys: string tune2fsReservedBlocks: string @@ -1723,10 +1720,7 @@ filesystem: string | `qosRwMbytes` _string_ | QosRwMbytes sets the read/write throughput limit in MB/s (0 = unlimited). | 0 | | | `qosRMbytes` _string_ | QosRMbytes sets the read throughput limit in MB/s (0 = unlimited). | 0 | | | `qosWMbytes` _string_ | QosWMbytes sets the write throughput limit in MB/s (0 = unlimited). | 0 | | -| `compression` _string_ | Compression enables compression for logical volumes. | False | | | `encryption` _boolean_ | Encryption enables encryption for logical volumes. | false | | -| `replicate` _boolean_ | Replicate enables replication for logical volumes. | false | | -| `lvolPriorityClass` _string_ | LvolPriorityClass sets the logical volume priority class. | 0 | | | `fabric` _string_ | Fabric is the transport fabric (e.g. tcp). | tcp | | | `maxNamespacePerSubsys` _string_ | MaxNamespacePerSubsys limits namespaces per NVMf subsystem. | 1 | | | `tune2fsReservedBlocks` _string_ | Tune2fsReservedBlocks sets the ext4 reserved-blocks percentage. Left unset, the node
plugin skips tune2fs entirely and mkfs.ext4's own default reserve applies, matching a
StorageClass that omits tune2fs_reserved_blocks. A default of "0" here would not be a
no-op: it actively runs `tune2fs -m 0` on every volume, since the node plugin only skips
the call when the parameter is empty (see stageVolume in the CSI driver), not when it's
"0". | | | @@ -2968,10 +2962,7 @@ spec: qosRwMbytes: string qosRMbytes: string qosWMbytes: string - compression: string encryption: boolean - replicate: boolean - lvolPriorityClass: string fabric: string maxNamespacePerSubsys: string tune2fsReservedBlocks: string @@ -3140,10 +3131,7 @@ storageClassParameters: qosRwMbytes: string qosRMbytes: string qosWMbytes: string - compression: string encryption: boolean - replicate: boolean - lvolPriorityClass: string fabric: string maxNamespacePerSubsys: string tune2fsReservedBlocks: string