Skip to content

Commit

Permalink
procedures: document PVC size configuration
Browse files Browse the repository at this point in the history
Signed-off-by: Andrew Obuchowicz <[email protected]>
  • Loading branch information
AObuchow committed Apr 28, 2023
1 parent 46bd5da commit ab73ab8
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 39 deletions.
1 change: 1 addition & 0 deletions modules/administration-guide/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
Expand Down
Original file line number Diff line number Diff line change
@@ -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
----
Original file line number Diff line number Diff line change
@@ -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].

Expand All @@ -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
----
3 changes: 2 additions & 1 deletion modules/administration-guide/pages/configuring-storage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,5 @@
====

* xref:installing-che-using-storage-classes.adoc[]
* xref:configuring-che-storage-strategy.adoc[]
* xref:configuring-che-storage-strategy.adoc[]
* xref:configuring-che-storage-size.adoc[]

0 comments on commit ab73ab8

Please sign in to comment.