From 2aa49b4d95e04592d133ff8e32c9f1c44773e6cf Mon Sep 17 00:00:00 2001 From: Anatolii Bazko Date: Fri, 22 Nov 2024 09:24:45 +0100 Subject: [PATCH 1/3] feat: Override workspace base domain Signed-off-by: Anatolii Bazko --- modules/administration-guide/nav.adoc | 1 + ...ring-workspaces-endpoints-base-domain.adoc | 41 +++++++++++++++++++ .../configuring-workspaces-globally.adoc | 4 +- 3 files changed, 45 insertions(+), 1 deletion(-) create mode 100644 modules/administration-guide/pages/configuring-workspaces-endpoints-base-domain.adoc diff --git a/modules/administration-guide/nav.adoc b/modules/administration-guide/nav.adoc index 1efb5e5a30..d705a6391b 100644 --- a/modules/administration-guide/nav.adoc +++ b/modules/administration-guide/nav.adoc @@ -52,6 +52,7 @@ *** xref:configuring-workspaces-nodeselector.adoc[] *** xref:configuring-the-open-vsx-registry-url.adoc[] *** xref:configuring-allowed-urls-for-cloud-development-environments.adoc[] +*** xref:configuring-workspaces-endpoints-base-domain.adoc[] ** xref:caching-images-for-faster-workspace-start.adoc[] *** xref:installing-kubernetes-image-puller.adoc[] **** xref:installing-image-puller-on-kubernetes-by-using-cli.adoc[] diff --git a/modules/administration-guide/pages/configuring-workspaces-endpoints-base-domain.adoc b/modules/administration-guide/pages/configuring-workspaces-endpoints-base-domain.adoc new file mode 100644 index 0000000000..544094eb94 --- /dev/null +++ b/modules/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 + +This section describes 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 index 738a7d93c8..ddf90655eb 100644 --- a/modules/administration-guide/pages/configuring-workspaces-globally.adoc +++ b/modules/administration-guide/pages/configuring-workspaces-globally.adoc @@ -19,4 +19,6 @@ This section describes how an administrator can configure workspaces globally. * xref:configuring-workspaces-nodeselector.adoc[] -* xref:configuring-allowed-urls-for-cloud-development-environments.adoc[] \ No newline at end of file +* xref:configuring-allowed-urls-for-cloud-development-environments.adoc[] + +* xref:configuring-workspaces-endpoints-base-domain.adoc[] \ No newline at end of file From 8e8dc67f0e68c878585d9e08090ec0fde001cdf8 Mon Sep 17 00:00:00 2001 From: Anatolii Bazko Date: Fri, 22 Nov 2024 14:34:38 +0100 Subject: [PATCH 2/3] Fixup Signed-off-by: Anatolii Bazko --- modules/administration-guide/nav.adoc | 2 +- modules/administration-guide/pages/configuring-networking.adoc | 1 + .../pages/configuring-workspaces-globally.adoc | 2 -- 3 files changed, 2 insertions(+), 3 deletions(-) diff --git a/modules/administration-guide/nav.adoc b/modules/administration-guide/nav.adoc index d705a6391b..89fb91f059 100644 --- a/modules/administration-guide/nav.adoc +++ b/modules/administration-guide/nav.adoc @@ -52,7 +52,6 @@ *** xref:configuring-workspaces-nodeselector.adoc[] *** xref:configuring-the-open-vsx-registry-url.adoc[] *** xref:configuring-allowed-urls-for-cloud-development-environments.adoc[] -*** xref:configuring-workspaces-endpoints-base-domain.adoc[] ** xref:caching-images-for-faster-workspace-start.adoc[] *** xref:installing-kubernetes-image-puller.adoc[] **** xref:installing-image-puller-on-kubernetes-by-using-cli.adoc[] @@ -76,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 index 498be817a6..a4f8011a01 100644 --- 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[] \ No newline at end of file diff --git a/modules/administration-guide/pages/configuring-workspaces-globally.adoc b/modules/administration-guide/pages/configuring-workspaces-globally.adoc index ddf90655eb..761622373c 100644 --- a/modules/administration-guide/pages/configuring-workspaces-globally.adoc +++ b/modules/administration-guide/pages/configuring-workspaces-globally.adoc @@ -20,5 +20,3 @@ 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-workspaces-endpoints-base-domain.adoc[] \ No newline at end of file From 49b57250b14f7d12baeb8772e7a020e245642e1c Mon Sep 17 00:00:00 2001 From: Anatolii Bazko Date: Fri, 22 Nov 2024 15:08:06 +0100 Subject: [PATCH 3/3] Update modules/administration-guide/pages/configuring-workspaces-endpoints-base-domain.adoc Co-authored-by: Jana Vrbkova --- .../pages/configuring-workspaces-endpoints-base-domain.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/administration-guide/pages/configuring-workspaces-endpoints-base-domain.adoc b/modules/administration-guide/pages/configuring-workspaces-endpoints-base-domain.adoc index 544094eb94..b5302164ec 100644 --- a/modules/administration-guide/pages/configuring-workspaces-endpoints-base-domain.adoc +++ b/modules/administration-guide/pages/configuring-workspaces-endpoints-base-domain.adoc @@ -7,7 +7,7 @@ [id="configuring-workspaces-endpoints-base-domain"] = Configuring workspace endpoints base domain -This section describes how to configure the base domain for workspace endpoints. +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"] ----