Merge pull request #76524 from dfitzmau/OSDOCS-7075-nutanix

OSDOCS-7075-nutanix: Added user-managed LB to Nutanix docs

Author: skopacz1

installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc

@@ -6,10 +6,13 @@ include::_attributes/common-attributes.adoc[]
 
 toc::[]
 
+// Installing {op-system-base} on the provisioner node
 include::modules/ipi-install-installing-rhel-on-the-provisioner-node.adoc[leveloffset=+1]
 
+// Preparing the provisioner node for {product-title} installation
 include::modules/ipi-install-preparing-the-provisioner-node-for-openshift-install.adoc[leveloffset=+1]
 
+// Checking NTP server synchronization
 include::modules/ipi-install-checking-ntp-sync.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
@@ -19,15 +22,19 @@ include::modules/ipi-install-checking-ntp-sync.adoc[leveloffset=+1]
 
 * xref:../../installing/installing_bare_metal_ipi/ipi-install-prerequisites.adoc#network-requirements-ntp_ipi-install-prerequisites[Network Time Protocol (NTP)]
 
+// Configuring networking
 include::modules/ipi-install-configuring-networking.adoc[leveloffset=+1]
 
 // Establishing communication between subnets
 include::modules/ipi-install-establishing-communication-between-subnets.adoc[leveloffset=+1]
 
+// Retrieving the {product-title} installer
 include::modules/ipi-install-retrieving-the-openshift-installer.adoc[leveloffset=+1]
 
+// Extracting the {product-title} installer
 include::modules/ipi-install-extracting-the-openshift-installer.adoc[leveloffset=+1]
 
+// Optional: Creating an {op-system} images cache
 include::modules/ipi-install-creating-an-rhcos-images-cache.adoc[leveloffset=+1]
 
 // Services for a user-managed load balancer
@@ -36,60 +43,82 @@ include::modules/nw-osp-services-external-load-balancer.adoc[leveloffset=+1]
 // Configuring a user-managed load balancer
 include::modules/nw-osp-configuring-external-load-balancer.adoc[leveloffset=+2]
 
+// Setting the cluster node hostnames through DHCP
 include::modules/ipi-install-setting-cluster-node-hostnames-dhcp.adoc[leveloffset=+1]
 
 [id="ipi-install-configuration-files"]
 [id="additional-resources_config"]
 == Configuring the install-config.yaml file
 
+// Configuring the install-config.yaml file
 include::modules/ipi-install-configuring-the-install-config-file.adoc[leveloffset=+2]
 
+// Additional `install-config` parameters
 include::modules/ipi-install-additional-install-config-parameters.adoc[leveloffset=+2]
 
+// BMC addressing
 include::modules/ipi-install-bmc-addressing.adoc[leveloffset=+2]
 
+// BMC addressing for Dell iDRAC
 include::modules/ipi-install-bmc-addressing-for-dell-idrac.adoc[leveloffset=+2]
 
+// BMC addressing for HPE iLO
 include::modules/ipi-install-bmc-addressing-for-hpe-ilo.adoc[leveloffset=+2]
 
+// BMC addressing for Fujitsu iRMC
 include::modules/ipi-install-bmc-addressing-for-fujitsu-irmc.adoc[leveloffset=+2]
 
+// Root device hints
 include::modules/ipi-install-root-device-hints.adoc[leveloffset=+2]
 
+// Optional: Setting proxy settings
 include::modules/ipi-install-setting-proxy-settings-within-install-config.adoc[leveloffset=+2]
 
+// Optional: Deploying with no provisioning network
 include::modules/ipi-install-modifying-install-config-for-no-provisioning-network.adoc[leveloffset=+2]
 
+// Optional: Deploying with dual-stack networking
 include::modules/ipi-install-modifying-install-config-for-dual-stack-network.adoc[leveloffset=+2]
 
