OSDOCS-12711: Documented the balance-slb mode for networking docs

dfitzmau · dfitzmau · commit fbcef80224a8 · 2025-06-11T13:57:01.000+01:00
diff --git a/images/552_OpenShift_slb_mode_0525.png b/images/552_OpenShift_slb_mode_0525.png
diff --git a/installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc b/installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc
@@ -17,6 +17,9 @@ include::modules/nw-enabling-a-provisioning-network-after-installation.adoc[leve
 // Creating a manifest object that includes a customized `br-ex` bridge
 include::modules/creating-manifest-file-customized-br-ex-bridge.adoc[leveloffset=+1]
 
+// Enabling OVS balance-slb mode for your cluster
+include::modules/enabling-OVS-balance-slb-mode.adoc[leveloffset=+1]
+
 // Services for a user-managed load balancer
 include::modules/nw-osp-services-external-load-balancer.adoc[leveloffset=+1]
 
diff --git a/installing/installing_bare_metal/ipi/ipi-install-installation-workflow.adoc b/installing/installing_bare_metal/ipi/ipi-install-installation-workflow.adoc
@@ -28,6 +28,9 @@ include::modules/ipi-install-configuring-networking.adoc[leveloffset=+1]
 // Creating a manifest object that includes a customized `br-ex` bridge
 include::modules/creating-manifest-file-customized-br-ex-bridge.adoc[leveloffset=+1]
 
+// Enabling OVS balance-slb mode for your cluster
+include::modules/enabling-OVS-balance-slb-mode.adoc[leveloffset=+1]
+
 // Scale each machine set to compute nodes
 include::modules/creating-scaling-machine-sets-compute-nodes-networking.adoc[leveloffset=+2]
 
diff --git a/installing/installing_bare_metal/upi/installing-bare-metal-network-customizations.adoc b/installing/installing_bare_metal/upi/installing-bare-metal-network-customizations.adoc
@@ -69,6 +69,9 @@ include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]
 // Creating a manifest object that includes a customized `br-ex` bridge
 include::modules/creating-manifest-file-customized-br-ex-bridge.adoc[leveloffset=+1]
 
+// Enabling OVS balance-slb mode for your cluster
+include::modules/enabling-OVS-balance-slb-mode.adoc[leveloffset=+1]
+
 // Scale each machine set to compute nodes
 include::modules/creating-scaling-machine-sets-compute-nodes-networking.adoc[leveloffset=+2]
 
diff --git a/installing/installing_bare_metal/upi/installing-bare-metal.adoc b/installing/installing_bare_metal/upi/installing-bare-metal.adoc
@@ -90,6 +90,9 @@ include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]
 // Creating a manifest object that includes a customized `br-ex` bridge
 include::modules/creating-manifest-file-customized-br-ex-bridge.adoc[leveloffset=+1]
 
+// Enabling OVS balance-slb mode for your cluster
+include::modules/enabling-OVS-balance-slb-mode.adoc[leveloffset=+1]
+
 // Scale each machine set to compute nodes
 include::modules/creating-scaling-machine-sets-compute-nodes-networking.adoc[leveloffset=+2]
 
diff --git a/installing/installing_bare_metal/upi/installing-restricted-networks-bare-metal.adoc b/installing/installing_bare_metal/upi/installing-restricted-networks-bare-metal.adoc
@@ -84,6 +84,9 @@ include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]
 // Creating a manifest object that includes a customized `br-ex` bridge
 include::modules/creating-manifest-file-customized-br-ex-bridge.adoc[leveloffset=+1]
 
+// Enabling OVS balance-slb mode for your cluster
+include::modules/enabling-OVS-balance-slb-mode.adoc[leveloffset=+1]
+
 // Scale each machine set to compute nodes
 include::modules/creating-scaling-machine-sets-compute-nodes-networking.adoc[leveloffset=+2]
 
diff --git a/modules/bmo-about-the-baremetalhost-resource.adoc b/modules/bmo-about-the-baremetalhost-resource.adoc
@@ -1,6 +1,6 @@
 // This is included in the following assemblies:
 //
-// * installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc
+// * installing/installing_bare_metal/ipi/bare-metal-postinstallation-configuration.adoc
 
 :_mod-docs-content-type: REFERENCE
 [id="bmo-about-the-baremetalhost-resource_{context}"]
diff --git a/modules/bmo-about-the-firmwareschema-resource.adoc b/modules/bmo-about-the-firmwareschema-resource.adoc
@@ -1,6 +1,6 @@
 // This is included in the following assemblies:
 //
-// * installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc
+// * installing/installing_bare_metal/ipi/bare-metal-postinstallation-configuration.adoc
 
 :_mod-docs-content-type: REFERENCE
 [id="bmo-about-the-firmwareschema-resource_{context}"]
diff --git a/modules/bmo-about-the-hostfirmwarecomponents-resource.adoc b/modules/bmo-about-the-hostfirmwarecomponents-resource.adoc
@@ -1,6 +1,6 @@
 // This is included in the following assemblies:
 //
-// * installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc
+// * installing/installing_bare_metal/ipi/bare-metal-postinstallation-configuration.adoc
 
 :_mod-docs-content-type: REFERENCE
 [id="bmo-about-the-hostfirmwarecomponents-resource_{context}"]
diff --git a/modules/bmo-about-the-hostfirmwaresettings-resource.adoc b/modules/bmo-about-the-hostfirmwaresettings-resource.adoc
@@ -1,6 +1,6 @@
 // This is included in the following assemblies:
 //
-// * installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc
+// * installing/installing_bare_metal/ipi/bare-metal-postinstallation-configuration.adoc
 
 :_mod-docs-content-type: REFERENCE
 [id="bmo-about-the-hostfirmwaresettings-resource_{context}"]
diff --git a/modules/bmo-about-the-hostupdatepolicy-resource.adoc b/modules/bmo-about-the-hostupdatepolicy-resource.adoc
@@ -1,6 +1,6 @@
 // This is included in the following assemblies:
 //
-// * installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc
+// * installing/installing_bare_metal/ipi/bare-metal-postinstallation-configuration.adoc
 
 :_mod-docs-content-type: REFERENCE
 [id="bmo-about-the-hostupdatepolicy-resource_{context}"]
diff --git a/modules/bmo-attaching-a-non-bootable-iso-to-a-bare-metal-node.adoc b/modules/bmo-attaching-a-non-bootable-iso-to-a-bare-metal-node.adoc
@@ -1,6 +1,6 @@
 // This module is included in the following assemblies:
 //
-// * installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc
+// * installing/installing_bare_metal/ipi/bare-metal-postinstallation-configuration.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="bmo-attaching-a-non-bootable-iso-to-a-bare-metal-node_{context}"]
diff --git a/modules/bmo-bare-metal-operator-architecture.adoc b/modules/bmo-bare-metal-operator-architecture.adoc
@@ -1,6 +1,6 @@
 // This is included in the following assemblies:
 //
-// * installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc
+// * installing/installing_bare_metal/ipi/bare-metal-postinstallation-configuration.adoc
 
 :_mod-docs-content-type: CONCEPT
 [id="bmo-bare-metal-operator-architecture_{context}"]
diff --git a/modules/bmo-config-using-bare-metal-operator.adoc b/modules/bmo-config-using-bare-metal-operator.adoc
@@ -1,6 +1,6 @@
 // This is included in the following assemblies:
 //
-// * installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc
+// * installing/installing_bare_metal/ipi/bare-metal-postinstallation-configuration.adoc
 
 :_mod-docs-content-type: CONCEPT
 [id="bmo-config-using-bare-metal-operator_{context}"]
diff --git a/modules/bmo-configuring-ncsi-disable-poweroff.adoc b/modules/bmo-configuring-ncsi-disable-poweroff.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * installing/installing_bare_metal_ipi/ipi-install-post-installation-configuration.adoc
+// * installing/installing_bare_metal/ipi/bare-metal-postinstallation-configuration.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="bmo-configuring-ncsi-disable-poweroff_{context}"]
diff --git a/modules/bmo-editing-a-baremetalhost-resource.adoc b/modules/bmo-editing-a-baremetalhost-resource.adoc
@@ -1,6 +1,6 @@
 // This module is included in the following assemblies:
 //
-// * installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc
+// * installing/installing_bare_metal/ipi/bare-metal-postinstallation-configuration.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="bmo-editing-a-baremetalhost-resource_{context}"]
diff --git a/modules/bmo-editing-the-hostfirmwarecomponents-resource-of-a-provisioned-host.adoc b/modules/bmo-editing-the-hostfirmwarecomponents-resource-of-a-provisioned-host.adoc
@@ -1,6 +1,7 @@
 // This is included in the following assemblies:
 //
-// * installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc
+// * installing/installing_bare_metal/ipi/bare-metal-postinstallation-configuration.adoc
+
 :_mod-docs-content-type: PROCEDURE
 [id="bmo-editing-the-hostfirmwarecomponents-resource-of-a-provisioned-host_{context}"]
 = Editing the HostFirmwareComponents resource of a provisioned host
