docs: added pvc resize info #2740
+8
−1
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -57,4 +57,12 @@ 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 -->] | ||
|
|
||
| [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, | ||
|
There was a problem hiding this comment. There's no actual need to modify the default workspace storage size in the Che-Cluster CR after modifying the PVC. I think this sentence could just be "If you choose to expand a PVC that is in use by a workspace, the workspace must be restarted before PVC expansion can occur" There was a problem hiding this comment. I think after this change we should be good to merge. Sorry for being slow to follow-up on this @deerskindoll There was a problem hiding this comment. no worries! I'll edit the wording. There was a problem hiding this comment. @AObuchow I reworded your suggestion a bit. please have a look |
||
| modify the default workspace storage size in the `CheCluster` custom resource and restart the workspace. | ||
| ==== | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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
devfileand restarting the workspace will not expand the PV automatically.There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
devfileI 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.