+// Optional: Configuring host network interfaces
 include::modules/ipi-install-configuring-host-network-interfaces-in-the-install-config.yaml-file.adoc[leveloffset=+2]
 
+// Configuring host network interfaces for subnets
 include::modules/ipi-install-configuring-host-network-interfaces-for-subnets.adoc[leveloffset=+2]
 
+// Optional: Configuring address generation modes for SLAAC in dual-stack networks
 include::modules/ipi-install-modifying-install-config-for-slaac-dual-stack-network.adoc[leveloffset=+2]
 
+// Optional: Configuring host network interfaces for dual port NIC
 include::modules/ipi-install-configuring-host-dual-network-interfaces-in-the-install-config.yaml-file.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
 .Additional resources
 
 * link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/configuring_and_managing_networking/configuring-network-bonding_configuring-and-managing-networking[Configuring network bonding]
 
+// Configuring multiple cluster nodes
 include::modules/ipi-install-configure-multiple-cluster-nodes.adoc[leveloffset=+2]
 
+// Optional: Configuring managed Secure Boot
 include::modules/ipi-install-configuring-managed-secure-boot-in-the-install-config-file.adoc[leveloffset=+2]
 
 [id="ipi-install-manifest-configuration-files"]
 == Manifest configuration files
 
+// Creating the {product-title} manifests
 include::modules/ipi-install-creating-the-openshift-manifests.adoc[leveloffset=+2]
 
+// Optional: Configuring NTP for disconnected clusters
 include::modules/ipi-install-configuring-ntp-for-disconnected-clusters.adoc[leveloffset=+2]
 
+// Configuring network components to run on the control plane
 include::modules/ipi-install-configure-network-components-to-run-on-the-control-plane.adoc[leveloffset=+2]
 
+// Optional: Deploying routers on worker nodes
 include::modules/ipi-install-deploying-routers-on-worker-nodes.adoc[leveloffset=+2]
 
+// Optional: Configuring the BIOS
 include::modules/ipi-install-configuring-the-bios.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
@@ -98,8 +127,10 @@ include::modules/ipi-install-configuring-the-bios.adoc[leveloffset=+2]
 
 * xref:../../post_installation_configuration/bare-metal-configuration.adoc#post-install-bare-metal-configuration[Bare metal configuration]
 
+// Optional: Configuring the RAID
 include::modules/ipi-install-configuring-the-raid.adoc[leveloffset=+2]
 
+// Optional: Configuring storage on nodes
 include::modules/ipi-install-configuring-storage-on-nodes.adoc[leveloffset=+2]
 
 [role="_additional-resources"]
@@ -110,6 +141,7 @@ include::modules/ipi-install-configuring-storage-on-nodes.adoc[leveloffset=+2]
 
 * link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html-single/managing_storage_devices/index#partition-naming-scheme_disk-partitions[Partition naming scheme]
 
+// Creating a disconnected registry
 include::modules/ipi-install-creating-a-disconnected-registry.adoc[leveloffset=+1]
 
 [discrete]
