Skip to content

Commit

Permalink
fixup: improve page on configuring storage strategy
Browse files Browse the repository at this point in the history
Signed-off-by: Andrew Obuchowicz <[email protected]>
  • Loading branch information
AObuchow authored and AObuchow committed Jun 22, 2023
1 parent b28d698 commit ce141e0
Showing 1 changed file with 19 additions and 12 deletions.
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
:_content-type: CONCEPT
: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
:_content-type: PROCEDURE
:description: Configuring the storage strategy
:keywords: administration guide, configuring, {prod-short}, storage, strategy, per-user, per-workspace, ephemeral
:navtitle: Configuring the storage strategy
:page-aliases: installation-guide:configuring-the-storage-strategy.adoc

[id="configuring-{prod-id-short}-storage-strategy"]
= Configuring the storage strategy in {prod-short}
[id="configuring-the-storage-strategy"]
= Configuring the storage strategy

{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].

.Available storage strategies:
Available storage strategies:

* `per-user`: Use a single PVC for all workspaces created by a user.
* `per-workspace`: Each workspace is given its own PVC.
Expand All @@ -19,16 +19,23 @@ The default storage strategy used in {prod-short} is `per-user`.

.Procedure

Use CheCluster Custom Resource definition to define the storage strategy:
. Set the `pvcStrategy` field in the Che Cluster Custom Resource to `per-user`, `per-workspace` or `ephemeral`.

Set the `pvcStrategy` field in the Che Cluster Custom Resource to `per-user`, `per-workspace` or `ephemeral`. 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[].
[NOTE]
====
* You can set this field at installation. See xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[].
* You can update this field on the command line. See xref:using-the-cli-to-configure-the-checluster-custom-resource.adoc[].
====

[source,yaml,subs="+quotes,+attributes"]
----
spec:
devEnvironments:
storage:
pvc:
# the available storage strategies are 'per-user', 'per-workspace' and 'ephemeral'
pvcStrategy: 'per-user'
pvcStrategy: 'per-user' <1>
----
<1> The available storage strategies are `per-user`, `per-workspace` and `ephemeral`.

0 comments on commit ce141e0

Please sign in to comment.