Merge pull request #77368 from dfitzmau/OSDOCS-9350-parameters

OSDOCS-9350: Contentx consolidate Ingress Controller parameter tidy

Author: mburke5678

_topic_maps/_topic_map.yml

@@ -1343,7 +1343,7 @@ Topics:
   File: ingress-controller-dnsmgt
   Distros: openshift-enterprise,openshift-origin
 - Name: Configuring the Ingress Controller endpoint publishing strategy
-  File: nw-ingress-controller-endpoint-publishing-strategies
+  File: nw-configuring-ingress-controller-endpoint-publishing-strategy
   Distros: openshift-enterprise,openshift-origin
 - Name: Verifying connectivity to an endpoint
   File: verifying-connectivity-endpoint

machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-aws.adoc

@@ -27,9 +27,10 @@ You can enable features by updating values in the control plane machine set.
 
 //Restricting the API server to private (AWS control plane machine set version)
 include::modules/private-clusters-setting-api-private.adoc[leveloffset=+2]
+
 [role="_additional-resources"]
 .Additional resources
-* xref:../../../networking/nw-ingress-controller-endpoint-publishing-strategies.adoc#nw-ingresscontroller-change-internal_nw-ingress-controller-endpoint-publishing-strategies[Configuring the Ingress Controller endpoint publishing scope to Internal]
+* xref:../../../networking/nw-configuring-ingress-controller-endpoint-publishing-strategy.adoc#nw-ingresscontroller-change-internal_nw-configuring-ingress-controller-endpoint-publishing-strategy[Configuring the Ingress Controller endpoint publishing scope to Internal]
 
 //Selecting a larger Amazon Web Services instance type for control plane machines
 include::modules/cpms-changing-aws-instance-type.adoc[leveloffset=+2]

machine_management/control_plane_machine_management/cpmso_provider_configurations/cpmso-config-options-azure.adoc

@@ -28,7 +28,7 @@ You can enable features by updating values in the control plane machine set.
 include::modules/private-clusters-setting-api-private.adoc[leveloffset=+2]
 [role="_additional-resources"]
 .Additional resources
-* xref:../../../networking/nw-ingress-controller-endpoint-publishing-strategies.adoc#nw-ingresscontroller-change-internal_nw-ingress-controller-endpoint-publishing-strategies[Configuring the Ingress Controller endpoint publishing scope to Internal]
+* xref:../../../networking/nw-configuring-ingress-controller-endpoint-publishing-strategy.adoc#nw-ingresscontroller-change-internal_nw-configuring-ingress-controller-endpoint-publishing-strategy[Configuring the Ingress Controller endpoint publishing scope to Internal]
 
 //Selecting an Azure Marketplace image
 include::modules/installation-azure-marketplace-subscribe.adoc[leveloffset=+2]

modules/nw-ingress-controller-configuration-parameters.adoc

@@ -1,12 +1,12 @@
 // Module included in the following assemblies:
 //
-// * ingress/configure-ingress-operator.adoc
+// * ingress/ingress-operator.adoc
+
 :_mod-docs-content-type: REFERENCE
 [id="nw-ingress-controller-configuration-parameters_{context}"]
 = Ingress Controller configuration parameters
 
-The `ingresscontrollers.operator.openshift.io` resource offers the following
-configuration parameters.
+The `ingresscontrollers.operator.openshift.io` resource includes optional configuration parameters that you can configure to meet specific needs for your organization.
 
 [cols="3a,8a",options="header"]
 |===
@@ -26,11 +26,13 @@ The `domain` value must be unique among all Ingress Controllers and cannot be up
 If empty, the default value is `ingress.config.openshift.io/cluster` `.spec.domain`.
 
 |`replicas`
-|`replicas` is the desired number of Ingress Controller replicas. If not set, the default value is `2`.
+|`replicas` is the number of Ingress Controller replicas. If not set, the default value is `2`.
 
 |`endpointPublishingStrategy`
 |`endpointPublishingStrategy` is used to publish the Ingress Controller endpoints to other networks, enable load balancer integrations, and provide access to other systems.
 
