From ab73ab8a97c70b4018fc8f8825b0f4b9f22d0133 Mon Sep 17 00:00:00 2001 From: Andrew Obuchowicz Date: Wed, 18 Jan 2023 06:00:18 +0000 Subject: [PATCH] procedures: document PVC size configuration Signed-off-by: Andrew Obuchowicz --- modules/administration-guide/nav.adoc | 1 + .../pages/configuring-che-storage-size.adoc | 38 +++++++++++++++++ .../configuring-che-storage-strategy.adoc | 42 ++----------------- .../pages/configuring-storage.adoc | 3 +- 4 files changed, 45 insertions(+), 39 deletions(-) create mode 100644 modules/administration-guide/pages/configuring-che-storage-size.adoc diff --git a/modules/administration-guide/nav.adoc b/modules/administration-guide/nav.adoc index 9519ad15460..db3e75d40e0 100644 --- a/modules/administration-guide/nav.adoc +++ b/modules/administration-guide/nav.adoc @@ -60,6 +60,7 @@ ** xref:configuring-storage.adoc[] *** xref:installing-che-using-storage-classes.adoc[] *** xref:configuring-che-storage-strategy.adoc[] +*** xref:configuring-che-storage-size.adoc[] ** xref:managing-identities-and-authorizations.adoc[] *** xref:configuring-oauth-for-git-providers.adoc[] **** xref:configuring-oauth-2-for-github.adoc[] diff --git a/modules/administration-guide/pages/configuring-che-storage-size.adoc b/modules/administration-guide/pages/configuring-che-storage-size.adoc new file mode 100644 index 00000000000..cdc3f785e6f --- /dev/null +++ b/modules/administration-guide/pages/configuring-che-storage-size.adoc @@ -0,0 +1,38 @@ +:_content-type: CONCEPT +:description: Configuring the storage size in {prod-short} +:keywords: administration guide, configuring, {prod-id-short}, storage size, PVC size, pvc +:navtitle: Configuring the storage size in {prod-short} +:page-aliases: installation-guide:configuring-che-storage-size.adoc + +[id="configuring-{prod-id-short}-workspace-pvc-size"] += Configuring the storage size in {prod-short} + +The persistent volume claim (PVC) size can be configured when using the `per-user` or `per-workspace` storage strategies. PVC sizes in the Che Cluster Custom Resource must be specified in the format of a https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/[{kubernetes} resource quantity]. For more details on the available storage strategies, see xref:configuring-che-storage-strategy.adoc[] + +.Default persistent volume claim sizes: + +* `per-user`: `10Gi` +* `per-workspace`: `5Gi` + +.Procedure + +Use CheCluster Custom Resource definition to define the persistent volume claim size for the desired storage strategy: + +Set the appropriate `claimSize` field for the desired storage strategy in the Che Cluster Custom Resource. To set this field prior to installing {prod-short}, see xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[], otherwise consult xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]. + +[source,yaml,subs="+quotes,+attributes"] +---- +spec: + devEnvironments: + storage: + pvc: + # the claimSize field that will be used depends on the selected pvcStrategy + # in this example, a persistent volume claim size of 15Gi will be used as the selected pvcStrategy is 'per-user' + pvcStrategy: 'per-user' + perUserStrategyPvcConfig: + # keep blank unless you need to use a non default persistent volume claim size + claimSize: 15Gi + perWorkspaceStrategyPvcConfig: + # keep blank unless you need to use a non default persistent volume claim size + claimSize: 2Gi +---- diff --git a/modules/administration-guide/pages/configuring-che-storage-strategy.adoc b/modules/administration-guide/pages/configuring-che-storage-strategy.adoc index bb3c2635ef4..8df27a218ba 100644 --- a/modules/administration-guide/pages/configuring-che-storage-strategy.adoc +++ b/modules/administration-guide/pages/configuring-che-storage-strategy.adoc @@ -1,11 +1,11 @@ :_content-type: CONCEPT -:description: Configuring the {prod-short} storage strategy -:keywords: administration guide, configuring-che-storage-strategy, configuring-che-storage-size -:navtitle: Configuring the {prod-short} storage strategy +:description: Configuring the storage strategy in {prod-short} +:keywords: administration guide, configuring, {prod-short}, storage, strategy +:navtitle: Configuring the storage strategy in {prod-short} :page-aliases: installation-guide:configuring-che-storage-strategy.adoc [id="configuring-{prod-id-short}-storage-strategy"] -= Configuring the storage strategy += Configuring the storage strategy in {prod-short} {prod-short} can be configured to provide persistent or non-persistent storage to workspaces by selecting a storage strategy. The selected storage strategy will be applied to all newly created workspaces by default. Users can opt for a non-default storage strategy for their workspace in their xref:end-user-guide:requesting-persistent-storage-for-workspaces.adoc[devfile] or through the xref:end-user-guide:url-parameter-for-the-workspace-storage.adoc[URL parameter]. @@ -32,37 +32,3 @@ spec: # the available storage strategies are 'per-user', 'per-workspace' and 'ephemeral' pvcStrategy: 'per-user' ---- - - -[id="configuring-{prod-id-short}-workspace-pvc-size"] -== Configuring the storage size - -The persistent volume claim (PVC) size can be configured when using the `per-user` or `per-workspace` storage strategies. PVC sizes in the Che Cluster Custom Resource must be specified in the format of a https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/[{kubernetes} resource quantity]. - -.Default persistent volume claim sizes: - -* `per-user`: `10Gi` -* `per-workspace`: `5Gi` - -.Procedure - -Use CheCluster Custom Resource definition to define the persistent volume claim size for the desired storage strategy: - -Set the appropriate `claimSize` field for the desired storage strategy in the Che Cluster Custom Resource. To set this field prior to installing {prod-short}, see xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[], otherwise consult xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[]. - -[source,yaml,subs="+quotes,+attributes"] ----- -spec: - devEnvironments: - storage: - pvc: - # the claimSize field that will be used depends on the selected pvcStrategy - # in this example, a persistent volume claim size of 15Gi will be used as the selected pvcStrategy is 'per-user' - pvcStrategy: 'per-user' - perUserStrategyPvcConfig: - # keep blank unless you need to use a non default persistent volume claim size - claimSize: 15Gi - perWorkspaceStrategyPvcConfig: - # keep blank unless you need to use a non default persistent volume claim size - claimSize: 2Gi ----- diff --git a/modules/administration-guide/pages/configuring-storage.adoc b/modules/administration-guide/pages/configuring-storage.adoc index 7591e2f0152..9451299f635 100644 --- a/modules/administration-guide/pages/configuring-storage.adoc +++ b/modules/administration-guide/pages/configuring-storage.adoc @@ -13,4 +13,5 @@ ==== * xref:installing-che-using-storage-classes.adoc[] -* xref:configuring-che-storage-strategy.adoc[] \ No newline at end of file +* xref:configuring-che-storage-strategy.adoc[] +* xref:configuring-che-storage-size.adoc[] \ No newline at end of file