[OSDOCS-5261] TP - External load balancers in place of default for ShiftStack IPI (#57520)

Author: maxwelldb

installing/installing_openstack/installing-openstack-installer-custom.adoc

@@ -20,6 +20,7 @@ In {product-title} version {product-version}, you can install a customized clust
 include::modules/installation-osp-default-deployment.adoc[leveloffset=+1]
 include::modules/installation-osp-control-compute-machines.adoc[leveloffset=+2]
 include::modules/installation-osp-bootstrap-machine.adoc[leveloffset=+2]
+include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]
 include::modules/cluster-entitlements.adoc[leveloffset=+1]
 include::modules/installation-osp-enabling-swift.adoc[leveloffset=+1]
 include::modules/installation-registry-osp-creating-custom-pvc.adoc[leveloffset=+1]
@@ -50,6 +51,7 @@ After you deploy your cluster, you can attach pods to additional networks. For m
 ====
 
 include::modules/installation-osp-config-yaml.adoc[leveloffset=+2]
+include::modules/installation-osp-external-lb-config.adoc[leveloffset=+2]
 // include::modules/installation-osp-setting-worker-affinity.adoc[leveloffset=+1]
 include::modules/ssh-agent-using.adoc[leveloffset=+1]
 include::modules/installation-osp-accessing-api.adoc[leveloffset=+1]

installing/installing_openstack/installing-openstack-installer-kuryr.adoc

@@ -30,6 +30,7 @@ You can xref:../../networking/load-balancing-openstack.adoc#installation-osp-kur
 include::modules/installation-osp-kuryr-known-limitations.adoc[leveloffset=+2]
 include::modules/installation-osp-control-compute-machines.adoc[leveloffset=+2]
 include::modules/installation-osp-bootstrap-machine.adoc[leveloffset=+2]
+include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]
 include::modules/cluster-entitlements.adoc[leveloffset=+1]
 include::modules/installation-osp-enabling-swift.adoc[leveloffset=+1]
 include::modules/installation-osp-verifying-external-network.adoc[leveloffset=+1]
@@ -41,6 +42,7 @@ include::modules/installation-configure-proxy.adoc[leveloffset=+2]
 include::modules/installation-configuration-parameters.adoc[leveloffset=+1]
 include::modules/installation-osp-custom-subnet.adoc[leveloffset=+2]
 include::modules/installation-osp-kuryr-config-yaml.adoc[leveloffset=+2]
+include::modules/installation-osp-external-lb-config.adoc[leveloffset=+2]
 include::modules/installation-osp-provider-networks.adoc[leveloffset=+2]
 include::modules/installation-osp-provider-network-preparation.adoc[leveloffset=+3]
 include::modules/installation-osp-deploying-provider-networks-installer.adoc[leveloffset=+3]

modules/installation-configuration-parameters.adoc

