Merge pull request #70387 from xenolinux/ALBO-improv

OSDOCS#9377: AWS Load Balancer Operator: Content Improvement

Author: mburke5678

_topic_maps/_topic_map.yml

@@ -1356,11 +1356,11 @@ Topics:
     File: understanding-aws-load-balancer-operator
   - Name: Installing the AWS Load Balancer Operator
     File: install-aws-load-balancer-operator
-  - Name: Installing the AWS Load Balancer Operator on a Security Token Service cluster
+  - Name: Installing the AWS Load Balancer Operator on a cluster using the AWS Security Token Service (STS)
     File: installing-albo-sts-cluster
   - Name: Creating an instance of the AWS Load Balancer Controller
     File: create-instance-aws-load-balancer-controller
-  - Name: Serving Multiple Ingresses through a single AWS Load Balancer
+  - Name: Serving multiple ingress resources through a single AWS Load Balancer
     File: multiple-ingress-through-single-alb
   - Name: Adding TLS termination on the AWS Load Balancer
     File: add-tls-termination

modules/adding-tls-termination.adoc

@@ -14,8 +14,9 @@ You can route the traffic for the domain to pods of a service and add TLS termin
 
 .Procedure
 
-. Install the Operator and create an instance of the `aws-load-balancer-controller` resource:
+. Create a YAML file that defines the `AWSLoadBalancerController` resource:
 +
+.Example `add-tls-termination-albc.yaml` file
 [source,yaml]
 ----
 apiVersion: networking.olm.openshift.io/v1
@@ -26,10 +27,11 @@ spec:
   subnetTagging: Auto
   ingressClass: tls-termination <1>
 ----
-<1> Defines the name of an `ingressClass` resource reconciled by the AWS Load Balancer Controller. This `ingressClass` resource gets created if it is not present. You can add additional `ingressClass` values. The controller reconciles the `ingressClass` values if the `spec.controller` is set to `ingress.k8s.aws/alb`.
+<1> Defines the ingress class name. If the ingress class is not present in your cluster the AWS Load Balancer Controller creates one. The AWS Load Balancer Controller reconciles the additional ingress class values if `spec.controller` is set to `ingress.k8s.aws/alb`.
 
-. Create an `Ingress` resource:
+. Create a YAML file that defines the `Ingress` resource:
 +
+.Example `add-tls-termination-ingress.yaml` file
 [source,yaml]
 ----
 apiVersion: networking.k8s.io/v1
@@ -53,9 +55,9 @@ spec:
                 port:
                   number: 80
 ----
-<1> Specifies the name of an ingress.
-<2> The controller provisions the load balancer for this `Ingress` resource in a public subnet so that the load balancer is reachable over the internet.
-<3> The Amazon Resource Name of the certificate that you attach to the load balancer.
+<1> Specifies the ingress name.
+<2> The controller provisions the load balancer for ingress in a public subnet to access the load balancer over the internet.
+<3> The Amazon Resource Name (ARN) of the certificate that you attach to the load balancer.
 <4> Defines the ingress class name.
 <5> Defines the domain for traffic routing.
 <6> Defines the service for traffic routing.

modules/configuring-egress-proxy.adoc

@@ -4,9 +4,9 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="nw-configuring-cluster-wide-proxy_{context}"]
-= Configuring the AWS Load Balancer Operator to trust the certificate authority of the cluster-wide proxy
+= Trusting the certificate authority of the cluster-wide proxy
 
-. Create the config map to contain the certificate authority (CA) bundle in the `aws-load-balancer-operator` namespace and inject a CA bundle that is trusted by {product-title} into a config map by running the following command:
+. Create the config map to contain the certificate authority (CA) bundle in the `aws-load-balancer-operator` namespace by running the following command:
 +
 [source,terminal]
 ----
@@ -20,14 +20,14 @@ $ oc -n aws-load-balancer-operator create configmap trusted-ca
 $ oc -n aws-load-balancer-operator label cm trusted-ca config.openshift.io/inject-trusted-cabundle=true
 ----
 
