Merge pull request #70322 from xenolinux/edns-improv

OSDOCS#9360: Improve the External DNS Operator content

Author: kcarmichael08

_topic_maps/_topic_map.yml

@@ -1315,11 +1315,11 @@ Topics:
     File: nw-installing-external-dns-operator-on-cloud-providers
   - Name: External DNS Operator configuration parameters
     File: nw-configuration-parameters
-  - Name: Creating DNS records on an public hosted zone for AWS
+  - Name: Creating DNS records on a public hosted zone for AWS
     File: nw-creating-dns-records-on-aws
-  - Name: Creating DNS records on an public zone for Azure
+  - Name: Creating DNS records on a public zone for Azure
     File: nw-creating-dns-records-on-azure
-  - Name: Creating DNS records on an public managed zone for GCP
+  - 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

modules/configuring-egress-proxy-edns-operator.adoc

@@ -4,7 +4,7 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="nw-configuring-cluster-wide-proxy_{context}"]
-= Configuring the External DNS Operator to trust the certificate authority of the cluster-wide proxy
+= Trusting the certificate authority of the cluster-wide proxy
 
 You can configure the External DNS Operator to trust the certificate authority of the cluster-wide proxy.
 
@@ -44,4 +44,4 @@ $ oc -n external-dns-operator exec deploy/external-dns-operator -c external-dns-
 [source,terminal]
 ----
 trusted-ca
-----
+----

modules/nw-control-dns-records-public-hosted-zone-azure.adoc

@@ -4,26 +4,18 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="nw-control-dns-records-public-hosted-zone-azure_{context}"]
-= Creating DNS records on an public DNS zone for Azure by using Red Hat External DNS Operator
+= Creating DNS records on an Azure public DNS zone
 
-You can create DNS records on a public DNS zone for Azure by using Red Hat External DNS Operator.
+You can create DNS records on a public DNS zone for Azure by using the External DNS Operator.
 
-.Procedure
+.Prerequisites
 
-. Check the user. The user must have access to the `kube-system` namespace. If you don’t have the credentials, as you can fetch the credentials from the `kube-system` namespace to use the cloud provider client:
-+
-[source,terminal]
-----
-$ oc whoami
-----
-+
-.Example output
-[source,terminal]
-----
-system:admin
-----
+* You must have administrator privileges.
+* The `admin` user must have access to the `kube-system` namespace.
+
+.Procedure
 
-. Fetch the values from azure-credentials secret present in `kube-system` namespace.
+. Fetch the credentials from the `kube-system` namespace to use the cloud provider client by running the following command:
 +
 [source,terminal]
 ----
