Update the usage of plan command

This commit is contained in:
Kenjiro Nakayama
2016-08-16 19:59:25 +09:00
parent bbc6a48596
commit 4836c0ffd6

View File

@@ -19,6 +19,14 @@ format.
nomad plan [options] <file>
```
The plan command requires a single argument, specifying the path to a file
containing a [HCL job specification](/docs/jobspec/index.html). This file
will be read and the job checked for any problems. If the
supplied path is "-", the jobfile is read from STDIN. Otherwise it is read
from the file at the supplied path or downloaded and read from URL specified.
Nomad downloads jobfile using [`go-getter`](https://github.com/hashicorp/go-getter)
and support `go-getter` syntax.
Plan invokes a dry-run of the scheduler to determine the effects of submitting
either a new or updated version of a job. The plan will not result in any
changes to the cluster but gives insight into whether the job could be run