Skip to content

docs: remove compression, replicate and lvol_priority_class StorageCl… #209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
noctarius merged 1 commit into from
Sep 2, 2026
Merged

docs: remove compression, replicate and lvol_priority_class StorageCl… #209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions docs/kubernetes/operations/data-protection/asynchronous-replication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<policy>-<pvc>`. 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
Expand Down
6 changes: 0 additions & 6 deletions docs/kubernetes/usage/storage-class.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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` |
Expand Down Expand Up @@ -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 | |
1 change: 0 additions & 1 deletion docs/reference/kubernetes/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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` |
Expand Down
12 changes: 0 additions & 12 deletions docs/reference/operator/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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<br />plugin skips tune2fs entirely and mkfs.ext4's own default reserve applies, matching a<br />StorageClass that omits tune2fs_reserved_blocks. A default of "0" here would not be a<br />no-op: it actively runs `tune2fs -m 0` on every volume, since the node plugin only skips<br />the call when the parameter is empty (see stageVolume in the CSI driver), not when it's<br />"0". | | |
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading