»Command: job validate
job validate command is used to check an HCL job specification for any
syntax errors or validation problems.
nomad job validate <file>
job validate command requires a single argument, specifying the path to a
file containing an HCL job specification. This file will be read and the job
checked for any problems. If the supplied path is "-", the job file is read from
STDIN. Otherwise it is read from the file at the supplied path or downloaded and
read from URL specified. Nomad downloads the job file using
On successful validation, exit code 0 will be returned, otherwise an exit code of 1 indicates an error.
The run command will set the
vault_token of the job based on the following
precedence, going from highest to lowest: the
-vault-token flag, the
$VAULT_TOKEN environment variable and finally the value in the job file.
When ACLs are enabled, this command requires a token with the
capability for the job's namespace.
-address=<addr>: The address of the Nomad server. Overrides the
NOMAD_ADDRenvironment variable if set. Defaults to
-region=<region>: The region of the Nomad server to forward commands to. Overrides the
NOMAD_REGIONenvironment 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_NAMESPACEenvironment 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_COLORmay be set. This option takes precedence over
-force-color: Forces colored command output. This can be used in cases where the usual terminal detection fails. Alternatively,
NOMAD_CLI_FORCE_COLORmay be set. This option has no effect if
-no-coloris 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_CACERTenvironment 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-certis used. Overrides the
NOMAD_CAPATHenvironment 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_CERTenvironment 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_KEYenvironment 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_NAMEenvironment variable if set.
-tls-skip-verify: Do not verify TLS certificate. This is highly not recommended. Verification will also be skipped if
-token: The SecretID of an ACL token to use to authenticate API requests with. Overrides the
NOMAD_TOKENenvironment variable if set.
-json: Parses the job file as JSON. If the outer object has a Job field, such as from "nomad job inspect" or "nomad run -output", the value of the field is used as the job.
-hcl1: If set, HCL1 parser is used for parsing the job spec. Takes precedence over
-hcl2-strict: Whether an error should be produced from the HCL2 parser where a variable has been supplied which is not defined within the root variables. Defaults to true, but ignored if
-vault-token: Used to validate if the user submitting the job has permission to run the job according to its Vault policies. A Vault token must be supplied if the
allow_unauthenticatedis disabled in the Nomad server configuration. If the
-vault-tokenflag is set, the passed Vault token is added to the jobspec before sending to the Nomad servers. This allows passing the Vault token without storing it in the job file. This overrides the token found in the
$VAULT_TOKENenvironment variable and the
vault_tokenfield in the job file. This token is cleared from the job after validating and cannot be used within the job executing environment. Use the
vaultblock when templating in a job with a Vault token.
-vault-namespace: If set, the passed Vault namespace is stored in the job before sending to the Nomad servers.
-var=<key=value>: Variable for template, can be used multiple times.
-var-file=<path>: Path to HCL2 file containing user variables.
Validate a JSON job with invalid syntax:
$ nomad job validate -json example.json Job validation errors: 1 error occurred: * Missing job datacenters
Validate a job that has a configuration that causes warnings:
$ nomad job validate example.nomad.hcl Job Warnings: 1 warning(s): * Group "cache" has warnings: 1 error(s) occurred: * Update max parallel count is greater than task group count (6 > 3). A destructive change would result in the simultaneous replacement of all allocations. Job validation successful