Merge pull request #35405 from bergerhoffer/console-url-updates

Updating console route procedures with formatting changes from OAuth …

Author: bergerhoffer

modules/customizing-the-web-console-URL.adoc

@@ -10,13 +10,28 @@ For `console` and `downloads` routes, custom routes functionality uses the `ingr
 [id="customizing-the-console-route_{context}"]
 == Customizing the console route
 
+You can customize the console route by setting the custom host name and TLS certificate in the `spec.componentRoutes` field of the cluster `Ingress` configuration.
+
 .Prerequisites
 
-* Log in to the cluster as a user with administrative privileges.
+* You have logged in to the cluster as a user with administrative privileges.
+* You have created a secret in the `openshift-config` namespace containing the TLS certificate and key. This is required if the domain for the custom host name suffix does not match the cluster domain suffix. The secret is optional if the suffix matches.
++
+[TIP]
+====
+You can create a TLS secret by using the `oc create secret tls` command.
+====
 
 .Procedure
 
-* Set the custom hostname and, if needed, set TLS on the ingress config's spec:
+. Edit the cluster `Ingress` configuration:
++
+[source,terminal]
+----
+$ oc edit ingress.config.openshift.io cluster
+----
+
+. Set the custom host name and optionally the serving certificate and key:
 +
 [source,yaml]
 ----
@@ -28,23 +43,40 @@ spec:
   componentRoutes:
     - name: console
       namespace: openshift-console
-      hostname: <custom-hostname>
+      hostname: <custom_hostname> <1>
       servingCertKeyPairSecret:
-        name: <secret-name>
+        name: <secret_name> <2>
 ----
-+
-If the domain for the custom hostname suffix does not match the cluster domain suffix, then a secret that contains a TLS certificate and key must exist in the `openshift-config` namespace and must be referenced in the `ingress` config. If the domain for the custom hostname suffix matches the cluster domain suffix, then the secret is optional. The secret must contain `tls.crt` and `tls.key` data keys, where the certificate and key are stored, and both must be in a valid format.
+<1> The custom host name.
+<2> Reference to a secret in the `openshift-config` namespace that contains a TLS certificate (`tls.crt`) and key (`tls.key`). This is required if the domain for the custom host name suffix does not match the cluster domain suffix. The secret is optional if the suffix matches.
+
+. Save the file to apply the changes.
 
 [id="customizing-the-download-route_{context}"]
 == Customizing the download route
 
+You can customize the download route by setting the custom host name and TLS certificate in the `spec.componentRoutes` field of the cluster `Ingress` configuration.
+
 .Prerequisites
 
-* Log in to the cluster as a user with administrative privileges.
+* You have logged in to the cluster as a user with administrative privileges.
+* You have created a secret in the `openshift-config` namespace containing the TLS certificate and key. This is required if the domain for the custom host name suffix does not match the cluster domain suffix. The secret is optional if the suffix matches.
++
+[TIP]
+====
+You can create a TLS secret by using the `oc create secret tls` command.
+====
 
 .Procedure
 
-* Set the custom hostname and, if needed, set TLS on the ingress config's spec:
+. Edit the cluster `Ingress` configuration:
++
+[source,terminal]
+----
+$ oc edit ingress.config.openshift.io cluster
+----
+
+. Set the custom host name and optionally the serving certificate and key:
 +
 [source,yaml]
 ----
@@ -56,7 +88,11 @@ spec:
   componentRoutes:
     - name: downloads
       namespace: openshift-console
-      hostname: <custom-hostname>
+      hostname: <custom_hostname> <1>
       servingCertKeyPairSecret:
-        name: <secret-name>
+        name: <secret_name> <2>
 ----
+<1> The custom host name.
+<2> Reference to a secret in the `openshift-config` namespace that contains a TLS certificate (`tls.crt`) and key (`tls.key`). This is required if the domain for the custom host name suffix does not match the cluster domain suffix. The secret is optional if the suffix matches.
+
+. Save the file to apply the changes.