@@ -118,20 +150,28 @@ include::modules/ipi-install-creating-a-disconnected-registry.adoc[leveloffset=+
 
 * If you have already prepared a mirror registry for xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#prerequisites_installing-mirroring-installation-images[Mirroring images for a disconnected installation], you can skip directly to xref:../../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#ipi-modify-install-config-for-a-disconnected-registry_ipi-install-installation-workflow[Modify the install-config.yaml file to use the disconnected registry].
 
+// Preparing the registry node to host the mirrored registry
 include::modules/ipi-install-preparing-a-disconnected-registry.adoc[leveloffset=+2]
 
+// Mirroring the {product-title} image repository for a disconnected registry
 include::modules/ipi-install-mirroring-for-disconnected-registry.adoc[leveloffset=+2]
 
+// Modify the install-config.yaml file to use the disconnected registry
 include::modules/ipi-modify-install-config-for-a-disconnected-registry.adoc[leveloffset=+2]
 
+// Validation checklist for installation
 include::modules/ipi-install-validation-checklist-for-installation.adoc[leveloffset=+1]
 
+// Deploying the cluster via the {product-title} installer
 include::modules/ipi-install-deploying-the-cluster-via-the-openshift-installer.adoc[leveloffset=+1]
 
+// Following the installation
 include::modules/ipi-install-following-the-installation.adoc[leveloffset=+1]
 
+// Verifying static IP address configuration
 include::modules/ipi-install-verifying-static-ip-address-configuration.adoc[leveloffset=+1]
 
+// Preparing to reinstall a cluster on bare metal
 include::modules/ipi-preparing-reinstall-cluster-bare-metal.adoc[leveloffset=+1]
 
 [role="_additional-resources"]

installing/installing_bare_metal_ipi/ipi-install-overview.adoc

@@ -21,7 +21,7 @@ In phase 2 of the deployment, the provisioner destroys the bootstrap VM automati
 
 The `keepalived.conf` file sets the control plane machines with a lower Virtual Router Redundancy Protocol (VRRP) priority than the bootstrap VM, which ensures that the API on the control plane machines is fully functional before the API VIP moves from the bootstrap VM to the control plane. Once the API VIP moves to one of the control plane nodes, traffic sent from external clients to the API VIP routes to an `haproxy` load balancer running on that control plane node. This instance of `haproxy` load balances the API VIP traffic across the control plane nodes.
 
-The Ingress VIP moves to the worker nodes. The `keepalived` instance also manages the Ingress VIP.
+The Ingress VIP moves to the compute nodes. The `keepalived` instance also manages the Ingress VIP.
 
 The following diagram illustrates phase 2 of deployment:
 

installing/installing_bare_metal_ipi/ipi-install-post-installation-configuration.adoc

@@ -12,8 +12,3 @@ include::modules/ipi-install-configuring-ntp-for-disconnected-clusters.adoc[leve
 
 include::modules/nw-enabling-a-provisioning-network-after-installation.adoc[leveloffset=+1]
 
-// Configuring a user-managed load balancer
-include::modules/nw-osp-services-external-load-balancer.adoc[leveloffset=+1]
-
-// Services for a user-managed load balancer
-include::modules/nw-osp-configuring-external-load-balancer.adoc[leveloffset=+2]

installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc

@@ -56,6 +56,13 @@ include::modules/manually-configure-iam-nutanix.adoc[leveloffset=+1]
 
 include::modules/installation-nutanix-ccm.adoc[leveloffset=+1]
 
+// Services for a user-managed load balancer
+include::modules/nw-osp-services-external-load-balancer.adoc[leveloffset=+1]
+
+// Configuring a user-managed load balancer
+include::modules/nw-osp-configuring-external-load-balancer.adoc[leveloffset=+2]
+
+// Deploying the cluster
 include::modules/installation-launching-installer.adoc[leveloffset=+1]
 
 include::modules/registry-configuring-storage-nutanix.adoc[leveloffset=+1]

modules/ipi-install-additional-install-config-parameters.adoc

@@ -38,7 +38,7 @@ and the `bmc` parameter for the `install-config.yaml` file.
 
 | `sshKey`
 |
-| The `sshKey` configuration setting contains the key in the `~/.ssh/id_rsa.pub` file required to access the control plane nodes and worker nodes. Typically, this key is from the `provisioner` node.
+| The `sshKey` configuration setting contains the key in the `~/.ssh/id_rsa.pub` file required to access the control plane nodes and compute nodes. Typically, this key is from the `provisioner` node.
 
 | `pullSecret`
 |
@@ -69,7 +69,7 @@ compute:
   - name: worker
 ----
 |
-|The {product-title} cluster requires a name be provided for worker (or compute) nodes even if there are zero nodes.
+|The {product-title} cluster requires a name be provided for compute nodes even if there are zero nodes.
 
 
 a|
@@ -78,7 +78,7 @@ compute:
     replicas: 2
 ----
 |
-|Replicas sets the number of worker (or compute) nodes in the {product-title} cluster.
+|Replicas sets the number of compute nodes in the {product-title} cluster.
 
 
 a|
@@ -87,7 +87,7 @@ controlPlane:
     name: master
 ----
 |
-|The {product-title} cluster requires a name for control plane (master) nodes.
+|The {product-title} cluster requires a name for control plane nodes.
 
 
 a|
@@ -96,7 +96,7 @@ controlPlane:
     replicas: 3
 ----
 |
-|Replicas sets the number of control plane (master) nodes included as part of the {product-title} cluster.
+|Replicas sets the number of control plane nodes included as part of the {product-title} cluster.
 
 a| `provisioningNetworkInterface` |  | The name of the network interface on nodes connected to the provisioning network. For {product-title} 4.9 and later releases, use the `bootMACAddress` configuration setting to enable Ironic to identify the IP address of the NIC instead of using the `provisioningNetworkInterface` configuration setting to identify the name of the NIC.
 
@@ -211,7 +211,7 @@ The `hosts` parameter is a list of separate bare metal assets used to build the
 
 | `role`
 |
-| The role of the bare metal node. Either `master` or `worker`.
+| The role of the bare metal node. Either `master` (control plane node) or `worker` (compute node).
 
 
 | `bmc`

modules/ipi-install-configure-network-components-to-run-on-the-control-plane.adoc

@@ -12,18 +12,18 @@ endif::[]
 [id='configure-network-components-to-run-on-the-control-plane_{context}']
 = Configuring network components to run on the control plane
 
-You can configure networking components to run exclusively on the control plane nodes. By default, {product-title} allows any node in the machine config pool to host the `ingressVIP` virtual IP address. However, some environments deploy worker nodes in separate subnets from the control plane nodes, which requires configuring the `ingressVIP` virtual IP address to run on the control plane nodes.
+You can configure networking components to run exclusively on the control plane nodes. By default, {product-title} allows any node in the machine config pool to host the `ingressVIP` virtual IP address. However, some environments deploy compute nodes in separate subnets from the control plane nodes, which requires configuring the `ingressVIP` virtual IP address to run on the control plane nodes.
 
 ifdef::vSphere[]
 [NOTE]
 ====
-You can scale the remote workers by creating a worker machineset in a separate subnet.
+You can scale the remote nodes by creating a compute machine set in a separate subnet.
 ====
 endif::vSphere[]
 
 [IMPORTANT]
 ====
-When deploying remote workers in separate subnets, you must place the `ingressVIP` virtual IP address exclusively with the control plane nodes.
+When deploying remote nodes in separate subnets, you must place the `ingressVIP` virtual IP address exclusively with the control plane nodes.
 ====
 
 ifdef::bare[]

modules/ipi-install-configuring-host-network-interfaces-for-subnets.adoc

@@ -33,7 +33,7 @@ networking:
   networkType: OVNKubernetes
 ----
 
-. Add the gateway and DNS configuration to the `networkConfig` parameter of each edge worker node using NMState syntax when using a static IP address or advanced networking such as bonds:
+. Add the gateway and DNS configuration to the `networkConfig` parameter of each edge compute node using NMState syntax when using a static IP address or advanced networking such as bonds:
 +
 [source,yaml]
 ----

modules/ipi-install-configuring-ntp-for-disconnected-clusters.adoc

@@ -12,15 +12,15 @@
 
 {product-title} installs the `chrony` Network Time Protocol (NTP) service on the cluster nodes.
 ifeval::["{context}" == "ipi-install-configuration-files"]
-Use the following procedure to configure NTP servers on the control plane nodes and configure worker nodes as NTP clients of the control plane nodes before deployment.
+Use the following procedure to configure NTP servers on the control plane nodes and configure compute nodes as NTP clients of the control plane nodes before deployment.
 endif::[]
 ifeval::["{context}" == "ipi-install-post-installation-configuration"]
-Use the following procedure to configure NTP servers on the control plane nodes and configure worker nodes as NTP clients of the control plane nodes after a successful deployment.
+Use the following procedure to configure NTP servers on the control plane nodes and configure compute nodes as NTP clients of the control plane nodes after a successful deployment.
 endif::[]
 
 image::152_OpenShift_Config_NTP_0421.png[Configuring NTP for disconnected clusters]
 
-{product-title} nodes must agree on a date and time to run properly. When worker nodes retrieve the date and time from the NTP servers on the control plane nodes, it enables the installation and operation of clusters that are not connected to a routable network and thereby do not have access to a higher stratum NTP server.
+{product-title} nodes must agree on a date and time to run properly. When compute nodes retrieve the date and time from the NTP servers on the control plane nodes, it enables the installation and operation of clusters that are not connected to a routable network and thereby do not have access to a higher stratum NTP server.
 
 .Procedure
 
@@ -69,7 +69,7 @@ storage:
           logdir /var/log/chrony
 
           # Configure the control plane nodes to serve as local NTP servers
-          # for all worker nodes, even if they are not in sync with an
+          # for all compute nodes, even if they are not in sync with an
           # upstream NTP server.
 
           # Allow NTP client access from the local network.
@@ -87,7 +87,7 @@ storage:
 $ butane 99-master-chrony-conf-override.bu -o 99-master-chrony-conf-override.yaml
 ----
 
-. Create a Butane config, `99-worker-chrony-conf-override.bu`, including the contents of the `chrony.conf` file for the worker nodes that references the NTP servers on the control plane nodes.
+. Create a Butane config, `99-worker-chrony-conf-override.bu`, including the contents of the `chrony.conf` file for the compute nodes that references the NTP servers on the control plane nodes.
 +
 [source,yaml,subs="attributes+"]
 .Butane config example
@@ -161,7 +161,7 @@ $ oc apply -f 99-master-chrony-conf-override.yaml
 machineconfig.machineconfiguration.openshift.io/99-master-chrony-conf-override created
 ----
 
-. Apply the `99-worker-chrony-conf-override.yaml` policy to the worker nodes.
+. Apply the `99-worker-chrony-conf-override.yaml` policy to the compute nodes.
 +
 [source,terminal]
 ----

modules/ipi-install-configuring-the-install-config-file.adoc

@@ -93,7 +93,7 @@ sshKey: '<ssh_pub_key>'
 ----
 +
 --
-<1> Scale the worker machines based on the number of worker nodes that are part of the {product-title} cluster. Valid options for the `replicas` value are `0` and integers greater than or equal to `2`. Set the number of replicas to `0` to deploy a three-node cluster, which contains only three control plane machines. A three-node cluster is a smaller, more resource-efficient cluster that can be used for testing, development, and production. You cannot install the cluster with only one worker.
+<1> Scale the compute machines based on the number of compute nodes that are part of the {product-title} cluster. Valid options for the `replicas` value are `0` and integers greater than or equal to `2`. Set the number of replicas to `0` to deploy a three-node cluster, which contains only three control plane machines. A three-node cluster is a smaller, more resource-efficient cluster that can be used for testing, development, and production. You cannot install the cluster with only one compute node.
 <2> When deploying a cluster with static IP addresses, you must set the `bootstrapExternalStaticIP` configuration setting to specify the static IP address of the bootstrap VM when there is no DHCP server on the bare-metal network.
 <3> When deploying a cluster with static IP addresses, you must set the `bootstrapExternalStaticGateway` configuration setting to specify the gateway IP address for the bootstrap VM when there is no DHCP server on the bare-metal network.
 <4> When deploying a cluster with static IP addresses, you must set the `bootstrapExternalStaticDNS` configuration setting to specify the DNS address for the bootstrap VM when there is no DHCP server on the bare-metal network.