chore: Configuring allowed URLs for Cloud Development Environment (#2790

) * chore: Configuring allowed URLs for Cloud Development Environment Signed-off-by: Anatolii Bazko <abazko@redhat.com> * fixup Signed-off-by: Anatolii Bazko <abazko@redhat.com> * fixup Signed-off-by: Anatolii Bazko <abazko@redhat.com> --------- Signed-off-by: Anatolii Bazko <abazko@redhat.com>
eclipse-che · Sep 20, 2024 · 16c91db · 16c91db
1 parent dcbd82a
commit 16c91db
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 0 deletions.
diff --git a/.htmltest.yml b/.htmltest.yml
@@ -29,4 +29,5 @@ IgnoreURLs:
   - https://mattermost.eclipse.org/eclipse/channels/eclipse-che
   - https://git.example.com:8443
   - https://stackoverflow.com/questions/tagged/eclipse-che
+  - https://example.com/
 
diff --git a/modules/administration-guide/nav.adoc b/modules/administration-guide/nav.adoc
@@ -48,6 +48,7 @@
 *** xref:configuring-workspaces-nodeselector.adoc[]
 *** xref:configuring-the-open-vsx-registry-url.adoc[]
 *** xref:configuring-a-user-namespace.adoc[]
+*** xref:configuring-allowed-urls-for-cloud-development-environments.adoc[]
 ** xref:caching-images-for-faster-workspace-start.adoc[]
 *** xref:installing-image-puller-on-kubernetes-by-using-cli.adoc[]
 *** xref:installing-image-puller-on-openshift-using-cli.adoc[]

diff --git a/...on-guide/pages/configuring-allowed-urls-for-cloud-development-environments.adoc b/...on-guide/pages/configuring-allowed-urls-for-cloud-development-environments.adoc
@@ -0,0 +1,33 @@
+:_content-type: PROCEDURE
+:description: Configuring allowed URLs for Cloud Development Environments
+:keywords: administration guide, configuring-allowed-sources
+:navtitle: Configuring allowed URLs for Cloud Development Environments
+
+[id="configuring-allowed-urls-for-cloud-development-environments"]
+= Configuring allowed URLs for Cloud Development Environments
+
+Allowed URLs play an important role in securing the initiation of Cloud Development Environments (CDEs), ensuring that they can only be launched from authorized sources. By utilizing wildcard support, such as `*`, organizations can implement flexible URL patterns, allowing for dynamic and secure CDE initiation across various paths within a domain.
+
+. Configure allowed sources:
++
+[source,subs="+quotes,+attributes"]
+----
+{orch-cli} patch checluster/{prod-checluster} \
+    --namespace {prod-namespace} \
+    --type='merge' \
+    -p \
+'{
+   "spec": {
+     "devEnvironments": {
+       "allowedSources": {
+         "urls": ["url_1", "url_2"] <1>
+       }
+     }
+   }
+ }'
+----
+<1> The array of approved URLs for starting Cloud Development Environments (CDEs). CDEs can only be initiated from these URLs. Wildcards `\*` are supported in URLs. For example, `https://example.com/*` would allow CDEs to be initiated from any path within `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
@@ -18,3 +18,5 @@ This section describes how an administrator can configure workspaces globally.
 * xref:deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc[]
 
 * xref:configuring-workspaces-nodeselector.adoc[]
+
+* xref:configuring-allowed-urls-for-cloud-development-environments.adoc[]
Original file line number	Diff line number	Diff line change
Expand Up		@@ -18,3 +18,5 @@ This section describes how an administrator can configure workspaces globally.
		* xref:deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc[]

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

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