open-nomad/website/source/docs/commands/job/validate.html.md.erb

62 lines
1.7 KiB
Plaintext
Raw Normal View History

2015-09-25 01:29:46 +00:00
---
layout: "docs"
2018-03-22 17:56:06 +00:00
page_title: "Commands: job validate"
sidebar_current: "docs-commands-job-validate"
2015-09-25 01:29:46 +00:00
description: >
2018-03-22 17:56:06 +00:00
The job validate command is used to check a job specification for syntax errors and validation problems.
2015-09-25 01:29:46 +00:00
---
2018-03-22 17:56:06 +00:00
# Command: job validate
2018-03-22 18:09:26 +00:00
**Alias: `nomad validate`**
2015-09-25 01:29:46 +00:00
The `job validate` command is used to check an HCL [job specification] for any
syntax errors or validation problems.
2015-09-25 01:29:46 +00:00
## Usage
```plaintext
2018-03-22 17:56:06 +00:00
nomad job validate <file>
2015-09-25 01:29:46 +00:00
```
The `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 [`go-getter`] and
supports `go-getter` syntax.
2015-09-25 01:29:46 +00:00
On successful validation, exit code 0 will be returned, otherwise an exit code
of 1 indicates an error.
2017-07-25 16:37:09 +00:00
## Examples
Validate a job with invalid syntax:
```shell
2018-03-22 17:56:06 +00:00
$ nomad job validate example.nomad
2017-07-25 16:37:09 +00:00
Job validation errors:
1 error(s) occurred:
* group "cache" -> task "redis" -> config: 1 error(s) occurred:
* field "image" is required
```
Validate a job that has a configuration that causes warnings:
```shell
2018-03-22 17:56:06 +00:00
$ nomad job validate example.nomad
2017-07-25 16:37:09 +00:00
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
```
[`go-getter`]: https://github.com/hashicorp/go-getter
[job specification]: /docs/job-specification/index.html