+For cloud environments, use the `loadBalancer` field to configure the endpoint publishing strategy for your Ingress Controller.
+
 ifndef::openshift-rosa,openshift-dedicated[]
 On GCP, AWS, and Azure you can configure the following `endpointPublishingStrategy` fields:
 endif::openshift-rosa,openshift-dedicated[]
@@ -53,47 +55,27 @@ endif::openshift-dedicated[]
 ifndef::openshift-rosa,openshift-dedicated[]
 * Azure: `LoadBalancerService` (with External scope)
 * Google Cloud Platform (GCP): `LoadBalancerService` (with External scope)
-* Bare metal: `NodePortService`
-* Other: `HostNetwork`
 endif::openshift-rosa,openshift-dedicated[]
-+
-[NOTE]
-====
-`HostNetwork` has a `hostNetwork` field with the following default values for the optional binding ports: `httpPort: 80`, `httpsPort: 443`, and `statsPort: 1936`.
-With the binding ports, you can deploy multiple Ingress Controllers on the same node for the `HostNetwork` strategy.
 
-.Example
-[source,yaml]
-----
-apiVersion: operator.openshift.io/v1
-kind: IngressController
-metadata:
-  name: internal
-  namespace: openshift-ingress-operator
-spec:
-  domain: example.com
-  endpointPublishingStrategy:
-    type: HostNetwork
-    hostNetwork:
-      httpPort: 80
-      httpsPort: 443
-      statsPort: 1936
-----
-====
-+
-[NOTE]
-====
-On {rh-openstack-first}, the `LoadBalancerService` endpoint publishing strategy is only supported if a cloud provider is configured to create health monitors. For {rh-openstack} 16.2, this strategy is only possible if you use the Amphora Octavia provider.
-
-For more information, see the "Setting cloud provider options" section of the {rh-openstack} installation documentation.
-====
 ifndef::openshift-rosa[]
 For most platforms, the `endpointPublishingStrategy` value can be updated. On GCP, you can configure the following `endpointPublishingStrategy` fields:
 
 * `loadBalancer.scope`
 * `loadbalancer.providerParameters.gcp.clientAccess`
+endif::openshift-rosa[]
+
+ifndef::openshift-rosa,openshift-dedicated[]
+For non-cloud environments, such as a bare-metal platform, use the `NodePortService`, `HostNetwork`, or `Private` fields to configure the endpoint publishing strategy for your Ingress Controller.
+
+If you do not set a value in one of these fields, the default value is based on binding ports specified in the `infrastructure.config.openshift.io/cluster` `.status.platform` resource.
+endif::openshift-rosa,openshift-dedicated[]
+
+ifndef::openshift-rosa[]
+If you need to update the `endpointPublishingStrategy` value after your cluster is deployed, you can configure the following `endpointPublishingStrategy` fields:
+
 * `hostNetwork.protocol`
 * `nodePort.protocol`
+* `private.protocol`
 endif::openshift-rosa[]
 
 |`defaultCertificate`
@@ -319,9 +301,3 @@ The `HTTPEmptyRequestsPolicy` type accepts either one of two values:
 
 These connections come from load balancer health probes or web browser speculative connections (preconnect) and can be safely ignored. However, these requests can be caused by network errors, so setting this field to `Ignore` can impede detection and diagnosis of problems. These requests can be caused by port scans, in which case logging empty requests can aid in detecting intrusion attempts.
 |===
-
-
-[NOTE]
-====
-All parameters are optional.
-====

modules/nw-ingress-controller-endpoint-publishing-strategies.adoc

@@ -1,7 +1,8 @@
 // Module included in the following assemblies:
 //
-// * ingress/configure-ingress-operator.adoc
+// * networking/nw-configuring-ingress-controller-endpoint-publishing-strategy.adoc
 
+:_mod-docs-content-type: CONCEPT
 [id="nw-ingress-controller-endpoint-publishing-strategies_{context}"]
 = Ingress Controller endpoint publishing strategy
 
@@ -33,3 +34,23 @@ For more information, see the link:https://kubernetes.io/docs/concepts/services-
 The `HostNetwork` endpoint publishing strategy publishes the Ingress Controller on node ports where the Ingress Controller is deployed.
 
 An Ingress Controller with the `HostNetwork` endpoint publishing strategy can have only one pod replica per node. If you want _n_ replicas, you must use at least _n_ nodes where those replicas can be scheduled. Because each pod replica requests ports `80` and `443` on the node host where it is scheduled, a replica cannot be scheduled to a node if another pod on the same node is using those ports.