-. Update the subscription of the AWS Load Balancer Operator to access the config map in the deployment of the AWS Load Balancer Operator by running the following command:
+. Update the AWS Load Balancer Operator subscription to access the config map in the AWS Load Balancer Operator deployment by running the following command:
 +
 [source,terminal]
 ----
 $ oc -n aws-load-balancer-operator patch subscription aws-load-balancer-operator --type='merge' -p '{"spec":{"config":{"env":[{"name":"TRUSTED_CA_CONFIGMAP_NAME","value":"trusted-ca"}],"volumes":[{"name":"trusted-ca","configMap":{"name":"trusted-ca"}}],"volumeMounts":[{"name":"trusted-ca","mountPath":"/etc/pki/tls/certs/albo-tls-ca-bundle.crt","subPath":"ca-bundle.crt"}]}}}'
 ----
 
-. After the deployment of the AWS Load Balancer Operator is completed, verify that the CA bundle is added to the `aws-load-balancer-operator-controller-manager` deployment by running the following command:
+. After the AWS Load Balancer Operator is deployed, verify that the CA bundle is added to the `aws-load-balancer-operator-controller-manager` deployment by running the following command:
 +
 [source,terminal]
 ----
@@ -46,4 +46,4 @@ trusted-ca
 [source,terminal]
 ----
 $ oc -n aws-load-balancer-operator rollout restart deployment/aws-load-balancer-operator-controller-manager
-----
+----

modules/creating-instance-aws-load-balancer-controller.adoc

@@ -4,9 +4,9 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="nw-creating-instance-aws-load-balancer-controller_{context}"]
-= Creating an instance of the AWS Load Balancer Controller using AWS Load Balancer Operator
+= Creating the AWS Load Balancer Controller
 
-You can install only a single instance of the `aws-load-balancer-controller` in a cluster. You can create the AWS Load Balancer Controller by using CLI. The AWS Load Balancer(ALB) Operator reconciles only the resource with the name `cluster`.
+You can install only a single instance of the `AWSLoadBalancerController` object in a cluster. You can create the AWS Load Balancer Controller by using CLI. The AWS Load Balancer Operator reconciles only the `cluster` named resource.
 
 .Prerequisites
 
@@ -15,8 +15,9 @@ You can install only a single instance of the `aws-load-balancer-controller` in
 
 .Procedure
 
-. Create an `aws-load-balancer-controller` resource YAML file, for example, `sample-aws-lb.yaml`, as follows:
+. Create a YAML file that defines the `AWSLoadBalancerController` object:
 +
+.Example `sample-aws-lb.yaml` file
 [source,yaml]
 ----
 apiVersion: networking.olm.openshift.io/v1
@@ -34,24 +35,27 @@ spec:
   enabledAddons: <7>
     - AWSWAFv2 <8>
 ----
-<1> Defines the `aws-load-balancer-controller` resource.
-<2> Defines the AWS Load Balancer Controller instance name. This instance name gets added as a suffix to all related resources.
-<3> Valid options are `Auto` and `Manual`. When the value is set to `Auto`, the Operator attempts to determine the subnets that belong to the cluster and tags them appropriately. The Operator cannot determine the role correctly if the internal subnet tags are not present on internal subnet. If you installed your cluster on user-provided infrastructure, you can manually tag the subnets with the appropriate role tags and set the subnet tagging policy to `Manual`.
-<4> Defines the tags used by the controller when it provisions AWS resources.
-<5> The default value for this field is `alb`. The Operator provisions an `IngressClass` resource with the same name if it does not exist.
-<6> Specifies the number of replicas of the controller.
-<7> Specifies add-ons for AWS load balancers, which get specified through annotations.
+<1> Defines the `AWSLoadBalancerController` object.
+<2> Defines the AWS Load Balancer Controller name. This instance name gets added as a suffix to all related resources.
+<3> Configures the subnet tagging method for the AWS Load Balancer Controller. The following values are valid:
+* `Auto`: The AWS Load Balancer Operator determines the subnets that belong to the cluster and tags them appropriately. The Operator cannot determine the role correctly if the internal subnet tags are not present on internal subnet.
+* `Manual`: You manually tag the subnets that belong to the cluster with the appropriate role tags. Use this option if you installed your cluster on user-provided infrastructure.
+<4> Defines the tags used by the AWS Load Balancer Controller when it provisions AWS resources.
+<5> Defines the ingress class name. The default value is `alb`.
+<6> Specifies the number of replicas of the AWS Load Balancer Controller.
+<7> Specifies annotations as an add-on for the AWS Load Balancer Controller.
 <8> Enables the `alb.ingress.kubernetes.io/wafv2-acl-arn` annotation.
 
