docs: correct the dominator of memory and examples in resource-durati… #11432
Conversation
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
…on.md - The dominator of memory should be `100Mi` instead of `1Gi`. [Source code](https://github.com/argoproj/argo-workflows/blob/7f22085d16316bdd77bdb1060455140d9d6e1664/pkg/apis/workflow/v1alpha1/workflow_types.go#L2012) - Fix the wrong examples in the document - Remove "Rounding Down" section, because it's not likely to happen Signed-off-by: Jay Lee <jayin920805@gmail.com>
|
@agilgur5 Can help me review this? |
|
Follow up from Slack where OP found this inconsistency (nice find!) and I found the correct amounts in the source code 🙂 |
terrytangyuan
approved these changes
Jul 24, 2023
agilgur5
reviewed
Jul 24, 2023
Comment on lines
56
to
57
| For example, `memory` means "amount of time a resource requested 1Gi of memory." If a container only | ||
| uses 100Mi, each second it runs will only count as a tenth-second of `memory`. |
There was a problem hiding this comment.
this example could also be fixed
Comment on lines
-58
to
-62
|
|
||
| ## Rounding Down | ||
|
|
||
| For short running pods (<10s), the memory value may be 0s. This is because the default is `100Mi`, | ||
| but the denominator is `1Gi`. |
There was a problem hiding this comment.
Hmm I still think this section is useful. I definitely have Pods that run for less than 10s
|
Oops, @terrytangyuan we got an IRL race condition; you happened to merge while I was still reviewing 😅 |
|
Oops feel free to submit follow up PR! |
|
I will file another PR later for the review @agilgur5 metioned above. |
|
Followed up in #11449. Thanks! |
8 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
The dominator of memory should be
100Miinstead of1Gi. Source codeModifications
Verification
These changes are consisitent with the source code.