Skip to content

Commit 5a7725d

Browse files
feat: Override workspace base domain (#2826)
* feat: Override workspace base domain Signed-off-by: Anatolii Bazko <abazko@redhat.com> * Fixup Signed-off-by: Anatolii Bazko <abazko@redhat.com> * Update modules/administration-guide/pages/configuring-workspaces-endpoints-base-domain.adoc Co-authored-by: Jana Vrbkova <jvrbkova@redhat.com> --------- Signed-off-by: Anatolii Bazko <abazko@redhat.com> Co-authored-by: Jana Vrbkova <jvrbkova@redhat.com>
1 parent 111ffa8 commit 5a7725d

File tree

4 files changed

+44
-1
lines changed

4 files changed

+44
-1
lines changed

modules/administration-guide/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@
7575
*** xref:configuring-che-with-self-signed-certificate.adoc[]
7676
*** xref:importing-untrusted-tls-certificates.adoc[]
7777
*** xref:adding-labels-and-annotations.adoc[]
78+
*** xref:configuring-workspaces-endpoints-base-domain.adoc[]
7879
** xref:configuring-storage.adoc[]
7980
*** xref:configuring-storage-classes.adoc[]
8081
*** xref:configuring-the-storage-strategy.adoc[]

modules/administration-guide/pages/configuring-networking.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,4 @@
1212
include::example$snip_{project-context}-xref-configuring-che-with-self-signed-certificate.adoc[]
1313
* xref:importing-untrusted-tls-certificates.adoc[]
1414
* xref:adding-labels-and-annotations.adoc[]
15+
* xref:configuring-workspaces-endpoints-base-domain.adoc[]
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
:_content-type: PROCEDURE
2+
:description: Configuring workspace endpoints base domain
3+
:keywords: administration guide, workspaces, networking, endpoints, domain
4+
:navtitle: Configuring workspace endpoints base domain
5+
:page-aliases:
6+
7+
[id="configuring-workspaces-endpoints-base-domain"]
8+
= Configuring workspace endpoints base domain
9+
10+
Learn how to configure the base domain for workspace endpoints.
11+
By default, {prod-short} Operator automatically detects the base domain. To change it, you need to configure the `CHE_INFRA_OPENSHIFT_ROUTE_HOST_DOMAIN__SUFFIX` property in the `CheCluster` Custom Resource.
12+
[source,yaml,subs="+quotes"]
13+
----
14+
spec:
15+
components:
16+
cheServer:
17+
extraProperties:
18+
CHE_INFRA_OPENSHIFT_ROUTE_HOST_DOMAIN__SUFFIX: "<...>" <1>
19+
20+
----
21+
<1> Workspace endpoints base domain, for example, `my-{prod-id-short}.example.com`.
22+
23+
.Procedure
24+
25+
. Configure the workspace endpoints base domain:
26+
+
27+
[source,subs="+quotes,attributes"]
28+
----
29+
{orch-cli} patch checluster/{prod-checluster} \
30+
--namespace {prod-namespace} \
31+
--type='merge' -p \
32+
'{"spec":
33+
{"components":
34+
{"cheServer":
35+
{"extraProperties":
36+
{"CHE_INFRA_OPENSHIFT_ROUTE_HOST_DOMAIN__SUFFIX": "my-{prod-id-short}.example.com"}}}}}'
37+
----
38+
39+
.Additional resources
40+
41+
* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]

modules/administration-guide/pages/configuring-workspaces-globally.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ This section describes how an administrator can configure workspaces globally.
1919

2020
* xref:configuring-workspaces-nodeselector.adoc[]
2121

22-
* xref:configuring-allowed-urls-for-cloud-development-environments.adoc[]
22+
* xref:configuring-allowed-urls-for-cloud-development-environments.adoc[]

0 commit comments

Comments
 (0)