The deployment promote command is used to promote task groups in a deployment.
Promotion should occur when the deployment has placed canaries for a task group
and those canaries have been deemed healthy. When a task group is promoted, the
rolling upgrade of the remaining allocations is unblocked. If the canaries are
found to be unhealthy, the deployment may either be failed using the "nomad
deployment fail" command, the job can be failed forward by submitting a new
version or failed backwards by reverting to an older version using the
job revert command.
The deployment promote command requires a single argument, a deployment ID or
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
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.
-address=<addr>: The address of the Nomad server. Overrides the NOMAD_ADDR
environment variable if set. Defaults to http://127.0.0.1:4646.
-region=<region>: The region of the Nomad server to forward commands to.
Overrides the NOMAD_REGION environment variable if set. Defaults to the
Agent's local region.
-namespace=<namespace>: The target namespace for queries and actions bound
to a namespace. Overrides the NOMAD_NAMESPACE environment variable if set.
If set to '*', job and alloc subcommands query all namespaces authorized to
user. Defaults to the "default" namespace.
-no-color: Disables colored command output. Alternatively,
NOMAD_CLI_NO_COLOR may be set. This option takes precedence over
-force-color.
-force-color: Forces colored command output. This can be used in cases where
the usual terminal detection fails. Alternatively, NOMAD_CLI_FORCE_COLOR
may be set. This option has no effect if -no-color is also used.
-ca-cert=<path>: Path to a PEM encoded CA cert file to use to verify the
Nomad server SSL certificate. Overrides the NOMAD_CACERT environment
variable if set.
-ca-path=<path>: Path to a directory of PEM encoded CA cert files to verify
the Nomad server SSL certificate. If both -ca-cert and -ca-path are
specified, -ca-cert is used. Overrides the NOMAD_CAPATH environment
variable if set.
-client-cert=<path>: Path to a PEM encoded client certificate for TLS
authentication to the Nomad server. Must also specify -client-key. Overrides
the NOMAD_CLIENT_CERT environment variable if set.
-client-key=<path>: Path to an unencrypted PEM encoded private key matching
the client certificate from -client-cert. Overrides the NOMAD_CLIENT_KEY
environment variable if set.
-tls-server-name=<value>: The server name to use as the SNI host when connecting
via TLS. Overrides the NOMAD_TLS_SERVER_NAME environment variable if set.
-tls-skip-verify: Do not verify TLS certificate. This is highly not
recommended. Verification will also be skipped if NOMAD_SKIP_VERIFY is set.
-token: The SecretID of an ACL token to use to authenticate API requests with.
Overrides the NOMAD_TOKEN environment variable if set.
-group: Group may be specified many times and is used to promote that
particular group. If no specific groups are specified, all groups are
promoted.
-detach: Return immediately instead of monitoring. A new evaluation ID
will be output, which can be used to examine the evaluation using the
eval status command
