Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added pvc resize info #2740

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

docs: added pvc resize info #2740

Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2782cae
added pvc resize info
deerskindoll May 30, 2024
a9cba94
Update configuring-storage-sizes.adoc
deerskindoll May 30, 2024
cc63a36
added pvc resize info
deerskindoll Jun 12, 2024
b9d1ff1
Update configuring-storage-sizes.adoc
deerskindoll Jun 19, 2024
fa2fac6
feedback
deerskindoll Jul 11, 2024
6ff63f8
Update configuring-storage-sizes.adoc
deerskindoll Jul 15, 2024
c42f882
Update configuring-storage-sizes.adoc
deerskindoll Jul 16, 2024
cc3751c
Update configuring-storage-sizes.adoc
deerskindoll Jul 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion modules/administration-guide/pages/configuring-storage-sizes.adoc
View file
Open in desktop
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current note says two options exist, but the text only describes one. What is the second option? Also, it is worth mentioning that changing the volume size in the devfile and restarting the workspace will not expand the PV automatically.

Copy link
Contributor Author

@deerskindoll deerskindoll Jun 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch! apologies, I'll fix the wording right away. Andrew and I decided to remove the second option from the note because it's more trouble than it's worth.

Check the updated wording and let me know if the message that modifying PVC is risky (and there's only one way to do it) is explicit enough. If yes, I think mentioning that changing the volume + restarting the workspace won't work is unnecessary. I can add it if you think it's important, though.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay. Looks good. Concerning the change in the devfile I think it is worth adding a note, maybe not in the Admin guide, but in the User guide. Without a note a developer user may think it is just a matter of changing the volume size in its devfile and it will be automatically resized.

Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,13 @@ spec:
<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> The claim size must be specified as a link:https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/[{kubernetes} resource quantity]. The available quantity units include: `Ei`, `Pi`, `Ti`, `Gi`, `Mi` and `Ki`.

pass:[<!-- vale RedHat.CaseSensitiveTerms = YES -->]
pass:[<!-- vale RedHat.CaseSensitiveTerms = YES -->]

[IMPORTANT]
====
Manually modifying a PVC on the cluster that was provisioned by {prod-short} is not officially supported and may result in unexpected consequences.

If you want to resize a PVC, you have two options:

AObuchow marked this conversation as resolved.
Show resolved Hide resolved
* Modify the default workspace storage size in the `CheCluster` custom resource.
====
Loading