-. Create a `aws-load-balancer-controller` resource by running the following command:
+. Create the `AWSLoadBalancerController` object by running the following command:
 +
 [source,terminal]
 ----
 $ oc create -f sample-aws-lb.yaml
 ----
 
-. After the AWS Load Balancer Controller is running, create a `deployment` resource:
+. Create a YAML file that defines the `Deployment` resource:
 +
+.Example `sample-aws-lb.yaml` file
 [source,yaml]
 ----
 apiVersion: apps/v1
@@ -85,8 +89,9 @@ spec:
 <2> Specifies the deployment name.
 <3> Specifies the number of replicas of the deployment.
 
-. Create a `service` resource:
+. Create a YAML file that defines the `Service` resource:
 +
+.Example `service-albo.yaml` file:
 [source,yaml]
 ----
 apiVersion: v1
@@ -104,16 +109,17 @@ spec:
     app: echoserver
 ----
 <1> Defines the service resource.
-<2> Specifies the name of the service.
+<2> Specifies the service name.
 
-. Deploy an ALB-backed `Ingress` resource:
+. Create a YAML file that defines the `Ingress` resource:
 +
+.Example `ingress-albo.yaml` file:
 [source,yaml]
 ----
 apiVersion: networking.k8s.io/v1
-kind: Ingress <1>
+kind: Ingress
 metadata:
-  name: <echoserver> <2>
+  name: <name> <1>
   namespace: echoserver
   annotations:
     alb.ingress.kubernetes.io/scheme: internet-facing
@@ -127,24 +133,23 @@ spec:
             pathType: Exact
             backend:
               service:
-                name: <echoserver> <3>
+                name: <echoserver> <2>
                 port:
                   number: 80
 ----
-<1> Defines the ingress resource.
-<2> Specifies the name of the ingress resource.
-<3> Specifies the name of the service resource.
+<1> Specify a name for the `Ingress` resource.
+<2> Specifies the service name.
 
 .Verification
 
-* Verify the status of the `Ingress` resource to show the host of the provisioned AWS Load Balancer (ALB) by running the following command:
+* Save the status of the `Ingress` resource in the `HOST` variable by running the following command:
 +
 [source,terminal]
 ----
 $ HOST=$(oc get ingress -n echoserver echoserver --template='{{(index .status.loadBalancer.ingress 0).hostname}}')
 ----
 
-* Verify the status of the provisioned AWS Load Balancer (ALB) host by running the following command:
+* Verify the status of the `Ingress` resource by running the following command:
 +
 [source,terminal]
 ----

modules/creating-multiple-ingress-through-single-alb.adoc

@@ -4,9 +4,9 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="nw-creating-multiple-ingress-through-single-alb_{context}"]
-= Creating multiple ingresses through a single AWS Load Balancer
+= Creating multiple ingress resources through a single AWS Load Balancer
 
-You can route the traffic to multiple Ingresses through a single AWS Load Balancer (ALB) by using the CLI.
+You can route the traffic to multiple ingress resources through a single AWS Load Balancer by using the CLI.
 
 .Prerequisites
 