@@ -34,14 +26,14 @@ $ SUBSCRIPTION_ID=$(oc get secrets azure-credentials  -n kube-system  --template
 $ TENANT_ID=$(oc get secrets azure-credentials  -n kube-system  --template={{.data.azure_tenant_id}} | base64 -d)
 ----
 
-. Login to azure with base64 decoded values:
+. Log in to Azure by running the following command:
 +
 [source,terminal]
 ----
 $ az login --service-principal -u "${CLIENT_ID}" -p "${CLIENT_SECRET}" --tenant "${TENANT_ID}"
 ----
 
-. Get the routes to check the domain:
+. Get a list of routes by running the following command:
 +
 [source,terminal]
 ----
@@ -55,15 +47,16 @@ openshift-console          console             console-openshift-console.apps.te
 openshift-console          downloads           downloads-openshift-console.apps.test.azure.example.com                     downloads           http    edge/Redirect          None
 ----
 
-. Get the list of dns zones to find the one which corresponds to the previously found route's domain:
+. Get a list of DNS zones by running the following command:
 +
 [source,terminal]
 ----
 $ az network dns zone list --resource-group "${RESOURCE_GROUP}"
 ----
 
-. Create `ExternalDNS` resource for `route` source:
+. Create a YAML file, for example, `external-dns-sample-azure.yaml`, that defines the `ExternalDNS` object:
 +
+.Example `external-dns-sample-azure.yaml` file
 [source,yaml]
 ----
 apiVersion: externaldns.olm.openshift.io/v1beta1
@@ -79,16 +72,15 @@ spec:
     openshiftRouteOptions: <4>
       routerName: default <5>
     type: OpenShiftRoute <6>
-EOF
 ----
-<1> Specifies the name of External DNS CR.
-<2> Define the zone ID.
-<3> Defines the Azure DNS provider.
+<1> Specifies the External DNS name.
+<2> Defines the zone ID.
+<3> Defines the provider type.
 <4> You can define options for the source of DNS records.
-<5> If the source is `OpenShiftRoute` then you can pass the OpenShift Ingress Controller name. External DNS selects the canonical hostname of that router as the target while creating CNAME record.
-<6> Defines OpenShift `route` resource as the source for the DNS records which gets created in the previously specified DNS provider.
+<5> If the source type is `OpenShiftRoute`, you can pass the OpenShift Ingress Controller name. External DNS selects the canonical hostname of that router as the target while creating CNAME record.
+<6> Defines the `route` resource as the source for the Azure DNS records.
 
-. Check the records created for OCP routes using the following command:
+. Check the DNS records created for {product-title} routes by running the following command:
 +
 [source,terminal]
 ----
@@ -97,5 +89,5 @@ $ az network dns record-set list -g "${RESOURCE_GROUP}"  -z test.azure.example.c
 +
 [NOTE]
 ====
-To create records on private hosted zones on private Azure dns, you need to specify the private zone under `zones` which populates the provider type to `azure-private-dns` in the `ExternalDNS` container args.
+To create records on private hosted zones on private Azure DNS, you need to specify the private zone under the `zones` field which populates the provider type to `azure-private-dns` in the `ExternalDNS` container arguments.
 ====

modules/nw-control-dns-records-public-hosted-zone-infoblox.adoc

@@ -6,7 +6,7 @@
 [id="nw-control-dns-records-public-dns-zone-infoblox_{context}"]
 = Creating DNS records on a public DNS zone on Infoblox
 
-You can create DNS records on a public DNS zone on Infoblox by using the Red Hat External DNS Operator.
+You can create DNS records on a public DNS zone on Infoblox by using the External DNS Operator.
 
 .Prerequisites
 
@@ -22,7 +22,7 @@ You can create DNS records on a public DNS zone on Infoblox by using the Red Hat
 $ oc -n external-dns-operator create secret generic infoblox-credentials --from-literal=EXTERNAL_DNS_INFOBLOX_WAPI_USERNAME=<infoblox_username> --from-literal=EXTERNAL_DNS_INFOBLOX_WAPI_PASSWORD=<infoblox_password>
 ----
 
-. Get the routes objects to check your cluster domain by running the following command:
+. Get a list of routes by running the following command:
 +
 [source,terminal]
 ----
@@ -36,17 +36,18 @@ openshift-console          console             console-openshift-console.apps.te
 openshift-console          downloads           downloads-openshift-console.apps.test.example.com                     downloads           http    edge/Redirect          None
 ----
 
-. Create an `ExternalDNS` resource YAML file, for example, sample-infoblox.yaml, as follows:
+. Create a YAML file, for example, `external-dns-sample-infoblox.yaml`, that defines the `ExternalDNS` object:
 +
+.Example `external-dns-sample-infoblox.yaml` file
 [source,yaml]
 ----
 apiVersion: externaldns.olm.openshift.io/v1beta1
 kind: ExternalDNS
 metadata:
-  name: sample-infoblox
+  name: sample-infoblox <1>
 spec:
   provider:
-    type: Infoblox
+    type: Infoblox <2>
     infoblox:
       credentials:
         name: infoblox-credentials
@@ -58,16 +59,20 @@ spec:
     matchType: Exact
     name: test.example.com
   source:
-    type: OpenShiftRoute
+    type: OpenShiftRoute <3>
     openshiftRouteOptions:
-      routerName: default
+      routerName: default <4>
 ----
+<1> Specifies the External DNS name.
+<2> Defines the provider type.
+<3> You can define options for the source of DNS records.
+<4> If the source type is `OpenShiftRoute`, you can pass the OpenShift Ingress Controller name. External DNS selects the canonical hostname of that router as the target while creating CNAME record.
 
-. Create an `ExternalDNS` resource on Infoblox by running the following command:
+. Create the `ExternalDNS` resource on Infoblox by running the following command:
 +
 [source,terminal]
 ----
-$ oc create -f sample-infoblox.yaml
+$ oc create -f external-dns-sample-infoblox.yaml
 ----
 
 . From the Infoblox UI, check the DNS records created for `console` routes:

modules/nw-control-dns-records-public-managed-zone-gcp.adoc

@@ -5,33 +5,24 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="nw-control-dns-records-public-managed-zone-gcp_{context}"]
-= Creating DNS records on an public managed zone for GCP by using Red Hat External DNS Operator
+= Creating DNS records on a public managed zone for GCP
 