+
+The `HostNetwork` object has a `hostNetwork` field with the following default values for the optional binding ports: `httpPort: 80`, `httpsPort: 443`, and `statsPort: 1936`. By specifying different binding ports for your network, you can deploy multiple Ingress Controllers on the same node for the `HostNetwork` strategy.
+
+.Example
+[source,yaml]
+----
+apiVersion: operator.openshift.io/v1
+kind: IngressController
+metadata:
+  name: internal
+  namespace: openshift-ingress-operator
+spec:
+  domain: example.com
+  endpointPublishingStrategy:
+    type: HostNetwork
+    hostNetwork:
+      httpPort: 80
+      httpsPort: 443
+      statsPort: 1936
+----

modules/nw-ingresscontroller-change-external.adoc

@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * networking/ingress-operator.adoc
+// * networking/nw-configuring-ingress-controller-endpoint-publishing-strategy.adoc
 
 [id="nw-ingresscontroller-change-external_{context}"]
 = Configuring the Ingress Controller endpoint publishing scope to External

modules/nw-ingresscontroller-change-internal.adoc

@@ -1,7 +1,8 @@
 // Module included in the following assemblies:
 //
-// * networking/ingress-operator.adoc
+// * networking/nw-configuring-ingress-controller-endpoint-publishing-strategy.adoc
 
+:_mod-docs-content-type: PROCEDURE
 [id="nw-ingresscontroller-change-internal_{context}"]
 = Configuring the Ingress Controller endpoint publishing scope to Internal
 

networking/ingress-operator.adoc

@@ -15,6 +15,7 @@ include::modules/nw-ne-openshift-ingress.adoc[leveloffset=+1]
 //ifndef::openshift-rosa,openshift-dedicated[] NOTE: commenting out this ifndef to track what was in place before OSDOCS-4883.
 include::modules/nw-installation-ingress-config-asset.adoc[leveloffset=+1]
 
+// Ingress Controller configuration parameters
 include::modules/nw-ingress-controller-configuration-parameters.adoc[leveloffset=+1]
 
 [id="configuring-ingress-controller-tls"]

networking/nw-configuring-ingress-controller-endpoint-publishing-strategy.adoc

@@ -0,0 +1,32 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="nw-configuring-ingress-controller-endpoint-publishing-strategy"]
+= Configuring the Ingress Controller endpoint publishing strategy
+include::_attributes/common-attributes.adoc[]
+:context: nw-configuring-ingress-controller-endpoint-publishing-strategy
+
+toc::[]
+
+The `endpointPublishingStrategy` is used to publish the Ingress Controller endpoints to other networks, enable load balancer integrations, and provide access to other systems.
+
+[IMPORTANT]
+====
+On {rh-openstack-first}, the `LoadBalancerService` endpoint publishing strategy is only supported if a cloud provider is configured to create health monitors. For {rh-openstack} 16.2, this strategy is only possible if you use the Amphora Octavia provider.
+
+For more information, see the " Setting {rh-openstack} Cloud Controller Manager options" section of the {rh-openstack} installation documentation.
+====
+
+// Ingress Controller endpoint publishing strategy
+include::modules/nw-ingress-controller-endpoint-publishing-strategies.adoc[leveloffset=+1]
+
+// Configuring the Ingress Controller endpoint publishing scope to Internal
+include::modules/nw-ingresscontroller-change-internal.adoc[leveloffset=+2]
+
+// Configuring the Ingress Controller endpoint publishing scope to External
+include::modules/nw-ingresscontroller-change-external.adoc[leveloffset=+2]
+
+[role="_additional-resources"]
+== Additional resources
+
+* xref:../networking/ingress-operator.adoc#nw-ingress-controller-configuration-parameters_configuring-ingress[Ingress Controller configuration parameters].
+
+* xref:../installing/installing_openstack/installing-openstack-installer-custom.adoc#installation-osp-setting-cloud-provider-options_installing-openstack-installer-custom[Setting {rh-openstack} Cloud Controller Manager options].