From 13f918bec8000f52ae2d9a6077ab044a9b412d4c Mon Sep 17 00:00:00 2001 From: dfitzmau Date: Fri, 8 Nov 2024 15:39:28 +0000 Subject: [PATCH] OSDOCS-12303-restructure: Restructure the Networking docs for Operators OSDOCS-12303-int-18: Cherry pick for OSDOCS-12303-restructure --- _topic_maps/_topic_map.yml | 104 ++++++++++++++---- _topic_maps/_topic_map_osd.yml | 8 ++ _topic_maps/_topic_map_rosa.yml | 14 ++- .../aws-compute-edge-zone-tasks.adoc | 2 +- .../ipi/installing-aws-outposts.adoc | 2 +- .../_attributes | 0 .../aws-load-balancer-operator.adoc | 0 .../aws_load_balancer_operator/_attributes | 1 + .../add-tls-termination.adoc | 0 ...-load-balancer-operator-release-notes.adoc | 2 +- ...ress-proxy-aws-load-balancer-operator.adoc | 2 +- ...instance-aws-load-balancer-controller.adoc | 0 .../aws_load_balancer_operator/images | 0 .../install-aws-load-balancer-operator.adoc | 0 .../installing-albo-sts-cluster.adoc | 6 +- .../aws_load_balancer_operator/modules | 0 .../multiple-ingress-through-single-alb.adoc | 0 .../aws_load_balancer_operator/snippets | 0 ...erstanding-aws-load-balancer-operator.adoc | 0 networking/networking_operators/images | 1 + networking/networking_operators/modules | 1 + networking/networking_operators/snippets | 1 + release_notes/addtl-release-notes.adoc | 2 +- 23 files changed, 116 insertions(+), 30 deletions(-) rename networking/{aws_load_balancer_operator => networking_operators}/_attributes (100%) rename networking/{ => networking_operators}/aws-load-balancer-operator.adoc (100%) create mode 120000 networking/networking_operators/aws_load_balancer_operator/_attributes rename networking/{ => networking_operators}/aws_load_balancer_operator/add-tls-termination.adoc (100%) rename networking/{ => networking_operators}/aws_load_balancer_operator/aws-load-balancer-operator-release-notes.adoc (96%) rename networking/{ => networking_operators}/aws_load_balancer_operator/configure-egress-proxy-aws-load-balancer-operator.adoc (81%) rename networking/{ => networking_operators}/aws_load_balancer_operator/create-instance-aws-load-balancer-controller.adoc (100%) rename networking/{ => networking_operators}/aws_load_balancer_operator/images (100%) rename networking/{ => networking_operators}/aws_load_balancer_operator/install-aws-load-balancer-operator.adoc (100%) rename networking/{ => networking_operators}/aws_load_balancer_operator/installing-albo-sts-cluster.adoc (84%) rename networking/{ => networking_operators}/aws_load_balancer_operator/modules (100%) rename networking/{ => networking_operators}/aws_load_balancer_operator/multiple-ingress-through-single-alb.adoc (100%) rename networking/{ => networking_operators}/aws_load_balancer_operator/snippets (100%) rename networking/{ => networking_operators}/aws_load_balancer_operator/understanding-aws-load-balancer-operator.adoc (100%) create mode 120000 networking/networking_operators/images create mode 120000 networking/networking_operators/modules create mode 120000 networking/networking_operators/snippets diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 1874725fe1..5b8d9f8e27 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -1327,6 +1327,90 @@ Topics: File: accessing-hosts - Name: Networking dashboards File: networking-dashboards +- Name: Networking Operators + Dir: networking_operators + Distros: openshift-enterprise,openshift-origin + Topics: + - Name: AWS Load Balancer Operator + Dir: aws_load_balancer_operator + Distros: openshift-enterprise,openshift-origin + Topics: + - Name: AWS Load Balancer Operator release notes + File: aws-load-balancer-operator-release-notes + - 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: 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 on the AWS Load Balancer + File: add-tls-termination + - Name: Configuring cluster-wide proxy on the AWS Load Balancer Operator + File: configure-egress-proxy-aws-load-balancer-operator +# - Name: Understanding the Ingress Node Firewall Operator +# File: ingress-node-firewall-operator +# - Name: eBPF manager Operator +# Dir: ebpf_manager +# Topics: +# - Name: About the eBPF Manager Operator +# File: ebpf-manager-operator-about +# - Name: Installing the eBPF Manager Operator +# File: ebpf-manager-operator-install +# - Name: Deploying an eBPF program +# File: ebpf-manager-operator-deploy +# - Name: Understanding the Cluster Network Operator +# File: cluster-network-operator +# - Name: Understanding the DNS Operator +# File: dns-operator +# - Name: Understanding the Ingress Operator +# File: ingress-operator +# - Name: External DNS Operator +# Dir: external_dns_operator +# Topics: +# - Name: External DNS Operator release notes +# File: external-dns-operator-release-notes +# - Name: Understanding the External DNS Operator +# File: understanding-external-dns-operator +# - Name: Installing the External DNS Operator +# File: nw-installing-external-dns-operator-on-cloud-providers +# - Name: External DNS Operator configuration parameters +# File: nw-configuration-parameters +# - Name: Creating DNS records on a public hosted zone for AWS +# File: nw-creating-dns-records-on-aws +# - Name: Creating DNS records on a public zone for Azure +# File: nw-creating-dns-records-on-azure +# - Name: Creating DNS records on a public managed zone for GCP +# File: nw-creating-dns-records-on-gcp +# - Name: Creating DNS records on a public DNS zone for Infoblox +# File: nw-creating-dns-records-on-infoblox +# - Name: Configuring the cluster-wide proxy on the External DNS Operator +# File: nw-configuring-cluster-wide-egress-proxy +# - Name: SR-IOV Operator +# Dir: sr-iov-operator +# Distros: openshift-enterprise,openshift-origin +# Topics: +# - Name: Installing the SR-IOV Operator +# File: installing-sriov-operator +# - Name: Configuring the SR-IOV Operator +# File: configuring-sriov-operator +# - Name: Uninstalling the SR-IOV Operator +# File: uninstalling-sriov-operator +# - Name: About the Kubernetes NMState Operator +# File: k8s-nmstate-about-the-k8s-nmstate-operator +# - Name: MetalLB Operator +# Dir: metallb-operator +# Distros: openshift-enterprise,openshift-origin +# Topics: +# - Name: About MetalLB and the MetalLB Operator +# File: about-metallb +# - Name: Installing the MetalLB Operator +# File: metallb-operator-install +# - Name: Upgrading the MetalLB Operator +# File: metallb-upgrading-operator - Name: Network security Dir: network_security Distros: openshift-enterprise,openshift-origin @@ -1460,26 +1544,6 @@ Topics: File: nw-configuring-cluster-wide-egress-proxy - Name: CIDR range definitions File: cidr-range-definitions -- Name: AWS Load Balancer Operator - Dir: aws_load_balancer_operator - Distros: openshift-enterprise,openshift-origin - Topics: - - Name: AWS Load Balancer Operator release notes - File: aws-load-balancer-operator-release-notes - - 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: 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 on the AWS Load Balancer - File: add-tls-termination - - Name: Configuring cluster-wide proxy on the AWS Load Balancer Operator - File: configure-egress-proxy-aws-load-balancer-operator - Name: Multiple networks Dir: multiple_networks Distros: openshift-enterprise,openshift-origin diff --git a/_topic_maps/_topic_map_osd.yml b/_topic_maps/_topic_map_osd.yml index 5750730435..204af6282f 100644 --- a/_topic_maps/_topic_map_osd.yml +++ b/_topic_maps/_topic_map_osd.yml @@ -823,6 +823,14 @@ Distros: openshift-dedicated Topics: - Name: About networking File: about-managed-networking +# - Name: Networking Operators +# Dir: networking_operators +# Distros: openshift-dedicated +# Topics: +# - Name: Understanding the DNS Operator +# File: dns-operator +# - Name: Understanding the Ingress Operator +# File: ingress-operator - Name: Understanding the DNS Operator File: dns-operator - Name: Understanding the Ingress Operator diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml index 384772a2f3..63bfd93b5e 100644 --- a/_topic_maps/_topic_map_rosa.yml +++ b/_topic_maps/_topic_map_rosa.yml @@ -1082,12 +1082,22 @@ Distros: openshift-rosa Topics: - Name: About networking File: about-managed-networking +- Name: Networking Operators + Dir: networking_operators + Distros: openshift-rosa + Topics: + - Name: AWS Load Balancer Operator + File: aws-load-balancer-operator + # - Name: Understanding the DNS Operator + # File: dns-operator + # - Name: Understanding the Ingress Operator + # File: ingress-operator + # - Name: Understanding the Ingress Node Firewall Operator + # File: ingress-node-firewall-operator - Name: Understanding the DNS Operator File: dns-operator - Name: Understanding the Ingress Operator File: ingress-operator -- Name: AWS Load Balancer Operator - File: aws-load-balancer-operator - Name: Network verification File: network-verification - Name: Configuring a cluster-wide proxy during installation diff --git a/installing/installing_aws/aws-compute-edge-zone-tasks.adoc b/installing/installing_aws/aws-compute-edge-zone-tasks.adoc index e674d41754..5bcf9e8417 100644 --- a/installing/installing_aws/aws-compute-edge-zone-tasks.adoc +++ b/installing/installing_aws/aws-compute-edge-zone-tasks.adoc @@ -78,4 +78,4 @@ include::modules/installation-extend-edge-nodes-aws-local-zones.adoc[leveloffset [id="next-steps_aws-zone-tasks"] == Next steps -* Optional: Use the AWS Load Balancer (ALB) Operator to expose a pod from a targeted edge compute node to services that run inside of a {zone-type} subnet from a public network. See xref:../../networking/aws_load_balancer_operator/install-aws-load-balancer-operator.adoc#nw-aws-load-balancer-operator[Installing the AWS Load Balancer Operator]. +* Optional: Use the AWS Load Balancer (ALB) Operator to expose a pod from a targeted edge compute node to services that run inside of a {zone-type} subnet from a public network. See xref:../../networking/networking_operators/aws_load_balancer_operator/install-aws-load-balancer-operator.adoc#install-aws-load-balancer-operator_install-aws-load-balancer-operator[Installing the AWS Load Balancer Operator]. diff --git a/installing/installing_aws/ipi/installing-aws-outposts.adoc b/installing/installing_aws/ipi/installing-aws-outposts.adoc index 2a2f344c6a..bc40359a97 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/aws_load_balancer_operator/create-instance-aws-load-balancer-controller.adoc#nw-creating-instance-aws-load-balancer-controller_create-instance-aws-load-balancer[Creating an instance of the AWS Load Balancer Controller using AWS Load Balancer Operator] +* 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] [role="_additional-resources"] [id="additional-installing-aws-outposts"] diff --git a/networking/aws_load_balancer_operator/_attributes b/networking/networking_operators/_attributes similarity index 100% rename from networking/aws_load_balancer_operator/_attributes rename to networking/networking_operators/_attributes diff --git a/networking/aws-load-balancer-operator.adoc b/networking/networking_operators/aws-load-balancer-operator.adoc similarity index 100% rename from networking/aws-load-balancer-operator.adoc rename to networking/networking_operators/aws-load-balancer-operator.adoc diff --git a/networking/networking_operators/aws_load_balancer_operator/_attributes b/networking/networking_operators/aws_load_balancer_operator/_attributes new file mode 120000 index 0000000000..20cc1dcb77 --- /dev/null +++ b/networking/networking_operators/aws_load_balancer_operator/_attributes @@ -0,0 +1 @@ +../../_attributes/ \ No newline at end of file diff --git a/networking/aws_load_balancer_operator/add-tls-termination.adoc b/networking/networking_operators/aws_load_balancer_operator/add-tls-termination.adoc similarity index 100% rename from networking/aws_load_balancer_operator/add-tls-termination.adoc rename to networking/networking_operators/aws_load_balancer_operator/add-tls-termination.adoc diff --git a/networking/aws_load_balancer_operator/aws-load-balancer-operator-release-notes.adoc b/networking/networking_operators/aws_load_balancer_operator/aws-load-balancer-operator-release-notes.adoc similarity index 96% rename from networking/aws_load_balancer_operator/aws-load-balancer-operator-release-notes.adoc rename to networking/networking_operators/aws_load_balancer_operator/aws-load-balancer-operator-release-notes.adoc index d54afba1a5..5b198814ba 100644 --- a/networking/aws_load_balancer_operator/aws-load-balancer-operator-release-notes.adoc +++ b/networking/networking_operators/aws_load_balancer_operator/aws-load-balancer-operator-release-notes.adoc @@ -16,7 +16,7 @@ The AWS Load Balancer (ALB) Operator is only supported on the `x86_64` architect These release notes track the development of the AWS Load Balancer Operator in {product-title}. -For an overview of the AWS Load Balancer Operator, see xref:../../networking/aws_load_balancer_operator/understanding-aws-load-balancer-operator.adoc#aws-load-balancer-operator[AWS Load Balancer Operator in {product-title}]. +For an overview of the AWS Load Balancer Operator, see xref:../../../networking/networking_operators/aws_load_balancer_operator/understanding-aws-load-balancer-operator.adoc#aws-load-balancer-operator[AWS Load Balancer Operator in {product-title}]. [NOTE] ==== diff --git a/networking/aws_load_balancer_operator/configure-egress-proxy-aws-load-balancer-operator.adoc b/networking/networking_operators/aws_load_balancer_operator/configure-egress-proxy-aws-load-balancer-operator.adoc similarity index 81% rename from networking/aws_load_balancer_operator/configure-egress-proxy-aws-load-balancer-operator.adoc rename to networking/networking_operators/aws_load_balancer_operator/configure-egress-proxy-aws-load-balancer-operator.adoc index b16cb0453c..277253e25e 100644 --- a/networking/aws_load_balancer_operator/configure-egress-proxy-aws-load-balancer-operator.adoc +++ b/networking/networking_operators/aws_load_balancer_operator/configure-egress-proxy-aws-load-balancer-operator.adoc @@ -13,4 +13,4 @@ include::modules/configuring-egress-proxy.adoc[leveloffset=+1] [role="_additional-resources"] == Additional resources -* xref:../../networking/configuring-a-custom-pki.adoc#certificate-injection-using-operators_configuring-a-custom-pki[Certificate injection using Operators] +* xref:../../../networking/configuring-a-custom-pki.adoc#certificate-injection-using-operators_configuring-a-custom-pki[Certificate injection using Operators] diff --git a/networking/aws_load_balancer_operator/create-instance-aws-load-balancer-controller.adoc b/networking/networking_operators/aws_load_balancer_operator/create-instance-aws-load-balancer-controller.adoc similarity index 100% rename from networking/aws_load_balancer_operator/create-instance-aws-load-balancer-controller.adoc rename to networking/networking_operators/aws_load_balancer_operator/create-instance-aws-load-balancer-controller.adoc diff --git a/networking/aws_load_balancer_operator/images b/networking/networking_operators/aws_load_balancer_operator/images similarity index 100% rename from networking/aws_load_balancer_operator/images rename to networking/networking_operators/aws_load_balancer_operator/images diff --git a/networking/aws_load_balancer_operator/install-aws-load-balancer-operator.adoc b/networking/networking_operators/aws_load_balancer_operator/install-aws-load-balancer-operator.adoc similarity index 100% rename from networking/aws_load_balancer_operator/install-aws-load-balancer-operator.adoc rename to networking/networking_operators/aws_load_balancer_operator/install-aws-load-balancer-operator.adoc diff --git a/networking/aws_load_balancer_operator/installing-albo-sts-cluster.adoc b/networking/networking_operators/aws_load_balancer_operator/installing-albo-sts-cluster.adoc similarity index 84% rename from networking/aws_load_balancer_operator/installing-albo-sts-cluster.adoc rename to networking/networking_operators/aws_load_balancer_operator/installing-albo-sts-cluster.adoc index 5475fb4870..9059bce70d 100644 --- a/networking/aws_load_balancer_operator/installing-albo-sts-cluster.adoc +++ b/networking/networking_operators/aws_load_balancer_operator/installing-albo-sts-cluster.adoc @@ -39,7 +39,7 @@ An additional {aws-first} Identity and Access Management (IAM) role is required You can create the IAM role by using the following options: -* Using xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#cco-ccoctl-configuring_installing-aws-customizations[the Cloud Credential Operator utility (`ccoctl`)] and a predefined `CredentialsRequest` object. +* Using xref:../../../installing/installing_aws/ipi/installing-aws-customizations.adoc#cco-ccoctl-configuring_installing-aws-customizations[the Cloud Credential Operator utility (`ccoctl`)] and a predefined `CredentialsRequest` object. * Using the {aws-short} CLI and predefined {aws-short} manifests. Use the {aws-short} CLI if your environment does not support the `ccoctl` command. @@ -60,7 +60,7 @@ The `CredentialsRequest` object for the {aws-short} Load Balancer Controller mus You can create the IAM role by using the following options: -* Using xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#cco-ccoctl-configuring_installing-aws-customizations[the Cloud Credential Operator utility (`ccoctl`)] and a predefined `CredentialsRequest` object. +* Using xref:../../../installing/installing_aws/ipi/installing-aws-customizations.adoc#cco-ccoctl-configuring_installing-aws-customizations[the Cloud Credential Operator utility (`ccoctl`)] and a predefined `CredentialsRequest` object. * Using the {aws-short} CLI and predefined {aws-short} manifests. Use the {aws-short} CLI if your environment does not support the `ccoctl` command. @@ -73,4 +73,4 @@ include::modules/using-aws-cli-create-iam-role-alb-controller.adoc[leveloffset=+ [role="_additional-resources"] == Additional resources -* xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#cco-ccoctl-configuring_installing-aws-customizations[Configuring the Cloud Credential Operator utility] +* xref:../../../installing/installing_aws/ipi/installing-aws-customizations.adoc#cco-ccoctl-configuring_installing-aws-customizations[Configuring the Cloud Credential Operator utility] diff --git a/networking/aws_load_balancer_operator/modules b/networking/networking_operators/aws_load_balancer_operator/modules similarity index 100% rename from networking/aws_load_balancer_operator/modules rename to networking/networking_operators/aws_load_balancer_operator/modules diff --git a/networking/aws_load_balancer_operator/multiple-ingress-through-single-alb.adoc b/networking/networking_operators/aws_load_balancer_operator/multiple-ingress-through-single-alb.adoc similarity index 100% rename from networking/aws_load_balancer_operator/multiple-ingress-through-single-alb.adoc rename to networking/networking_operators/aws_load_balancer_operator/multiple-ingress-through-single-alb.adoc diff --git a/networking/aws_load_balancer_operator/snippets b/networking/networking_operators/aws_load_balancer_operator/snippets similarity index 100% rename from networking/aws_load_balancer_operator/snippets rename to networking/networking_operators/aws_load_balancer_operator/snippets diff --git a/networking/aws_load_balancer_operator/understanding-aws-load-balancer-operator.adoc b/networking/networking_operators/aws_load_balancer_operator/understanding-aws-load-balancer-operator.adoc similarity index 100% rename from networking/aws_load_balancer_operator/understanding-aws-load-balancer-operator.adoc rename to networking/networking_operators/aws_load_balancer_operator/understanding-aws-load-balancer-operator.adoc diff --git a/networking/networking_operators/images b/networking/networking_operators/images new file mode 120000 index 0000000000..847b03ed05 --- /dev/null +++ b/networking/networking_operators/images @@ -0,0 +1 @@ +../../images/ \ No newline at end of file diff --git a/networking/networking_operators/modules b/networking/networking_operators/modules new file mode 120000 index 0000000000..36719b9de7 --- /dev/null +++ b/networking/networking_operators/modules @@ -0,0 +1 @@ +../../modules/ \ No newline at end of file diff --git a/networking/networking_operators/snippets b/networking/networking_operators/snippets new file mode 120000 index 0000000000..5a3f5add14 --- /dev/null +++ b/networking/networking_operators/snippets @@ -0,0 +1 @@ +../../snippets/ \ No newline at end of file diff --git a/release_notes/addtl-release-notes.adoc b/release_notes/addtl-release-notes.adoc index 8124c639c3..48592f56f5 100644 --- a/release_notes/addtl-release-notes.adoc +++ b/release_notes/addtl-release-notes.adoc @@ -16,7 +16,7 @@ The following release notes are for downstream Red Hat products only; upstream o ==== A:: -xref:../networking/aws_load_balancer_operator/aws-load-balancer-operator-release-notes.adoc#aws-load-balancer-operator-release-notes[AWS Load Balancer Operator] +xref:../networking/networking_operators/aws_load_balancer_operator/aws-load-balancer-operator-release-notes.adoc#aws-load-balancer-operator-release-notes[AWS Load Balancer Operator] B:: link:https://docs.redhat.com/en/documentation/builds_for_red_hat_openshift/1.1/html/about_builds/ob-release-notes#ob-release-notes[{builds-v2title}]