From 13e78c2b320570037fd9f41ea46dd9ce69f403bd Mon Sep 17 00:00:00 2001 From: Jessi Manthei Date: Tue, 10 Dec 2024 14:01:33 -0600 Subject: [PATCH] OSDOCS-12759 the ALBO docs restructure --- _topic_maps/_topic_map.yml | 14 ++++--------- .../ipi/installing-aws-outposts.adoc | 2 +- modules/adding-tls-termination.adoc | 6 +++--- modules/configuring-egress-proxy.adoc | 4 +++- ...instance-aws-load-balancer-controller.adoc | 2 +- ...g-multiple-ingress-through-single-alb.adoc | 4 ++-- modules/specifying-role-arn-albo-sts.adoc | 2 +- ...ws-cli-create-iam-role-alb-controller.adoc | 2 +- ...-aws-cli-create-iam-role-alb-operator.adoc | 2 +- ...ccoctl-create-iam-role-alb-controller.adoc | 2 +- ...g-ccoctl-create-iam-role-alb-operator.adoc | 2 +- ...onfiguring-aws-load-balancer-operator.adoc | 21 +++++++++++++++++++ .../install-aws-load-balancer-operator.adoc | 4 +++- ...oc => preparing-sts-cluster-for-albo.adoc} | 4 ++-- ...erstanding-aws-load-balancer-operator.adoc | 4 +--- 15 files changed, 46 insertions(+), 29 deletions(-) create mode 100644 networking/networking_operators/aws_load_balancer_operator/configuring-aws-load-balancer-operator.adoc rename networking/networking_operators/aws_load_balancer_operator/{installing-albo-sts-cluster.adoc => preparing-sts-cluster-for-albo.adoc} (95%) diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 37305c0705..6a0ce3b44e 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -1348,18 +1348,12 @@ Topics: File: aws-load-balancer-operator-release-notes - Name: AWS Load Balancer Operator in OpenShift Container Platform File: understanding-aws-load-balancer-operator + - Name: Preparing an AWS STS cluster for the AWS Load Balancer Operator + File: preparing-sts-cluster-for-albo - Name: Installing the AWS Load Balancer Operator File: install-aws-load-balancer-operator - - Name: Installing the AWS Load Balancer Operator on a cluster that uses AWS 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 ingress resources through a single AWS Load Balancer - File: multiple-ingress-through-single-alb - - Name: Adding TLS termination - File: add-tls-termination - - Name: Configuring cluster-wide proxy - File: configure-egress-proxy-aws-load-balancer-operator + - Name: Configuring the AWS Load Balancer Operator + File: configuring-aws-load-balancer-operator - Name: eBPF manager Operator Dir: ebpf_manager Topics: diff --git a/installing/installing_aws/ipi/installing-aws-outposts.adoc b/installing/installing_aws/ipi/installing-aws-outposts.adoc index bc40359a97..cae0d040a7 100644 --- a/installing/installing_aws/ipi/installing-aws-outposts.adoc +++ b/installing/installing_aws/ipi/installing-aws-outposts.adoc @@ -81,7 +81,7 @@ include::modules/nw-aws-load-balancer-with-outposts.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../../../networking/networking_operators/aws_load_balancer_operator/create-instance-aws-load-balancer-controller.adoc#create-instance-aws-load-balancer-controller_create-instance-aws-load-balancer-controller[Creating an instance of the AWS Load Balancer Controller] +* xref:../../../networking/networking_operators/aws_load_balancer_operator/install-aws-load-balancer-operator.adoc#nw-creating-instance-aws-load-balancer-controller_aws-load-balancer-operator[Creating the AWS Load Balancer Controller] [role="_additional-resources"] [id="additional-installing-aws-outposts"] diff --git a/modules/adding-tls-termination.adoc b/modules/adding-tls-termination.adoc index 1482ec8a48..b9d9529c0d 100644 --- a/modules/adding-tls-termination.adoc +++ b/modules/adding-tls-termination.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * networking/aws_load_balancer_operator/add-tls-termination.adoc +// * networking/networking_operators/aws_load_balancer_operator/configuring-aws-load-balancer-operator.adoc :_mod-docs-content-type: PROCEDURE [id="nw-adding-tls-termination_{context}"] @@ -44,14 +44,14 @@ metadata: spec: ingressClassName: tls-termination <4> rules: - - host: <5> + - host: example.com <5> http: paths: - path: / pathType: Exact backend: service: - name: <6> + name: <6> port: number: 80 ---- diff --git a/modules/configuring-egress-proxy.adoc b/modules/configuring-egress-proxy.adoc index b71f41c80e..629820a0f2 100644 --- a/modules/configuring-egress-proxy.adoc +++ b/modules/configuring-egress-proxy.adoc @@ -1,11 +1,13 @@ // Module included in the following assemblies: // -// * networking/aws_load_balancer_operator/configure-egress-proxy-aws-load-balancer-operator.adoc +// * networking/networking-operators/aws_load_balancer_operator/configuring-aws-load-balancer-operator/configure-egress-proxy-aws-load-balancer-operator.adoc :_mod-docs-content-type: PROCEDURE [id="nw-configuring-cluster-wide-proxy_{context}"] = Trusting the certificate authority of the cluster-wide proxy +You can configure the cluster-wide proxy in the AWS Load Balancer Operator. After configuring the cluster-wide proxy, Operator Lifecycle Manager (OLM) automatically updates all the deployments of the Operators with the environment variables such as `HTTP_PROXY`, `HTTPS_PROXY`, and `NO_PROXY`. These variables are populated to the managed controller by the AWS Load Balancer Operator. + . 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] diff --git a/modules/creating-instance-aws-load-balancer-controller.adoc b/modules/creating-instance-aws-load-balancer-controller.adoc index 5206b3019e..3e88c84075 100644 --- a/modules/creating-instance-aws-load-balancer-controller.adoc +++ b/modules/creating-instance-aws-load-balancer-controller.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * networking/aws_load_balancer_operator/create-instance-aws-load-balancer-controller.adoc +// * networking/networking_operators/aws_load_balancer_operator/create-instance-aws-load-balancer-controller.adoc :_mod-docs-content-type: PROCEDURE [id="nw-creating-instance-aws-load-balancer-controller_{context}"] diff --git a/modules/creating-multiple-ingress-through-single-alb.adoc b/modules/creating-multiple-ingress-through-single-alb.adoc index d44c0d2ab3..3a4e79149a 100644 --- a/modules/creating-multiple-ingress-through-single-alb.adoc +++ b/modules/creating-multiple-ingress-through-single-alb.adoc @@ -1,12 +1,12 @@ // Module included in the following assemblies: // -// * networking/aws_load_balancer_operator/multiple-ingress-through-single-alb.adoc +// * networking/networking-operators/aws_load_balancer_operator/configuring-aws-load-balancer-operator/multiple-ingress-through-single-alb.adoc :_mod-docs-content-type: PROCEDURE [id="nw-creating-multiple-ingress-through-single-alb_{context}"] = Creating multiple ingress resources through a single AWS Load Balancer -You can route the traffic to multiple ingress resources through a single AWS Load Balancer by using the CLI. +You can route the traffic to different services with multiple ingress resources that are part of a single domain through a single AWS Load Balancer. Each Ingress resource provides different endpoints of the domain. .Prerequisites diff --git a/modules/specifying-role-arn-albo-sts.adoc b/modules/specifying-role-arn-albo-sts.adoc index 3e5c090df9..56b6a5ee8a 100644 --- a/modules/specifying-role-arn-albo-sts.adoc +++ b/modules/specifying-role-arn-albo-sts.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * networking/installing-albo-sts-cluster.adoc +// * networking/networking_operators/aws-load-balancer-operator/preparing-sts-cluster-for-albo.adoc :_mod-docs-content-type: PROCEDURE [id="specifying-role-arn-albo-sts_{context}"] diff --git a/modules/using-aws-cli-create-iam-role-alb-controller.adoc b/modules/using-aws-cli-create-iam-role-alb-controller.adoc index 795fdf637e..c3fccfa3b2 100644 --- a/modules/using-aws-cli-create-iam-role-alb-controller.adoc +++ b/modules/using-aws-cli-create-iam-role-alb-controller.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * networking/installing-albo-sts-cluster.adoc +// * networking/networking_operators/aws-load-balancer-operator/preparing-sts-cluster-for-albo.adoc :_mod-docs-content-type: PROCEDURE [id="using-aws-cli-create-iam-role-alb-controller_{context}"] diff --git a/modules/using-aws-cli-create-iam-role-alb-operator.adoc b/modules/using-aws-cli-create-iam-role-alb-operator.adoc index 743a0b770d..fda3c900a4 100644 --- a/modules/using-aws-cli-create-iam-role-alb-operator.adoc +++ b/modules/using-aws-cli-create-iam-role-alb-operator.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * networking/installing-albo-sts-cluster.adoc +// * networking/networking_operators/aws-load-balancer-operator/preparing-sts-cluster-for-albo.adoc :_mod-docs-content-type: PROCEDURE [id="using-aws-cli-create-iam-role-alb-operator_{context}"] diff --git a/modules/using-ccoctl-create-iam-role-alb-controller.adoc b/modules/using-ccoctl-create-iam-role-alb-controller.adoc index e86682cc1c..86f82903d3 100644 --- a/modules/using-ccoctl-create-iam-role-alb-controller.adoc +++ b/modules/using-ccoctl-create-iam-role-alb-controller.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * networking/installing-albo-sts-cluster.adoc +// * networking/networking_operators/aws-load-balancer-operator/preparing-sts-cluster-for-albo.adoc :_mod-docs-content-type: PROCEDURE [id="using-ccoctl-create-iam-role-alb-controller_{context}"] diff --git a/modules/using-ccoctl-create-iam-role-alb-operator.adoc b/modules/using-ccoctl-create-iam-role-alb-operator.adoc index e6a6182ac2..348c942ae8 100644 --- a/modules/using-ccoctl-create-iam-role-alb-operator.adoc +++ b/modules/using-ccoctl-create-iam-role-alb-operator.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * networking/installing-albo-sts-cluster.adoc +// * networking/networking_operators/preparing-sts-cluster-for-albo.adoc :_mod-docs-content-type: PROCEDURE [id="using-ccoctl-create-iam-role-alb-operator_{context}"] diff --git a/networking/networking_operators/aws_load_balancer_operator/configuring-aws-load-balancer-operator.adoc b/networking/networking_operators/aws_load_balancer_operator/configuring-aws-load-balancer-operator.adoc new file mode 100644 index 0000000000..87c912105f --- /dev/null +++ b/networking/networking_operators/aws_load_balancer_operator/configuring-aws-load-balancer-operator.adoc @@ -0,0 +1,21 @@ +:_mod-docs-content-type: ASSEMBLY +[id="configuring-aws-load-balancer-operator"] += Configuring the AWS Load Balancer Operator +include::_attributes/common-attributes.adoc[] +:context: aws-load-balancer-operator + +toc::[] + +include::modules/configuring-egress-proxy.adoc[leveloffset=+1] + +[role="_additional-resources"] +[id="additional-resources_{context}"] +== Additional resources + +* xref:../../../networking/configuring-a-custom-pki.adoc#certificate-injection-using-operators_configuring-a-custom-pki[Certificate injection using Operators] + +include::modules/adding-tls-termination.adoc[leveloffset=+1] + +include::modules/creating-multiple-ingress-through-single-alb.adoc[leveloffset=+1] + +include::modules/nw-aws-load-balancer-logs.adoc[leveloffset=+1] \ No newline at end of file diff --git a/networking/networking_operators/aws_load_balancer_operator/install-aws-load-balancer-operator.adoc b/networking/networking_operators/aws_load_balancer_operator/install-aws-load-balancer-operator.adoc index bdf63880b0..ade40ec13a 100644 --- a/networking/networking_operators/aws_load_balancer_operator/install-aws-load-balancer-operator.adoc +++ b/networking/networking_operators/aws_load_balancer_operator/install-aws-load-balancer-operator.adoc @@ -1,5 +1,5 @@ :_mod-docs-content-type: ASSEMBLY -[id="nw-aws-load-balancer-operator"] +[id="install-aws-load-balancer-operator"] = Installing the AWS Load Balancer Operator include::_attributes/common-attributes.adoc[] :context: aws-load-balancer-operator @@ -11,3 +11,5 @@ The AWS Load Balancer Operator deploys and manages the AWS Load Balancer Control include::modules/installing-aws-load-balancer-operator.adoc[leveloffset=+1] include::modules/installing-aws-load-balancer-operator-cli.adoc[leveloffset=+1] + +include::modules/creating-instance-aws-load-balancer-controller.adoc[leveloffset=+1] \ No newline at end of file diff --git a/networking/networking_operators/aws_load_balancer_operator/installing-albo-sts-cluster.adoc b/networking/networking_operators/aws_load_balancer_operator/preparing-sts-cluster-for-albo.adoc similarity index 95% rename from networking/networking_operators/aws_load_balancer_operator/installing-albo-sts-cluster.adoc rename to networking/networking_operators/aws_load_balancer_operator/preparing-sts-cluster-for-albo.adoc index 9059bce70d..ea818a9d01 100644 --- a/networking/networking_operators/aws_load_balancer_operator/installing-albo-sts-cluster.adoc +++ b/networking/networking_operators/aws_load_balancer_operator/preparing-sts-cluster-for-albo.adoc @@ -1,7 +1,7 @@ :_mod-docs-content-type: ASSEMBLY include::_attributes/common-attributes.adoc[] [id="albo-sts-cluster"] -= Installing the AWS Load Balancer Operator on a cluster that uses AWS STS += Preparing an AWS STS cluster for the AWS Load Balancer Operator :context: albo-sts-cluster toc::[] @@ -28,7 +28,7 @@ $ oc get infrastructure cluster -o=jsonpath="{.status.infrastructureName}" ---- $ oc get authentication.config cluster -o=jsonpath="{.spec.serviceAccountIssuer}" <1> ---- -<1> An OIDC DNS example is `https://rh-oidc.s3.us-east-1.amazonaws.com/28292va7ad7mr9r4he1fb09b14t59t4f`. +<1> An OIDC DNS example is `\https://rh-oidc.s3.us-east-1.amazonaws.com/28292va7ad7mr9r4he1fb09b14t59t4f`. * You logged into the {aws-short} Web Console, navigated to *IAM* -> *Access management* -> *Identity providers*, and located the OIDC Amazon Resource Name (ARN) information. An OIDC ARN example is `arn:aws:iam::777777777777:oidc-provider/`. diff --git a/networking/networking_operators/aws_load_balancer_operator/understanding-aws-load-balancer-operator.adoc b/networking/networking_operators/aws_load_balancer_operator/understanding-aws-load-balancer-operator.adoc index c2a06b72a6..f09096d2fc 100644 --- a/networking/networking_operators/aws_load_balancer_operator/understanding-aws-load-balancer-operator.adoc +++ b/networking/networking_operators/aws_load_balancer_operator/understanding-aws-load-balancer-operator.adoc @@ -12,6 +12,4 @@ include::modules/nw-aws-load-balancer-operator-considerations.adoc[leveloffset=+ include::modules/nw-aws-load-balancer-operator.adoc[leveloffset=+1] -include::modules/nw-aws-load-balancer-with-outposts.adoc[leveloffset=+1] - -include::modules/nw-aws-load-balancer-logs.adoc[leveloffset=+1] +include::modules/nw-aws-load-balancer-with-outposts.adoc[leveloffset=+1] \ No newline at end of file