doc : add note clarifying defaultContainerResources behavior and add reference link#2053
Conversation
|
Skipping CI for Draft Pull Request. |
rohanKanojia
requested review from
SDawley,
dkwon17,
ibuziuk,
mkuznyetsov and
tolusha
as code owners
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: rohanKanojia, vinokurig The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
PR needs rebase. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
rohanKanojia
force-pushed
the
pr/doc-effective-container-resources-editor-overhead
branch
from
0a3e18a to
a274cf8
Compare
|
New changes are detected. LGTM label has been removed. |
rohanKanojia
force-pushed
the
pr/doc-effective-container-resources-editor-overhead
branch
3 times, most recently
from
7632730 to
5b42561
Compare
rohanKanojia
force-pushed
the
pr/doc-effective-container-resources-editor-overhead
branch
from
5b42561 to
70ee6a0
Compare
…reference link Added a note to the GoDoc for DefaultContainerResources explaining how actual resource values are calculated — as the sum of CheCluster defaults and editor overhead. Included a link to the official Che documentation for more details. Signed-off-by: Rohan Kumar <rohaan@redhat.com>
rohanKanojia
force-pushed
the
pr/doc-effective-container-resources-editor-overhead
branch
from
70ee6a0 to
387f83e
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2053 +/- ##
==========================================
- Coverage 50.09% 49.49% -0.61%
==========================================
Files 94 96 +2
Lines 12569 12555 -14
==========================================
- Hits 6297 6214 -83
- Misses 5853 5922 +69
Partials 419 419 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
PR needs rebase. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
4 participants
What does this PR do?
While verifying https://issues.redhat.com/browse/CRW-9493 , this point created a lot of confusion as configured CPU/Memory resource limits were not directly reflected in the workspace pod. I performed some tests with various resource limits in CheCluster and noticed configured limits are included in the workspace pod, it's just that additional overhead is added for Editor used:
Added a note to the GoDoc for DefaultContainerResources explaining how actual resource values are calculated — as the sum of CheCluster defaults and editor overhead. Included a link to the official Che documentation https://eclipse.dev/che/docs/stable/administration-guide/calculating-che-resource-requirements/ for more details.
Screenshot/screencast of this PR
What issues does this PR fix or reference?
It's related to https://issues.redhat.com/browse/CRW-9493
How to test this PR?
It's just a documentation change.
PR Checklist
As the author of this Pull Request I made sure that:
What issues does this PR fix or referenceandHow to test this PRcompletedReviewers
Reviewers, please comment how you tested the PR when approving it.