mirror of
https://github.com/kemko/nomad.git
synced 2026-01-09 11:55:42 +03:00
53b083b8c5
* Move commands from docs to its own root-level directory * temporarily use modified dev-portal branch with nomad ia changes * explicitly clone nomad ia exp branch * retrigger build, fixed dev-portal broken build * architecture, concepts and get started individual pages * fix get started section destinations * reference section * update repo comment in website-build.sh to show branch * docs nav file update capitalization * update capitalization to force deploy * remove nomad-vs-kubernetes dir; move content to what is nomad pg * job section * Nomad operations category, deploy section * operations category, govern section * operations - manage * operations/scale; concepts scheduling fix * networking * monitor * secure section * remote auth-methods folder and move up pages to sso; linkcheck * Fix install2deploy redirects * fix architecture redirects * Job section: Add missing section index pages * Add section index pages so breadcrumbs build correctly * concepts/index fix front matter indentation * move task driver plugin config to new deploy section * Finish adding full URL to tutorials links in nav * change SSO to Authentication in nav and file system * Docs NomadIA: Move tutorials into NomadIA branch (#26132) * Move governance and policy from tutorials to docs * Move tutorials content to job-declare section * run jobs section * stateful workloads * advanced job scheduling * deploy section * manage section * monitor section * secure/acl and secure/authorization * fix example that contains an unseal key in real format * remove images from sso-vault * secure/traffic * secure/workload-identities * vault-acl change unseal key and root token in command output sample * remove lines from sample output * fix front matter * move nomad pack tutorials to tools * search/replace /nomad/tutorials links * update acl overview with content from deleted architecture/acl * fix spelling mistake * linkcheck - fix broken links * fix link to Nomad variables tutorial * fix link to Prometheus tutorial * move who uses Nomad to use cases page; move spec/config shortcuts add dividers * Move Consul out of Integrations; move namespaces to govern * move integrations/vault to secure/vault; delete integrations * move ref arch to docs; rename Deploy Nomad back to Install Nomad * address feedback * linkcheck fixes * Fixed raw_exec redirect * add info from /nomad/tutorials/manage-jobs/jobs * update page content with newer tutorial * link updates for architecture sub-folders * Add redirects for removed section index pages. Fix links. * fix broken links from linkcheck * Revert to use dev-portal main branch instead of nomadIA branch * build workaround: add intro-nav-data.json with single entry * fix content-check error * add intro directory to get around Vercel build error * workound for emtpry directory * remove mdx from /intro/ to fix content-check and git snafu * Add intro index.mdx so Vercel build should work --------- Co-authored-by: Tu Nguyen <im2nguyen@gmail.com>
81 lines
2.8 KiB
Plaintext
81 lines
2.8 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Nomad node pool specification
|
|
description: |-
|
|
Learn about Nomad's node pool specification. Review an example node pool specification. Configure description, metadata, and scheduler options.
|
|
---
|
|
|
|
# Nomad node pool specification
|
|
|
|
Node pools group nodes, letting you restrict which jobs are able to place
|
|
allocations in a given set of nodes. Specify node pools as HCL files and submit
|
|
them with the [`nomad node pool apply`][pool-apply] CLI command. Unlike [job
|
|
specifications][jobspecs], node pool specifications do not support HCL2
|
|
features like functions.
|
|
|
|
This example is a node pool specification generated with the [`nomad node pool
|
|
init` command][pool-init].
|
|
|
|
```hcl
|
|
node_pool "example" {
|
|
|
|
description = "Example node pool"
|
|
|
|
# meta is optional metadata on the node pool, defined as key-value pairs.
|
|
# The scheduler does not use node pool metadata as part of scheduling.
|
|
meta {
|
|
environment = "prod"
|
|
owner = "sre"
|
|
}
|
|
|
|
# The scheduler configuration options specific to this node pool. This block
|
|
# supports a subset of the fields supported in the global scheduler
|
|
# configuration as described at:
|
|
# https://developer.hashicorp.com/nomad/commands/operator/scheduler/set-config
|
|
#
|
|
# * scheduler_algorithm is the scheduling algorithm to use for the pool.
|
|
# If not defined, the global cluster scheduling algorithm is used.
|
|
#
|
|
# Available only in Nomad Enterprise.
|
|
|
|
# scheduler_config {
|
|
# scheduler_algorithm = "spread"
|
|
# }
|
|
}
|
|
```
|
|
|
|
Example usage if the above is in a file named `pool.nomad.hcl`:
|
|
|
|
```shell-session
|
|
$ nomad node pool apply ./pool.nomad.hcl
|
|
Successfully applied node pool "example"!
|
|
```
|
|
|
|
## Parameters
|
|
|
|
- `description` `(string: <optional>)` - Sets a human readable description for
|
|
the node pool.
|
|
|
|
- `meta` `(map[string]string: <optional>)` - Sets optional metadata on the node
|
|
pool, defined as key-value pairs. The scheduler does not use node pool
|
|
metadata as part of scheduling.
|
|
|
|
- `scheduler_config` <code>([SchedulerConfig][sched-config]: nil)</code> <EnterpriseAlert inline /> -
|
|
Sets scheduler configuration options specific to the node pool. If not
|
|
defined, the global scheduler configurations are used.
|
|
|
|
### `scheduler_config` parameters <EnterpriseAlert inline />
|
|
|
|
- `scheduler_algorithm` `(string: <optional>)` - The [scheduler algorithm][]
|
|
used for this node pool. Must be one of `binpack` or `spread`.
|
|
|
|
- `memory_oversubscription_enabled` `(bool: <optional>)` - The [memory
|
|
oversubscription][] setting to use for this node pool.
|
|
|
|
[pool-apply]: /nomad/commands/node-pool/apply
|
|
[jobspecs]: /nomad/docs/job-specification
|
|
[pool-init]: /nomad/commands/node-pool/init
|
|
[sched-config]: #scheduler_config-parameters
|
|
[scheduler algorithm]: /nomad/api-docs/operator/scheduler#scheduleralgorithm-1
|
|
[memory oversubscription]: /nomad/api-docs/operator/scheduler#memoryoversubscriptionenabled-1
|