Skip to content

Commit

Permalink
WIP: Improve page on configuring storage sizes
Browse files Browse the repository at this point in the history
  • Loading branch information
AObuchow authored and AObuchow committed Apr 28, 2023
1 parent ab73ab8 commit f209d82
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 40 deletions.
2 changes: 1 addition & 1 deletion modules/administration-guide/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +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:configuring-storage-sizes.adoc[]
** xref:managing-identities-and-authorizations.adoc[]
*** xref:configuring-oauth-for-git-providers.adoc[]
**** xref:configuring-oauth-2-for-github.adoc[]
Expand Down

This file was deleted.

56 changes: 56 additions & 0 deletions modules/administration-guide/pages/configuring-storage-sizes.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
:_content-type: PROCEDURE
:description: Configuring storage sizes
:keywords: administration guide, configuring, {prod-id-short}, storage sizes, PVC size, pvc
:navtitle: Configuring storage sizes
:page-aliases: installation-guide:configuring-storage-sizes.adoc

[id="configuring-storage-sizes"]
= Configuring storage sizes

You can configure the persistent volume claim (PVC) size when using the `per-user` or `per-workspace` storage strategies. You must specify the PVC sizes in the `CheCluster` Custom Resource in the format of a link: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:

* {empty}
+
[source,yaml]
----
per-user: 10Gi
----

* {empty}
+
[source,yaml]
----
per-workspace: 5Gi
----


.Procedure

Set the appropriate `claimSize` field for the desired storage strategy in the Che Cluster Custom Resource.

[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:
pvcStrategy: '__<strategy_name>__' <1>
perUserStrategyPvcConfig: <2>
claimSize: __<size_number>__Gi
perWorkspaceStrategyPvcConfig: <3>
claimSize: __<size_number>__Gi
----
<1> Select the storage strategy: `per-user` or * `per-workspace` or `ephemeral`. Note: the `ephemeral` storage strategy does not use persistent storage, therefore you cannot configure its storage size or other PVC-related attributes.
<2> Specify a claim size on the next line or omit the next line to set the default claim size value. The specified claim size is only used when you select this storage strategy.
<3> Specify a claim size on the next line or omit the next line to set the default claim size value. The specified claim size is only used when you select this storage strategy.
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@

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

0 comments on commit f209d82

Please sign in to comment.