Fix: Inaccurate Memory Resource Example #25023
Merged
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.
Description
Fix: Inaccurate Memory Resource Example
Nomad memory sizes are always in binary units (plenty of places with e.g.
MemoryMB * 1024 * 1024
around the codebase). This snippet of documentation, however, is misleading, and implies that Nomad manages/tracks memory with decimal units.Without going crazy changing "MB"->"MiB" everywhere, causing mass confusion and horrid edit wars, let's just change this one number! This is a subtle but effective way to signal to developers that we're using binary-based sizes.
(Even if this argument fails, this documentation is plain wrong:
MemoryMB = 2000
will use ~2.1GB: 2000 binary megabytes, 1048576 bytes each.)Testing & Reproduction steps
N/A
Links
Example of size computation in Docker driver, clearly computing mibibytes
Contributor Checklist
changelog entry using the
make cl
command.ensure regressions will be caught.
and job configuration, please update the Nomad website documentation to reflect this. Refer to
the website README for docs guidelines. Please also consider whether the
change requires notes within the upgrade guide.
Reviewer Checklist
backporting document.
in the majority of situations. The main exceptions are long-lived feature branches or merges where
history should be preserved.
within the public repository.