Merge pull request #45296 from jldohmann/OSDOCS-3501

mburke5678 · web-flow · commit 80236bd19e5e · 2022-06-09T11:00:26.000-04:00
OSDOCS-3501: add clb timeouts and restructure
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -1160,8 +1160,8 @@ Topics:
   - Name: Configuring ingress cluster traffic using a load balancer
     File: configuring-ingress-cluster-traffic-load-balancer
     Distros: openshift-enterprise,openshift-origin
-  - Name: Configuring ingress cluster traffic on AWS using a Network Load Balancer
-    File: configuring-ingress-cluster-traffic-aws-network-load-balancer
+  - Name: Configuring ingress cluster traffic on AWS
+    File: configuring-ingress-cluster-traffic-aws
     Distros: openshift-enterprise,openshift-origin
   - Name: Configuring ingress cluster traffic using a service external IP
     File: configuring-ingress-cluster-traffic-service-external-ip
diff --git a/installing/installing_aws/installing-aws-network-customizations.adoc b/installing/installing_aws/installing-aws-network-customizations.adoc
@@ -57,7 +57,7 @@ include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1]
 
 [NOTE]
 ====
-For more information on using a Network Load Balancer (NLB) on AWS, see xref:../../networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-aws-network-load-balancer.adoc#configuring-ingress-cluster-traffic-aws-network-load-balancer[Configuring Ingress cluster traffic on AWS using a Network Load Balancer].
+For more information on using a Network Load Balancer (NLB) on AWS, see xref:../../networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-aws.adoc#configuring-ingress-cluster-traffic-aws-network-load-balancer[Configuring Ingress cluster traffic on AWS using a Network Load Balancer].
 ====
 
 include::modules/nw-aws-nlb-new-cluster.adoc[leveloffset=+1]
diff --git a/modules/nw-aws-nlb-existing-cluster.adoc b/modules/nw-aws-nlb-existing-cluster.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-aws-network-load-balancer.adoc
+// * networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-aws.adoc
 
 :_content-type: PROCEDURE
 [id="nw-aws-nlb-existing-cluster_{context}"]
diff --git a/modules/nw-aws-nlb-new-cluster.adoc b/modules/nw-aws-nlb-new-cluster.adoc
@@ -1,7 +1,7 @@
 // Module included in the following assemblies:
 //
 // * installing/installing_aws/installing-aws-network-customizations.adoc
-// * networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-aws-network-load-balancer.adoc
+// * networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-aws.adoc
 
 :_content-type: PROCEDURE
 [id="nw-aws-nlb-new-cluster_{context}"]
diff --git a/modules/nw-aws-replacing-clb-with-nlb.adoc b/modules/nw-aws-replacing-clb-with-nlb.adoc
@@ -1,6 +1,6 @@
 // Module included in the following assemblies:
 //
-// * networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-aws-network-load-balancer.adoc
+// * networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-aws.adoc
 
 :_content-type: PROCEDURE
 [id="nw-aws-replacing-clb-with-nlb_{context}"]