@@ -1049,6 +1049,10 @@ You can also use this property to enable the QEMU guest agent by including the `
 |IP addresses for external DNS servers that cluster instances use for DNS resolution.
 |A list of IP addresses as strings. For example, `["8.8.8.8", "192.168.1.12"]`.
 
+|`platform.openstack.loadbalancer`
+|Whether or not to use the default, internal load balancer. If the value is set to `UserManaged`, this default load balancer is disabled so that you can deploy a cluster that uses an external, user-managed load balancer. If the parameter is not set, or if the value is `OpenShiftManagedDefault`, the cluster uses the default load balancer.
+|`UserManaged` or `OpenShiftManagedDefault`.
+
 |`platform.openstack.machinesSubnet`
 |The UUID of a {rh-openstack} subnet that the cluster's nodes use. Nodes and virtual IP (VIP) ports are created on this subnet.
 

modules/installation-load-balancing-user-infra.adoc

@@ -16,6 +16,8 @@
 // * installing/installing_ibm_z/installing-ibm-power.adoc
 // * installing/installing_ibm_z/installing-restricted-networks-ibm-power.adoc
 // * installing/installing-rhv-restricted-network.adoc
+// * installing/installing_openstack/installing-openstack-installer-custom.adoc
+// * installing/installing_openstack/installing-openstack-installer-kuryr.adoc
 
 ifeval::["{context}" == "installing-vsphere"]
 :vsphere:
@@ -44,12 +46,37 @@ endif::[]
 ifeval::["{context}" == "installing-restricted-networks-bare-metal"]
 :restricted:
 endif::[]
+ifeval::["{context}" == "installing-openstack-installer-custom"]
+:user-managed-lb:
+endif::[]
+ifeval::["{context}" == "installing-openstack-installer-kuryr"]
+:user-managed-lb:
+endif::[]
 
 :_content-type: CONCEPT
 [id="installation-load-balancing-user-infra_{context}"]
 = Load balancing requirements for user-provisioned infrastructure
 
+ifndef::user-managed-lb[]
 Before you install {product-title}, you must provision the API and application ingress load balancing infrastructure. In production scenarios, you can deploy the API and application ingress load balancers separately so that you can scale the load balancer infrastructure for each in isolation.
+endif::user-managed-lb[]
+
+ifdef::user-managed-lb[]
+[IMPORTANT]
+====
+[subs="attributes+"]
+Deployment with User-Managed Load Balancers is a Technology Preview feature only. Technology Preview features
+are not supported with Red Hat production service level agreements (SLAs) and
+might not be functionally complete. Red Hat does not recommend using them
+in production. These features provide early access to upcoming product
+features, enabling customers to test functionality and provide feedback during
+the development process.
+
+For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope].
+====
+
+Before you install {product-title}, you can provision your own API and application ingress load balancing infrastructure to use in place of the default, internal load balancing solution. In production scenarios, you can deploy the API and application ingress load balancers separately so that you can scale the load balancer infrastructure for each in isolation.
+endif::user-managed-lb[]
 
 [NOTE]
 ====
@@ -166,9 +193,17 @@ plane initializes.
 ====
 
 [id="installation-load-balancing-user-infra-example_{context}"]
+ifndef::user-managed-lb[]
 == Example load balancer configuration for user-provisioned clusters
 
 This section provides an example API and application ingress load balancer configuration that meets the load balancing requirements for user-provisioned clusters. The sample is an `/etc/haproxy/haproxy.cfg` configuration for an HAProxy load balancer. The example is not meant to provide advice for choosing one load balancing solution over another.
+endif::user-managed-lb[]
+
+ifdef::user-managed-lb[]
+== Example load balancer configuration for clusters that are deployed with user-managed load balancers
+
+This section provides an example API and application ingress load balancer configuration that meets the load balancing requirements for clusters that are deployed with user-managed load balancers. The sample is an `/etc/haproxy/haproxy.cfg` configuration for an HAProxy load balancer. The example is not meant to provide advice for choosing one load balancing solution over another.
+endif::user-managed-lb[]
 
 [NOTE]
 ====
@@ -277,4 +312,10 @@ ifeval::["{context}" == "installing-restricted-networks-ibm-power"]
 endif::[]
 ifeval::["{context}" == "installing-restricted-networks-bare-metal"]
 :!restricted:
+endif::[]
+ifeval::["{context}" == "installing-openstack-installer-custom"]
+:!user-managed-lb:
+endif::[]
+ifeval::["{context}" == "installing-openstack-installer-kuryr"]
+:!user-managed-lb:
 endif::[]

modules/installation-osp-external-lb-config.adoc

@@ -0,0 +1,48 @@
+:_content-type: REFERENCE
+[id="install-osp-external-lb-config_{context}"]
+= Installation configuration for a cluster on OpenStack with a user-managed load balancer
+
+:FeatureName: Deployment on OpenStack with User-Managed Load Balancers
+include::snippets/technology-preview.adoc[]
+
+The following example `install-config.yaml` file demonstrates how to configure a cluster that uses an external, user-managed load balancer rather than the default internal load balancer.
+
+[source,yaml]
+----
+apiVersion: v1
+baseDomain: mydomain.test 
+compute:
+- name: worker
+  platform:
+    openstack:
+      type: m1.xlarge
+  replicas: 3
+controlPlane:
+  name: master
+  platform:
+    openstack:
+      type: m1.xlarge
+  replicas: 3
+metadata:
+  name: mycluster
+networking:
+  clusterNetwork:
+  - cidr: 10.128.0.0/14
+    hostPrefix: 23
+  machineNetwork:
+  - cidr: 192.168.10.0/24
+platform:
+  openstack:
+    cloud: mycloud
+    machinesSubnet: 8586bf1a-cc3c-4d40-bdf6-c243decc603a <1>
+    apiVIPs:
+    - 192.168.10.5
+    ingressVIPs:
+    - 192.168.10.7
+    loadBalancer:
+      type: UserManaged <2>
+featureSet: TechPreviewNoUpgrade <3>
+----
+<1> Regardless of which load balancer you use, the load balancer is deployed to this subnet.
+<2> The `UserManaged` value indicates that you are using an user-managed load balancer.
+<3> Because user-managed load balancers are in Technology Preview, you must include the `TechPreviewNoUpgrade` value to deploy a cluster that uses a user-managed load balancer.