Skip to content

Commit

Permalink
Add instructions to enable API group to VolumeAttributesClass
Browse files Browse the repository at this point in the history
  • Loading branch information
AndrewSirenko committed Jul 29, 2024
1 parent c827617 commit 4437318
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions content/en/docs/concepts/storage/volume-attributes-classes.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ weight: 40
{{< feature-state feature_gate_name="VolumeAttributesClass" >}}

This page assumes that you are familiar with [StorageClasses](/docs/concepts/storage/storage-classes/),
[Volumes](/docs/concepts/storage/volumes/) and [PersistentVolumes](/docs/concepts/storage/persistent-volumes/)
[volumes](/docs/concepts/storage/volumes/) and [PersistentVolumes](/docs/concepts/storage/persistent-volumes/)
in Kubernetes.

<!-- body -->
Expand All @@ -29,6 +29,12 @@ If you want to test the feature whilst it's beta, you need to enable the `Volume
--feature-gates="...,VolumeAttributesClass=true"
```

You will also have to enable the `storage.k8s.io/v1beta1` API group through the `kube-apiserver` [runtime-config](https://kubernetes.io/docs/tasks/administer-cluster/enable-disable-api/). You use the following command line argument:

```
--runtime-config=storage.k8s.io/v1beta1=true
```

You can also only use VolumeAttributesClasses with storage backed by
{{< glossary_tooltip text="Container Storage Interface" term_id="csi" >}}, and only where the
relevant CSI driver implements the `ModifyVolume` API.
Expand Down Expand Up @@ -128,4 +134,4 @@ the parameters may be used depends on the CSI driver implementation.
Please refer to the related CSI driver documentation for more details.

There can be at most 512 parameters defined for a VolumeAttributesClass.
The total length of the parameters object including its keys and values cannot exceed 256 KiB.
The total length of the parameters object including its keys and values cannot exceed 256 KiB.

0 comments on commit 4437318

Please sign in to comment.