doc : add note clarifying defaultContainerResources behavior and add reference link #2053
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.
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.