Merge pull request #93040 from mletalie/OSDOCS-14568

[OSDOCS-14568]Add reference to C3 and N4 instance types in OSD docs

Author: bmcelvee

modules/persistent-storage-csi-gcp-hyperdisk-limitations.adoc

@@ -11,15 +11,15 @@ The GCP PD CSI driver support for the C3 instance type for bare metal and N4 mac
 
 * For cloning or resizing, hyperdisk-balanced disks original volume size must be 6Gi or greater.
 
-* The default storage class is standard-csi. 
+* The default storage class is standard-csi.
 +
 [IMPORTANT]
 ====
 You need to manually create a storage class.
 
 For information about creating the storage class, see Step 2 in Section _Setting up hyperdisk-balanced disks_.
 ====
-
+ifndef::openshift-dedicated[]
 * Clusters with mixed virtual machines (VMs) that use different storage types, for example, N2 and N4, are not supported. This is due to hyperdisks-balanced disks not being usable on most legacy VMs. Similarly, regular persistent disks are not usable on N4/C3 VMs.
-
+endif::openshift-dedicated[]
 * A GCP cluster with c3-standard-2, c3-standard-4, n4-standard-2, and n4-standard-4 nodes can erroneously exceed the maximum attachable disk number, which should be 16 (link:https://issues.redhat.com/browse/OCPBUGS-39258[JIRA link]).

modules/persistent-storage-csi-gcp-hyperdisk-storage-pools-procedure.adoc

@@ -10,10 +10,45 @@
 * Access to the cluster with administrative privileges
 
 .Procedure
-To set up hyperdisk-balanced disks:
+Complete the following steps to set up hyperdisk-balanced disks:
+
+ifdef::openshift-dedicated[]
+. Create an {product-title} cluster on {GCP} with attached disks provisioned with hyperdisk-balanced disks. This can be achieved by provisioning the cluster with compute node types that support hyperdisk-balanced disks, such as the C3 and N4 machine series from {GCP}.
+. Once the OSD cluster is ready, navigate to the **OpenShift console** for Storage Class creation.
+Within the console, navigate to the **Storage** section to create a Storage Class specifying the hyperdisk-balanced disk:
++
+.Example StorageClass YAML file
+[source, yaml]
+----
+kind: StorageClass
+apiVersion: storage.k8s.io/v1
+metadata:
+ name: hyperdisk-sc <1>
+ annotations:
+   storageclass.kubernetes.io/is-default-class: 'true'
+provisioner: pd.csi.storage.gke.io <2>
+parameters:
+ replication-type: none
+ storage-pools: projects/myproject/zones/us-east1-c/storagePools/hyperdisk-storagepool <3>
+ type: hyperdisk-balanced <4>
+reclaimPolicy: Delete
+allowVolumeExpansion: true
+volumeBindingMode: Immediate
+----
+<1> Specify the name for your storage class. In this example, the name is `hyperdisk-sc`.
+<2> Specify the GCP CSI provisioner as `pd.csi.storage.gke.io`.
+<3> If using storage pools, specify a list of specific storage pools that you want to use in the following format: `projects/PROJECT_ID/zones/ZONE/storagePools/STORAGE_POOL_NAME`.
+<4> Specify the disk type as `hyperdisk-balanced`.
++
+[NOTE]
+====
+If you use storage pools, you must first create a Hyperdisk Storage Pool of the type "Hyperdisk Balanced" in the Google Cloud console prior to referencing it in the OpenShift Storage Class. The Hyperdisk Storage Pool must be created in the same zone as the compute node supporting Hyperdisk is installed in the cluster configuration. For more information about creating a Hyperdisk Storage Pool, see link:https://cloud.google.com/compute/docs/disks/create-storage-pools#create-pool[Create a Hyperdisk Storage Pool] in the Google Cloud documentation.
+====
+
+endif::openshift-dedicated[]
 
 ifndef::openshift-dedicated[]
-. Create GCP cluster with attached disks provisioned with hyperdisk-balanced disks.
+. Create a GCP cluster with attached disks provisioned with hyperdisk-balanced disks.
 endif::openshift-dedicated[]
 
 ifndef::openshift-dedicated[]
@@ -22,7 +57,7 @@ endif::openshift-dedicated[]
 
 ifndef::openshift-dedicated[]
 .. Follow the procedure in the _Installing a cluster on GCP with customizations_ section.
-+ 
++
 For your install-config.yaml file, use the following example file:
 +
 .Example install-config YAML file
@@ -74,6 +109,7 @@ ifndef::openshift-dedicated[]
 * cluster_csi_driver.yaml - specifies opting out of the default storage class creation
 * storageclass.yaml - creates a hyperdisk-specific storage class
 +
+--
 .Example cluster CSI driver YAML file
 [source, yaml]
 ----
@@ -88,7 +124,9 @@ spec:
   storageClassState: Unmanaged <1>
 ----
 <1> Specifies disabling creation of the default {product-title} storage classes.
+--
 +
+--
 .Example storage class YAML file
 [source, yaml]
 ----
@@ -121,7 +159,8 @@ allowedTopologies: <7>
 <4> Specifies the throughput value in MiBps using the "Mi" qualifier. For example, if your required throughput is 250 MiBps, specify "250Mi". If you do not specify a value, the capacity is based upon the disk type default.
 <5> Specifies the IOPS value without any qualifiers. For example, if you require 7,000 IOPS, specify "7000". If you do not specify a value, the capacity is based upon the disk type default.
 <6> If using storage pools, specify a list of specific storage pools that you want to use in the format: projects/PROJECT_ID/zones/ZONE/storagePools/STORAGE_POOL_NAME.
-<7> If using storage pools, set `allowedTopologies` to restrict the topology of provisioned volumes to where the storage pool exists. In this example, `us-east4-c`. 
+<7> If using storage pools, set `allowedTopologies` to restrict the topology of provisioned volumes to where the storage pool exists. In this example, `us-east4-c`.
+--
 endif::openshift-dedicated[]
 
 . Create a persistent volume claim (PVC) that uses the hyperdisk-specific storage class using the following example YAML file:
@@ -245,5 +284,4 @@ $ gcloud compute storage-pools list-disks pool-us-east4-c --zone=us-east4-c
 ----
 NAME                                      STATUS  PROVISIONED_IOPS  PROVISIONED_THROUGHPUT  SIZE_GB
 pvc-1ff52479-4c81-4481-aa1d-b21c8f8860c6  READY   3000              140                     2048
-----
-
+----

storage/container_storage_interface/persistent-storage-csi-gcp-pd.adoc

@@ -2,6 +2,7 @@
 [id="persistent-storage-csi-gcp-pd"]
 = GCP PD CSI Driver Operator
 include::_attributes/common-attributes.adoc[]
+include::_attributes/attributes-openshift-dedicated.adoc[]
 :context: persistent-storage-csi-gcp-pd
 
 toc::[]
@@ -19,15 +20,15 @@ To create CSI-provisioned persistent volumes (PVs) that mount to GCP PD storage
 * *GCP PD CSI Driver Operator*: By default, the Operator provides a storage class that you can use to create PVCs. You can disable this default storage class if desired (see xref:../../storage/container_storage_interface/persistent-storage-csi-sc-manage.adoc#persistent-storage-csi-sc-manage[Managing the default storage class]). You also have the option to create the GCP PD storage class as described in xref:../../storage/persistent_storage/persistent-storage-gce.adoc#persistent-storage-using-gce[Persistent storage using GCE Persistent Disk].
 
 * *GCP PD driver*: The driver enables you to create and mount GCP PD PVs.
-ifndef::openshift-dedicated[]
+//
 +
 GCP PD CSI driver supports the C3 instance type for bare metal and N4 machine series. The C3 instance type and N4 machine series support the hyperdisk-balanced disks.
-
+ifndef::openshift-dedicated[]
 [NOTE]
 ====
 {product-title} provides automatic migration for the GCE Persistent Disk in-tree volume plugin to its equivalent CSI driver. For more information, see xref:../../storage/container_storage_interface/persistent-storage-csi-migration.adoc#persistent-storage-csi-migration[CSI automatic migration].
 ====
-
+endif::openshift-dedicated[]
 
 [id="c3-instance-type-for-bare-metal-and-n4-machine-series"]
 == C3 instance type for bare metal and N4 machine series
@@ -39,7 +40,7 @@ include::modules/persistent-storage-csi-gcp-hyperdisk-storage-pools-overview.ado
 To set up storage pools, see xref:../../storage/container_storage_interface/persistent-storage-csi-gcp-pd.adoc#persistent-storage-csi-gcp-hyperdisk-storage-pools-procedure_persistent-storage-csi-gcp-pd[Setting up hyperdisk-balanced disks].
 
 include::modules/persistent-storage-csi-gcp-hyperdisk-storage-pools-procedure.adoc[leveloffset=+2]
-endif::openshift-dedicated[]
+
 ifndef::openshift-dedicated[]
 [id="resources-for-gcp-c3-n4-instances"]
 [role="_additional-resources"]