feat: Override workspace base domain (#2826)

* feat: Override workspace base domain Signed-off-by: Anatolii Bazko <[email protected]> * Fixup Signed-off-by: Anatolii Bazko <[email protected]> * Update modules/administration-guide/pages/configuring-workspaces-endpoints-base-domain.adoc Co-authored-by: Jana Vrbkova <[email protected]> --------- Signed-off-by: Anatolii Bazko <[email protected]> Co-authored-by: Jana Vrbkova <[email protected]>
eclipse-che · Nov 22, 2024 · 5a7725d · 5a7725d
1 parent 111ffa8
commit 5a7725d
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 1 deletion.
diff --git a/modules/administration-guide/nav.adoc b/modules/administration-guide/nav.adoc
@@ -75,6 +75,7 @@
 *** xref:configuring-che-with-self-signed-certificate.adoc[]
 *** xref:importing-untrusted-tls-certificates.adoc[]
 *** xref:adding-labels-and-annotations.adoc[]
+*** xref:configuring-workspaces-endpoints-base-domain.adoc[]
 ** xref:configuring-storage.adoc[]
 *** xref:configuring-storage-classes.adoc[]
 *** xref:configuring-the-storage-strategy.adoc[]

diff --git a/modules/administration-guide/pages/configuring-networking.adoc b/modules/administration-guide/pages/configuring-networking.adoc
@@ -12,3 +12,4 @@
 include::example$snip_{project-context}-xref-configuring-che-with-self-signed-certificate.adoc[]
 * xref:importing-untrusted-tls-certificates.adoc[]
 * xref:adding-labels-and-annotations.adoc[]
+* xref:configuring-workspaces-endpoints-base-domain.adoc[]
diff --git a/...es/administration-guide/pages/configuring-workspaces-endpoints-base-domain.adoc b/...es/administration-guide/pages/configuring-workspaces-endpoints-base-domain.adoc
@@ -0,0 +1,41 @@
+:_content-type: PROCEDURE
+:description: Configuring workspace endpoints base domain
+:keywords: administration guide, workspaces, networking, endpoints, domain
+:navtitle: Configuring workspace endpoints base domain
+:page-aliases:
+
+[id="configuring-workspaces-endpoints-base-domain"]
+= Configuring workspace endpoints base domain
+
+Learn how to configure the base domain for workspace endpoints.
+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.
+[source,yaml,subs="+quotes"]
+----
+spec:
+  components:
+    cheServer:
+      extraProperties:
+        CHE_INFRA_OPENSHIFT_ROUTE_HOST_DOMAIN__SUFFIX: "<...>" <1>
+
+----
+<1> Workspace endpoints base domain, for example, `my-{prod-id-short}.example.com`.
+
+.Procedure
+
+. Configure the workspace endpoints base domain:
++
+[source,subs="+quotes,attributes"]
+----
+{orch-cli} patch checluster/{prod-checluster} \
+    --namespace {prod-namespace} \
+    --type='merge' -p \
+'{"spec":
+    {"components":
+        {"cheServer":
+            {"extraProperties":
+                {"CHE_INFRA_OPENSHIFT_ROUTE_HOST_DOMAIN__SUFFIX": "my-{prod-id-short}.example.com"}}}}}'
+----
+
+.Additional resources
+
+* xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]
diff --git a/modules/administration-guide/pages/configuring-workspaces-globally.adoc b/modules/administration-guide/pages/configuring-workspaces-globally.adoc
@@ -19,4 +19,4 @@ This section describes how an administrator can configure workspaces globally.
 
 * xref:configuring-workspaces-nodeselector.adoc[]
 
-* xref:configuring-allowed-urls-for-cloud-development-environments.adoc[]
+* xref:configuring-allowed-urls-for-cloud-development-environments.adoc[]
Original file line number	Diff line number	Diff line change
Expand Up		@@ -19,4 +19,4 @@ This section describes how an administrator can configure workspaces globally.

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

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