-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
docs: add Quota specification page #24152
base: main
Are you sure you want to change the base?
Conversation
and update some related pages
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've left a suggestion on expanding the explanations to make this a better reference doc (vs the tutorial).
A non-blocking syntax suggestion: you've hard-wrapped at a very narrow width instead of the traditional 80, and when you combine that with using inline lines we get some lines with one or two words. If you use footer links and wrap at something with a little more breathing room it might make it a little easier to read the source.
@@ -0,0 +1,88 @@ | |||
--- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we add a link to this page from the quota apply
and/or quota init
docs?
These are associated with the parameters on a task | ||
[`resources`](/nomad/docs/job-specification/resources) | ||
block in a job specification, and the | ||
[CPU concepts](/nomad/docs/concepts/cpu) | ||
page has more information regarding CPU resources as well. | ||
|
||
- `cores` `(int: <optional>)` - Number of CPU cores | ||
- `cpu` `(int: <optional>)` - Amount of CPU in MHz | ||
- `memory` `(int: <optional>)` - Amount of memory in MB | ||
- `memory_max` `(int: <optional>)` - Max amount of memory in MB | ||
- `device` <code>([Device](#device-parameters): nil)</code> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd probably break the leading paragraph into 2 sentences. The "as well" doesn't seem to follow from the "are associated with". We don't really have good reference docs on what the heck quotas do (just the tutorials), so this seems like a good place for it.
These are associated with the parameters on a task | |
[`resources`](/nomad/docs/job-specification/resources) | |
block in a job specification, and the | |
[CPU concepts](/nomad/docs/concepts/cpu) | |
page has more information regarding CPU resources as well. | |
- `cores` `(int: <optional>)` - Number of CPU cores | |
- `cpu` `(int: <optional>)` - Amount of CPU in MHz | |
- `memory` `(int: <optional>)` - Amount of memory in MB | |
- `memory_max` `(int: <optional>)` - Max amount of memory in MB | |
- `device` <code>([Device](#device-parameters): nil)</code> | |
Region limits define the limits on cumulative task `resources` blocks for allocations | |
in the namespace and region the quota is applied to. | |
- `cores` `(int: <optional>)` - The limit on total number of CPU cores from all | |
`resources.cores` in the namespace. The [CPU concepts](/nomad/docs/concepts/cpu) | |
documentation has more details on CPU resources. | |
- `cpu` `(int: <optional>)` - The limit on total amount of CPU from all `resources.cpu` | |
in the namespace. | |
- `memory` `(int: <optional>)` - The limit on total mount of memory in MB from all | |
`resources.memory` in the namespace. | |
- `memory_max` `(int: <optional>)` - The limit on total mount of hard memory limits in MB | |
from all `resources.memory_max` in the namespace. | |
- `device` <code>([Device](#device-parameters): nil)</code> |
The resources.memory_max
bit here feels like it could use more precision but I'm not super familiar with how that's implemented either.
main new page: https://nomad-piwjwg6gg-hashicorp.vercel.app/nomad/docs/other-specifications/quota
other affected pages:
relates to hashicorp/tutorials#2263
closes #23258