OSDOCS-12422#VolumeAttributesClass TP

Author: Lisa Pettyjohn

modules/storage-persistent-storage-pvc-volumeattributesclass.adoc

@@ -0,0 +1,67 @@
+// Module included in the following assemblies:
+//
+// * storage/understanding-persistent-storage.adoc
+//
+
+:_mod-docs-content-type: CONCEPT 
+[id="storage-persistent-storage-pvc-volumeattributesclass_{context}"]
+= Volume Attributes Classes
+
+Volume Attributes Classes provide a way for administrators to describe "classes" of storage they offer. Different classes might correspond to different quality-of-service levels.
+
+:FeatureName: Volume Attributes Classes
+include::snippets/technology-preview.adoc[leveloffset=+1]
+
+You can only use Volume Attributes Classes in {product-title} with AWS Elastic Block Storage (EBS) Container Storage Interface (CSI).
+
+You can apply a Volume Attributes Class to a persistent volume claim (PVC). If a new Volume Attributes Class becomes available in the cluster, a user can update the PVC with the new Volume Attributes Class if desired.
+
+Volume Attribute Classes have parameters that describe volumes belonging to them. Different parameters can be accepted depending on the provisioner or the resizer. If a parameter is omitted, the default is used at volume provisioning. If a user applies the PVC with a different Volume Attributes Class with omitted parameters, the default value of the parameters might be used depending on the CSI driver implementation. For more information, see the related CSI driver documentation .
+
+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.
+
+== Enabling Volume Attributes Classes 
+Volume Attributes Classes are not enabled by default.
+
+To enable Volume Attributes Classes, follow the procedure in xref:../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling-features[Enabling {product-title} features using FeatureGates].
+
+== Defining Volume Attributes Classes
+
+The following is an example Volume Attributes Class YAML file.
+
+.`VolumeAttributesClass` definition example
+[source,yaml]
+----
+apiVersion: storage.k8s.io/v1beta1
+kind: VolumeAttributesClass <1>
+metadata:
+  name: silver <2>
+driverName: pd.csi.storage.gke.io <3>
+parameters:
+  provisioned-iops: "3000"
+  provisioned-throughput: "50" 
+  ...
+----
+<1> Defines object as Volumes Attributes Classes
+<2> Name of the `VolumeAttributesClass`. In this example, it is "silver".
+<3> The provisioner that determines what volume plugin is used for provisioning persistent volumes (PVs). In this example, it is "pd.csi.storage.gke.io" for GCE Persistent Disk (gcePD).
+
+== Applying a Volume Attribute Class to a PVC
+
+To apply a Volume Attribute Class to a PVC:
+
+* Set the PVC's `volumeAttributesClassName` parameter to the Volume Attribute Class's name:
++
+.PVC definition example specifying a Volume Attribute Class 
++
+[source,yaml]
+----
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: test-pv-claim
+spec:
+  …
+  volumeAttributesClassName: silver <1>
+----
+<1> Specifies using the Volume Attribute Class "silver" for this PVC.

storage/understanding-persistent-storage.adoc

@@ -24,6 +24,8 @@ endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
 
 include::modules/storage-persistent-storage-pvc.adoc[leveloffset=+1]
 
+include::modules/storage-persistent-storage-pvc-volumeattributesclass.adoc[leveloffset=+2]
+
 include::modules/storage-persistent-storage-block-volume.adoc[leveloffset=+1]
 
 // As these volumes have transitioned to being tech preview per plugin,