-You can create DNS records on a public managed zone for GCP by using Red Hat External DNS Operator.
+You can create DNS records on a public managed zone for GCP by using the External DNS Operator.
 
-.Procedure
+.Prerequisites
 
-. Check the user. The user must have access to the `kube-system` namespace. If you don’t have the credentials, as you can fetch the credentials from the `kube-system` namespace to use the cloud provider client:
-+
-[source,terminal]
-----
-$ oc whoami
-----
-+
-.Example output
-[source,terminal]
-----
-system:admin
-----
+* You must have administrator privileges.
+
+.Procedure
 
-. Copy the value of service_account.json in gcp-credentials secret in a file encoded-gcloud.json by running the following command:
+. Copy the `gcp-credentials` secret in the `encoded-gcloud.json` file by running the following command:
 +
 [source,terminal]
 ----
 $ oc get secret gcp-credentials -n kube-system --template='{{$v := index .data "service_account.json"}}{{$v}}' | base64 -d - > decoded-gcloud.json
 ----
 
-. Export Google credentials:
+. Export your Google credentials by running the following command:
 +
 [source,terminal]
 ----
@@ -45,14 +36,14 @@ $ export GOOGLE_CREDENTIALS=decoded-gcloud.json
 $ gcloud auth activate-service-account  <client_email as per decoded-gcloud.json> --key-file=decoded-gcloud.json
 ----
 
-. Set your project:
+. Set your project by running the following command:
 +
 [source,terminal]
 ----
 $ gcloud config set project <project_id as per decoded-gcloud.json>
 ----
 
-. Get the routes to check the domain:
+. Get a list of routes by running the following command:
 +
 [source,terminal]
 ----
@@ -66,16 +57,22 @@ openshift-console          console             console-openshift-console.apps.te
 openshift-console          downloads           downloads-openshift-console.apps.test.gcp.example.com                     downloads           http    edge/Redirect          None
 ----
 
-. Get the list of managed zones to find the zone which corresponds to the previously found route’s domain:
+. Get a list of managed zones by running the following command:
 +
 [source,terminal]
 ----
 $ gcloud dns managed-zones list | grep test.gcp.example.com
+----
++
+.Example output
+[source,terminal]
+----
 qe-cvs4g-private-zone test.gcp.example.com
 ----
 
-. Create `ExternalDNS` resource for `route` source:
+. Create a YAML file, for example, `external-dns-sample-gcp.yaml`, that defines the `ExternalDNS` object:
 +
+.Example `external-dns-sample-gcp.yaml` file
 [source,yaml]
 ----
 apiVersion: externaldns.olm.openshift.io/v1beta1
@@ -93,18 +90,17 @@ spec:
     openshiftRouteOptions: <6>
       routerName: default <7>
     type: OpenShiftRoute <8>
-EOF
 ----
-<1> Specifies the name of External DNS CR.
-<2> By default all hosted zones are selected as potential targets. You can include a hosted zone that you need.
-<3> The matching of the target zone's domain has to be exact (as opposed to regular expression match).
+<1> Specifies the External DNS name.
+<2> By default, all hosted zones are selected as potential targets. You can include your hosted zone.
+<3> The domain of the target must match the string defined by the `name` key.
 <4> Specify the exact domain of the zone you want to update. The hostname of the routes must be subdomains of the specified domain.
-<5> Defines Google Cloud DNS provider.
+<5> Defines the provider type.
 <6> You can define options for the source of DNS records.
-<7> If the source is `OpenShiftRoute` then you can pass the OpenShift Ingress Controller name. External DNS selects the canonical hostname of that router as the target while creating CNAME record.
-<8> Defines OpenShift `route` resource as the source for the DNS records which gets created in the previously specified DNS provider.
+<7> If the source type is `OpenShiftRoute`, you can pass the OpenShift Ingress Controller name. External DNS selects the canonical hostname of that router as the target while creating CNAME record.
+<8> Defines the `route` resource as the source for GCP DNS records.
 
-. Check the records created for OCP routes using the following command:
+. Check the DNS records created for {product-title} routes by running the following command:
 +
 [source,terminal]
 ----

