update: Better explain YAML files for the Storage labs (#1545)

athavr · Raj Athavale · web-flow · commit 97f6a2127fef · 2025-07-27T07:47:30.000-06:00
Co-authored-by: Raj Athavale &lt;athavr@amazon.com&gt;
diff --git a/website/docs/fundamentals/storage/efs/deployment-with-efs.md b/website/docs/fundamentals/storage/efs/deployment-with-efs.md
@@ -5,11 +5,13 @@ sidebar_position: 30
 
 Now that we understand the EFS storage class for Kubernetes, let's create a [Persistent Volume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) and modify the UI component to mount this volume.
 
-First, let's examine the `efspvclaim.yaml` file which defines a PersistentVolumeClaim requesting 5GB of storage from the `efs-sc` storage class we created earlier:
+First, let's examine the `efspvclaim.yaml` file:
 
-```file
-manifests/modules/fundamentals/storage/efs/deployment/efspvclaim.yaml
-```
+::yaml{file="manifests/modules/fundamentals/storage/efs/deployment/efspvclaim.yaml" paths="kind,spec.storageClassName,spec.resources.requests.storage"}
+
+1. The resource being defined is a PersistentVolumeClaim
+2. This refers to the `efs-sc` storage class we created earlier
+3. We are requesting 5GB of storage 
 
 Now we'll update the UI component to reference the EFS PVC:
 
diff --git a/website/docs/fundamentals/storage/efs/efs-csi-driver.md b/website/docs/fundamentals/storage/efs/efs-csi-driver.md
@@ -42,13 +42,13 @@ $ echo $EFS_ID
 fs-061cb5c5ed841a6b0
 ```
 
-Next, we'll create a [StorageClass](https://kubernetes.io/docs/concepts/storage/storage-classes/) object configured to use our pre-provisioned EFS file system and [EFS Access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in provisioning mode.
+Next, we'll create a [StorageClass](https://kubernetes.io/docs/concepts/storage/storage-classes/) object configured to use our pre-provisioned EFS file system and [EFS Access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in provisioning mode using the `efsstorageclass.yaml` file.
 
-Using Kustomize, we'll create the storage class and inject the `EFS_ID` environment variable into the `filesystemid` parameter:
+::yaml{file="manifests/modules/fundamentals/storage/efs/storageclass/efsstorageclass.yaml" paths="provisioner,parameters.fileSystemId"}
+
+1. Set the `provisioner` parameter to `efs.csi.aws.com` for the EFS CSI provisioner
+2. Inject `EFS_ID` environment variable into the `filesystemid` parameter
 
-```file
-manifests/modules/fundamentals/storage/efs/storageclass/efsstorageclass.yaml
-```
 
 Apply the kustomization:
 
diff --git a/website/docs/fundamentals/storage/fsx-for-netapp-ontap/deployment-with-fsxn.md b/website/docs/fundamentals/storage/fsx-for-netapp-ontap/deployment-with-fsxn.md
@@ -5,11 +5,15 @@ sidebar_position: 30
 
 Now that we understand the FSx for NetApp ONTAP storage class for Kubernetes, let's create a [Persistent Volume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) and modify the UI component to mount this volume.
 
-First, let's examine the `fsxnpvclaim.yaml` file which defines a PersistentVolumeClaim requesting 5GB of storage from the `fsxn-sc-nfs` storage class we created earlier:
 
-```file
-manifests/modules/fundamentals/storage/fsxn/deployment/fsxnpvclaim.yaml
-```
+First, let's examine the `fsxnpvclaim.yaml` file:
+
+::yaml{file="manifests/modules/fundamentals/storage/fsxn/deployment/fsxnpvclaim.yaml" paths="kind,spec.storageClassName,spec.resources.requests.storage"}
+
+1. The resource being defined is a PersistentVolumeClaim
+2. This refers to the `fsxn-sc-nfs` storage class we created earlier
+3. We are requesting 5GB of storage 
+
 
 Now we'll update the UI component to reference the FSx for NetApp ONTAP PVC:
 
diff --git a/website/docs/fundamentals/storage/fsx-for-netapp-ontap/fsxn-csi-driver.md b/website/docs/fundamentals/storage/fsx-for-netapp-ontap/fsxn-csi-driver.md
@@ -46,14 +46,13 @@ The FSx for NetApp ONTAP CSI driver supports both dynamic and static provisionin
 - **Dynamic provisioning**: The driver creates volumes on the existing FSx for NetApp ONTAP file system. This requires an existing AWS FSx for NetApp ONTAP file system that must be specified in the StorageClass parameters.
 - **Static provisioning**: This also requires a pre-created AWS FSx for NetApp ONTAP file system, which can then be mounted as a volume inside a container using the driver.
 
-Next, we'll create a TridentBackendConfig object configured to use the pre-provisioned FSx for NetApp ONTAP file system. We'll be using Kustomize to create the backend and inject the following environment variables:
+Next, we'll create a TridentBackendConfig object configured to use the pre-provisioned FSx for NetApp ONTAP file system. For this, lets examine the `fsxn-backend-nas.yaml` file we'll be using to create the backend:
 
-- `FSXN_ID` in the parameter `fsxFilesystemID` - This is the FSxN filesystem we're going to connect our CSI driver to.
-- `FSXN_SECRET_ARN` in the parameter `credentials.name` - This is the secret ARN with the credentials to connect to the ONTAP API interface.
+::yaml{file="manifests/modules/fundamentals/storage/fsxn/backend/fsxn-backend-nas.yaml" paths="spec.svm,spec.aws.fsxFilesystemID,spec.credentials.name"}
 
-```file
-manifests/modules/fundamentals/storage/fsxn/backend/fsxn-backend-nas.yaml
-```
+1. Inject `EKS_CLUSTER_NAME` environment variable into the `svm` parameter - This is the Storage Virtual Machine name
+2. Inject `FSXN_ID` environment variable into the `fsxFilesystemID` parameter - This is the FSxN filesystem we're going to connect our CSI driver to
+3. Inject `FSXN_SECRET_ARN` environment variable into the `credentials.name` parameter - This is the ARN of a secret stored securely in AWS Secrets Manager, which contains the credentials to connect to the ONTAP API interface
 
 Apply the backend configuration:
 
@@ -71,11 +70,12 @@ NAME                    BACKEND NAME    BACKEND UUID                           P
 backend-tbc-ontap-nas   tbc-ontap-nas   bbae8686-25e4-4fca-a4c7-7ab664c7db9c   Bound   Success
 ```
 
-Now let's create the [StorageClass](https://kubernetes.io/docs/concepts/storage/storage-classes/) object:
+Now let's create the [StorageClass](https://kubernetes.io/docs/concepts/storage/storage-classes/) object using the `fsxnstorageclass.yaml` file:
 
-```file
-manifests/modules/fundamentals/storage/fsxn/storageclass/fsxnstorageclass.yaml
-```
+::yaml{file="manifests/modules/fundamentals/storage/fsxn/storageclass/fsxnstorageclass.yaml" paths="provisioner,parameters.backendType"}
+
+1. Set the `provisioner` parameter to `csi.trident.netapp.io` for the Amazon FSx for NetApp ONTAP CSI provisioner
+2. Set the `backendType` to `ontap-nas` to indicate that the ONTAP NAS driver should be used for accessing the ONTAP volume
 
 Apply the StorageClass:
 
diff --git a/website/docs/fundamentals/storage/fsx-for-openzfs/deployment-with-fsxz.md b/website/docs/fundamentals/storage/fsx-for-openzfs/deployment-with-fsxz.md
@@ -5,11 +5,13 @@ sidebar_position: 30
 
 Now that we understand the FSx for OpenZFS storage class for Kubernetes, let's create a [Persistent Volume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) and modify the UI component to mount this volume.
 
-First, let's examine the `fsxzpvcclaim.yaml` file which defines a PersistentVolumeClaim requesting 5GB of storage from the `fsxz-vol-sc` storage class we created earlier:
+First, let's examine the `fsxzpvcclaim.yaml` file:
 
-```file
-manifests/modules/fundamentals/storage/fsxz/deployment/fsxzpvcclaim.yaml
-```
+::yaml{file="manifests/modules/fundamentals/storage/fsxz/deployment/fsxzpvcclaim.yaml" paths="kind,spec.storageClassName,spec.resources.requests.storage"}
+
+1. The resource being defined is a PersistentVolumeClaim
+2. This refers to the `fsxz-vol-sc` storage class we created earlier
+3. We are requesting 1GB of storage 
 
 Now we'll update the UI component to reference the FSx for OpenZFS PVC:
 
@@ -47,7 +49,7 @@ A PersistentVolume (PV) has been automatically created to fulfill our Persistent
 ```bash
 $ kubectl get pv
 NAME                                       CAPACITY   ACCESS MODES   RECLAIM POLICY   STATUS   CLAIM                                 STORAGECLASS   REASON   AGE
-pvc-342a674d-b426-4214-b8b6-7847975ae121   5Gi        RWX            Delete           Bound    ui/fsxz-claim                      fsxz-vol-sc                  2m33s
+pvc-342a674d-b426-4214-b8b6-7847975ae121   1Gi        RWX            Delete           Bound    ui/fsxz-claim                      fsxz-vol-sc                  2m33s
 ```
 
 Let's examine the details of our PersistentVolumeClaim (PVC):
diff --git a/website/docs/fundamentals/storage/fsx-for-openzfs/fsxz-csi-driver.md b/website/docs/fundamentals/storage/fsx-for-openzfs/fsxz-csi-driver.md
@@ -63,11 +63,13 @@ fsvol-0123456789abcdef0
 
 Next, we'll create a [StorageClass](https://kubernetes.io/docs/concepts/storage/storage-classes/) object configured to use our pre-provisioned FSx for OpenZFS file system and create child volumes in provisioning mode.
 
-Using Kustomize, we'll create the storage class and inject the `ROOT_VOL_ID`, `VPC_CIDR`, and `EKS_CLUSTER_NAME` environment variables into the `ParentVolumeId`, `NfsExports`, and `Name` parameters respectively:
+For this, let's examine the `fsxzstorageclass.yaml` file:
 
-```file
-manifests/modules/fundamentals/storage/fsxz/storageclass/fsxzstorageclass.yaml
-```
+::yaml{file="manifests/modules/fundamentals/storage/fsxz/storageclass/fsxzstorageclass.yaml" paths="provisioner,parameters.ParentVolumeId, parameters.NfsExports"}
+
+1. Set the `provisioner` parameter to `fsx.openzfs.csi.aws.com` for the FSx for OpenZFS CSI provisioner
+2. Assign the `ROOT_VOL_ID` environment variable to the `ParentVolumeId` parameter
+3. Inject the `VPC_CIDR` environment variable into the `NfsExports` parameter
 
 Apply the kustomization:
 