@@ -27,17 +27,17 @@ spec:
     name: single-lb <3>
 ----
 <1> Defines the API group and version of the `IngressClassParams` resource.
-<2> Specifies the name of the `IngressClassParams` resource.
-<3> Specifies the name of the `IngressGroup`. All Ingresses of this class belong to this `IngressGroup`.
+<2> Specifies the `IngressClassParams` resource name.
+<3> Specifies the `IngressGroup` resource name. All of the `Ingress` resources of this class belong to this `IngressGroup`.
 
-. Create an `IngressClassParams` resource by running the following command:
+. Create the `IngressClassParams` resource by running the following command:
 +
 [source,terminal]
 ----
 $ oc create -f sample-single-lb-params.yaml
 ----
 
-. Create an `IngressClass` resource YAML file, for example, `sample-single-lb-class.yaml`, as follows:
+. Create the `IngressClass` resource YAML file, for example, `sample-single-lb-class.yaml`, as follows:
 +
 [source,yaml]
 ----
@@ -53,20 +53,20 @@ spec:
     name: single-lb-params <6>
 ----
 <1> Defines the API group and version of the `IngressClass` resource.
-<2> Specifies the name of the `IngressClass`.
-<3> Defines the controller name. `ingress.k8s.aws/alb` denotes that all Ingresses of this class should be managed by the `aws-load-balancer-controller`.
+<2> Specifies the ingress class name.
+<3> Defines the controller name. The `ingress.k8s.aws/alb` value denotes that all ingress resources of this class should be managed by the AWS Load Balancer Controller.
 <4> Defines the API group of the `IngressClassParams` resource.
 <5> Defines the resource type of the `IngressClassParams` resource.
-<6> Defines the name of the `IngressClassParams` resource.
+<6> Defines the `IngressClassParams` resource name.
 
-. Create an `IngressClass` resource by running the following command:
+. Create the `IngressClass` resource by running the following command:
 +
 [source,terminal]
 ----
 $ oc create -f sample-single-lb-class.yaml
 ----
 
-. Create an `AWSLoadBalancerController` resource YAML file, for example, `sample-single-lb.yaml`, as follows:
+. Create the `AWSLoadBalancerController` resource YAML file, for example, `sample-single-lb.yaml`, as follows:
 +
 [source,yaml]
 ----
@@ -80,14 +80,14 @@ spec:
 ----
 <1> Defines the name of the `IngressClass` resource.
 
-. Create an `AWSLoadBalancerController` resource by running the following command:
+. Create the `AWSLoadBalancerController` resource by running the following command:
 +
 [source,terminal]
 ----
 $ oc create -f sample-single-lb.yaml
 ----
 
-. Create an `Ingress` resource YAML file, for example, `sample-multiple-ingress.yaml`, as follows:
+. Create the `Ingress` resource YAML file, for example, `sample-multiple-ingress.yaml`, as follows:
 +
 [source,yaml]
 ----
@@ -157,17 +157,17 @@ spec:
               port:
                 number: 80
 ----
-<1> Specifies the name of an ingress.
-<2> Indicates the load balancer to provision in the public subnet and makes it accessible over the internet.
-<3> Specifies the order in which the rules from the Ingresses are matched when the request is received at the load balancer.
-<4> Indicates the load balancer will target OpenShift nodes to reach the service.
-<5> Specifies the Ingress Class that belongs to this ingress.
-<6> Defines the name of a domain used for request routing.
+<1> Specifies the ingress name.
+<2> Indicates the load balancer to provision in the public subnet to access the internet.
+<3> Specifies the order in which the rules from the multiple ingress resources are matched when the request is received at the load balancer.
+<4> Indicates that the load balancer will target {product-title} nodes to reach the service.
+<5> Specifies the ingress class that belongs to this ingress.
+<6> Defines a domain name used for request routing.
 <7> Defines the path that must route to the service.
-<8> Defines the name of the service that serves the endpoint configured in the ingress.
+<8> Defines the service name that serves the endpoint configured in the `Ingress` resource.
 <9> Defines the port on the service that serves the endpoint.
 
