HashiConf 2024 Now streaming live from Boston! Attend for free
Nomad
Nomad Home

Command: job tag

Applying a tag to a version prevents Nomad from garbage collecting that version. You can compare versions by tag name as well as version number.

Tag names must be unique per job.

Use the job tag command to manage tags for job versions. job tag has the following subcommands:

Usage

nomad job tag <subcommand> [options] [args]

General options

Use these optional general options with the subcommands.

  • -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 '*', subcommands which support this functionality 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.

Apply

Use job tag apply to create or modify a version tag.

Apply usage

nomad job tag apply [options] <job_id>

Apply options

  • name: Specifies the name of the tag. Must be unique per job.
  • description: If set, specifies a description for the tag.
  • version: If set, specifies the version of the job to tag. If not provided, Nomad tags the latest version of the job.

Apply examples

This example tags the latest version of the job hello-world.

$ nomad job tag apply -name "golden-version" \
        -description "The version we can roll back to." \
    hello-world

This example tags version zero of the job hello-world.

$ nomad job tag apply -version 0 \
      -name "golden-version" \
      hello-world

Unset

Use nomad job tag unset to delete a tag from a version. This command requires a job name and a tag name.

Unset usage

nomad job tag unset [options] <job_id> -name <tag>

Unset options

  • name: Specifies the name of the tag to remove from the job version.

Examples

This example removes the golden-version tag from the hello-world job.

$ nomad job tag unset hello-world -name "golden-version"
Edit this page on GitHub