chore: Add URL parameters to limit resource usage (#2914)

* chore: Add URL parameters to limit resource usage

Signed-off-by: Oleksii Orel <[email protected]>

* Update modules/end-user-guide/pages/url-parameter-for-cpu-limit.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update modules/end-user-guide/pages/url-parameter-for-memory-limit.adoc

Co-authored-by: Jana Vrbkova <[email protected]>

* Update modules/end-user-guide/pages/url-parameter-for-cpu-limit.adoc

Co-authored-by: David Kwon <[email protected]>

* Update modules/end-user-guide/pages/url-parameter-for-memory-limit.adoc

Co-authored-by: David Kwon <[email protected]>

* Update modules/end-user-guide/pages/url-parameter-for-memory-limit.adoc

Co-authored-by: David Kwon <[email protected]>

* Update modules/end-user-guide/pages/url-parameter-for-cpu-limit.adoc

Co-authored-by: David Kwon <[email protected]>

* Update modules/end-user-guide/pages/url-parameter-for-cpu-limit.adoc

Co-authored-by: David Kwon <[email protected]>

* Update modules/end-user-guide/pages/url-parameter-for-memory-limit.adoc

Co-authored-by: David Kwon <[email protected]>

---------

Signed-off-by: Oleksii Orel <[email protected]>
Co-authored-by: Jana Vrbkova <[email protected]>
Co-authored-by: David Kwon <[email protected]>

Author: 3 people

modules/end-user-guide/nav.adoc

@@ -12,6 +12,8 @@
 **** xref:url-parameter-for-the-workspace-storage.adoc[]
 **** xref:url-parameter-for-additional-remotes.adoc[]
 **** xref:url-parameter-for-container-image.adoc[]
+**** xref:url-parameter-for-memory-limit.adoc[]
+**** xref:url-parameter-for-cpu-limit.adoc[]
 ** xref:starting-a-workspace-from-a-raw-devfile-url.adoc[]
 ** xref:basic-actions-you-can-perform-on-a-workspace.adoc[]
 ** xref:authenticating-to-a-git-server-from-a-workspace.adoc[]

modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc

@@ -18,3 +18,5 @@ When you start a new workspace, {prod-short} configures the workspace according
 * xref:url-parameter-for-the-workspace-storage.adoc[]
 * xref:url-parameter-for-additional-remotes.adoc[]
 * xref:url-parameter-for-container-image.adoc[]
+* xref:url-parameter-for-memory-limit.adoc[]
+* xref:url-parameter-for-cpu-limit.adoc[]

modules/end-user-guide/pages/url-parameter-for-cpu-limit.adoc

@@ -0,0 +1,39 @@
+:_content-type: CONCEPT
+:description: URL parameter for a CPU limit
+:keywords: parameter, URL, container, CPU limit
+:navtitle: URL parameter for a CPU limit
+//:page-aliases:
+
+[id="url-parameter-for-cpu-limit"]
+= URL parameter for a CPU limit
+
+You can use the `cpuLimit` parameter to specify or override the container CPU limit
+when starting a new workspace from a devfile URL. This is useful when you want to ensure that the workspace has enough memory allocated for your development tasks.
+
+The URL parameter for the CPU limit is `cpuLimit=`:
+
+[source,subs="+quotes,+attributes,+macros"]
+----
+pass:c,a,q[{prod-url}]#__<git_repository_url>__?cpuLimit=__<container_cpu_limit>__
+----
+You can specify the CPU limit in cores.
+
+.Example
+
+====
+
+`pass:c,a,q[{prod-url}]#https://github.com/eclipse-che/che-docs?cpuLimit=2`
+
+====
+[IMPORTANT]
+====
+When you specify the `cpuLimit` parameter, it overrides the CPU limit defined for the first container of the devfile.
+
+The sum of the limits from the target devfile and from the editor definition will be applied to the workspace pod `spec.containers[0].resources.limits.cpu`.
+====
+
+.Additional resources
+
+* link:https://devfile.io/docs/2.3.0/limiting-resources-usage[Limiting resources usage]
+
+* {editor-definition-samples-link}

modules/end-user-guide/pages/url-parameter-for-memory-limit.adoc

@@ -0,0 +1,39 @@
+:_content-type: CONCEPT
+:description: URL parameter for a memory limit
+:keywords: parameter, URL, container, memory limit
+:navtitle: URL parameter for a memory limit
+//:page-aliases:
+
+[id="url-parameter-for-memory-limit"]
+= URL parameter for a memory limit
+
+You can use the `memoryLimit` parameter to specify or override the container memory limit
+when starting a new workspace from a devfile URL. This is useful when you want to ensure that the workspace has enough memory allocated for your development tasks.
+
+The URL parameter for the memory limit is `memoryLimit=`:
+
+[source,subs="+quotes,+attributes,+macros"]
+----
+pass:c,a,q[{prod-url}]#__<git_repository_url>__?memoryLimit=__<container_memory_limit>__
+----
+You can specify the memory limit in bytes, or use a suffix such as `Mi` for mebibytes or `Gi` for gibibytes.
+
+.Example
+
+====
+
+`pass:c,a,q[{prod-url}]#https://github.com/eclipse-che/che-docs?memoryLimit=4Gi`
+
+====
+[IMPORTANT]
+====
+When you specify the `memoryLimit` parameter, it overrides the memory limit defined for the first container of the devfile.
+
+The sum of the limits from the target devfile and from the editor definition will be applied to the workspace pod `spec.containers[0].resources.limits.memory`.
+====
+
+.Additional resources
+
+* link:https://devfile.io/docs/2.3.0/limiting-resources-usage[Limiting resources usage]
+
+* {editor-definition-samples-link}