github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'b2d9c10fad'
${ noResults }
consul/website/source/docs/commands/configtest.html.markdown

1.3 KiB
Raw Blame History

layout page_title sidebar_current description
docs Commands: ConfigTest docs-commands-configtest The `consul configtest` command tests that config files are valid by attempting to parse them. Useful to ensure a configuration change will not cause consul to fail after a restart.

Consul ConfigTest

The consul configtest command performs a basic sanity test on Consul configuration files. For each file or directory given, the configtest command will attempt to parse the contents just as the "consul agent" command would, and catch any errors. This is useful to do a test of the configuration only, without actually starting the agent.

For more information on the format of Consul's configuration files, read the consul agent Configuration Files section.

Usage

Usage: consul configtest [options]

At least one -config-file or -config-dir parameter must be given. Returns 0 if the configuration is valid, or 1 if there are problems. The list of available flags are:

  • -config-file - Path to a config file. May be specified multiple times.

  • -config-dir - Path to a directory of config files. All files ending in .json in the directory will be included. May be specified multiple times.