Merge pull request #33161 from ahardin-rh/customize-console-routes

OSDOCS-1864:Customizing console route updates

Author: ahardin-rh

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

@@ -3,67 +3,60 @@
 // * web_console/customizing-the-web-console.adoc
 
 [id="customizing-the-web-console-url_{context}"]
-= Customizing the web console URL
+= Customizing console routes
 
-You can update the web console URL, `consoleURL`, to a custom value.
+For `console` and `downloads` routes, custom routes functionality uses the `ingress` config route configuration API. If the `console` custom route is set up in both the `ingress` config and `console-operator` config, then the new `ingress` config custom route configuration takes precedent. The route configuration with the `console-operator` config is deprecated.
+
+[id="customizing-the-console-route_{context}"]
+== Customizing the console route
+
+.Prerequisites
+
+* Log in to the cluster as a user with administrative privileges.
 
 .Procedure
 
-. Modify the cluster instance created by default during installation in the `consoles.operator.openshift.io` custom resource:
-+
-[source,terminal]
-----
-$ oc patch consoles.operator.openshift.io cluster --patch '{"spec":{"route":{"hostname":"console.example.com"}}}' --type=merge
-----
+* Set the custom hostname and, if needed, set TLS on the ingress config's spec:
 +
 [source,yaml]
 ----
-apiVersion: operator.openshift.io/v1
-kind: Console
+apiVersion: config.openshift.io/v1
+kind: Ingress
 metadata:
   name: cluster
 spec:
-  route:
-    hostname: 'console.example.com'
+  componentRoutes:
+    - name: console
+      namespace: openshift-console
+      hostname: <custom-hostname>
+       secret:
+         name: <secret-name>
 ----
-. If you specify a custom certificate, you must create a secret in the `openshift-config` namespace that has the key and certificate. For example:
 +
-[source,terminal]
-----
-$ oc create secret tls console-tls --key=key.pem --cert=cert.pem -n openshift-config
-----
+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.
+
+[id="customizing-the-download-route_{context}"]
+== Customizing the download route
+
+.Prerequisites
+
+* Log in to the cluster as a user with administrative privileges.
+
+.Procedure
+
+* Set the custom hostname and, if needed, set TLS on the ingress config's spec:
 +
 [source,yaml]
 ----
-apiVersion: v1
-kind: Secret
+apiVersion: config.openshift.io/v1
+kind: Ingress
 metadata:
-  name: console-tls
-  namespace: openshift-config
-type: kubernetes.io/tls
-data:
-  tls.crt: >-
-        <base64-encoded_cert> ... <1>
-  tls.key: >-
-        <base64-encoded_key> ... <2>
-----
-<1> Provide a valid TLS certificate.
-<2> Provide a valid TLS key.
-+
-Then, edit the web console’s Operator configuration:
-+
-[source,terminal]
-----
-$ oc edit consoles.operator.openshift.io cluster
-----
-+
-Add the following stanza to the configuration resource:
-+
-[source,yaml]
-----
+  name: cluster
 spec:
-  route:
-    hostname: console.example.com
-    secret:
-      name: console-tls
+  componentRoutes:
+    - name: downloads
+      namespace: openshift-console
+      hostname: <custom-hostname>
+       secret:
+         name: <secret-name>
 ----