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.

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

Document per-workspace PVC size calculation #23258

Open
AObuchow opened this issue Nov 20, 2024 · 0 comments
Open

Document per-workspace PVC size calculation #23258

AObuchow opened this issue Nov 20, 2024 · 0 comments
Labels
area/doc Issues related to documentation kind/task Internal things, technical debt, and to-do tasks to be performed.

Comments

@AObuchow
Copy link

Is your task related to a problem? Please describe

When using the per-workspace storage strategy, the PVC size can actually be calculated based on the requirements of the CDE's devfile by summing the size of the devfile volumes that are defined. Currently, the rules used in calculating the PVC size are not documented, which may confuse users about this issue.

Describe the solution you'd like

We should document the per-workspace PVC size calculation rules in the Che Docs. The rules are as follows:

  1. If all volumes in a devfile specify their size, the computed PVC size will be used.
  2. If all volumes in a devfile either specify their size or are ephemeral, the computed PVC size will be used.
  3. If at least one volume in a devfile specifies its size, and the computed PVC size is greater than the default per-workspace PVC size, the computed PVC size will be used.

Some notes:

  • In rule 1. or 2. it's possible for the PVC size to be larger or smaller than the per-workspace PVC storage size that is set in the Che Cluster CRs devEnvironments.storage.PerWorkspaceStrategyPvcConfig.claimSize.
  • In rule 3, the computed PVC size will only be used if it is larger than the per-workspace PVC storage size that is set in the Che Cluster CRs devEnvironments.storage.PerWorkspaceStrategyPvcConfig.claimSize. If it's smaller than the per-workspace PVC claimSize defined in the Che Cluster CR, then the PVC size will be set to the Che Cluster's per-workspace PVC claim size.
  • If the devfile's volumes do not meet any of these rules requirements, then the default per-workspace PVC storage size will be used (i.e. the size defined in the Che Cluster CRs `devEnvironments.storage.PerWorkspaceStrategyPvcConfig.claimSize).

Describe alternatives you've considered

No response

Additional context

Some extra notes:

@AObuchow AObuchow added kind/task Internal things, technical debt, and to-do tasks to be performed. area/doc Issues related to documentation labels Nov 20, 2024
@che-bot che-bot added the status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. label Nov 20, 2024
@deerskindoll deerskindoll removed the status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. label Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/doc Issues related to documentation kind/task Internal things, technical debt, and to-do tasks to be performed.
Projects
None yet
Development

No branches or pull requests

3 participants