Add help and documentation
This commit is contained in:
parent
7fb866ae4c
commit
c77fbcc67b
|
@ -39,7 +39,8 @@ Usage: nomad plan [options] <file>
|
|||
successfully and how it would affect existing allocations.
|
||||
|
||||
If the supplied path is "-", the jobfile is read from stdin. Otherwise
|
||||
it is read from the file at the supplied path.
|
||||
it is read from the file at the supplied path or downloaded and
|
||||
read from URL specified.
|
||||
|
||||
A job modify index is returned with the plan. This value can be used when
|
||||
submitting the job using "nomad run -check-index", which will check that the job
|
||||
|
|
|
@ -33,7 +33,8 @@ Usage: nomad run [options] <path>
|
|||
used to interact with Nomad.
|
||||
|
||||
If the supplied path is "-", the jobfile is read from stdin. Otherwise
|
||||
it is read from the file at the supplied path.
|
||||
it is read from the file at the supplied path or downloaded and
|
||||
read from URL specified.
|
||||
|
||||
Upon successful job submission, this command will immediately
|
||||
enter an interactive monitor. This is useful to watch Nomad's
|
||||
|
|
|
@ -18,7 +18,8 @@ Usage: nomad validate [options] <file>
|
|||
check for any syntax errors or validation problems with a job.
|
||||
|
||||
If the supplied path is "-", the jobfile is read from stdin. Otherwise
|
||||
it is read from the file at the supplied path.
|
||||
it is read from the file at the supplied path or downloaded and
|
||||
read from URL specified.
|
||||
`
|
||||
return strings.TrimSpace(helpText)
|
||||
}
|
||||
|
|
|
@ -22,7 +22,9 @@ The run command requires a single argument, specifying the path to a file
|
|||
containing a valid [job specification](/docs/jobspec/index.html). This file
|
||||
will be read and the job will be submitted to Nomad for scheduling. If the
|
||||
supplied path is "-", the jobfile is read from STDIN. Otherwise it is read
|
||||
from the file at the supplied path.
|
||||
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.
|
||||
|
||||
By default, on successful job submission the run command will enter an
|
||||
interactive monitor and display log information detailing the scheduling
|
||||
|
|
|
@ -19,7 +19,11 @@ nomad validate <file>
|
|||
|
||||
The validate 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.
|
||||
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.
|
||||
|
||||
On successful validation, exit code 0 will be returned, otherwise an exit code
|
||||
of 1 indicates an error.
|
||||
|
|
Loading…
Reference in New Issue