diff --git a/modules/nw-configuring-clb-timeouts.adoc b/modules/nw-configuring-clb-timeouts.adoc
@@ -0,0 +1,42 @@
+// Modules included in the following assemblies:
+//
+// * networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-aws.adoc
+
+:_content-type: PROCEDURE
+[id="nw-configuring-clb-timeouts_{context}"]
+= Configuring Classic Load Balancer timeouts
+
+You can configure the default timeouts for a Classic Load Balancer (CLB) to extend idle connections.
+
+.Prerequisites
+
+* You must have a deployed Ingress Controller on a running cluster.
+
+.Procedure
+
+. Set an AWS connection idle timeout of five minutes for the default `ingresscontroller` by running the following command:
++
+[source,terminal]
+----
+$ oc -n openshift-ingress-operator patch ingresscontroller/default \
+    --type=merge --patch='{"spec":{"endpointPublishingStrategy": \
+    {"type":"LoadBalancerService", "loadBalancer": \
+    {"scope":"External", "providerParameters":{"type":"AWS", "aws": \
+    {"type":"Classic", "classicLoadBalancer": \
+    {"connectionIdleTimeout":"5m"}}}}}}}'
+----
+
+. Optional: Restore the default value of the timeout by running the following command:
++
+[source,terminal]
+----
+$ oc -n openshift-ingress-operator patch ingresscontroller/default \
+    --type=merge --patch='{"spec":{"endpointPublishingStrategy": \
+    {"loadBalancer":{"providerParameters":{"aws":{"classicLoadBalancer": \
+    {"connectionIdleTimeout":null}}}}}}}'
+----
+
+[NOTE]
+====
+You must specify the `scope` field when you change the connection timeout value unless the current scope is already set. When you set the `scope` field, you do not need to do so again if you restore the default timeout value.
+====
diff --git a/modules/nw-configuring-elb-timeouts-aws-classic.adoc b/modules/nw-configuring-elb-timeouts-aws-classic.adoc
@@ -0,0 +1,11 @@
+// Module included in the following assemblies:
+//
+// * networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-aws.adoc
+
+:_content-type: CONCEPT
+[id="nw-configuring-elb-timeouts-aws-classic_{context}"]
+= Configuring Classic Load Balancer timeouts on AWS
+
+{product-title} provides a method for setting a custom timeout period for a specific route or Ingress Controller. Additionally, an AWS Classic Load Balancer (CLB) has its own timeout period with a default time of 60 seconds.
+
+If the timeout period of the CLB is shorter than the route timeout or Ingress Controller timeout, the load balancer can prematurely terminate the connection. You can prevent this problem by increasing both the timeout period of the route and CLB.
diff --git a/modules/nw-configuring-ingress-cluster-traffic-aws-networking-load-balancer.adoc b/modules/nw-configuring-ingress-cluster-traffic-aws-networking-load-balancer.adoc
@@ -0,0 +1,9 @@
+// Module included in the following assemblies:
+//
+// * networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-aws.adoc
+
+:_content-type: CONCEPT
+[id="nw-configuring-ingress-cluster-traffic-aws-network-load-balancer_{context}"]
+= Configuring ingress cluster traffic on AWS using a Network Load Balancer
+
+{product-title} provides methods for communicating from outside the cluster with services that run in the cluster. One such method uses a Network Load Balancer (NLB). You can configure an NLB on a new or existing AWS cluster.
diff --git a/modules/nw-configuring-route-timeouts.adoc b/modules/nw-configuring-route-timeouts.adoc
@@ -1,6 +1,7 @@
 // Module filename: nw-configuring-route-timeouts.adoc
 // Module included in the following assemblies:
 // * networking/configuring-routing.adoc
+// * networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-aws.adoc
 
 :_content-type: PROCEDURE
 [id="nw-configuring-route-timeouts_{context}"]
diff --git a/networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-aws-network-load-balancer.adoc b/networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-aws-network-load-balancer.adoc
diff --git a/networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-aws.adoc b/networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-aws.adoc
@@ -0,0 +1,38 @@
+:_content-type: ASSEMBLY
+[id="configuring-ingress-cluster-traffic-aws"]
+= Configuring ingress cluster traffic on AWS
+include::_attributes/common-attributes.adoc[]
+:context: configuring-ingress-cluster-traffic-aws
+
+toc::[]
+
+{product-title} provides methods for communicating from outside the cluster with services running in the cluster. This method uses load balancers on AWS, specifically a Network Load Balancer (NLB) or a Classic Load Balancer (CLB). Both types of load balancers can forward the client's IP address to the node, but a CLB requires proxy protocol support, which {product-title} automatically enables.
+
+You can configure these load balancers on a new or existing AWS cluster.
+
+include::modules/nw-configuring-elb-timeouts-aws-classic.adoc[leveloffset=+1]
+
+include::modules/nw-configuring-route-timeouts.adoc[leveloffset=+2]
+
+include::modules/nw-configuring-clb-timeouts.adoc[leveloffset=+2]
+
+include::modules/nw-configuring-ingress-cluster-traffic-aws-networking-load-balancer.adoc[leveloffset=+1]
+
+include::modules/nw-aws-replacing-clb-with-nlb.adoc[leveloffset=+2]
+
+include::modules/nw-aws-nlb-existing-cluster.adoc[leveloffset=+2]
+
+[IMPORTANT]
+====
+Before you can configure an Ingress Controller NLB on a new AWS cluster, you must complete the xref:../../installing/installing_aws/installing-aws-network-customizations.adoc#installation-initializing_installing-aws-network-customizations[Creating the installation configuration file] procedure.
+====
+
+include::modules/nw-aws-nlb-new-cluster.adoc[leveloffset=+2]
+
+[role="_additional-resources"]
+[id="additional-resources_configuring-ingress-cluster-traffic-aws"]
+== Additional resources
+
+* xref:../../installing/installing_aws/installing-aws-network-customizations.adoc#installing-aws-network-customizations[Installing a cluster on AWS with network customizations].
+* For more information on support for NLBs, see link:https://kubernetes.io/docs/concepts/services-networking/service/#aws-nlb-support[Network Load Balancer support on AWS].
+* For more information on proxy protocol support for CLBs, see link:https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/enable-proxy-protocol.html[Configure proxy protocol support for your Classic Load Balancer]
