Merge pull request #48717 from xenolinux/understanding-ALB-Operator

Adds the understanding AWS Load Balancer Operator page

Author: mburke5678

_topic_maps/_topic_map.yml

@@ -1047,6 +1047,8 @@ Topics:
   Dir: aws_load_balancer_operator
   Distros: openshift-enterprise,openshift-origin
   Topics:
+  - Name: Understanding the AWS Load Balancer Operator
+    File: understanding-aws-load-balancer-operator  
   - Name: Installing the AWS Load Balancer Operator
     File: install-aws-load-balancer-operator
   - Name: Creating an instance of the AWS Load Balancer Controller

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

@@ -0,0 +1,17 @@
+// Module included in the following assemblies:
+// * networking/aws_load_balancer_operator/understanding-aws-load-balancer-operator.adoc
+
+:_content-type: PROCEDURE
+[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.
+
+.Procedure
+
+* View the logs of the AWS Load Balancer Operator:
++
+[source,terminal]
+----
+$ oc logs -n aws-load-balancer-operator deployment/aws-load-balancer-operator-controller-manager -c manager
+----

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

@@ -0,0 +1,58 @@
+// Module included in the following assemblies:
+// * networking/aws_load_balancer_operator/understanding-aws-load-balancer-operator.adoc
+
+:_content-type: PROCEDURE
+[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 ID of the virtual private cloud (VPC) on which the cluster hosting the Operator is deployed in.
+
+* Public and private subnets of the discovered VPC.
+
+.Prerequisites
+
+* You must have the AWS credentials secret. The credentials are used to provide subnet tagging and VPC discovery.
+
+.Procedure
+
+. You can deploy the AWS Load Balancer Operator on demand from the OperatorHub, by creating a `Subscription` object:
++
+[source,terminal]
+----
+$ oc -n aws-load-balancer-operator get sub aws-load-balancer-operator --template='{{.status.installplan.name}}{{"\n"}}'
+----
++
+.Example output
+[source,terminal]
+----
+install-zlfbt
+----
+
+. Check the status of an install plan. The status of an install plan must be `Complete`:
++
+[source,terminal]
+----
+$ oc -n aws-load-balancer-operator get ip <install_plan_name> --template='{{.status.phase}}{{"\n"}}'
+----
++
+.Example output
+[source,terminal]
+----
+Complete
+----
+
+. Use the `oc get` command to view the `Deployment` status:
++
+[source,terminal]
+----
+$ oc get -n aws-load-balancer-operator deployment/aws-load-balancer-operator-controller-manager
+----
++
+.Example output
+[source,terminal]
+----
+NAME                                           READY     UP-TO-DATE   AVAILABLE   AGE
+aws-load-balancer-operator-controller-manager  1/1       1            1           23h
+----

networking/aws_load_balancer_operator/understanding-aws-load-balancer-operator.adoc

@@ -0,0 +1,13 @@
+:_content-type: ASSEMBLY
+[id="aws-load-balancer-operator"]
+= AWS Load Balancer Operator in {product-title}
+include::_attributes/common-attributes.adoc[]
+:context: aws-load-balancer-operator
+
+toc::[]
+
+The AWS Load Balancer (ALB) Operator deploys and manages an instance of the `aws-load-balancer-controller`. You can install the ALB Operator from the OperatorHub by using {product-title} web console or CLI.
+
+include::modules/nw-aws-load-balancer-operator.adoc[leveloffset=+1]
+
+include::modules/nw-aws-load-balancer-logs.adoc[leveloffset=+1]