-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs and changelog for
nomad config validate
- Loading branch information
Showing
4 changed files
with
118 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
```release-note:improvement | ||
cli: add Usage: nomad [-version] [-help] [-autocomplete-(un)install] <command> [args] | ||
|
||
Common commands: | ||
run Run a new job or update an existing job | ||
stop Stop a running job | ||
status Display the status output for a resource | ||
alloc Interact with allocations | ||
job Interact with jobs | ||
node Interact with nodes | ||
agent Runs a Nomad agent | ||
|
||
Other commands: | ||
acl Interact with ACL policies and tokens | ||
agent-info Display status information about the local agent | ||
deployment Interact with deployments | ||
eval Interact with evaluations | ||
exec Execute commands in task | ||
license Interact with Nomad Enterprise License | ||
monitor Stream logs from a Nomad agent | ||
namespace Interact with namespaces | ||
operator Provides cluster-level tools for Nomad operators | ||
plugin Inspect plugins | ||
quota Interact with quotas | ||
recommendation Interact with the Nomad recommendation endpoint | ||
scaling Interact with the Nomad scaling endpoint | ||
sentinel Interact with Sentinel policies | ||
server Interact with servers | ||
system Interact with the system API | ||
ui Open the Nomad Web UI | ||
version Prints the Nomad version | ||
volume Interact with volumes command to check configuration files without an agent | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
layout: docs | ||
page_title: 'Commands: config' | ||
description: | | ||
The config command interacting with configurations. | ||
--- | ||
|
||
# Command: config | ||
|
||
The `config` command is used to interact with configurations. | ||
|
||
## Usage | ||
|
||
Usage: `nomad config <subcommand> [options]` | ||
|
||
Run `nomad config <subcommand> -h` for help on that subcommand. The | ||
following subcommands are available: | ||
|
||
- [`config validate`][validate] - Validate configuration files | ||
|
||
[gc]: /docs/commands/config/validate 'Validate configuration files' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
--- | ||
layout: docs | ||
page_title: 'Commands: config validate' | ||
description: | | ||
The config validate command is used to validate Nomad configuration files. | ||
--- | ||
|
||
# Command: config validate | ||
|
||
The `config validate` command performs validation on a set of Nomad | ||
configuration files. This is useful to test the Nomad configuration | ||
without starting the agent. | ||
|
||
## Usage | ||
|
||
```plaintext | ||
nomad config validate <config_path> [<config_path...>] | ||
``` | ||
|
||
The `config validate` command requires a path to either a single | ||
configuration file or a directory of configuration files to use for | ||
configuring the Nomad agent. This option can be specified multiple | ||
times. If multiple config files are passed, the values from each will | ||
be merged together. During merging, values from files found later in | ||
the list are merged over values from previously parsed files. | ||
|
||
This command cannot operate on partial configuration fragments since | ||
those won't pass the full agent validation. This command does not | ||
require an ACL token. | ||
|
||
Returns 0 if the configuration is valid, or 1 if there are problems. | ||
|
||
## General Options | ||
|
||
@include 'general_options.mdx' | ||
|
||
## Examples | ||
|
||
Validate a configuration file: | ||
|
||
```shell-session | ||
$ nomad config validate ./nomad.hcl | ||
Configuration is valid! | ||
``` | ||
|
||
Validate a directory of configuration files: | ||
|
||
```shell-session | ||
$ nomad config validate /etc/nomad.d | ||
Configuration is valid! | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters