Skip to content

Commit d6cb345

Browse files
committed
Update README
with topology support - it's GA now.
1 parent c031ee3 commit d6cb345

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ protocol](https://github.com/kubernetes/design-proposals-archive/blob/main/stora
139139
The [design document](./doc/design.md) explains this in more detail.
140140

141141
### Topology support
142-
When `Topology` feature is enabled and the driver specifies `VOLUME_ACCESSIBILITY_CONSTRAINTS` in its plugin capabilities, external-provisioner prepares `CreateVolumeRequest.AccessibilityRequirements` while calling `Controller.CreateVolume`. The driver has to consider these topology constraints while creating the volume. Below table shows how these `AccessibilityRequirements` are prepared:
142+
When `Topology` feature is enabled* and the driver specifies `VOLUME_ACCESSIBILITY_CONSTRAINTS` in its plugin capabilities, external-provisioner prepares `CreateVolumeRequest.AccessibilityRequirements` while calling `Controller.CreateVolume`. The driver has to consider these topology constraints while creating the volume. Below table shows how these `AccessibilityRequirements` are prepared:
143143

144144
[Delayed binding](https://kubernetes.io/docs/concepts/storage/storage-classes/#volume-binding-mode) | Strict topology | [Allowed topologies](https://kubernetes.io/docs/concepts/storage/storage-classes/#allowed-topologies) | Immediate Topology | [Resulting accessibility requirements](https://github.com/container-storage-interface/spec/blob/master/spec.md#createvolume)
145145
:---: |:---:|:---:|:---:|:---|
@@ -150,6 +150,11 @@ No | Irrelevant | Yes | Irrelevant | `Requisite` = Allowed topologies<br>`Prefer
150150
No | Irrelevant | No | Yes | `Requisite` = Aggregated cluster topology<br>`Preferred` = `Requisite` with randomly selected node topology as first element
151151
No | Irrelevant | No | No | `Requisite` and `Preferred` both nil
152152

153+
*) `Topology` feature gate is enabled by default since v5.0.
154+
<!-- TODO: remove the feature gate in the next release - remove the whole column in the table above. -->
155+
156+
When enabling topology support in a CSI driver that had it disabled, please make sure the topology is first enabled in the driver's node DaemonSet and topology labels are populated on all nodes. The topology can be then updated in the driver's Deployment and its external-provisioner sidecar.
157+
153158
### Capacity support
154159

155160
The external-provisioner can be used to create CSIStorageCapacity

0 commit comments

Comments
 (0)