modules/nw-external-dns-operator-configuration-parameters.adoc

@@ -24,22 +24,22 @@ spec:
       credentials:
         name: aws-access-key <2>
 ----
-<1> Defines available options such as AWS, GCP and Azure.
-<2> Defines a name of the `secret` which contains credentials for your cloud provider.
+<1> Defines available options such as AWS, GCP, Azure, and Infoblox.
+<2> Defines a secret name for your cloud provider.
 
 |`zones`
-|Enables you to specify DNS zones by their domains. If you do not specify zones, `ExternalDNS` discovers all the zones present in your cloud provider account.
+|Enables you to specify DNS zones by their domains. If you do not specify zones, the `ExternalDNS` resource discovers all of the zones present in your cloud provider account.
 
 [source,yaml]
 ----
 zones:
 - "myzoneid" <1>
 ----
 
-<1> Specifies the IDs of DNS zones.
+<1> Specifies the name of DNS zones.
 
 |`domains`
-|Enables you to specify AWS zones by their domains. If you do not specify domains, `ExternalDNS` discovers all the zones present in your cloud provider account.
+|Enables you to specify AWS zones by their domains. If you do not specify domains, the `ExternalDNS` resource discovers all of the zones present in your cloud provider account.
 
 [source,yaml]
 ----
@@ -51,11 +51,11 @@ domains:
   matchType: Pattern <4>
   pattern: ".*\\.otherzonedomain\\.com" <5>
 ----
-<1> Instructs `ExternalDNS` to include the domain specified.
+<1> Ensures that the `ExternalDNS` resource includes the domain name.
 <2> Instructs `ExtrnalDNS` that the domain matching has to be exact as opposed to regular expression match.
-<3> Defines the exact domain name by which `ExternalDNS` filters.
-<4> Sets `regex-domain-filter` flag in `ExternalDNS`. You can limit possible domains by using a Regex filter.
-<5> Defines the regex pattern to be used by `ExternalDNS` to filter the domains of the target zones.
+<3> Defines the name of the domain.
+<4> Sets the `regex-domain-filter` flag in the `ExternalDNS` resource. You can limit possible domains by using a Regex filter.
+<5> Defines the regex pattern to be used by the `ExternalDNS` resource to filter the domains of the target zones.
 
 |`source`
 |Enables you to specify the source for the DNS records, `Service` or `Route`.
@@ -76,16 +76,16 @@ source: <1>
   - "{{.Name}}.myzonedomain.com" <6>
 ----
 <1> Defines the settings for the source of DNS records.
-<2> The `ExternalDNS` uses `Service` type as source for creating dns records.
-<3> Sets `service-type-filter` flag in `ExternalDNS`. The `serviceType` contains the following fields:
+<2> The `ExternalDNS` resource uses the `Service` type as the source for creating DNS records.
+<3> Sets the `service-type-filter` flag in the `ExternalDNS` resource. The `serviceType` contains the following fields:
 * `default`: `LoadBalancer`
 * `expected`: `ClusterIP`
 * `NodePort`
 * `LoadBalancer`
 * `ExternalName`
 <4> Ensures that the controller considers only those resources which matches with label filter.
 <5> The default value for `hostnameAnnotation` is `Ignore` which instructs `ExternalDNS` to generate DNS records using the templates specified in the field `fqdnTemplates`. When the value is `Allow` the DNS records get generated based on the value specified in the `external-dns.alpha.kubernetes.io/hostname` annotation.
-<6> External DNS Operator uses a string to generate DNS names from sources that don't define a hostname, or to add a hostname suffix when paired with the fake source.
+<6> The External DNS Operator uses a string to generate DNS names from sources that don't define a hostname, or to add a hostname suffix when paired with the fake source.
 
 [source,yaml]
 ----
@@ -98,7 +98,7 @@ source:
         external-dns.mydomain.org/publish: "yes"
 ----
 
-<1> ExternalDNS` uses type `route` as source for creating dns records.
-<2> If the source is `OpenShiftRoute`, then you can pass the Ingress Controller name. The `ExternalDNS` uses canonical name of Ingress Controller as the target for CNAME record.
+<1> Creates DNS records.
+<2> If the source type is `OpenShiftRoute`, then you can pass the Ingress Controller name. The `ExternalDNS` resource uses the canonical name of the Ingress Controller as the target for CNAME records.
 
 |===