Skip to content
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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add Quota specification page #24152

wants to merge 1 commit into from

Conversation

gulducat
Copy link
Member

@gulducat gulducat commented Oct 8, 2024

and update some related pages
@gulducat gulducat added theme/docs Documentation issues and enhancements theme/enterprise Issues related to Enterprise features theme/ent/quotas labels Oct 8, 2024
Copy link
Member

@tgross tgross left a 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 @@
---
Copy link
Member

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?

Comment on lines +69 to +79
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>
Copy link
Member

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.

Suggested change
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
theme/docs Documentation issues and enhancements theme/ent/quotas theme/enterprise Issues related to Enterprise features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: add quota section to other specifications
2 participants