diff --git a/modules/bmo-editing-the-hostfirmwaresettings-resource-of-a-provisioned-host.adoc b/modules/bmo-editing-the-hostfirmwaresettings-resource-of-a-provisioned-host.adoc
@@ -1,6 +1,6 @@
 // This is included in the following assemblies:
 //
-// * installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc
+// * installing/installing_bare_metal/ipi/bare-metal-postinstallation-configuration.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="bmo-editing-the-hostfirmwaresettings-resource-of-a-provisioned-host_{context}"]
diff --git a/modules/bmo-getting-the-baremetalhost-resource.adoc b/modules/bmo-getting-the-baremetalhost-resource.adoc
@@ -1,6 +1,6 @@
 // This is included in the following assemblies:
 //
-// * installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc
+// * installing/installing_bare_metal/ipi/bare-metal-postinstallation-configuration.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="bmo-getting-the-baremetalhost-resource_{context}"]
diff --git a/modules/bmo-getting-the-firmwareschema-resource.adoc b/modules/bmo-getting-the-firmwareschema-resource.adoc
@@ -1,6 +1,6 @@
 // This is included in the following assemblies:
 //
-// * installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc
+// * installing/installing_bare_metal/ipi/bare-metal-postinstallation-configuration.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="bmo-getting-the-firmwareschema-resource_{context}"]
diff --git a/modules/bmo-getting-the-hostfirmwarecomponents-resource.adoc b/modules/bmo-getting-the-hostfirmwarecomponents-resource.adoc
@@ -1,6 +1,7 @@
 // This is included in the following assemblies:
 //
-// * installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc
+// * installing/installing_bare_metal/ipi/bare-metal-postinstallation-configuration.adoc
+
 :_mod-docs-content-type: PROCEDURE
 [id="bmo-getting-the-hostfirmwarecomponents-resource_{context}"]
 = Getting the HostFirmwareComponents resource
diff --git a/modules/bmo-getting-the-hostfirmwaresettings-resource.adoc b/modules/bmo-getting-the-hostfirmwaresettings-resource.adoc
@@ -1,6 +1,7 @@
 // This is included in the following assemblies:
 //
-// * installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc
+// * installing/installing_bare_metal/ipi/bare-metal-postinstallation-configuration.adoc
+
 :_mod-docs-content-type: PROCEDURE
 [id="bmo-getting-the-hostfirmwaresettings-resource_{context}"]
 = Getting the HostFirmwareSettings resource
diff --git a/modules/bmo-performing-a-live-update-to-the-hostfirmwarecomponents-resource.adoc b/modules/bmo-performing-a-live-update-to-the-hostfirmwarecomponents-resource.adoc
@@ -1,6 +1,7 @@
 // This is included in the following assemblies:
 //
-// * installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc
+// * installing/installing_bare_metal/ipi/bare-metal-postinstallation-configuration.adoc
+
 :_mod-docs-content-type: PROCEDURE
 [id="bmo-performing-a-live-update-to-the-hostfirmwarecomponents-resource_{context}"]
 = Performing a live update to the HostFirmwareComponents resource
diff --git a/modules/bmo-performing-a-live-update-to-the-hostfirmwaresettings-resource.adoc b/modules/bmo-performing-a-live-update-to-the-hostfirmwaresettings-resource.adoc
@@ -1,6 +1,7 @@
 // This is included in the following assemblies:
 //
-// * installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc
+// * installing/installing_bare_metal/ipi/bare-metal-postinstallation-configuration.adoc
+
 :_mod-docs-content-type: PROCEDURE
 [id="bmo-performing-a-live-update-to-the-hostfirmwaresettings-resource_{context}"]
 = Performing a live update to the HostFirmwareSettings resource
diff --git a/modules/bmo-setting-the-hostupdatepolicy-resource.adoc b/modules/bmo-setting-the-hostupdatepolicy-resource.adoc
@@ -1,8 +1,8 @@
 // This is included in the following assemblies:
 //
-// * installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc
-:_mod-docs-content-type: PROCEDURE
+// * installing/installing_bare_metal/ipi/bare-metal-postinstallation-configuration.adoc
 
+:_mod-docs-content-type: PROCEDURE
 [id="bmo-setting-the-hostupdatepolicy-resource_{context}"]
 = Setting the HostUpdatePolicy resource
 
diff --git a/modules/bmo-verifying-the-hostfirmware-settings-resource-is-valid.adoc b/modules/bmo-verifying-the-hostfirmware-settings-resource-is-valid.adoc
@@ -1,6 +1,6 @@
 // This is included in the following assemblies:
 //
-// * installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc
+// * installing/installing_bare_metal/ipi/bare-metal-postinstallation-configuration.adoc
 
 :_mod-docs-content-type: PROCEDURE
 [id="bmo-verifying-the-hostfirmware-settings-resource-is-valid_{context}"]
diff --git a/modules/creating-manifest-file-customized-br-ex-bridge.adoc b/modules/creating-manifest-file-customized-br-ex-bridge.adoc
@@ -2,66 +2,62 @@
 //
 // IPI
 // * installing/installing_bare_metal/ipi/ipi-install-installation-workflow.adoc
-// * installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc
+// * installing/installing_bare_metal/ipi/bare-metal-postinstallation-configuration.adoc
 // UPI
 // * installing/installing_bare_metal/upi/installing-bare-metal-network-customizations.adoc
 // * installing/installing_bare_metal/upi/installing-restricted-networks-bare-metal.adoc
 // * installing/installing_bare_metal/upi/installing-bare-metal.adoc
 
-ifeval::["{context}" == "ipi-install-post-installation-configuration"]
-:postinstall-bare-metal-ipi:
-endif::[]
-ifeval::["{context}" == "post-install-bare-metal-configuration"]
-:postinstall-bare-metal-upi:
+ifeval::["{context}" == "bare-metal-postinstallation-configuration"]
+:bare-metal-postinstallation-configuration:
 endif::[]
 
 :_mod-docs-content-type: PROCEDURE
 [id="creating-manifest-file-customized-br-ex-bridge_{context}"]
 = Creating a manifest object that includes a customized `br-ex` bridge
 
-ifndef::postinstall-bare-metal-ipi,postinstall-bare-metal-upi[]
+ifndef::bare-metal-postinstallation-configuration[]
 As an alternative to using the `configure-ovs.sh` shell script to set a `br-ex` bridge on a bare-metal platform, you can create a `MachineConfig` object that includes an NMState configuration file. The NMState configuration file creates a customized `br-ex` bridge network configuration on each node in your cluster.
-endif::postinstall-bare-metal-ipi,postinstall-bare-metal-upi[]
+endif::bare-metal-postinstallation-configuration[]
 
-ifdef::postinstall-bare-metal-ipi,postinstall-bare-metal-upi[]
+ifdef::bare-metal-postinstallation-configuration[]
 As an alternative to using the `configure-ovs.sh` shell script to set a `br-ex` bridge on a bare-metal platform, you can create a `NodeNetworkConfigurationPolicy` custom resource (CR) that includes an NMState configuration file. The NMState configuration file creates a customized `br-ex` bridge network configuration on each node in your cluster.
 
 This feature supports the following tasks:
 
 * Modifying the maximum transmission unit (MTU) for your cluster.
 * Modifying attributes of a different bond interface, such as MIImon (Media Independent Interface Monitor), bonding mode, or Quality of Service (QoS).
 * Updating DNS values.
-endif::postinstall-bare-metal-ipi,postinstall-bare-metal-upi[]
+endif::bare-metal-postinstallation-configuration[]
 
 Consider the following use cases for creating a manifest object that includes a customized `br-ex` bridge:
 
 * You want to make postinstallation changes to the bridge, such as changing the Open vSwitch (OVS) or OVN-Kubernetes `br-ex` bridge network. The `configure-ovs.sh` shell script does not support making postinstallation changes to the bridge.
 * You want to deploy the bridge on a different interface than the interface available on a host or server IP address.
 * You want to make advanced configurations to the bridge that are not possible with the `configure-ovs.sh` shell script. Using the script for these configurations might result in the bridge failing to connect multiple network interfaces and facilitating data forwarding between the interfaces.
 
-ifndef::postinstall-bare-metal-ipi,postinstall-bare-metal-upi[]
-
+ifndef::bare-metal-postinstallation-configuration[]
 [NOTE]
 ====
 If you require an environment with a single network interface controller (NIC) and default network settings, use the `configure-ovs.sh` shell script.
 ====
 
 After you install {op-system-first} and the system reboots, the Machine Config Operator injects Ignition configuration files into each node in your cluster, so that each node received the `br-ex` bridge network configuration. To prevent configuration conflicts, the `configure-ovs.sh` shell script receives a signal to not configure the `br-ex` bridge.
-endif::postinstall-bare-metal-ipi,postinstall-bare-metal-upi[]
+endif::bare-metal-postinstallation-configuration[]
 
 .Prerequisites