-. Create the `Ingress` resources by running the following command:
+. Create the `Ingress` resource by running the following command:
 +
 [source,terminal]
 ----

modules/nw-aws-load-balancer-logs.adoc

@@ -5,11 +5,11 @@
 [id="nw-aws-load-balancer-operator-logs_{context}"]
 = AWS Load Balancer Operator logs
 
-Use the `oc logs` command to view the AWS Load Balancer Operator logs.
+You can view the AWS Load Balancer Operator logs by using the `oc logs` command.
 
 .Procedure
 
-* View the logs of the AWS Load Balancer Operator:
+* View the logs of the AWS Load Balancer Operator by running the following command:
 +
 [source,terminal]
 ----

modules/nw-aws-load-balancer-operator-considerations.adoc

@@ -5,8 +5,8 @@
 [id="nw-aws-load-balancer-operator-considerations_{context}"]
 = AWS Load Balancer Operator considerations
 
-Review the following limitations before installing and using the AWS Load Balancer Operator.
+Review the following limitations before installing and using the AWS Load Balancer Operator:
 
 * The IP traffic mode only works on AWS Elastic Kubernetes Service (EKS). The AWS Load Balancer Operator disables the IP traffic mode for the AWS Load Balancer Controller. As a result of disabling the IP traffic mode, the AWS Load Balancer Controller cannot use the pod readiness gate.
 
-* The AWS Load Balancer Operator adds command-line flags such as `--disable-ingress-class-annotation` and `--disable-ingress-group-name-annotation` to the AWS Load Balancer Controller. Therefore, the AWS Load Balancer Operator does not allow using the `kubernetes.io/ingress.class` and `alb.ingress.kubernetes.io/group.name` annotations in the `Ingress` resource.
+* The AWS Load Balancer Operator adds command-line flags such as `--disable-ingress-class-annotation` and `--disable-ingress-group-name-annotation` to the AWS Load Balancer Controller. Therefore, the AWS Load Balancer Operator does not allow using the `kubernetes.io/ingress.class` and `alb.ingress.kubernetes.io/group.name` annotations in the `Ingress` resource.

modules/nw-aws-load-balancer-operator.adoc

@@ -5,7 +5,7 @@
 [id="nw-aws-load-balancer-operator_{context}"]
 = AWS Load Balancer Operator
 
-The AWS Load Balancer Operator can tag the public subnets if the `kubernetes.io/role/elb` tag is missing. Also, the AWS Load Balancer Operator detects the following from the underlying AWS cloud:
+The AWS Load Balancer Operator can tag the public subnets if the `kubernetes.io/role/elb` tag is missing. Also, the AWS Load Balancer Operator detects the following information from the underlying AWS cloud:
 
 * The ID of the virtual private cloud (VPC) on which the cluster hosting the Operator is deployed in.
 
@@ -15,7 +15,7 @@ The AWS Load Balancer Operator supports the Kubernetes service resource of type
 
 .Procedure
 
-. You can deploy the AWS Load Balancer Operator on demand from the OperatorHub, by creating a `Subscription` object:
+. You can deploy the AWS Load Balancer Operator on demand from OperatorHub, by creating a `Subscription` object by running the following command:
 +
 [source,terminal]
 ----
@@ -28,7 +28,7 @@ $ oc -n aws-load-balancer-operator get sub aws-load-balancer-operator --template
 install-zlfbt
 ----
 
-. Check the status of an install plan. The status of an install plan must be `Complete`:
+. Check if the status of an install plan is `Complete` by running the following command:
 +
 [source,terminal]
 ----
@@ -41,7 +41,7 @@ $ oc -n aws-load-balancer-operator get ip <install_plan_name> --template='{{.sta
 Complete
 ----
 
-. Use the `oc get` command to view the `Deployment` status:
+. View the status of the `aws-load-balancer-operator-controller-manager` deployment by running the following command:
 +
 [source,terminal]
 ----