HashiDays One conference. Three cities. Find a city near you
Nomad
Nomad Home

You are viewing documentation for version v1.0.x. View latest version.

Command: deployment status

The deployment status command 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.

Usage

nomad deployment status [options] <deployment id>

The deployment status command requires a single argument, a deployment ID or prefix.

When ACLs are enabled, this command requires a token with the 'read-job' capability for the deployment's namespace.

General Options

  • -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 namespacecs authorized to user. Defaults to the "default" namespace.

  • -no-color: Disables colored command output. Alternatively, NOMAD_CLI_NO_COLOR may be set.

  • -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.

Status Options

  • -json : Output the deployment in its JSON format.
  • -t : Format and display the deployment using a Go template.
  • -verbose: Show full information.

Examples

Inspect the status of a complete deployment:

$ nomad deployment status 06ca68a2ID          = 06ca68a2Job ID      = exampleJob Version = 0Status      = successfulDescription = Deployment completed successfullyDeployedTask Group  Desired  Placed  Healthy  Unhealthycache       2        2       2        0web         2        2       2        0

Inspect the status of a deployment that is waiting for canary promotion:

$ nomad deployment status 0bID          = 0b23b149Job ID      = exampleJob Version = 1Status      = runningDescription = Deployment is running but requires manual promotionDeployedTask Group  Promoted  Desired  Canaries  Placed  Healthy  Unhealthycache       false     2        1         1       0        0web         N/A       2        0         2       2        0