CheatNomad Workload orchestrator
Light · Postcard
102 × 152 mm · PDF
Dark · Postcard
102 × 152 mm · PDF
Ink saver · Postcard
102 × 152 mm · PDF
Light · A4 landscape
297 × 210 mm · PDF
Dark · A4 landscape
297 × 210 mm · PDF
Ink saver · A4 landscape
297 × 210 mm · PDF
Light · A3 landscape
420 × 297 mm · PDF
Dark · A3 landscape
420 × 297 mm · PDF
Ink saver · A3 landscape
420 × 297 mm · PDF
Start here
nomad agent -dev
Throwaway local cluster
export NOMAD_ADDR=<url>
Point the CLI at a server
nomad job initWrite an example job file
nomad job plan <file>
Dry run, show the diff
nomad job run <file>
Submit the job
nomad job status <job>
Allocations and health
nomad alloc logs <alloc> <task>
Read task output
nomad job stop <job>
Stop the job
Concepts
- Job your spec file
- Eval scheduler run
- Allocation group on a node
- Task container, process
Connect
export NOMAD_ADDR=<url>
Set the server address
Default is http://127.0.0.1:4646
export NOMAD_TOKEN=<secret-id>
Authenticate with an ACL token
Same as -token; the flag wins
export NOMAD_NAMESPACE=<ns>
Work in a namespace
Default is default; * means all authorized
nomad server members
List servers and leader
nomad versionPrint the CLI version
Run jobs
nomad job initWrite example.nomad.hcl
nomad job validate <file>
Check a job file offline
nomad job plan <file>
Dry run with a diff
Prints the check-index to pass to job run
nomad job run <file>
Submit or update a job
nomad job run -detach <file>
Submit without monitoring
Prints the evaluation ID
nomad job run -check-index <n> <file>
Submit only if unchanged since plan
nomad job run -var <key>=<value>
<file>
Set a job variable
nomad job run -preserve-counts <file>
Keep group counts when updating
Inspect jobs
nomad statusList all jobs
nomad job status <job>
Summary, allocations, deployment
nomad job inspect <job>
Show the stored job as JSON
nomad job history <job>
List versions of a job
nomad job allocs <job>
List allocations of a job
Change and stop
nomad job stop <job>
Stop a job
Job stays visible as dead
nomad job stop -purge <job>
Stop and remove from the state
nomad job scale <job> <group>
<count>
Set a task group count
nomad job revert <job> <version>
Roll back to an older version
nomad job restart <job>
Restart allocations in place
nomad job promote <job>
Promote canaries
Allocations
nomad alloc status <alloc>
Task states and events
nomad alloc logs <alloc> <task>
Print task stdout
nomad alloc logs -f <alloc> <task>
Follow logs
nomad alloc logs -stderr <alloc> <task>
Print task stderr
nomad alloc logs -job <job>
Logs of a random alloc of the job
Add -task or -group when the job has several
nomad alloc exec <alloc> <cmd>
Run a command in a task
Add -task <task> if the group has several tasks
nomad alloc exec -job <job> /bin/sh
Shell into a job's task
nomad alloc fs <alloc> [<path>]
Browse the allocation directory
nomad alloc restart <alloc>
Restart a task in place
Nodes
nomad node status
List client nodes
nomad node status <node>
Resources and allocations of a node
nomad node drain -enable <node>
Migrate allocations away
Deadline defaults to 1h; add -yes to skip the prompt
nomad node drain -disable <node>
Cancel a drain
nomad node eligibility -disable <node>
Stop new placements
nomad node eligibility -enable <node>
Allow placements again
Evals and deployments
nomad eval status <eval>
Why a placement failed
Look for the failed placement section
nomad deployment status <id>
Progress of a rolling update
nomad deployment list
List deployments
nomad deployment promote <id>
Promote healthy canaries
Variables and namespaces
nomad var put <path> <key>=<value>
Write a variable
nomad var get <path>
Read a variable
nomad var list [<prefix>]
List variables
nomad var put -check-index <n> <path>
<k>=<v>
Update only if unchanged
nomad namespace list
List namespaces
ACL and operate
nomad acl bootstrap
Create the first management token
Works once per cluster; keep the secret
nomad acl token self
Show the token in use
nomad operator raft list-peers
Show the Raft peers
nomad agent -config <path>
Start a server or client agent
Recipes
nomad job plan web.nomad.hcl# copy the Job Modify Index from the outputnomad job run -check-index <n> web.nomad.hclnomad node drain -enable -yes <node>nomad node status <node># ...maintenance...nomad node drain -disable <node>nomad node eligibility -enable <node>nomad job status <job>nomad alloc status <alloc>nomad alloc logs -stderr <alloc> <task>nomad alloc exec -task <task> <alloc> /bin/shjob "web" { group "app" { task "server" { driver = "docker" config { image = "nginx:1.27" } } }}
