From 725545142b943a07cc66b90e36c45a4302c1bcf7 Mon Sep 17 00:00:00 2001 From: Tereza Stastna Date: Fri, 21 May 2021 14:01:10 +0200 Subject: [PATCH 1/8] Running multiple workspaces simultaneously first draft --- .../examples/che-pvc-strategies.adoc | 2 +- modules/installation-guide/nav.adoc | 2 +- ...spaces-a-user-can-run-using-configmap.adoc | 8 ++++ ...ces-a-user-can-run-using-the-operator.adoc | 8 ++++ ...e-number-of-workspaces-a-user-can-run.adoc | 7 +++ ...ing-more-than-one-workspace-at-a-time.adoc | 8 ---- .../assembly_advanced-configuration.adoc | 2 +- ...e-number-of-workspaces-a-user-can-run.adoc | 30 +++++++++++++ .../con_persistent-volume-configuration.adoc | 2 +- ...proc_configuring-namespace-strategies.adoc | 2 +- ...spaces-a-user-can-run-using-configmap.adoc | 42 ++++++++++++++++++ ...ces-a-user-can-run-using-the-operator.adoc | 38 ++++++++++++++++ ...ing-more-than-one-workspace-at-a-time.adoc | 43 ------------------- 13 files changed, 138 insertions(+), 56 deletions(-) create mode 100644 modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc create mode 100644 modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc create mode 100644 modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run.adoc delete mode 100644 modules/installation-guide/pages/running-more-than-one-workspace-at-a-time.adoc create mode 100644 modules/installation-guide/partials/assembly_defining-the-number-of-workspaces-a-user-can-run.adoc create mode 100644 modules/installation-guide/partials/proc_defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc create mode 100644 modules/installation-guide/partials/proc_defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc delete mode 100644 modules/installation-guide/partials/proc_running-more-than-one-workspace-at-a-time.adoc diff --git a/modules/installation-guide/examples/che-pvc-strategies.adoc b/modules/installation-guide/examples/che-pvc-strategies.adoc index 46dd4d9c7d..c79c8736a2 100644 --- a/modules/installation-guide/examples/che-pvc-strategies.adoc +++ b/modules/installation-guide/examples/che-pvc-strategies.adoc @@ -10,7 +10,7 @@ One PVC for all workspaces in one {platforms-namespace} * Each workspace is in a separate {platforms-namespace} -* Only one workspace is running per {platforms-namespace} at the same time. See xref:installation-guide:running-more-than-one-workspace-at-a-time.adoc[]. +* Only one workspace is running per {platforms-namespace} at the same time. See xref:installation-guide:defining-the-number-of-workspaces-a-user-can-run.adoc[]. |*per-workspace* | One PVC for one workspace diff --git a/modules/installation-guide/nav.adoc b/modules/installation-guide/nav.adoc index 79e101b0e3..b6e0448452 100644 --- a/modules/installation-guide/nav.adoc +++ b/modules/installation-guide/nav.adoc @@ -35,7 +35,7 @@ ** xref:configuring-namespace-strategies.adoc[] ** xref:configuring-storage-strategies.adoc[] ** xref:configuring-storage-types.adoc[] -** xref:running-more-than-one-workspace-at-a-time.adoc[] +** xref:defining-the-number-of-workspaces-a-user-can-run.adoc[] ** xref:configuring-workspace-exposure-strategies.adoc[] ** xref:configuring-workspaces-nodeselector.adoc[] ** xref:configuring-che-hostname.adoc[] diff --git a/modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc b/modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc new file mode 100644 index 0000000000..fc29daae32 --- /dev/null +++ b/modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc @@ -0,0 +1,8 @@ +[id="defining-the-number-of-workspaces-a-user-can-run-using-configmap"] +// = Defining the number of workspaces a user can run using ConfigMap +:navtitle: Defining the number of workspaces a user can run using ConfigMap +:keywords: installation-guide, running-workspaces +:page-aliases: defining-the-number-of-workspaces-a-user-can-run-using-configmap + +include::partial$proc_defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc[] + diff --git a/modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc b/modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc new file mode 100644 index 0000000000..c8f4995eb6 --- /dev/null +++ b/modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc @@ -0,0 +1,8 @@ +[id="defining-the-number-of-workspaces-a-user-can-run-using-the-operator"] +// = Defining the number of workspaces a user can run using the Operator +:navtitle: Defining the number of workspaces a user can run using the Operator +:keywords: installation-guide, running-workspaces +:page-aliases: defining-the-number-of-workspaces-a-user-can-run-using-the-operator, .:running-more-than-one-workspace-at-a-time + +include::partial$proc_defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc[] + diff --git a/modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run.adoc b/modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run.adoc new file mode 100644 index 0000000000..a1722b9a65 --- /dev/null +++ b/modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run.adoc @@ -0,0 +1,7 @@ +[id="defining-the-number-of-workspaces-a-user-can-run"] +// = Defining the number of workspaces a user can run +:navtitle: Defining the number of workspaces a user can run +:keywords: installation-guide, running-workspaces +:page-aliases: defining-the-number-of-workspaces-a-user-can-run + +include::partial$assembly_defining-the-number-of-workspaces-a-user-can-run.adoc[] diff --git a/modules/installation-guide/pages/running-more-than-one-workspace-at-a-time.adoc b/modules/installation-guide/pages/running-more-than-one-workspace-at-a-time.adoc deleted file mode 100644 index 2f0edeb0ef..0000000000 --- a/modules/installation-guide/pages/running-more-than-one-workspace-at-a-time.adoc +++ /dev/null @@ -1,8 +0,0 @@ -[id="running-more-than-one-workspace-at-a-time"] -// = Running more than one workspace at a time -:navtitle: Running more than one workspace at a time -:keywords: installation-guide, running-workspaces -:page-aliases: .:running-more-than-one-workspace-at-a-time - -include::partial$proc_running-more-than-one-workspace-at-a-time.adoc[] - diff --git a/modules/installation-guide/partials/assembly_advanced-configuration.adoc b/modules/installation-guide/partials/assembly_advanced-configuration.adoc index c8192bcb09..4a709e25bc 100644 --- a/modules/installation-guide/partials/assembly_advanced-configuration.adoc +++ b/modules/installation-guide/partials/assembly_advanced-configuration.adoc @@ -16,7 +16,7 @@ The next sections describe some specific user stories. * xref:configuring-namespace-strategies.adoc[] -* xref:running-more-than-one-workspace-at-a-time.adoc[] +* xref:defining-the-number-of-workspaces-a-user-can-run.adoc[] * xref:configuring-workspaces-nodeselector.adoc[] diff --git a/modules/installation-guide/partials/assembly_defining-the-number-of-workspaces-a-user-can-run.adoc b/modules/installation-guide/partials/assembly_defining-the-number-of-workspaces-a-user-can-run.adoc new file mode 100644 index 0000000000..d9236bc367 --- /dev/null +++ b/modules/installation-guide/partials/assembly_defining-the-number-of-workspaces-a-user-can-run.adoc @@ -0,0 +1,30 @@ +ifdef::context[:parent-context-of-assembly_defining-the-number-of-workspaces-a-user-can-run: {context}] + +ifndef::context[] +[id="defining-the-number-of-workspaces-a-user-can-run"] +endif::[] +ifdef::context[] +[id="defining-the-number-of-workspaces-a-user-can-run_{context}"] +endif::[] += Defining the number of workspaces a user can run + +:context: assembly_defining-the-number-of-workspaces-a-user-can-run + +This article describes how to define the number of workspaces a user can run simultaneously. + +== Prerequisites +* An instance of {prod-short} running in {platforms-name}. + +include::partial$proc_defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc[leveloffset=+1] + +ifeval::["{project-context}" == "che"] +include::partial$proc_defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc[leveloffset=+1] +endif::[] + +[role="_additional-resources"] +== Additional resources +//TODO: + +ifdef::parent-context-of-assembly_defining-the-number-of-workspaces-a-user-can-run[:context: {parent-context-of-assembly_defining-the-number-of-workspaces-a-user-can-run}] +ifndef::parent-context-of-assembly_defining-the-number-of-workspaces-a-user-can-run[:!context:] + diff --git a/modules/installation-guide/partials/con_persistent-volume-configuration.adoc b/modules/installation-guide/partials/con_persistent-volume-configuration.adoc index c185625e93..c5653af3d3 100644 --- a/modules/installation-guide/partials/con_persistent-volume-configuration.adoc +++ b/modules/installation-guide/partials/con_persistent-volume-configuration.adoc @@ -38,7 +38,7 @@ If there are several nodes, you can use the `common` strategy, but: * The workspace PVC access mode must be reconfigured to `ReadWriteMany` (RWM), so multiple nodes can use this PVC simultaneously. -* Only one workspace in the same {orch-namespace} may be running. See xref:installation-guide:running-more-than-one-workspace-at-a-time.adoc[]. +* Only one workspace in the same {orch-namespace} may be running. See xref:installation-guide:defining-the-number-of-workspaces-a-user-can-run.adoc[]. The `common` PVC strategy is not suitable for large multi-node clusters. Therefore, it is best to use it in single-node clusters. However, in combination with the `per-workspace` {orch-namespace} strategy, the `common` PVC strategy is usable for clusters with not more than 75 nodes. The PVC used with this strategy must be large enough to accommodate all projects to prevent a situation in which one project depletes the resources of others. diff --git a/modules/installation-guide/partials/proc_configuring-namespace-strategies.adoc b/modules/installation-guide/partials/proc_configuring-namespace-strategies.adoc index 94e2adff91..7fa9b8f50c 100644 --- a/modules/installation-guide/partials/proc_configuring-namespace-strategies.adoc +++ b/modules/installation-guide/partials/proc_configuring-namespace-strategies.adoc @@ -44,7 +44,7 @@ endif::[] NOTE: The underlying environment variable that {prod-short} server uses is `CHE_INFRA_KUBERNETES_NAMESPACE_DEFAULT`. -WARNING: By default, only one workspace in the same {orch-namespace} can be running at one time. See xref:running-more-than-one-workspace-at-a-time.adoc[]. +WARNING: By default, only one workspace in the same {orch-namespace} can be running at one time. See xref:defining-the-number-of-workspaces-a-user-can-run.adoc[]. [WARNING] ==== diff --git a/modules/installation-guide/partials/proc_defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc b/modules/installation-guide/partials/proc_defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc new file mode 100644 index 0000000000..7d6e9386cb --- /dev/null +++ b/modules/installation-guide/partials/proc_defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc @@ -0,0 +1,42 @@ +[id="defining-the-number-of-workspaces-a-user-can-run-using-configmap_{context}"] += Defining the number of workspaces a user can run using ConfigMap + +This procedure describes how to run more than one workspace simultaneously using ConfigMap. + +.Prerequisites +* The `{platforms-cli}` tool is available. + +.Placeholders used in examples +[cols="1,2"] +|=== +| `__` +| The namespace of the product. The default option for {platforms-namespace} is `{prod-namespace}`. + +| `__` +| The number of workspaces to run simultaneously. The default value is `1`. Set the value to `-1` to allow the user to run an unlimited number of concurrent workspaces. Set it to a precise value to allow running that many concurrent workspaces. +|=== + +.Procedure +. If the persistent volume claim (PVC) strategy of the cluster is `common`, configure the persistent volumes of the cluster to use the `ReadWriteMany` access mode. ++ +If you are unable to use the `ReadWriteMany` access mode, configure the PVC strategy to `per-workspace` or `unique`. For more information, see xref:configuring-storage-strategies.adoc[]. ++ +[NOTE] +==== +In some cases, configuring `ReadWriteMany` is not possible due to the storage limitations. For example, link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html[EBS] only supports `ReadWriteOnce` access mode. +==== +. Set the number of workspaces a user can run simultaneously: ++ +[subs="+quotes,+attributes"] +---- +$ helm upgrade che -n --set che.limits.userWorkspacesRunCount= +---- + +.Verification +//TODO: + +[role="_additional-resources"] +.Additional resources +//TODO: + + diff --git a/modules/installation-guide/partials/proc_defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc b/modules/installation-guide/partials/proc_defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc new file mode 100644 index 0000000000..808e0ed2c8 --- /dev/null +++ b/modules/installation-guide/partials/proc_defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc @@ -0,0 +1,38 @@ +// Module included in the following assemblies: +// +// advanced-configuration + +[id="defining-the-number-of-workspaces-a-user-can-run-using-the-operator_{context}"] += Defining the number of workspaces a user can run using the Operator + +This procedure describes how to run more than one workspace simultaneously using the Operator. + +//This makes it possible for multiple workspace contexts per user to run in parallel. +//TODO: fix second sentence +// pvc persistent volume claim + +.Procedure + +. Set the `per-workspace` or `unique` PVC strategy if the underlying storage backend does not support or is not configured to use the `ReadWriteMany` access mode. See xref:configuring-storage-strategies.adoc[]. ++ +IMPORTANT: The default `common` PVC strategy, which uses a single PVC per user, supports running multiple workspaces simultaneously only if the persistent volumes on the cluster are configured to use the `ReadWriteMany` access mode. +That way, any of the user's concurrent workspaces can read from and write to the common PVC. +In some cases, configuring `ReadWriteMany` is not possible due to the storage limitations, for example, link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html[EBS] only supports `ReadWriteOnce` access mode. +. In `CheCluster` Custom Resource `server` settings, add the `+CHE_LIMITS_USER_WORKSPACES_RUN_COUNT+` property to `customCheProperties`: +==== +[source,yaml] +---- +apiVersion: org.eclipse.che/v1 +kind: CheCluster +# [...] +spec: + server: + # [...] + customCheProperties: + CHE_LIMITS_USER_WORKSPACES_RUN_COUNT: "1" +---- +==== + +Change the default limit of `1` to `-1` to allow an unlimited number of concurrent workspaces, or to the precise value, for example, `10` to allow running `10` concurrent workspaces per user simultaneously. + + diff --git a/modules/installation-guide/partials/proc_running-more-than-one-workspace-at-a-time.adoc b/modules/installation-guide/partials/proc_running-more-than-one-workspace-at-a-time.adoc deleted file mode 100644 index 5f4574470e..0000000000 --- a/modules/installation-guide/partials/proc_running-more-than-one-workspace-at-a-time.adoc +++ /dev/null @@ -1,43 +0,0 @@ -// Module included in the following assemblies: -// -// advanced-configuration - -[id="running-more-than-one-workspace-at-a-time_{context}"] -= Running more than one workspace at a time - -This procedure describes how to run more than one workspace simultaneously. This makes it possible for multiple workspace contexts per user to run in parallel. - -.Prerequisites - -* The `{platforms-cli}` tool is available. -* An instance of {prod-short} running in {platforms-name}. -+ -[NOTE] -==== -The following commands use the default {platforms-namespace}, `{prod-namespace}`, as a user's example for the `-n` option. -==== - -.Procedure - -. Set the `per-workspace` or `unique` PVC strategy if the underlying storage backend does not support or not configured to use the `ReadWriteMany` access mode. See xref:configuring-storage-strategies.adoc[]. -+ -IMPORTANT: The default `common` PVC strategy, which uses a single PVC per user, supports running multiple workspaces simultaneously only if the persistent volumes on the cluster are configured to use the `ReadWriteMany` access mode. -That way, any of the user's concurrent workspaces can read from and write to the common PVC. -In some cases, configuring `ReadWriteMany` is not possible due to the storage limitations, for example, link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html[EBS] only supports `ReadWriteOnce` access mode. -. Change the default limit of `1` to `-1` to allow an unlimited number of concurrent workspaces, or to the precise value, for example, `10` to allow running `10` concurrent workspaces per user simultaneously: - -ifeval::["{project-context}" == "che"] -* For Helm Chart deployments: -+ -[subs="+quotes,+attributes"] ----- -$ helm upgrade che -n {prod-namespace} --set che.limits.userWorkspacesRunCount=-1 ----- -* For Operator deployments: -+ -endif::[] -[subs="+quotes,+attributes"] ----- -$ {orch-cli} patch checluster/{prod-checluster} -n {prod-namespace} --type merge \ - -p '{ "spec": { "server": {"customCheProperties": {"CHE_LIMITS_USER_WORKSPACES_RUN_COUNT": "-1"} } }}' ----- From 7cedd36209aade9d45b7f42061f84369ddc59c13 Mon Sep 17 00:00:00 2001 From: Tereza Stastna Date: Mon, 24 May 2021 17:01:42 +0200 Subject: [PATCH 2/8] Updating the Operator procedure and doing small fixes --- ...spaces-a-user-can-run-using-configmap.adoc | 18 +++++++------ ...ces-a-user-can-run-using-the-operator.adoc | 26 ++++++++++++------- 2 files changed, 26 insertions(+), 18 deletions(-) diff --git a/modules/installation-guide/partials/proc_defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc b/modules/installation-guide/partials/proc_defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc index 7d6e9386cb..82a7b6e68b 100644 --- a/modules/installation-guide/partials/proc_defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc +++ b/modules/installation-guide/partials/proc_defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc @@ -3,29 +3,31 @@ This procedure describes how to run more than one workspace simultaneously using ConfigMap. -.Prerequisites -* The `{platforms-cli}` tool is available. - .Placeholders used in examples [cols="1,2"] |=== | `__` -| The namespace of the product. The default option for {platforms-namespace} is `{prod-namespace}`. +| The namespace of the product. The default option for `{platforms-namespace}` is `{prod-namespace}`. | `__` | The number of workspaces to run simultaneously. The default value is `1`. Set the value to `-1` to allow the user to run an unlimited number of concurrent workspaces. Set it to a precise value to allow running that many concurrent workspaces. |=== +.Prerequisites +* The `{platforms-cli}` tool is available. + .Procedure -. If the persistent volume claim (PVC) strategy of the cluster is `common`, configure the persistent volumes of the cluster to use the `ReadWriteMany` access mode. +. If the Persistent Volume Claim (PVC) strategy of the cluster is `common`, configure the persistent volumes of the cluster to use the `ReadWriteMany` access mode. ++ +If you are unable to use the `ReadWriteMany` access mode, configure the PVC strategy to `per-workspace` or `unique`. + -If you are unable to use the `ReadWriteMany` access mode, configure the PVC strategy to `per-workspace` or `unique`. For more information, see xref:configuring-storage-strategies.adoc[]. +For more information, see xref:configuring-storage-strategies.adoc[]. + [NOTE] ==== -In some cases, configuring `ReadWriteMany` is not possible due to the storage limitations. For example, link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html[EBS] only supports `ReadWriteOnce` access mode. +In some cases, using the `ReadWriteMany` access mode is not possible due to the storage limitations. For example, link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html[EBS] only supports `ReadWriteOnce` access mode. ==== -. Set the number of workspaces a user can run simultaneously: +. Define the number of workspaces a user can run simultaneously: + [subs="+quotes,+attributes"] ---- diff --git a/modules/installation-guide/partials/proc_defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc b/modules/installation-guide/partials/proc_defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc index 808e0ed2c8..cb674c8dfc 100644 --- a/modules/installation-guide/partials/proc_defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc +++ b/modules/installation-guide/partials/proc_defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc @@ -7,17 +7,24 @@ This procedure describes how to run more than one workspace simultaneously using the Operator. -//This makes it possible for multiple workspace contexts per user to run in parallel. -//TODO: fix second sentence -// pvc persistent volume claim +.Placeholders used in examples +[cols="1,2"] +|=== +| `__` +| The number of workspaces to run simultaneously. The default value is `1`. Set the value to `-1` to allow the user to run an unlimited number of concurrent workspaces. Set it to a precise value to allow running that many concurrent workspaces. +|=== .Procedure - -. Set the `per-workspace` or `unique` PVC strategy if the underlying storage backend does not support or is not configured to use the `ReadWriteMany` access mode. See xref:configuring-storage-strategies.adoc[]. +. If the Persistent Volume Claim (PVC) strategy of the cluster is `common`, configure the persistent volumes of the cluster to use the `ReadWriteMany` access mode. ++ +If you are unable to use the `ReadWriteMany` access mode, configure the PVC strategy to `per-workspace` or `unique`. + -IMPORTANT: The default `common` PVC strategy, which uses a single PVC per user, supports running multiple workspaces simultaneously only if the persistent volumes on the cluster are configured to use the `ReadWriteMany` access mode. -That way, any of the user's concurrent workspaces can read from and write to the common PVC. -In some cases, configuring `ReadWriteMany` is not possible due to the storage limitations, for example, link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html[EBS] only supports `ReadWriteOnce` access mode. +For more information, see xref:configuring-storage-strategies.adoc[]. ++ +[NOTE] +==== +In some cases, using the `ReadWriteMany` access mode is not possible due to the storage limitations. For example, link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html[EBS] only supports `ReadWriteOnce` access mode. +==== . In `CheCluster` Custom Resource `server` settings, add the `+CHE_LIMITS_USER_WORKSPACES_RUN_COUNT+` property to `customCheProperties`: ==== [source,yaml] @@ -29,10 +36,9 @@ spec: server: # [...] customCheProperties: - CHE_LIMITS_USER_WORKSPACES_RUN_COUNT: "1" + CHE_LIMITS_USER_WORKSPACES_RUN_COUNT: "" ---- ==== -Change the default limit of `1` to `-1` to allow an unlimited number of concurrent workspaces, or to the precise value, for example, `10` to allow running `10` concurrent workspaces per user simultaneously. From 643d65e5c8edc9c337fdda5e00db23959ab13962 Mon Sep 17 00:00:00 2001 From: Tereza Stastna Date: Tue, 25 May 2021 11:16:28 +0200 Subject: [PATCH 3/8] Fix context in assembly --- ...g-the-number-of-workspaces-a-user-can-run.adoc | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/modules/installation-guide/partials/assembly_defining-the-number-of-workspaces-a-user-can-run.adoc b/modules/installation-guide/partials/assembly_defining-the-number-of-workspaces-a-user-can-run.adoc index d9236bc367..8df303ae47 100644 --- a/modules/installation-guide/partials/assembly_defining-the-number-of-workspaces-a-user-can-run.adoc +++ b/modules/installation-guide/partials/assembly_defining-the-number-of-workspaces-a-user-can-run.adoc @@ -1,14 +1,9 @@ -ifdef::context[:parent-context-of-assembly_defining-the-number-of-workspaces-a-user-can-run: {context}] +:parent-context-of-defining-the-number-of-workspaces-a-user-can-run: {context} -ifndef::context[] -[id="defining-the-number-of-workspaces-a-user-can-run"] -endif::[] -ifdef::context[] [id="defining-the-number-of-workspaces-a-user-can-run_{context}"] -endif::[] = Defining the number of workspaces a user can run -:context: assembly_defining-the-number-of-workspaces-a-user-can-run +:context: defining-the-number-of-workspaces-a-user-can-run This article describes how to define the number of workspaces a user can run simultaneously. @@ -18,13 +13,13 @@ This article describes how to define the number of workspaces a user can run sim include::partial$proc_defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc[leveloffset=+1] ifeval::["{project-context}" == "che"] + include::partial$proc_defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc[leveloffset=+1] + endif::[] [role="_additional-resources"] == Additional resources //TODO: -ifdef::parent-context-of-assembly_defining-the-number-of-workspaces-a-user-can-run[:context: {parent-context-of-assembly_defining-the-number-of-workspaces-a-user-can-run}] -ifndef::parent-context-of-assembly_defining-the-number-of-workspaces-a-user-can-run[:!context:] - +:context: {parent-context-of-defining-the-number-of-workspaces-a-user-can-run} From d0757b254d53250b1516af04290a406098bdce85 Mon Sep 17 00:00:00 2001 From: Tereza Stastna Date: Wed, 26 May 2021 13:51:17 +0200 Subject: [PATCH 4/8] Rename the files and improve the content --- .../examples/che-pvc-strategies.adoc | 2 +- modules/installation-guide/nav.adoc | 2 +- ...e-number-of-workspaces-a-user-can-run.adoc | 7 ++++ ...spaces-a-user-can-run-using-configmap.adoc | 8 ----- ...ces-a-user-can-run-using-the-operator.adoc | 8 ----- ...e-number-of-workspaces-a-user-can-run.adoc | 7 ---- .../assembly_advanced-configuration.adoc | 2 +- ...e-number-of-workspaces-a-user-can-run.adoc | 19 +++++++++++ ...e-number-of-workspaces-a-user-can-run.adoc | 25 -------------- .../con_persistent-volume-configuration.adoc | 2 +- ...proc_configuring-namespace-strategies.adoc | 2 +- ...paces-a-user-can-run-using-configmap.adoc} | 9 ++--- ...es-a-user-can-run-using-the-operator.adoc} | 33 +++++++++---------- 13 files changed, 48 insertions(+), 78 deletions(-) create mode 100644 modules/installation-guide/pages/configuring-the-number-of-workspaces-a-user-can-run.adoc delete mode 100644 modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc delete mode 100644 modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc delete mode 100644 modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run.adoc create mode 100644 modules/installation-guide/partials/assembly_configuring-the-number-of-workspaces-a-user-can-run.adoc delete mode 100644 modules/installation-guide/partials/assembly_defining-the-number-of-workspaces-a-user-can-run.adoc rename modules/installation-guide/partials/{proc_defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc => proc_configuring-the-number-of-workspaces-a-user-can-run-using-configmap.adoc} (86%) rename modules/installation-guide/partials/{proc_defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc => proc_configuring-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc} (51%) diff --git a/modules/installation-guide/examples/che-pvc-strategies.adoc b/modules/installation-guide/examples/che-pvc-strategies.adoc index c79c8736a2..a2237fc969 100644 --- a/modules/installation-guide/examples/che-pvc-strategies.adoc +++ b/modules/installation-guide/examples/che-pvc-strategies.adoc @@ -10,7 +10,7 @@ One PVC for all workspaces in one {platforms-namespace} * Each workspace is in a separate {platforms-namespace} -* Only one workspace is running per {platforms-namespace} at the same time. See xref:installation-guide:defining-the-number-of-workspaces-a-user-can-run.adoc[]. +* Only one workspace is running per {platforms-namespace} at the same time. See xref:installation-guide:configuring-the-number-of-workspaces-a-user-can-run.adoc[]. |*per-workspace* | One PVC for one workspace diff --git a/modules/installation-guide/nav.adoc b/modules/installation-guide/nav.adoc index b6e0448452..49cfdec30c 100644 --- a/modules/installation-guide/nav.adoc +++ b/modules/installation-guide/nav.adoc @@ -35,7 +35,7 @@ ** xref:configuring-namespace-strategies.adoc[] ** xref:configuring-storage-strategies.adoc[] ** xref:configuring-storage-types.adoc[] -** xref:defining-the-number-of-workspaces-a-user-can-run.adoc[] +** xref:configuring-the-number-of-workspaces-a-user-can-run.adoc[] ** xref:configuring-workspace-exposure-strategies.adoc[] ** xref:configuring-workspaces-nodeselector.adoc[] ** xref:configuring-che-hostname.adoc[] diff --git a/modules/installation-guide/pages/configuring-the-number-of-workspaces-a-user-can-run.adoc b/modules/installation-guide/pages/configuring-the-number-of-workspaces-a-user-can-run.adoc new file mode 100644 index 0000000000..980897c82c --- /dev/null +++ b/modules/installation-guide/pages/configuring-the-number-of-workspaces-a-user-can-run.adoc @@ -0,0 +1,7 @@ +[id="configuring-the-number-of-workspaces-a-user-can-run"] +// = Configuring the number of workspaces a user can run +:navtitle: Configuring the number of workspaces +:keywords: installation-guide, running-workspaces +:page-aliases: .:configuring-the-number-of-workspaces-a-user-can-run, .:running-more-than-one-workspace-at-a-time, running-more-than-one-workspace-at-a-time + +include::partial$assembly_configuring-the-number-of-workspaces-a-user-can-run.adoc[] diff --git a/modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc b/modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc deleted file mode 100644 index fc29daae32..0000000000 --- a/modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc +++ /dev/null @@ -1,8 +0,0 @@ -[id="defining-the-number-of-workspaces-a-user-can-run-using-configmap"] -// = Defining the number of workspaces a user can run using ConfigMap -:navtitle: Defining the number of workspaces a user can run using ConfigMap -:keywords: installation-guide, running-workspaces -:page-aliases: defining-the-number-of-workspaces-a-user-can-run-using-configmap - -include::partial$proc_defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc[] - diff --git a/modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc b/modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc deleted file mode 100644 index c8f4995eb6..0000000000 --- a/modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc +++ /dev/null @@ -1,8 +0,0 @@ -[id="defining-the-number-of-workspaces-a-user-can-run-using-the-operator"] -// = Defining the number of workspaces a user can run using the Operator -:navtitle: Defining the number of workspaces a user can run using the Operator -:keywords: installation-guide, running-workspaces -:page-aliases: defining-the-number-of-workspaces-a-user-can-run-using-the-operator, .:running-more-than-one-workspace-at-a-time - -include::partial$proc_defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc[] - diff --git a/modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run.adoc b/modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run.adoc deleted file mode 100644 index a1722b9a65..0000000000 --- a/modules/installation-guide/pages/defining-the-number-of-workspaces-a-user-can-run.adoc +++ /dev/null @@ -1,7 +0,0 @@ -[id="defining-the-number-of-workspaces-a-user-can-run"] -// = Defining the number of workspaces a user can run -:navtitle: Defining the number of workspaces a user can run -:keywords: installation-guide, running-workspaces -:page-aliases: defining-the-number-of-workspaces-a-user-can-run - -include::partial$assembly_defining-the-number-of-workspaces-a-user-can-run.adoc[] diff --git a/modules/installation-guide/partials/assembly_advanced-configuration.adoc b/modules/installation-guide/partials/assembly_advanced-configuration.adoc index 4a709e25bc..bc9c97c8a9 100644 --- a/modules/installation-guide/partials/assembly_advanced-configuration.adoc +++ b/modules/installation-guide/partials/assembly_advanced-configuration.adoc @@ -16,7 +16,7 @@ The next sections describe some specific user stories. * xref:configuring-namespace-strategies.adoc[] -* xref:defining-the-number-of-workspaces-a-user-can-run.adoc[] +* xref:configuring-the-number-of-workspaces-a-user-can-run.adoc[] * xref:configuring-workspaces-nodeselector.adoc[] diff --git a/modules/installation-guide/partials/assembly_configuring-the-number-of-workspaces-a-user-can-run.adoc b/modules/installation-guide/partials/assembly_configuring-the-number-of-workspaces-a-user-can-run.adoc new file mode 100644 index 0000000000..5fcda8f27a --- /dev/null +++ b/modules/installation-guide/partials/assembly_configuring-the-number-of-workspaces-a-user-can-run.adoc @@ -0,0 +1,19 @@ +:parent-context-of-configuring-the-number-of-workspaces-a-user-can-run: {context} + +[id="configuring-the-number-of-workspaces-a-user-can-run_{context}"] += Configuring the number of workspaces a user can run + +:context: configuring-the-number-of-workspaces-a-user-can-run + +This article describes how to configure the number of workspaces a user can run simultaneously. + +include::partial$proc_configuring-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc[leveloffset=+1] + +ifeval::["{project-context}" == "che"] + +include::partial$proc_configuring-the-number-of-workspaces-a-user-can-run-using-configmap.adoc[leveloffset=+1] + +endif::[] + + +:context: {parent-context-of-configuring-the-number-of-workspaces-a-user-can-run} diff --git a/modules/installation-guide/partials/assembly_defining-the-number-of-workspaces-a-user-can-run.adoc b/modules/installation-guide/partials/assembly_defining-the-number-of-workspaces-a-user-can-run.adoc deleted file mode 100644 index 8df303ae47..0000000000 --- a/modules/installation-guide/partials/assembly_defining-the-number-of-workspaces-a-user-can-run.adoc +++ /dev/null @@ -1,25 +0,0 @@ -:parent-context-of-defining-the-number-of-workspaces-a-user-can-run: {context} - -[id="defining-the-number-of-workspaces-a-user-can-run_{context}"] -= Defining the number of workspaces a user can run - -:context: defining-the-number-of-workspaces-a-user-can-run - -This article describes how to define the number of workspaces a user can run simultaneously. - -== Prerequisites -* An instance of {prod-short} running in {platforms-name}. - -include::partial$proc_defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc[leveloffset=+1] - -ifeval::["{project-context}" == "che"] - -include::partial$proc_defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc[leveloffset=+1] - -endif::[] - -[role="_additional-resources"] -== Additional resources -//TODO: - -:context: {parent-context-of-defining-the-number-of-workspaces-a-user-can-run} diff --git a/modules/installation-guide/partials/con_persistent-volume-configuration.adoc b/modules/installation-guide/partials/con_persistent-volume-configuration.adoc index c5653af3d3..ba20fbd2a2 100644 --- a/modules/installation-guide/partials/con_persistent-volume-configuration.adoc +++ b/modules/installation-guide/partials/con_persistent-volume-configuration.adoc @@ -38,7 +38,7 @@ If there are several nodes, you can use the `common` strategy, but: * The workspace PVC access mode must be reconfigured to `ReadWriteMany` (RWM), so multiple nodes can use this PVC simultaneously. -* Only one workspace in the same {orch-namespace} may be running. See xref:installation-guide:defining-the-number-of-workspaces-a-user-can-run.adoc[]. +* Only one workspace in the same {orch-namespace} may be running. See xref:installation-guide:configuring-the-number-of-workspaces-a-user-can-run.adoc[]. The `common` PVC strategy is not suitable for large multi-node clusters. Therefore, it is best to use it in single-node clusters. However, in combination with the `per-workspace` {orch-namespace} strategy, the `common` PVC strategy is usable for clusters with not more than 75 nodes. The PVC used with this strategy must be large enough to accommodate all projects to prevent a situation in which one project depletes the resources of others. diff --git a/modules/installation-guide/partials/proc_configuring-namespace-strategies.adoc b/modules/installation-guide/partials/proc_configuring-namespace-strategies.adoc index 7fa9b8f50c..0e5aab3f79 100644 --- a/modules/installation-guide/partials/proc_configuring-namespace-strategies.adoc +++ b/modules/installation-guide/partials/proc_configuring-namespace-strategies.adoc @@ -44,7 +44,7 @@ endif::[] NOTE: The underlying environment variable that {prod-short} server uses is `CHE_INFRA_KUBERNETES_NAMESPACE_DEFAULT`. -WARNING: By default, only one workspace in the same {orch-namespace} can be running at one time. See xref:defining-the-number-of-workspaces-a-user-can-run.adoc[]. +WARNING: By default, only one workspace in the same {orch-namespace} can be running at one time. See xref:configuring-the-number-of-workspaces-a-user-can-run.adoc[]. [WARNING] ==== diff --git a/modules/installation-guide/partials/proc_defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc b/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-configmap.adoc similarity index 86% rename from modules/installation-guide/partials/proc_defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc rename to modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-configmap.adoc index 82a7b6e68b..90807ed662 100644 --- a/modules/installation-guide/partials/proc_defining-the-number-of-workspaces-a-user-can-run-using-configmap.adoc +++ b/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-configmap.adoc @@ -1,5 +1,5 @@ -[id="defining-the-number-of-workspaces-a-user-can-run-using-configmap_{context}"] -= Defining the number of workspaces a user can run using ConfigMap +[id="configuring-the-number-of-workspaces-a-user-can-run-using-configmap_{context}"] += Configuring the number of workspaces a user can run using ConfigMap This procedure describes how to run more than one workspace simultaneously using ConfigMap. @@ -34,11 +34,6 @@ In some cases, using the `ReadWriteMany` access mode is not possible due to the $ helm upgrade che -n --set che.limits.userWorkspacesRunCount= ---- -.Verification -//TODO: -[role="_additional-resources"] -.Additional resources -//TODO: diff --git a/modules/installation-guide/partials/proc_defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc b/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc similarity index 51% rename from modules/installation-guide/partials/proc_defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc rename to modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc index cb674c8dfc..134aaea577 100644 --- a/modules/installation-guide/partials/proc_defining-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc +++ b/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc @@ -1,31 +1,28 @@ -// Module included in the following assemblies: -// -// advanced-configuration -[id="defining-the-number-of-workspaces-a-user-can-run-using-the-operator_{context}"] -= Defining the number of workspaces a user can run using the Operator +[id="configuring-the-number-of-workspaces-a-user-can-run-using-the-operator_{context}"] += Configuring the number of workspaces a user can run using the Operator This procedure describes how to run more than one workspace simultaneously using the Operator. -.Placeholders used in examples +.Prerequisites +* An instance of {prod-short} installed by using the Operator +* The storage configuration is one of the following: +. `common` PVC strategy and `ReadWriteMany` access mode +. `per-workspace` or `unique` PVC strategy and `ReadWriteOnce` access mode ++ +For more information, see xref:configuring-storage-strategies.adoc[]. + + +.Procedure +. Define the value of the placeholder: ++ [cols="1,2"] |=== | `__` | The number of workspaces to run simultaneously. The default value is `1`. Set the value to `-1` to allow the user to run an unlimited number of concurrent workspaces. Set it to a precise value to allow running that many concurrent workspaces. |=== - -.Procedure -. If the Persistent Volume Claim (PVC) strategy of the cluster is `common`, configure the persistent volumes of the cluster to use the `ReadWriteMany` access mode. -+ -If you are unable to use the `ReadWriteMany` access mode, configure the PVC strategy to `per-workspace` or `unique`. -+ -For more information, see xref:configuring-storage-strategies.adoc[]. -+ -[NOTE] -==== -In some cases, using the `ReadWriteMany` access mode is not possible due to the storage limitations. For example, link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html[EBS] only supports `ReadWriteOnce` access mode. -==== . In `CheCluster` Custom Resource `server` settings, add the `+CHE_LIMITS_USER_WORKSPACES_RUN_COUNT+` property to `customCheProperties`: ++ ==== [source,yaml] ---- From c7d2c68e7f0dda8fe6e4ff0ec73668f224fd0c0e Mon Sep 17 00:00:00 2001 From: Tereza Stastna Date: Wed, 26 May 2021 16:31:35 +0200 Subject: [PATCH 5/8] Improve language, reorganize content --- ...e-number-of-workspaces-a-user-can-run.adoc | 3 +- ...spaces-a-user-can-run-using-configmap.adoc | 37 ++++++++----------- ...ces-a-user-can-run-using-the-operator.adoc | 25 ++++++------- 3 files changed, 29 insertions(+), 36 deletions(-) diff --git a/modules/installation-guide/partials/assembly_configuring-the-number-of-workspaces-a-user-can-run.adoc b/modules/installation-guide/partials/assembly_configuring-the-number-of-workspaces-a-user-can-run.adoc index 5fcda8f27a..25d2c0d6a8 100644 --- a/modules/installation-guide/partials/assembly_configuring-the-number-of-workspaces-a-user-can-run.adoc +++ b/modules/installation-guide/partials/assembly_configuring-the-number-of-workspaces-a-user-can-run.adoc @@ -15,5 +15,4 @@ include::partial$proc_configuring-the-number-of-workspaces-a-user-can-run-using- endif::[] - -:context: {parent-context-of-configuring-the-number-of-workspaces-a-user-can-run} +:context: {parent-context-of-configuring-the-number-of-workspaces-a-user-can-run} \ No newline at end of file diff --git a/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-configmap.adoc b/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-configmap.adoc index 90807ed662..bef8c250b1 100644 --- a/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-configmap.adoc +++ b/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-configmap.adoc @@ -3,7 +3,18 @@ This procedure describes how to run more than one workspace simultaneously using ConfigMap. -.Placeholders used in examples +.Prerequisites +* An instance of `{prod-short}` installed using ConfigMap. +* The combination of PVC strategy and access mode meets the following criteria: ++ +-- +** `ReadWriteMany` access mode and an arbitrary PVC strategy +** `ReadWriteOnce` access mode and `per-workspace` or `unique` PVC strategy +-- ++ +For more information, see xref:configuring-storage-strategies.adoc[]. +* Determine the values of the following placeholders: ++ [cols="1,2"] |=== | `__` @@ -13,27 +24,11 @@ This procedure describes how to run more than one workspace simultaneously using | The number of workspaces to run simultaneously. The default value is `1`. Set the value to `-1` to allow the user to run an unlimited number of concurrent workspaces. Set it to a precise value to allow running that many concurrent workspaces. |=== -.Prerequisites -* The `{platforms-cli}` tool is available. - .Procedure -. If the Persistent Volume Claim (PVC) strategy of the cluster is `common`, configure the persistent volumes of the cluster to use the `ReadWriteMany` access mode. -+ -If you are unable to use the `ReadWriteMany` access mode, configure the PVC strategy to `per-workspace` or `unique`. -+ -For more information, see xref:configuring-storage-strategies.adoc[]. -+ -[NOTE] -==== -In some cases, using the `ReadWriteMany` access mode is not possible due to the storage limitations. For example, link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html[EBS] only supports `ReadWriteOnce` access mode. -==== -. Define the number of workspaces a user can run simultaneously: +. Configure the number of workspaces a user can run simultaneously: + [subs="+quotes,+attributes"] ---- -$ helm upgrade che -n --set che.limits.userWorkspacesRunCount= ----- - - - - +$ helm upgrade che -n --set \ +che.limits.userWorkspacesRunCount= +---- \ No newline at end of file diff --git a/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc b/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc index 134aaea577..7b7075fa57 100644 --- a/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc +++ b/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc @@ -5,23 +5,25 @@ This procedure describes how to run more than one workspace simultaneously using the Operator. .Prerequisites -* An instance of {prod-short} installed by using the Operator -* The storage configuration is one of the following: -. `common` PVC strategy and `ReadWriteMany` access mode -. `per-workspace` or `unique` PVC strategy and `ReadWriteOnce` access mode +* An instance of `{prod-short}` installed using the Operator. +* The combination of PVC strategy and access mode meets the following criteria: ++ +-- +** `ReadWriteMany` access mode and an arbitrary PVC strategy +** `ReadWriteOnce` access mode and `per-workspace` or `unique` PVC strategy +-- + For more information, see xref:configuring-storage-strategies.adoc[]. - - -.Procedure -. Define the value of the placeholder: +* Determine the value of the following placeholder: + [cols="1,2"] |=== | `__` | The number of workspaces to run simultaneously. The default value is `1`. Set the value to `-1` to allow the user to run an unlimited number of concurrent workspaces. Set it to a precise value to allow running that many concurrent workspaces. |=== -. In `CheCluster` Custom Resource `server` settings, add the `+CHE_LIMITS_USER_WORKSPACES_RUN_COUNT+` property to `customCheProperties`: + +.Procedure +. In the `CheCluster` Custom Resource `server` settings, add the `+CHE_LIMITS_USER_WORKSPACES_RUN_COUNT+` property to `customCheProperties`: + ==== [source,yaml] @@ -35,7 +37,4 @@ spec: customCheProperties: CHE_LIMITS_USER_WORKSPACES_RUN_COUNT: "" ---- -==== - - - +==== \ No newline at end of file From f705058bc1ca09d3d2ec584fb9d03be2d9a0dd41 Mon Sep 17 00:00:00 2001 From: Tereza Stastna Date: Wed, 26 May 2021 17:16:05 +0200 Subject: [PATCH 6/8] Improve language --- ...the-number-of-workspaces-a-user-can-run-using-configmap.adoc | 2 +- ...-number-of-workspaces-a-user-can-run-using-the-operator.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-configmap.adoc b/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-configmap.adoc index bef8c250b1..773490fea4 100644 --- a/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-configmap.adoc +++ b/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-configmap.adoc @@ -21,7 +21,7 @@ For more information, see xref:configuring-storage-strategies.adoc[]. | The namespace of the product. The default option for `{platforms-namespace}` is `{prod-namespace}`. | `__` -| The number of workspaces to run simultaneously. The default value is `1`. Set the value to `-1` to allow the user to run an unlimited number of concurrent workspaces. Set it to a precise value to allow running that many concurrent workspaces. +| The number of workspaces a user can run simultaneously. The default value is `1`. If the value is `-1`, an unlimited number of workspaces can run per user. If it is a precise positive value, that many workspaces can run per user. |=== .Procedure diff --git a/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc b/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc index 7b7075fa57..869fde05ea 100644 --- a/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc +++ b/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc @@ -19,7 +19,7 @@ For more information, see xref:configuring-storage-strategies.adoc[]. [cols="1,2"] |=== | `__` -| The number of workspaces to run simultaneously. The default value is `1`. Set the value to `-1` to allow the user to run an unlimited number of concurrent workspaces. Set it to a precise value to allow running that many concurrent workspaces. +| The number of workspaces a user can run simultaneously. The default value is `1`. If the value is `-1`, an unlimited number of workspaces can run per user. If it is a precise positive value, that many workspaces can run per user. |=== .Procedure From a353123ef2d22985fc7d1ca3198e02b22d8ce026 Mon Sep 17 00:00:00 2001 From: Sergii Kabashniuk Date: Tue, 1 Jun 2021 11:55:14 +0300 Subject: [PATCH 7/8] Update modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-configmap.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fabrice Flore-Thébault --- ...e-number-of-workspaces-a-user-can-run-using-configmap.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-configmap.adoc b/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-configmap.adoc index 773490fea4..052aa7bf3d 100644 --- a/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-configmap.adoc +++ b/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-configmap.adoc @@ -5,7 +5,7 @@ This procedure describes how to run more than one workspace simultaneously using .Prerequisites * An instance of `{prod-short}` installed using ConfigMap. -* The combination of PVC strategy and access mode meets the following criteria: +Each new workspace creates at least one new mount point to the storage (PV), in write mode. The default `common` storage strategy in `ReadWriteOnce` access mode reuses the same PV to physically store all data from multiple volumes of all workspaces of the same user, and doesn't support multiple mount points. Therefore to increase the number of simultaneously running workspaces, the combination of PVC strategy and access mode must meet the following criteria: + -- ** `ReadWriteMany` access mode and an arbitrary PVC strategy @@ -31,4 +31,4 @@ For more information, see xref:configuring-storage-strategies.adoc[]. ---- $ helm upgrade che -n --set \ che.limits.userWorkspacesRunCount= ----- \ No newline at end of file +---- From 9dde6f4dd6a2a8cac0fc9e81a2101c5dd19dcb29 Mon Sep 17 00:00:00 2001 From: Sergii Kabashniuk Date: Tue, 1 Jun 2021 11:55:24 +0300 Subject: [PATCH 8/8] Update modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fabrice Flore-Thébault --- ...umber-of-workspaces-a-user-can-run-using-the-operator.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc b/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc index 869fde05ea..a44a7e045c 100644 --- a/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc +++ b/modules/installation-guide/partials/proc_configuring-the-number-of-workspaces-a-user-can-run-using-the-operator.adoc @@ -6,7 +6,7 @@ This procedure describes how to run more than one workspace simultaneously using .Prerequisites * An instance of `{prod-short}` installed using the Operator. -* The combination of PVC strategy and access mode meets the following criteria: +Each new workspace creates at least one new mount point to the storage (PV), in write mode. The default `common` storage strategy in `ReadWriteOnce` access mode reuses the same PV to physically store all data from multiple volumes of all workspaces of the same user, and doesn't support multiple mount points. Therefore to increase the number of simultaneously running workspaces, the combination of PVC strategy and access mode must meet the following criteria: + -- ** `ReadWriteMany` access mode and an arbitrary PVC strategy @@ -37,4 +37,4 @@ spec: customCheProperties: CHE_LIMITS_USER_WORKSPACES_RUN_COUNT: "" ---- -==== \ No newline at end of file +====