Merge pull request #27827 from ahardin-rh/change-console-url

Bug 1858387, clarify how to update the console URL

Author: ahardin-rh

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

@@ -0,0 +1,35 @@
+// Module included in the following assemblies:
+//
+// * web_console/customizing-the-web-console.adoc
+
+[id="customizing-the-web-console-url_{context}"]
+= Customizing the web console URL
+
+You can update the web console URL, `consoleURL`, to a custom value.
+
+.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
+----
+
+. 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
+----
++
+Then, add the following stanza to the configuration resource:
++
+[source,yaml]
+----
+spec:
+  route:
+    hostname: console.example.com
+    secret:
+      name: console-tls
+----

modules/web-console-configuration.adoc

@@ -5,8 +5,7 @@
 [id="web-console-configuration_{context}"]
 = Configuring the web console
 
-You can configure the web console settings by editing the
-`console.config.openshift.io` resource.
+You can configure the web console settings by editing the `console.config.openshift.io` resource.
 
 * Edit the `console.config.openshift.io` resource:
 +
@@ -29,10 +28,5 @@ spec:
 status:
   consoleURL: "" <2>
 ----
-<1> Specify the URL of the page to load when a user logs out of the web console.
-If you do not specify a value, the user returns to the login page for the
-web console. Specifying a `logoutRedirect` URL allows your users to perform
-single logout (SLO) through the identity provider to destroy their single
-sign-on session.
-<2> The web console URL. You cannot modify this parameter value. If you do, the
-cluster resets it to the default value.
+<1> Specify the URL of the page to load when a user logs out of the web console. If you do not specify a value, the user returns to the login page for the web console. Specifying a `logoutRedirect` URL allows your users to perform single logout (SLO) through the identity provider to destroy their single sign-on session.
+<2> The web console URL. To update this to a custom value, see *Customizing the web console URL*.

web_console/customizing-the-web-console.adoc

@@ -13,6 +13,8 @@ include::modules/adding-a-custom-logo.adoc[leveloffset=+1]
 
 include::modules/creating-custom-links.adoc[leveloffset=+1]
 
+include::modules/customizing-the-web-console-URL.adoc[leveloffset=+1]
+
 include::modules/customizing-the-login-page.adoc[leveloffset=+1]
 
 include::modules/defining-template-for-external-log-link.adoc[leveloffset=+1]