kemko/nomad
1
0
Fork 0
mirror of https://github.com/kemko/nomad.git synced 2026-01-01 16:05:42 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: add note and example of storing nomad job plan index to disk (#11377)

Browse Source
This commit is contained in:
Luiz Aoqui
2021-10-26 20:25:22 -04:00
committed by GitHub
parent dce23e829f
commit 1fbe88fbd6
2 changed files with 23 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
website/content/docs/commands/job/plan.mdx
View File

@@ -203,7 +203,29 @@ changed, another user has modified the job and the plan's results are
potentially invalid.
```
When using the `nomad job plan` command in automated environments, such as
in CI/CD pipelines, it is useful to output the plan result for manual
validation and also store the check index on disk so it can be used later to
guarantee that a job deployment will match the expected changes described in
the plan result.
This can be done by parsing the command output and redirecting the index to a
file. For example, in Linux environments the [`tee`] command can be used for
this purpose:
```console
$ nomad job plan -no-color example.nomad | tee /dev/stderr | grep 'Job Modify Index:' | awk -F': ' '{ print $2 }' > check-index || true
```
The [`-no-color`](#no-color) flag prevents style characters from impacting
parsing. Colored output may be helpful when analyzing the plan result, so the
[`-force-color`](#force-color) flag can be used. This will affect how parsing
is done to avoid hidden control characters. Adding `|| true` at the end
prevents undesired failures since `nomad job plan` returns a non-zero exit code
if a change is detected.
[job specification]: /docs/job-specification
[hcl job specification]: /docs/job-specification
[`go-getter`]: https://github.com/hashicorp/go-getter
[`nomad job run -check-index`]: /docs/commands/job/run#check-index
[`tee`]: https://man7.org/linux/man-pages/man1/tee.1.html

2
website/content/partials/general_options.mdx
View File

@@ -14,7 +14,7 @@
`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
- `-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.