-ifndef::postinstall-bare-metal-ipi,postinstall-bare-metal-upi[]
+ifndef::bare-metal-postinstallation-configuration[]
 * Optional: You have installed the link:https://nmstate.io/[`nmstate`] API so that you can validate the NMState configuration.
-endif::postinstall-bare-metal-ipi,postinstall-bare-metal-upi[]
+endif::bare-metal-postinstallation-configuration[]
 
-ifdef::postinstall-bare-metal-ipi,postinstall-bare-metal-upi[]
+ifdef::bare-metal-postinstallation-configuration[]
 * You set a customized `br-ex` by using the alternative method to `configure-ovs`.
 * You installed the Kubernetes NMState Operator.
-endif::postinstall-bare-metal-ipi,postinstall-bare-metal-upi[]
+endif::bare-metal-postinstallation-configuration[]
 
 .Procedure
 
-ifndef::postinstall-bare-metal-ipi,postinstall-bare-metal-upi[]
+ifndef::bare-metal-postinstallation-configuration[]
 . Create a NMState configuration file that has decoded base64 information for your customized `br-ex` bridge network:
 +
 .Example of an NMState configuration for a customized `br-ex` bridge network
@@ -142,10 +138,17 @@ spec:
 <1> For each node in your cluster, specify the hostname path to your node and the base-64 encoded Ignition configuration file data for the machine type. If you have a single global configuration specified in an `/etc/nmstate/openshift/cluster.yml` configuration file that you want to apply to all nodes in your cluster, you do not need to specify the hostname path for each node. The `worker` role is the default role for nodes in your cluster. The `.yaml` extension does not work when specifying the hostname path for each node or all nodes in the `MachineConfig` manifest file.
 <2> The name of the policy.
 <3> Writes the encoded base64 information to the specified path.
-endif::postinstall-bare-metal-ipi,postinstall-bare-metal-upi[]
 
-ifdef::postinstall-bare-metal-ipi,postinstall-bare-metal-upi[]
-* Create a `NodeNetworkConfigurationPolicy` (NNCP) CR and define a customized `br-ex` bridge network configuration. Depending on your needs, ensure that you set a masquerade IP for either the `ipv4.address.ip`, `ipv6.address.ip`, or both parameters. A masquerade IP address must match an in-use IP address block.
+. Apply the `MachineConfig` file, which defines your network interfaces, to the manifests directory by entering the following command. After you apply the file to the directory, the file is passed to the installation program.
++
+[source,terminal]
+----
+$ oc apply -f <machine_config_file_name>.yaml
+----
+endif::bare-metal-postinstallation-configuration[]
+
+ifdef::bare-metal-postinstallation-configuration[]
+. Create a `NodeNetworkConfigurationPolicy` (NNCP) CR and define a customized `br-ex` bridge network configuration. Depending on your needs, ensure that you set a masquerade IP for either the `ipv4.address.ip`, `ipv6.address.ip`, or both parameters. A masquerade IP address must match an in-use IP address block.
 +
 [IMPORTANT]
 ====
@@ -209,11 +212,16 @@ spec:
 <4> The requested state for the interface after creation.
 <5> Disables IPv4 and IPv6 in this example.
 <6> The node NIC to which the bridge is attached.
-endif::postinstall-bare-metal-ipi,postinstall-bare-metal-upi[]
 
-ifeval::["{context}" == "ipi-install-post-installation-configuration"]
-:!postinstall-bare-metal:
-endif::[]
-ifeval::["{context}" == "bare-metal-configuration"]
-:!postinstall-bare-metal:
+. Apply the NNCP configuration to each node in your cluster by running the following command:
++
+[source,yaml]
+----
+$ oc apply -f <nncp_file_name> <1>
+----
+<1> Replace `<nncp_file_name>` with the name of your NNCP file.
+endif::bare-metal-postinstallation-configuration[]
+
+ifeval::["{context}" == "bare-metal-postinstallation-configuration"]
+:!bare-metal-postinstallation-configuration:
 endif::[]
diff --git a/modules/enabling-OVS-balance-slb-mode.adoc b/modules/enabling-OVS-balance-slb-mode.adoc
diff --git a/modules/ipi-install-configuring-ntp-for-disconnected-clusters.adoc b/modules/ipi-install-configuring-ntp-for-disconnected-clusters.adoc
diff --git a/modules/nw-osp-configuring-external-load-balancer.adoc b/modules/nw-osp-configuring-external-load-balancer.adoc
diff --git a/modules/nw-osp-services-external-load-balancer.adoc b/modules/nw-osp-services-external-load-balancer.adoc
