Merge pull request #62717 from amolnar-rh/OCPBUGS-13354

/lgtm, merging

Author: JoeAldinger

modules/agent-install-ipi-install-root-device-hints.adoc

@@ -13,7 +13,7 @@ The `rootDeviceHints` parameter enables the installer to provision the {op-syste
 |===
 | Subfield | Description
 
-| `deviceName` | A string containing a Linux device name like `/dev/vda`. The hint must match the actual value exactly.
+| `deviceName` | A string containing a Linux device name such as `/dev/vda` or `/dev/disk/by-path/`. It is recommended to use the `/dev/disk/by-path/<device_path>` link to the storage location. The hint must match the actual value exactly.
 
 | `hctl` | A string containing a SCSI bus address like `0:0:0:0`. The hint must match the actual value exactly.
 

modules/ipi-install-root-device-hints.adoc

@@ -13,7 +13,7 @@ The `rootDeviceHints` parameter enables the installer to provision the {op-syste
 |===
 | Subfield | Description
 
-| `deviceName` | A string containing a Linux device name like `/dev/vda`. The hint must match the actual value exactly.
+| `deviceName` | A string containing a Linux device name such as `/dev/vda` or `/dev/disk/by-path/`. It is recommended to use the `/dev/disk/by-path/<device_path>` link to the storage location. The hint must match the actual value exactly.
 
 | `hctl` | A string containing a SCSI bus address like `0:0:0:0`. The hint must match the actual value exactly.
 

scalability_and_performance/ztp_far_edge/ztp-deploying-far-edge-sites.adoc

@@ -38,6 +38,8 @@ include::modules/ztp-deploying-a-site.adoc[leveloffset=+1]
 
 * xref:../../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#bmc-addressing_ipi-install-installation-workflow[BMC addressing]
 
+* xref:../../installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc#root-device-hints_preparing-to-install-with-agent-based-installer[About root device hints]
+
 include::modules/ztp-monitoring-installation-progress.adoc[leveloffset=+1]
 
 include::modules/ztp-troubleshooting-ztp-gitops-installation-crs.adoc[leveloffset=+1]

scalability_and_performance/ztp_far_edge/ztp-manual-install.adoc

@@ -27,6 +27,8 @@ include::modules/ztp-generating-install-and-config-crs-manually.adoc[leveloffset
 
 * xref:../../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#bmc-addressing_ipi-install-installation-workflow[BMC addressing]
 
+* xref:../../installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc#root-device-hints_preparing-to-install-with-agent-based-installer[About root device hints]
+
 include::modules/ztp-creating-the-site-secrets.adoc[leveloffset=+1]
 
 include::modules/ztp-configuring-kernel-arguments-for-discovery-iso-in-manual-installations.adoc[leveloffset=+1]

snippets/ztp-example-siteconfig.adoc

@@ -39,10 +39,10 @@ spec:
           name: "bmh-secret" <8>
         bootMACAddress: "AA:BB:CC:DD:EE:11"
         bootMode: "UEFI" <9>
-        rootDeviceHints:
+        rootDeviceHints: <10>
           wwn: "0x11111000000asd123"
-        cpuset: "0-1,52-53"  <10>
-        nodeNetwork: <11>
+        cpuset: "0-1,52-53"  <11>
+        nodeNetwork: <12>
           interfaces:
             - name: eno1
               macAddress: "AA:BB:CC:DD:EE:11"
@@ -53,7 +53,7 @@ spec:
                 state: up
                 ipv4:
                   enabled: false
-                ipv6: <12>
+                ipv6: <13>
                   enabled: true
                   address:
                   - ip: 1111:2222:3333:4444::aaaa:1
@@ -77,9 +77,10 @@ spec:
 <4> Cluster labels must correspond to the `bindingRules` field in the `PolicyGenTemplate` CRs that you define. For example, `policygentemplates/common-ranGen.yaml` applies to all clusters with `common: true` set, `policygentemplates/group-du-sno-ranGen.yaml` applies to all clusters with `group-du-sno: ""` set.
 <5> Optional. The CR specifed under `KlusterletAddonConfig` is used to override the default `KlusterletAddonConfig` that is created for the cluster.
 <6> For single-node deployments, define a single host. For three-node deployments, define three hosts. For standard deployments, define three hosts with `role: master` and two or more hosts defined with `role: worker`.
-<7> BMC address that you use to access the host. Applies to all cluster types. {ztp} supports iPXE and virtual media booting by using Redfish or IPMI protocols. To use iPXE booting, you must use {rh-rhacm} 2.8 or later. For more information about BMC addressing, see the _Additional resources_ section. 
+<7> BMC address that you use to access the host. Applies to all cluster types. {ztp} supports iPXE and virtual media booting by using Redfish or IPMI protocols. To use iPXE booting, you must use {rh-rhacm} 2.8 or later. For more information about BMC addressing, see the _Additional resources_ section.
 <8> Name of the `bmh-secret` CR that you separately create with the host BMC credentials. When creating the `bmh-secret` CR, use the same namespace as the `SiteConfig` CR that provisions the host.
 <9> Configures the boot mode for the host. The default value is `UEFI`. Use `UEFISecureBoot` to enable secure boot on the host.
-<10> `cpuset` must match the value set in the cluster `PerformanceProfile` CR `spec.cpu.reserved` field for workload partitioning.
-<11> Specifies the network settings for the node.
-<12> Configures the IPv6 address for the host. For {sno} clusters with static IP addresses, the node-specific API and Ingress IPs should be the same.
+<10> Specifies the device for deployment. Identifiers that are stable across reboots are recommended, for example `wwn: <disk_wwn>` or `deviceName: /dev/disk/by-path/<device_path>`. For a detailed list of stable identifiers, see the _About root device hints_ section.
+<11> `cpuset` must match the value set in the cluster `PerformanceProfile` CR `spec.cpu.reserved` field for workload partitioning.
+<12> Specifies the network settings for the node.
+<13> Configures the IPv6 address for the host. For {sno} clusters with static IP addresses, the node-specific API and Ingress IPs should be the same.