Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Override workspace base domain #2826

Merged
merged 3 commits into from
Nov 22, 2024
Merged

feat: Override workspace base domain #2826

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2aa49b4
feat: Override workspace base domain
tolusha Nov 22, 2024
8e8dc67
Fixup
tolusha Nov 22, 2024
49b5725
Update modules/administration-guide/pages/configuring-workspaces-endp…
tolusha Nov 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modules/administration-guide/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand Down
1 change: 1 addition & 0 deletions modules/administration-guide/pages/configuring-networking.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
41 changes: 41 additions & 0 deletions ...es/administration-guide/pages/configuring-workspaces-endpoints-base-domain.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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[]
2 changes: 1 addition & 1 deletion modules/administration-guide/pages/configuring-workspaces-globally.adoc
View file
Open in desktop
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[]
Loading