You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/customizing-the-web-console-URL.adoc
+46-10Lines changed: 46 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,13 +10,28 @@ For `console` and `downloads` routes, custom routes functionality uses the `ingr
10
10
[id="customizing-the-console-route_{context}"]
11
11
== Customizing the console route
12
12
13
+
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.
14
+
13
15
.Prerequisites
14
16
15
-
* Log in to the cluster as a user with administrative privileges.
17
+
* You have logged in to the cluster as a user with administrative privileges.
18
+
* 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.
19
+
+
20
+
[TIP]
21
+
====
22
+
You can create a TLS secret by using the `oc create secret tls` command.
23
+
====
16
24
17
25
.Procedure
18
26
19
-
* Set the custom hostname and, if needed, set TLS on the ingress config's spec:
27
+
. Edit the cluster `Ingress` configuration:
28
+
+
29
+
[source,terminal]
30
+
----
31
+
$ oc edit ingress.config.openshift.io cluster
32
+
----
33
+
34
+
. Set the custom host name and optionally the serving certificate and key:
20
35
+
21
36
[source,yaml]
22
37
----
@@ -28,23 +43,40 @@ spec:
28
43
componentRoutes:
29
44
- name: console
30
45
namespace: openshift-console
31
-
hostname: <custom-hostname>
46
+
hostname: <custom_hostname> <1>
32
47
servingCertKeyPairSecret:
33
-
name: <secret-name>
48
+
name: <secret_name> <2>
34
49
----
35
-
+
36
-
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.
50
+
<1> The custom host name.
51
+
<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.
52
+
53
+
. Save the file to apply the changes.
37
54
38
55
[id="customizing-the-download-route_{context}"]
39
56
== Customizing the download route
40
57
58
+
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.
59
+
41
60
.Prerequisites
42
61
43
-
* Log in to the cluster as a user with administrative privileges.
62
+
* You have logged in to the cluster as a user with administrative privileges.
63
+
* 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.
64
+
+
65
+
[TIP]
66
+
====
67
+
You can create a TLS secret by using the `oc create secret tls` command.
68
+
====
44
69
45
70
.Procedure
46
71
47
-
* Set the custom hostname and, if needed, set TLS on the ingress config's spec:
72
+
. Edit the cluster `Ingress` configuration:
73
+
+
74
+
[source,terminal]
75
+
----
76
+
$ oc edit ingress.config.openshift.io cluster
77
+
----
78
+
79
+
. Set the custom host name and optionally the serving certificate and key:
48
80
+
49
81
[source,yaml]
50
82
----
@@ -56,7 +88,11 @@ spec:
56
88
componentRoutes:
57
89
- name: downloads
58
90
namespace: openshift-console
59
-
hostname: <custom-hostname>
91
+
hostname: <custom_hostname> <1>
60
92
servingCertKeyPairSecret:
61
-
name: <secret-name>
93
+
name: <secret_name> <2>
62
94
----
95
+
<1> The custom host name.
96
+
<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.
0 commit comments