docs: describe required ACLs for all commands
This commit is contained in:
parent
6cc5c40cdb
commit
f1ad512986
|
@ -21,6 +21,8 @@ Usage: nomad acl policy apply [options] <name> <path>
|
||||||
Apply is used to create or update an ACL policy. The policy is
|
Apply is used to create or update an ACL policy. The policy is
|
||||||
sourced from <path> or from stdin if path is "-".
|
sourced from <path> or from stdin if path is "-".
|
||||||
|
|
||||||
|
This command requires a management ACL token.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
||||||
|
|
|
@ -17,6 +17,8 @@ Usage: nomad acl policy delete <name>
|
||||||
|
|
||||||
Delete is used to delete an existing ACL policy.
|
Delete is used to delete an existing ACL policy.
|
||||||
|
|
||||||
|
This command requires a management ACL token.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace)
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace)
|
||||||
|
|
|
@ -17,6 +17,9 @@ Usage: nomad acl policy info <name>
|
||||||
|
|
||||||
Info is used to fetch information on an existing ACL policy.
|
Info is used to fetch information on an existing ACL policy.
|
||||||
|
|
||||||
|
This command requires a management ACL token or a token that has the
|
||||||
|
associated policy.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace)
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace)
|
||||||
|
|
|
@ -18,6 +18,9 @@ Usage: nomad acl policy list
|
||||||
|
|
||||||
List is used to list available ACL policies.
|
List is used to list available ACL policies.
|
||||||
|
|
||||||
|
This command requires a management ACL token to view all policies. A
|
||||||
|
non-management token can query its own policies.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
||||||
|
|
|
@ -18,6 +18,9 @@ Usage: nomad agent-info [options]
|
||||||
|
|
||||||
Display status information about the local agent.
|
Display status information about the local agent.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'agent:read'
|
||||||
|
capability.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace)
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace)
|
||||||
|
|
|
@ -27,6 +27,9 @@ Usage: nomad monitor [options]
|
||||||
example your agent may only be logging at INFO level, but with the monitor
|
example your agent may only be logging at INFO level, but with the monitor
|
||||||
command you can set -log-level DEBUG
|
command you can set -log-level DEBUG
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'agent:read'
|
||||||
|
capability.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
||||||
|
|
|
@ -32,6 +32,12 @@ Usage: nomad alloc exec [options] <allocation> <command>
|
||||||
|
|
||||||
Run command inside the environment of the given allocation and task.
|
Run command inside the environment of the given allocation and task.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'alloc-exec',
|
||||||
|
'read-job', and 'list-jobs' capabilities for the allocation's namespace. If
|
||||||
|
the task driver does not have file system isolation (as with 'raw_exec'),
|
||||||
|
this command requires the 'alloc-node-exec', 'read-job', and 'list-jobs'
|
||||||
|
capabilities for the allocation's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -36,9 +36,12 @@ func (f *AllocFSCommand) Help() string {
|
||||||
Usage: nomad alloc fs [options] <allocation> <path>
|
Usage: nomad alloc fs [options] <allocation> <path>
|
||||||
Alias: nomad fs
|
Alias: nomad fs
|
||||||
|
|
||||||
fs displays either the contents of an allocation directory for the passed allocation,
|
fs displays either the contents of an allocation directory for the passed
|
||||||
or displays the file at the given path. The path is relative to the root of the alloc
|
allocation, or displays the file at the given path. The path is relative to
|
||||||
dir and defaults to root if unspecified.
|
the root of the alloc dir and defaults to root if unspecified.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'read-fs',
|
||||||
|
'read-job', and 'list-jobs' capabilities for the allocation's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
|
|
|
@ -26,6 +26,9 @@ Alias: nomad logs
|
||||||
|
|
||||||
Streams the stdout/stderr of the given allocation and task.
|
Streams the stdout/stderr of the given allocation and task.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'read-logs',
|
||||||
|
'read-job', and 'list-jobs' capabilities for the allocation's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -17,10 +17,14 @@ func (a *AllocRestartCommand) Help() string {
|
||||||
helpText := `
|
helpText := `
|
||||||
Usage: nomad alloc restart [options] <allocation> <task>
|
Usage: nomad alloc restart [options] <allocation> <task>
|
||||||
|
|
||||||
restart an existing allocation. This command is used to restart a specific alloc
|
Restart an existing allocation. This command is used to restart a specific alloc
|
||||||
and its tasks. If no task is provided then all of the allocation's tasks will
|
and its tasks. If no task is provided then all of the allocation's tasks will
|
||||||
be restarted.
|
be restarted.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the
|
||||||
|
'alloc-lifecycle', 'read-job', and 'list-jobs' capabilities for the
|
||||||
|
allocation's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -21,6 +21,10 @@ Usage: nomad alloc signal [options] <signal> <allocation> <task>
|
||||||
and its subtasks. If no task is provided then all of the allocations subtasks
|
and its subtasks. If no task is provided then all of the allocations subtasks
|
||||||
will receive the signal.
|
will receive the signal.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the
|
||||||
|
'alloc-lifecycle', 'read-job', and 'list-jobs' capabilities for the
|
||||||
|
allocation's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -29,6 +29,9 @@ Usage: nomad alloc status [options] <allocation>
|
||||||
status, metadata, and verbose failure messages reported by internal
|
status, metadata, and verbose failure messages reported by internal
|
||||||
subsystems.
|
subsystems.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'read-job' and
|
||||||
|
'list-jobs' capabilities for the allocation's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -16,12 +16,16 @@ func (a *AllocStopCommand) Help() string {
|
||||||
Usage: nomad alloc stop [options] <allocation>
|
Usage: nomad alloc stop [options] <allocation>
|
||||||
Alias: nomad stop
|
Alias: nomad stop
|
||||||
|
|
||||||
stop an existing allocation. This command is used to signal a specific alloc
|
Stop an existing allocation. This command is used to signal a specific alloc
|
||||||
to shut down. When the allocation has been shut down, it will then be
|
to shut down. When the allocation has been shut down, it will then be
|
||||||
rescheduled. An interactive monitoring session will display log lines as the
|
rescheduled. An interactive monitoring session will display log lines as the
|
||||||
allocation completes shutting down. It is safe to exit the monitor early with
|
allocation completes shutting down. It is safe to exit the monitor early with
|
||||||
ctrl-c.
|
ctrl-c.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the
|
||||||
|
'alloc-lifecycle', 'read-job', and 'list-jobs' capabilities for the
|
||||||
|
allocation's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -21,6 +21,9 @@ Usage: nomad deployment fail [options] <deployment id>
|
||||||
if the job is configured to auto revert, the job will attempt to roll back to a
|
if the job is configured to auto revert, the job will attempt to roll back to a
|
||||||
stable version.
|
stable version.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'submit-job'
|
||||||
|
and 'read-job' capabilities for the deployment's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -18,6 +18,9 @@ Usage: nomad deployment list [options]
|
||||||
|
|
||||||
List is used to list the set of deployments tracked by Nomad.
|
List is used to list the set of deployments tracked by Nomad.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'read-job'
|
||||||
|
capability for the deployment's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -19,6 +19,9 @@ Usage: nomad deployment pause [options] <deployment id>
|
||||||
Pause is used to pause a deployment. Pausing a deployment will pause the
|
Pause is used to pause a deployment. Pausing a deployment will pause the
|
||||||
placement of new allocations as part of rolling deployment.
|
placement of new allocations as part of rolling deployment.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'submit-job'
|
||||||
|
and 'read-job' capabilities for the deployment's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -26,6 +26,9 @@ Usage: nomad deployment promote [options] <deployment id>
|
||||||
the job can be failed forward by submitting a new version or failed backwards by
|
the job can be failed forward by submitting a new version or failed backwards by
|
||||||
reverting to an older version using the "nomad job revert" command.
|
reverting to an older version using the "nomad job revert" command.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'submit-job'
|
||||||
|
and 'read-job' capabilities for the deployment's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -19,6 +19,9 @@ Usage: nomad deployment resume [options] <deployment id>
|
||||||
Resume is used to unpause a paused deployment. Resuming a deployment will
|
Resume is used to unpause a paused deployment. Resuming a deployment will
|
||||||
resume the placement of new allocations as part of rolling deployment.
|
resume the placement of new allocations as part of rolling deployment.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'submit-job'
|
||||||
|
and 'read-job' capabilities for the deployment's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -22,6 +22,9 @@ Usage: nomad deployment status [options] <deployment id>
|
||||||
Status is used to display the status of a deployment. The status will display
|
Status is used to display the status of a deployment. The status will display
|
||||||
the number of desired changes as well as the currently applied changes.
|
the number of desired changes as well as the currently applied changes.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'read-job'
|
||||||
|
capability for the deployment's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -19,6 +19,9 @@ Usage: nomad deployment unblock [options] <deployment id>
|
||||||
Unblock is used to unblock a multiregion deployment that's waiting for
|
Unblock is used to unblock a multiregion deployment that's waiting for
|
||||||
peer region deployments to complete.
|
peer region deployments to complete.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'submit-job'
|
||||||
|
and 'read-job' capabilities for the deployment's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -12,7 +12,9 @@ func (c *EventSinkDeregisterCommand) Help() string {
|
||||||
helpText := `
|
helpText := `
|
||||||
Usage: nomad event sink deregister <event sink id>
|
Usage: nomad event sink deregister <event sink id>
|
||||||
|
|
||||||
Deregister is used to deregister a registered event sink.
|
Deregister is used to deregister a registered event sink.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a management token.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
|
|
|
@ -16,7 +16,10 @@ func (c *EventSinkListCommand) Help() string {
|
||||||
helpText := `
|
helpText := `
|
||||||
Usage: nomad event sink list
|
Usage: nomad event sink list
|
||||||
|
|
||||||
List is used to list event sinks that have been registered.
|
List is used to list event sinks that have been registered.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the
|
||||||
|
'operator:read' capability.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
|
|
|
@ -20,8 +20,10 @@ func (c *EventSinkRegisterCommand) Help() string {
|
||||||
helpText := `
|
helpText := `
|
||||||
Usage: nomad event sink register <path>
|
Usage: nomad event sink register <path>
|
||||||
|
|
||||||
Register is used to register a new event sink. The event sink is
|
Register is used to register a new event sink. The event sink is
|
||||||
sourced from <path> or from stdin if path is "-".
|
sourced from <path> or from stdin if path is "-".
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a management token.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
|
|
|
@ -19,6 +19,9 @@ Usage: nomad job deployments [options] <job>
|
||||||
|
|
||||||
Deployments is used to display the deployments for a particular job.
|
Deployments is used to display the deployments for a particular job.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'read-job' and
|
||||||
|
'list-jobs' capabilities for the job's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -28,6 +28,9 @@ Usage: nomad job dispatch [options] <parameterized job> [input source]
|
||||||
triggered evaluation will be monitored. This can be disabled by supplying the
|
triggered evaluation will be monitored. This can be disabled by supplying the
|
||||||
detach flag.
|
detach flag.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'dispatch-job'
|
||||||
|
capability for the job's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -18,9 +18,13 @@ func (c *JobEvalCommand) Help() string {
|
||||||
helpText := `
|
helpText := `
|
||||||
Usage: nomad job eval [options] <job_id>
|
Usage: nomad job eval [options] <job_id>
|
||||||
|
|
||||||
Force an evaluation of the provided job ID. Forcing an evaluation will trigger the scheduler
|
Force an evaluation of the provided job ID. Forcing an evaluation will
|
||||||
to re-evaluate the job. The force flags allow operators to force the scheduler to create
|
trigger the scheduler to re-evaluate the job. The force flags allow
|
||||||
new allocations under certain scenarios.
|
operators to force the scheduler to create new allocations under certain
|
||||||
|
scenarios.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'submit-job'
|
||||||
|
capability for the job's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
|
|
|
@ -26,6 +26,9 @@ Usage: nomad job history [options] <job>
|
||||||
the changes that occurred to the job as well as deciding job versions to revert
|
the changes that occurred to the job as well as deciding job versions to revert
|
||||||
to.
|
to.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'read-job' and
|
||||||
|
'list-jobs' capabilities for the job's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -20,6 +20,9 @@ Alias: nomad inspect
|
||||||
|
|
||||||
Inspect is used to see the specification of a submitted job.
|
Inspect is used to see the specification of a submitted job.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'read-job' and
|
||||||
|
'list-jobs' capabilities for the job's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -20,6 +20,9 @@ Usage: nomad job periodic force <job id>
|
||||||
This is used to immediately run a periodic job, even if it violates the job's
|
This is used to immediately run a periodic job, even if it violates the job's
|
||||||
prohibit_overlap setting.
|
prohibit_overlap setting.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'submit-job'
|
||||||
|
and 'list-jobs' capabilities for the job's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -63,6 +63,9 @@ Alias: nomad plan
|
||||||
* 1: Allocations created or destroyed.
|
* 1: Allocations created or destroyed.
|
||||||
* 255: Error determining plan results.
|
* 255: Error determining plan results.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'submit-job'
|
||||||
|
capability for the job's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -27,6 +27,9 @@ Usage: nomad job promote [options] <job id>
|
||||||
a new version or failed backwards by reverting to an older version using the
|
a new version or failed backwards by reverting to an older version using the
|
||||||
"nomad job revert" command.
|
"nomad job revert" command.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'submit-job',
|
||||||
|
'list-jobs', and 'read-job' capabilities for the job's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -21,6 +21,9 @@ Usage: nomad job revert [options] <job> <version>
|
||||||
Revert is used to revert a job to a prior version of the job. The available
|
Revert is used to revert a job to a prior version of the job. The available
|
||||||
versions to revert to can be found using "nomad job history" command.
|
versions to revert to can be found using "nomad job history" command.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'submit-job'
|
||||||
|
and 'list-jobs' capabilities for the job's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -61,6 +61,12 @@ Alias: nomad run
|
||||||
precedence, going from highest to lowest: the -vault-token flag, the
|
precedence, going from highest to lowest: the -vault-token flag, the
|
||||||
$VAULT_TOKEN environment variable and finally the value in the job file.
|
$VAULT_TOKEN environment variable and finally the value in the job file.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'submit-job'
|
||||||
|
capability for the job's namespace. Jobs that mount CSI volumes require a
|
||||||
|
token with the 'csi-mount-volume' capability for the volume's
|
||||||
|
namespace. Jobs that mount host volumes require a token with the
|
||||||
|
'host_volume' capability for that volume.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -32,6 +32,9 @@ Usage: nomad job scale [options] <job> [<group>] <count>
|
||||||
onto nodes. The monitor will end once job placement is done. It
|
onto nodes. The monitor will end once job placement is done. It
|
||||||
is safe to exit the monitor early using ctrl+c.
|
is safe to exit the monitor early using ctrl+c.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'scale-job'
|
||||||
|
capability for the job's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -27,6 +27,9 @@ Usage: nomad job scaling-events [options] <args>
|
||||||
|
|
||||||
List the scaling events for the specified job.
|
List the scaling events for the specified job.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the
|
||||||
|
'read-job-scaling' capability for the job's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -33,6 +33,9 @@ Usage: nomad status [options] <job>
|
||||||
Display status information about a job. If no job ID is given, a list of all
|
Display status information about a job. If no job ID is given, a list of all
|
||||||
known jobs will be displayed.
|
known jobs will be displayed.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'read-job' and
|
||||||
|
'list-jobs' capabilities for the job's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -18,11 +18,14 @@ func (c *JobStopCommand) Help() string {
|
||||||
Usage: nomad job stop [options] <job>
|
Usage: nomad job stop [options] <job>
|
||||||
Alias: nomad stop
|
Alias: nomad stop
|
||||||
|
|
||||||
Stop an existing job. This command is used to signal allocations
|
Stop an existing job. This command is used to signal allocations to shut
|
||||||
to shut down for the given job ID. Upon successful deregistration,
|
down for the given job ID. Upon successful deregistration, an interactive
|
||||||
an interactive monitor session will start to display log lines as
|
monitor session will start to display log lines as the job unwinds its
|
||||||
the job unwinds its allocations and completes shutting down. It
|
allocations and completes shutting down. It is safe to exit the monitor
|
||||||
is safe to exit the monitor early using ctrl+c.
|
early using ctrl+c.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'submit-job',
|
||||||
|
'read-job', and 'list-jobs' capabilities for the job's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
|
|
|
@ -29,6 +29,9 @@ Alias: nomad validate
|
||||||
it is read from the file at the supplied path or downloaded and
|
it is read from the file at the supplied path or downloaded and
|
||||||
read from URL specified.
|
read from URL specified.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'read-job'
|
||||||
|
capability for the job's namespace.
|
||||||
|
|
||||||
Validate Options:
|
Validate Options:
|
||||||
|
|
||||||
-hcl1
|
-hcl1
|
||||||
|
|
|
@ -12,7 +12,11 @@ func (c *LicenseGetCommand) Help() string {
|
||||||
helpText := `
|
helpText := `
|
||||||
Usage: nomad license get [options]
|
Usage: nomad license get [options]
|
||||||
|
|
||||||
Gets a new license in Servers and Clients
|
Gets a new license in Servers and Clients
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the
|
||||||
|
'operator:read' capability.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace)
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace)
|
||||||
|
|
|
@ -21,7 +21,10 @@ func (c *LicensePutCommand) Help() string {
|
||||||
helpText := `
|
helpText := `
|
||||||
Usage: nomad license put [options]
|
Usage: nomad license put [options]
|
||||||
|
|
||||||
Puts a new license in Servers and Clients
|
Puts a new license in Servers and Clients
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the
|
||||||
|
'operator:write' capability.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
|
|
|
@ -20,6 +20,8 @@ Usage: nomad namespace apply [options] <namespace>
|
||||||
Apply is used to create or update a namespace. It takes the namespace name to
|
Apply is used to create or update a namespace. It takes the namespace name to
|
||||||
create or update as its only argument.
|
create or update as its only argument.
|
||||||
|
|
||||||
|
If ACLs are enabled, this command requires a management ACL token.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
||||||
|
|
|
@ -17,6 +17,8 @@ Usage: nomad namespace delete [options] <namespace>
|
||||||
|
|
||||||
Delete is used to remove a namespace.
|
Delete is used to remove a namespace.
|
||||||
|
|
||||||
|
If ACLs are enabled, this command requires a management ACL token.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace)
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace)
|
||||||
|
|
|
@ -17,6 +17,9 @@ Usage: nomad namespace inspect [options] <namespace>
|
||||||
|
|
||||||
Inspect is used to view raw information about a particular namespace.
|
Inspect is used to view raw information about a particular namespace.
|
||||||
|
|
||||||
|
If ACLs are enabled, this command requires a management ACL token or a token
|
||||||
|
that has a capability associated with the namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
||||||
|
|
|
@ -19,6 +19,10 @@ Usage: nomad namespace list [options]
|
||||||
|
|
||||||
List is used to list available namespaces.
|
List is used to list available namespaces.
|
||||||
|
|
||||||
|
If ACLs are enabled, this command requires a management ACL token to view
|
||||||
|
all namespaces. A non-management token can be used to list namespaces for
|
||||||
|
which it has an associated capability.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
||||||
|
|
|
@ -18,6 +18,9 @@ Usage: nomad namespace status [options] <namespace>
|
||||||
|
|
||||||
Status is used to view the status of a particular namespace.
|
Status is used to view the status of a particular namespace.
|
||||||
|
|
||||||
|
If ACLs are enabled, this command requires a management ACL token or a token
|
||||||
|
that has a capability associated with the namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace)
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace)
|
||||||
|
|
|
@ -29,16 +29,21 @@ General Options:
|
||||||
Client Config Options:
|
Client Config Options:
|
||||||
|
|
||||||
-servers
|
-servers
|
||||||
List the known server addresses of the client node. Client
|
List the known server addresses of the client node. Client nodes do not
|
||||||
nodes do not participate in the gossip pool, and instead
|
participate in the gossip pool, and instead register with these servers
|
||||||
register with these servers periodically over the network.
|
periodically over the network.
|
||||||
|
|
||||||
|
If ACLs are enabled, this option requires a token with the 'agent:read'
|
||||||
|
capability.
|
||||||
|
|
||||||
-update-servers
|
-update-servers
|
||||||
Updates the client's server list using the provided
|
Updates the client's server list using the provided arguments. Multiple
|
||||||
arguments. Multiple server addresses may be passed using
|
server addresses may be passed using multiple arguments. IMPORTANT: When
|
||||||
multiple arguments. IMPORTANT: When updating the servers
|
updating the servers list, you must specify ALL of the server nodes you
|
||||||
list, you must specify ALL of the server nodes you wish
|
wish to configure. The set is updated atomically.
|
||||||
to configure. The set is updated atomically.
|
|
||||||
|
If ACLs are enabled, this option requires a token with the 'agent:write'
|
||||||
|
capability.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
$ nomad node config -update-servers foo:4647 bar:4647
|
$ nomad node config -update-servers foo:4647 bar:4647
|
||||||
|
|
|
@ -25,9 +25,12 @@ func (c *NodeDrainCommand) Help() string {
|
||||||
helpText := `
|
helpText := `
|
||||||
Usage: nomad node drain [options] <node>
|
Usage: nomad node drain [options] <node>
|
||||||
|
|
||||||
Toggles node draining on a specified node. It is required
|
Toggles node draining on a specified node. It is required that either
|
||||||
that either -enable or -disable is specified, but not both.
|
-enable or -disable is specified, but not both. The -self flag is useful to
|
||||||
The -self flag is useful to drain the local node.
|
drain the local node.
|
||||||
|
|
||||||
|
If ACLs are enabled, this option requires a token with the 'node:write'
|
||||||
|
capability.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
|
|
|
@ -23,6 +23,9 @@ Usage: nomad node eligibility [options] <node>
|
||||||
It is required that either -enable or -disable is specified, but not both.
|
It is required that either -enable or -disable is specified, but not both.
|
||||||
The -self flag is useful to set the scheduling eligibility of the local node.
|
The -self flag is useful to set the scheduling eligibility of the local node.
|
||||||
|
|
||||||
|
If ACLs are enabled, this option requires a token with the 'node:write'
|
||||||
|
capability.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
||||||
|
|
|
@ -49,6 +49,9 @@ Usage: nomad node status [options] <node>
|
||||||
short-hand list of all nodes will be displayed. The -self flag is useful to
|
short-hand list of all nodes will be displayed. The -self flag is useful to
|
||||||
quickly access the status of the local node.
|
quickly access the status of the local node.
|
||||||
|
|
||||||
|
If ACLs are enabled, this option requires a token with the 'node:read'
|
||||||
|
capability.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
||||||
|
|
|
@ -64,6 +64,9 @@ Usage: nomad operator autopilot get-config [options]
|
||||||
|
|
||||||
Displays the current Autopilot configuration.
|
Displays the current Autopilot configuration.
|
||||||
|
|
||||||
|
If ACLs are enabled, this command requires a token with the 'operator:read'
|
||||||
|
capability.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace)
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace)
|
||||||
|
|
|
@ -110,6 +110,9 @@ Usage: nomad operator autopilot set-config [options]
|
||||||
|
|
||||||
Modifies the current Autopilot configuration.
|
Modifies the current Autopilot configuration.
|
||||||
|
|
||||||
|
If ACLs are enabled, this command requires a token with the 'operator:write'
|
||||||
|
capability.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
||||||
|
|
|
@ -55,6 +55,11 @@ Usage: nomad operator debug [options]
|
||||||
Build an archive containing Nomad cluster configuration and state, and Consul and Vault
|
Build an archive containing Nomad cluster configuration and state, and Consul and Vault
|
||||||
status. Include logs and pprof profiles for selected servers and client nodes.
|
status. Include logs and pprof profiles for selected servers and client nodes.
|
||||||
|
|
||||||
|
If ACLs are enabled, this command will require a token with the 'node:read'
|
||||||
|
capability to run. In order to collect information, the token will also
|
||||||
|
require the 'agent:read' and 'operator:read' capabilities, as well as the
|
||||||
|
'list-jobs' capability for all namespaces.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
||||||
|
|
|
@ -31,6 +31,9 @@ Usage: nomad operator keyring [options]
|
||||||
are no errors. If any node fails to reply or reports failure, the exit code
|
are no errors. If any node fails to reply or reports failure, the exit code
|
||||||
will be 1.
|
will be 1.
|
||||||
|
|
||||||
|
If ACLs are enabled, this command requires a token with the 'agent:write'
|
||||||
|
capability.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
||||||
|
|
|
@ -17,9 +17,11 @@ func (c *OperatorRaftInfoCommand) Help() string {
|
||||||
Usage: nomad operator raft _info <path to nomad data dir>
|
Usage: nomad operator raft _info <path to nomad data dir>
|
||||||
|
|
||||||
Displays info about the raft logs in the data directory.
|
Displays info about the raft logs in the data directory.
|
||||||
|
|
||||||
This is a low-level debugging tool and not subject to Nomad's usual backward
|
This is a low-level debugging tool and not subject to Nomad's usual backward
|
||||||
compatibility guarantees.
|
compatibility guarantees.
|
||||||
|
|
||||||
|
If ACLs are enabled, this command requires a management token.
|
||||||
`
|
`
|
||||||
return strings.TrimSpace(helpText)
|
return strings.TrimSpace(helpText)
|
||||||
}
|
}
|
||||||
|
|
|
@ -19,6 +19,8 @@ Usage: nomad operator raft list-peers [options]
|
||||||
|
|
||||||
Displays the current Raft peer configuration.
|
Displays the current Raft peer configuration.
|
||||||
|
|
||||||
|
If ACLs are enabled, this command requires a management token.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
||||||
|
|
|
@ -22,6 +22,8 @@ Usage: nomad operator raft _logs <path to nomad data dir>
|
||||||
|
|
||||||
This is a low-level debugging tool and not subject to Nomad's usual backward
|
This is a low-level debugging tool and not subject to Nomad's usual backward
|
||||||
compatibility guarantees.
|
compatibility guarantees.
|
||||||
|
|
||||||
|
If ACLs are enabled, this command requires a management token.
|
||||||
`
|
`
|
||||||
return strings.TrimSpace(helpText)
|
return strings.TrimSpace(helpText)
|
||||||
}
|
}
|
||||||
|
|
|
@ -25,6 +25,8 @@ Usage: nomad operator raft remove-peer [options]
|
||||||
server-members" command, it is preferable to clean up by simply running "nomad
|
server-members" command, it is preferable to clean up by simply running "nomad
|
||||||
server-force-leave" instead of this command.
|
server-force-leave" instead of this command.
|
||||||
|
|
||||||
|
If ACLs are enabled, this command requires a management token.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
||||||
|
|
|
@ -23,6 +23,8 @@ Usage: nomad operator raft _state <path to nomad data dir>
|
||||||
This is a low-level debugging tool and not subject to Nomad's usual backward
|
This is a low-level debugging tool and not subject to Nomad's usual backward
|
||||||
compatibility guarantees.
|
compatibility guarantees.
|
||||||
|
|
||||||
|
If ACLs are enabled, this command requires a management token.
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
|
|
||||||
-last-index=<last_index>
|
-last-index=<last_index>
|
||||||
|
|
|
@ -21,8 +21,11 @@ func (c *PluginStatusCommand) Help() string {
|
||||||
helpText := `
|
helpText := `
|
||||||
Usage nomad plugin status [options] <plugin>
|
Usage nomad plugin status [options] <plugin>
|
||||||
|
|
||||||
Display status information about a plugin. If no plugin id is given,
|
Display status information about a plugin. If no plugin id is given,
|
||||||
a list of all plugins will be displayed.
|
a list of all plugins will be displayed.
|
||||||
|
|
||||||
|
If ACLs are enabled, this command requires a token with the 'plugin:read'
|
||||||
|
capability.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
|
|
|
@ -29,6 +29,9 @@ Usage: nomad quota apply [options] <input>
|
||||||
will be read from stdin by specifying "-", otherwise a path to the file is
|
will be read from stdin by specifying "-", otherwise a path to the file is
|
||||||
expected.
|
expected.
|
||||||
|
|
||||||
|
If ACLs are enabled, this command requires a token with the 'quota:write'
|
||||||
|
capability.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -17,6 +17,9 @@ Usage: nomad quota delete [options] <quota>
|
||||||
|
|
||||||
Delete is used to delete an existing quota specification.
|
Delete is used to delete an existing quota specification.
|
||||||
|
|
||||||
|
If ACLs are enabled, this command requires a token with the 'quota:write'
|
||||||
|
capability.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault)
|
` + generalOptionsUsage(usageOptsDefault)
|
||||||
|
|
|
@ -24,6 +24,9 @@ Usage: nomad quota inspect [options] <quota>
|
||||||
|
|
||||||
Inspect is used to view raw information about a particular quota.
|
Inspect is used to view raw information about a particular quota.
|
||||||
|
|
||||||
|
If ACLs are enabled, this command requires a token with the 'quota:read'
|
||||||
|
capability and access to any namespaces that the quota is applied to.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -19,6 +19,10 @@ Usage: nomad quota list [options]
|
||||||
|
|
||||||
List is used to list available quota specifications.
|
List is used to list available quota specifications.
|
||||||
|
|
||||||
|
If ACLs are enabled, this command requires a token with the 'quota:read'
|
||||||
|
capability. Any quotas applied to namespaces that the token does not have
|
||||||
|
access to will be filtered from the results.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -21,6 +21,9 @@ Usage: nomad quota status [options] <quota>
|
||||||
|
|
||||||
Status is used to view the status of a particular quota specification.
|
Status is used to view the status of a particular quota specification.
|
||||||
|
|
||||||
|
If ACLs are enabled, this command requires a token with the 'quota:read'
|
||||||
|
capability and access to any namespaces that the quota is applied to.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault)
|
` + generalOptionsUsage(usageOptsDefault)
|
||||||
|
|
|
@ -25,6 +25,10 @@ Usage: nomad recommendation apply [options] <recommendation_ids>
|
||||||
|
|
||||||
Apply one or more Nomad recommendations.
|
Apply one or more Nomad recommendations.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'submit-job',
|
||||||
|
'read-job', and 'submit-recommendation' capabilities for the
|
||||||
|
recommendation's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -46,6 +46,10 @@ Usage: nomad recommendation dismiss [options] <recommendation_ids>
|
||||||
|
|
||||||
Dismiss one or more Nomad recommendations.
|
Dismiss one or more Nomad recommendations.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'submit-job',
|
||||||
|
'read-job', and 'submit-recommendation' capabilities for the
|
||||||
|
recommendation's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault)
|
` + generalOptionsUsage(usageOptsDefault)
|
||||||
|
|
|
@ -24,6 +24,9 @@ Usage: nomad recommendation info [options] <recommendation_id>
|
||||||
|
|
||||||
Info is used to read the specified recommendation.
|
Info is used to read the specified recommendation.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'read-job'
|
||||||
|
capability for the recommendation's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -25,6 +25,10 @@ Usage: nomad recommendation list [options]
|
||||||
|
|
||||||
List is used to list the available recommendations.
|
List is used to list the available recommendations.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'submit-job',
|
||||||
|
'read-job', and 'submit-recommendation' capabilities for the namespace being
|
||||||
|
queried.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -23,6 +23,9 @@ Usage: nomad scaling policy info [options] <policy_id>
|
||||||
|
|
||||||
Info is used to read the specified scaling policy.
|
Info is used to read the specified scaling policy.
|
||||||
|
|
||||||
|
If ACLs are enabled, this command requires a token with the 'read-job' and
|
||||||
|
'list-jobs' capabilities for the policy's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -25,6 +25,11 @@ Usage: nomad scaling policy list [options]
|
||||||
|
|
||||||
List is used to list the currently configured scaling policies.
|
List is used to list the currently configured scaling policies.
|
||||||
|
|
||||||
|
If ACLs are enabled, this command requires a token with the 'read-job' and
|
||||||
|
'list-jobs' capabilities for the namespace of all policies. Any namespaces
|
||||||
|
that the token does not have access to will have its policies filtered from
|
||||||
|
the results.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -22,6 +22,9 @@ Usage: nomad sentinel apply [options] <name> <file>
|
||||||
The name of the policy and file must be specified. The file will be read
|
The name of the policy and file must be specified. The file will be read
|
||||||
from stdin by specifying "-".
|
from stdin by specifying "-".
|
||||||
|
|
||||||
|
Sentinel commands are only available when ACLs are enabled. This command
|
||||||
|
requires a management token.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
||||||
|
|
|
@ -17,6 +17,9 @@ Usage: nomad sentinel delete [options] <name>
|
||||||
|
|
||||||
Delete is used to delete an existing Sentinel policy.
|
Delete is used to delete an existing Sentinel policy.
|
||||||
|
|
||||||
|
Sentinel commands are only available when ACLs are enabled. This command
|
||||||
|
requires a management token.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
||||||
|
|
|
@ -17,6 +17,9 @@ Usage: nomad sentinel list [options]
|
||||||
|
|
||||||
List is used to display all the installed Sentinel policies.
|
List is used to display all the installed Sentinel policies.
|
||||||
|
|
||||||
|
Sentinel commands are only available when ACLs are enabled. This command
|
||||||
|
requires a management token.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
||||||
|
|
|
@ -17,6 +17,9 @@ Usage: nomad sentinel read [options] <name>
|
||||||
|
|
||||||
Read is used to inspect a Sentinel policy.
|
Read is used to inspect a Sentinel policy.
|
||||||
|
|
||||||
|
Sentinel commands are only available when ACLs are enabled. This command
|
||||||
|
requires a management token.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
||||||
|
|
|
@ -20,6 +20,9 @@ Usage: nomad server force-leave [options] <node>
|
||||||
Note that if the member is actually still alive, it will
|
Note that if the member is actually still alive, it will
|
||||||
eventually rejoin the cluster again.
|
eventually rejoin the cluster again.
|
||||||
|
|
||||||
|
If ACLs are enabled, this option requires a token with the 'agent:write'
|
||||||
|
capability.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace)
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace)
|
||||||
|
|
|
@ -23,6 +23,9 @@ Usage: nomad server members [options]
|
||||||
Display a list of the known servers and their status. Only Nomad servers are
|
Display a list of the known servers and their status. Only Nomad servers are
|
||||||
able to service this command.
|
able to service this command.
|
||||||
|
|
||||||
|
If ACLs are enabled, this option requires a token with the 'node:read'
|
||||||
|
capability.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace) + `
|
||||||
|
|
|
@ -17,6 +17,8 @@ Usage: nomad system gc [options]
|
||||||
|
|
||||||
Initializes a garbage collection of jobs, evaluations, allocations, and nodes.
|
Initializes a garbage collection of jobs, evaluations, allocations, and nodes.
|
||||||
|
|
||||||
|
If ACLs are enabled, this option requires a management token.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace)
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace)
|
||||||
|
|
|
@ -17,6 +17,8 @@ Usage: nomad system reconcile summaries [options]
|
||||||
|
|
||||||
Reconciles the summaries of all registered jobs.
|
Reconciles the summaries of all registered jobs.
|
||||||
|
|
||||||
|
If ACLs are enabled, this option requires a management token.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace)
|
` + generalOptionsUsage(usageOptsDefault|usageOptsNoNamespace)
|
||||||
|
|
|
@ -18,6 +18,9 @@ Usage: nomad volume deregister [options] <id>
|
||||||
|
|
||||||
Remove an unused volume from Nomad.
|
Remove an unused volume from Nomad.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the
|
||||||
|
'csi-write-volume' capability for the volume's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -18,6 +18,10 @@ Usage: nomad volume detach [options] <vol id> <node id>
|
||||||
|
|
||||||
Detach a volume from a Nomad client.
|
Detach a volume from a Nomad client.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the
|
||||||
|
'csi-write-volume' and 'csi-read-volume' capabilities for the volume's
|
||||||
|
namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -25,6 +25,9 @@ Usage: nomad volume register [options] <input>
|
||||||
If the supplied path is "-" the volume file is read from stdin. Otherwise, it
|
If the supplied path is "-" the volume file is read from stdin. Otherwise, it
|
||||||
is read from the file at the supplied path.
|
is read from the file at the supplied path.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the
|
||||||
|
'csi-write-volume' capability for the volume's namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault)
|
` + generalOptionsUsage(usageOptsDefault)
|
||||||
|
|
|
@ -24,6 +24,10 @@ Usage: nomad volume status [options] <id>
|
||||||
Display status information about a CSI volume. If no volume id is given, a
|
Display status information about a CSI volume. If no volume id is given, a
|
||||||
list of all volumes will be displayed.
|
list of all volumes will be displayed.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the
|
||||||
|
'csi-read-volume' and 'csi-list-volumes' capability for the volume's
|
||||||
|
namespace.
|
||||||
|
|
||||||
General Options:
|
General Options:
|
||||||
|
|
||||||
` + generalOptionsUsage(usageOptsDefault) + `
|
` + generalOptionsUsage(usageOptsDefault) + `
|
||||||
|
|
|
@ -19,6 +19,8 @@ nomad acl policy apply [options] <name> <path>
|
||||||
The `acl policy apply` command requires two arguments, the policy name and path
|
The `acl policy apply` command requires two arguments, the policy name and path
|
||||||
to file. The policy can be read from stdin by setting the path to "-".
|
to file. The policy can be read from stdin by setting the path to "-".
|
||||||
|
|
||||||
|
This command requires a management ACL token.
|
||||||
|
|
||||||
## General Options
|
## General Options
|
||||||
|
|
||||||
@include 'general_options_no_namespace.mdx'
|
@include 'general_options_no_namespace.mdx'
|
||||||
|
|
|
@ -18,6 +18,8 @@ nomad acl policy delete <policy_name>
|
||||||
|
|
||||||
The `acl policy delete` command requires the policy name as an argument.
|
The `acl policy delete` command requires the policy name as an argument.
|
||||||
|
|
||||||
|
This command requires a management ACL token.
|
||||||
|
|
||||||
## General Options
|
## General Options
|
||||||
|
|
||||||
@include 'general_options_no_namespace.mdx'
|
@include 'general_options_no_namespace.mdx'
|
||||||
|
|
|
@ -20,6 +20,9 @@ nomad acl policy info <name>
|
||||||
|
|
||||||
The `acl policy info` command requires the policy name.
|
The `acl policy info` command requires the policy name.
|
||||||
|
|
||||||
|
This command requires a management ACL token or a token that has the
|
||||||
|
associated policy.
|
||||||
|
|
||||||
## General Options
|
## General Options
|
||||||
|
|
||||||
@include 'general_options_no_namespace.mdx'
|
@include 'general_options_no_namespace.mdx'
|
||||||
|
|
|
@ -16,6 +16,9 @@ The `acl policy list` command is used to list available ACL policies.
|
||||||
nomad acl policy list
|
nomad acl policy list
|
||||||
```
|
```
|
||||||
|
|
||||||
|
This command requires a management ACL token to view all policies. A
|
||||||
|
non-management token can query its own policies.
|
||||||
|
|
||||||
## General Options
|
## General Options
|
||||||
|
|
||||||
@include 'general_options_no_namespace.mdx'
|
@include 'general_options_no_namespace.mdx'
|
||||||
|
|
|
@ -18,6 +18,9 @@ is connected to. This is useful for troubleshooting and performance monitoring.
|
||||||
nomad agent-info [options]
|
nomad agent-info [options]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the `agent:read`
|
||||||
|
capability.
|
||||||
|
|
||||||
## General Options
|
## General Options
|
||||||
|
|
||||||
@include 'general_options_no_namespace.mdx'
|
@include 'general_options_no_namespace.mdx'
|
||||||
|
|
|
@ -28,6 +28,12 @@ allocation is only running a single task, the task name can be omitted.
|
||||||
Optionally, the `-job` option may be used in which case a random allocation from
|
Optionally, the `-job` option may be used in which case a random allocation from
|
||||||
the given job will be chosen.
|
the given job will be chosen.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the `alloc-exec`,
|
||||||
|
`read-job`, and `list-jobs` capabilities for the allocation's namespace. If
|
||||||
|
the task driver does not have file system isolation (as with `raw_exec`),
|
||||||
|
this command requires the `alloc-node-exec`, `read-job`, and `list-jobs`
|
||||||
|
capabilities for the allocation's namespace.
|
||||||
|
|
||||||
## General Options
|
## General Options
|
||||||
|
|
||||||
@include 'general_options.mdx'
|
@include 'general_options.mdx'
|
||||||
|
|
|
@ -36,6 +36,9 @@ specified, in which case an allocation is chosen from the given job) and a
|
||||||
path. The path is optional and relative to the root of the [allocation working
|
path. The path is optional and relative to the root of the [allocation working
|
||||||
directory].
|
directory].
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the `read-fs`,
|
||||||
|
`read-job`, and `list-jobs` capabilities for the allocation's namespace.
|
||||||
|
|
||||||
## General Options
|
## General Options
|
||||||
|
|
||||||
@include 'general_options.mdx'
|
@include 'general_options.mdx'
|
||||||
|
|
|
@ -23,6 +23,9 @@ allocation is only running a single task, the task name can be omitted.
|
||||||
Optionally, the `-job` option may be used in which case a random allocation from
|
Optionally, the `-job` option may be used in which case a random allocation from
|
||||||
the given job will be chosen.
|
the given job will be chosen.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the `read-logs`,
|
||||||
|
`read-job`, and `list-jobs` capabilities for the allocation's namespace.
|
||||||
|
|
||||||
## General Options
|
## General Options
|
||||||
|
|
||||||
@include 'general_options.mdx'
|
@include 'general_options.mdx'
|
||||||
|
|
|
@ -21,6 +21,10 @@ This command accepts a single allocation ID and a task name. The task name must
|
||||||
be part of the allocation and the task must be currently running. The task name
|
be part of the allocation and the task must be currently running. The task name
|
||||||
is optional and if omitted every task in the allocation will be restarted.
|
is optional and if omitted every task in the allocation will be restarted.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the
|
||||||
|
`alloc-lifecycle`, `read-job`, and `list-jobs` capabilities for the
|
||||||
|
allocation's namespace.
|
||||||
|
|
||||||
## General Options
|
## General Options
|
||||||
|
|
||||||
@include 'general_options.mdx'
|
@include 'general_options.mdx'
|
||||||
|
|
|
@ -21,6 +21,10 @@ This command accepts a single allocation ID and a task name. The task name must
|
||||||
be part of the allocation and the task must be currently running. The task name
|
be part of the allocation and the task must be currently running. The task name
|
||||||
is optional and if omitted every task in the allocation will be signaled.
|
is optional and if omitted every task in the allocation will be signaled.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the
|
||||||
|
`alloc-lifecycle`, `read-job`, and `list-jobs` capabilities for the
|
||||||
|
allocation's namespace.
|
||||||
|
|
||||||
## General Options
|
## General Options
|
||||||
|
|
||||||
@include 'general_options.mdx'
|
@include 'general_options.mdx'
|
||||||
|
|
|
@ -27,6 +27,9 @@ An allocation ID or prefix must be provided. If there is an exact match, the
|
||||||
full details of the allocation will be displayed. Otherwise, a list of matching
|
full details of the allocation will be displayed. Otherwise, a list of matching
|
||||||
allocations and information will be displayed.
|
allocations and information will be displayed.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the `read-job` and
|
||||||
|
`list-jobs` capabilities for the allocation's namespace.
|
||||||
|
|
||||||
## General Options
|
## General Options
|
||||||
|
|
||||||
@include 'general_options.mdx'
|
@include 'general_options.mdx'
|
||||||
|
|
|
@ -26,6 +26,10 @@ Stop will issue a request to stop and reschedule the allocation. An interactive
|
||||||
monitoring session will display log lines as the allocation completes shutting
|
monitoring session will display log lines as the allocation completes shutting
|
||||||
down. It is safe to exit the monitor early with ctrl-c.
|
down. It is safe to exit the monitor early with ctrl-c.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the
|
||||||
|
`alloc-lifecycle`, `read-job`, and `list-jobs` capabilities for the
|
||||||
|
allocation's namespace.
|
||||||
|
|
||||||
## General Options
|
## General Options
|
||||||
|
|
||||||
@include 'general_options.mdx'
|
@include 'general_options.mdx'
|
||||||
|
|
|
@ -22,6 +22,9 @@ nomad deployment fail [options] <deployment id>
|
||||||
The `deployment fail` command requires a single argument, a deployment ID or
|
The `deployment fail` command requires a single argument, a deployment ID or
|
||||||
prefix.
|
prefix.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the `submit-job`
|
||||||
|
and `read-job` capabilities for the deployment's namespace.
|
||||||
|
|
||||||
## General Options
|
## General Options
|
||||||
|
|
||||||
@include 'general_options.mdx'
|
@include 'general_options.mdx'
|
||||||
|
|
|
@ -18,6 +18,9 @@ nomad deployment list [options]
|
||||||
|
|
||||||
The `deployment list` command requires no arguments.
|
The `deployment list` command requires no arguments.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'read-job'
|
||||||
|
capability for the deployment's namespace.
|
||||||
|
|
||||||
## General Options
|
## General Options
|
||||||
|
|
||||||
@include 'general_options.mdx'
|
@include 'general_options.mdx'
|
||||||
|
|
|
@ -22,6 +22,9 @@ nomad deployment pause [options] <deployment id>
|
||||||
The `deployment pause` command requires a single argument, a deployment ID or
|
The `deployment pause` command requires a single argument, a deployment ID or
|
||||||
prefix.
|
prefix.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the `submit-job`
|
||||||
|
and `read-job` capabilities for the deployment's namespace.
|
||||||
|
|
||||||
## General Options
|
## General Options
|
||||||
|
|
||||||
@include 'general_options.mdx'
|
@include 'general_options.mdx'
|
||||||
|
|
|
@ -28,6 +28,9 @@ prefix. When run without specifying any groups to promote, the promote command
|
||||||
promotes all task groups. The group flag can be specified multiple times to
|
promotes all task groups. The group flag can be specified multiple times to
|
||||||
select particular groups to promote.
|
select particular groups to promote.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the `submit-job`
|
||||||
|
and `read-job` capabilities for the deployment's namespace.
|
||||||
|
|
||||||
## General Options
|
## General Options
|
||||||
|
|
||||||
@include 'general_options.mdx'
|
@include 'general_options.mdx'
|
||||||
|
|
|
@ -21,6 +21,9 @@ nomad deployment resume [options] <deployment id>
|
||||||
The `deployment resume` command requires a single argument, a deployment ID or
|
The `deployment resume` command requires a single argument, a deployment ID or
|
||||||
prefix.
|
prefix.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the `submit-job`
|
||||||
|
and `read-job` capabilities for the deployment's namespace.
|
||||||
|
|
||||||
## General Options
|
## General Options
|
||||||
|
|
||||||
@include 'general_options.mdx'
|
@include 'general_options.mdx'
|
||||||
|
|
|
@ -21,6 +21,9 @@ nomad deployment status [options] <deployment id>
|
||||||
The `deployment status` command requires a single argument, a deployment ID or
|
The `deployment status` command requires a single argument, a deployment ID or
|
||||||
prefix.
|
prefix.
|
||||||
|
|
||||||
|
When ACLs are enabled, this command requires a token with the 'read-job'
|
||||||
|
capability for the deployment's namespace.
|
||||||
|
|
||||||
## General Options
|
## General Options
|
||||||
|
|
||||||
@include 'general_options.mdx'
|
@include 'general_options.mdx'
|
||||||
|
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue