2014-02-08 00:41:03 +00:00
---
layout: "docs"
page_title: "Configuration"
sidebar_current: "docs-agent-config"
2014-10-19 23:40:10 +00:00
description: |-
2015-02-13 19:58:05 +00:00
The agent has various configuration options that can be specified via the command-line or via configuration files. All of the configuration options are completely optional. Defaults are specified with their descriptions.
2014-02-08 00:41:03 +00:00
---
# Configuration
The agent has various configuration options that can be specified via
the command-line or via configuration files. All of the configuration
2015-02-13 19:58:05 +00:00
options are completely optional. Defaults are specified with their
descriptions.
2014-02-08 00:41:03 +00:00
2017-03-30 18:13:50 +00:00
Configuration precedence is evaluated in the following order:
1. Command line arguments
2. Environment Variables
3. Configuration files
2017-09-25 18:40:42 +00:00
When loading configuration, Consul loads the configuration from files and
directories in lexical order. For example, configuration file
`basic_config.json` will be processed before `extra_config.json` . Configuration
2017-09-27 22:30:30 +00:00
can be in either [HCL ](https://github.com/hashicorp/hcl#syntax ) or JSON format.
Available in Consul 1.0 and later, the HCL support now requires an `.hcl` or
`.json` extension on all configuration files in order to specify their format.
2017-09-25 18:40:42 +00:00
Configuration specified later will be merged into configuration specified
earlier. In most cases, "merge" means that the later version will override the
earlier. In some cases, such as event handlers, merging appends the handlers to
the existing configuration. The exact merging behavior is specified for each
2015-02-13 19:58:05 +00:00
option below.
2014-02-08 00:41:03 +00:00
2015-02-13 19:58:05 +00:00
Consul also supports reloading configuration when it receives the
2014-02-08 00:41:03 +00:00
SIGHUP signal. Not all changes are respected, but those that are
2014-11-26 03:03:14 +00:00
are documented below in the
[Reloadable Configuration ](#reloadable-configuration ) section. The
[reload command ](/docs/commands/reload.html ) can also be used to trigger a
configuration reload.
2014-02-08 00:41:03 +00:00
2016-08-15 20:48:54 +00:00
## <a name="commandline_options"></a>Command-line Options
2014-02-08 00:41:03 +00:00
The options below are all specified on the command-line.
2018-05-10 13:56:48 +00:00
* < a name = "_advertise" ></ a >< a href = "#_advertise" > `-advertise`</ a > - The
advertise address is used to change the address that we advertise to other
nodes in the cluster. By default, the [`-bind` ](#_bind ) address is advertised.
However, in some cases, there may be a routable address that cannot be bound.
This flag enables gossiping a different address to support this. If this
address is not routable, the node will be in a constant flapping state as
other nodes will treat the non-routability as a failure. In Consul 1.0 and
later this can be set to a
[go-sockaddr ](https://godoc.org/github.com/hashicorp/go-sockaddr/template )
template.
2014-05-16 17:49:36 +00:00
2016-02-07 18:56:47 +00:00
* < a name = "_advertise-wan" ></ a >< a href = "#_advertise-wan" > `-advertise-wan`</ a > - The
advertise WAN address is used to change the address that we advertise to server nodes
joining through the WAN. This can also be set on client agents when used in combination
with the < a href = "#translate_wan_addrs" > `translate_wan_addrs`< / a > configuration
option. By default, the [`-advertise` ](#_advertise ) address is advertised. However, in some
cases all members of all datacenters cannot be on the same physical or virtual network,
especially on hybrid setups mixing cloud and private datacenters. This flag enables server
nodes gossiping through the public network for the WAN while using private VLANs for gossiping
to each other and their client agents, and it allows client agents to be reached at this
address when being accessed from a remote datacenter if the remote datacenter is configured
2018-05-10 13:56:48 +00:00
with < a href = "#translate_wan_addrs" > `translate_wan_addrs`< / a > . In Consul 1.0 and
later this can be set to a
[go-sockaddr ](https://godoc.org/github.com/hashicorp/go-sockaddr/template )
template
2015-03-28 15:04:09 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "_bootstrap" ></ a >< a href = "#_bootstrap" > `-bootstrap`</ a > - This flag is used to control if a
server is in "bootstrap" mode. It is important that
2015-02-19 22:45:47 +00:00
no more than one server *per* datacenter be running in this mode. Technically, a server in bootstrap mode
2015-02-13 19:58:05 +00:00
is allowed to self-elect as the Raft leader. It is important that only a single node is in this mode;
otherwise, consistency cannot be guaranteed as multiple nodes are able to self-elect.
2014-07-01 22:02:26 +00:00
It is not recommended to use this flag after a cluster has been bootstrapped.
2015-02-24 17:30:17 +00:00
* < a name = "_bootstrap_expect" ></ a >< a href = "#_bootstrap_expect" > `-bootstrap-expect`</ a > - This flag
provides the number of expected servers in the datacenter.
2015-02-13 19:58:05 +00:00
Either this value should not be provided or the value must agree with other servers in
2014-07-01 22:02:26 +00:00
the cluster. When provided, Consul waits until the specified number of servers are
2015-02-13 19:58:05 +00:00
available and then bootstraps the cluster. This allows an initial leader to be elected
2015-02-24 19:11:11 +00:00
automatically. This cannot be used in conjunction with the legacy [`-bootstrap` ](#_bootstrap ) flag.
2017-09-29 05:02:37 +00:00
This flag requires [`-server` ](#_server ) mode.
2014-04-11 23:23:16 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "_bind" ></ a >< a href = "#_bind" > `-bind`</ a > - The address that should be bound to
for internal cluster communications.
2014-02-18 23:30:07 +00:00
This is an IP address that should be reachable by all other nodes in the cluster.
2016-11-02 18:35:37 +00:00
By default, this is "0.0.0.0", meaning Consul will bind to all addresses on
2016-09-27 22:36:19 +00:00
the local machine and will [advertise ](/docs/agent/options.html#_advertise )
the first available private IPv4 address to the rest of the cluster. If there
2018-06-29 20:43:12 +00:00
are **multiple private IPv4 addresses** available, Consul will exit with an error
2016-11-02 18:35:37 +00:00
at startup. If you specify "[::]", Consul will
2016-09-27 22:36:19 +00:00
[advertise ](/docs/agent/options.html#_advertise ) the first available public
2018-06-29 20:43:12 +00:00
IPv6 address. If there are **multiple public IPv6 addresses** available, Consul
2016-09-27 22:36:19 +00:00
will exit with an error at startup.
2015-09-05 15:53:41 +00:00
Consul uses both TCP and UDP and the same port for both. If you
2018-06-29 20:43:12 +00:00
have any firewalls, be sure to allow both protocols. **In Consul 1.0 and later this can be set to a [go-sockaddr](https://godoc.org/github.com/hashicorp/go-sockaddr/template) template that needs to resolve to a single address.**
2014-02-08 00:41:03 +00:00
2018-05-10 13:56:48 +00:00
* < a name = "_serf_wan_bind" ></ a >< a href = "#_serf_wan_bind" > `-serf-wan-bind`</ a > -
The address that should be bound to for Serf WAN gossip communications. By
default, the value follows the same rules as [`-bind` command-line
flag](#_bind), and if this is not specified, the `-bind` option is used. This
is available in Consul 0.7.1 and later. In Consul 1.0 and later this can be
set to a
[go-sockaddr ](https://godoc.org/github.com/hashicorp/go-sockaddr/template )
template
* < a name = "_serf_lan_bind" ></ a >< a href = "#_serf_lan_bind" > `-serf-lan-bind`</ a > -
The address that should be bound to for Serf LAN gossip communications. This
is an IP address that should be reachable by all other LAN nodes in the
cluster. By default, the value follows the same rules as [`-bind` command-line
flag](#_bind), and if this is not specified, the `-bind` option is used. This
is available in Consul 0.7.1 and later. In Consul 1.0 and later this can be
set to a
[go-sockaddr ](https://godoc.org/github.com/hashicorp/go-sockaddr/template )
template
* < a name = "_client" ></ a >< a href = "#_client" > `-client`</ a > - The address to which
Consul will bind client interfaces, including the HTTP and DNS servers. By
default, this is "127.0.0.1", allowing only loopback connections. In Consul
1.0 and later this can be set to a space-separated list of addresses to bind
to, or a
[go-sockaddr ](https://godoc.org/github.com/hashicorp/go-sockaddr/template )
template that can potentially resolve to multiple addresses.
2015-02-24 17:30:17 +00:00
* < a name = "_config_file" ></ a >< a href = "#_config_file" > `-config-file`</ a > - A configuration file
to load. For more information on
2015-02-13 19:58:05 +00:00
the format of this file, read the [Configuration Files ](#configuration_files ) section.
2014-02-08 00:41:03 +00:00
This option can be specified multiple times to load multiple configuration
files. If it is specified multiple times, configuration files loaded later
2014-11-13 20:02:41 +00:00
will merge with configuration files loaded earlier. During a config merge,
2015-02-13 19:58:05 +00:00
single-value keys (string, int, bool) will simply have their values replaced
2014-11-13 20:02:41 +00:00
while list types will be appended together.
2014-02-08 00:41:03 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "_config_dir" ></ a >< a href = "#_config_dir" > `-config-dir`</ a > - A directory of
configuration files to load. Consul will
2018-07-05 22:23:39 +00:00
load all files in this directory with the suffix ".json" or ".hcl". The load order
2015-02-17 00:48:49 +00:00
is alphabetical, and the the same merge routine is used as with the
2016-05-15 16:13:52 +00:00
[`config-file` ](#_config_file ) option above. This option can be specified multiple times
2015-05-11 17:36:50 +00:00
to load multiple directories. Sub-directories of the config directory are not loaded.
For more information on the format of the configuration files, see the
[Configuration Files ](#configuration_files ) section.
2014-02-08 00:41:03 +00:00
2017-10-31 22:30:01 +00:00
* < a name = "_config_format" ></ a >< a href = "#_config_format" > `-config-format`</ a > - The format
of the configuration files to load. Normally, Consul detects the format of the
config files from the ".json" or ".hcl" extension. Setting this option to
either "json" or "hcl" forces Consul to interpret any file with or without
extension to be interpreted in that format.
2018-03-02 16:20:11 +00:00
* < a name = "_data_dir" ></ a >< a href = "#_data_dir" > `-data-dir`</ a > - This flag
provides a data directory for the agent to store state. This is required for
all agents. The directory should be durable across reboots. This is especially
critical for agents that are running in server mode as they must be able to
persist cluster state. Additionally, the directory must support the use of
filesystem locking, meaning some types of mounted folders (e.g. VirtualBox
shared folders) may not be suitable. **Note:** both server and non-server
agents may store ACL tokens in the state in this directory so read access may
2018-03-02 16:22:12 +00:00
grant access to any tokens on servers and to any tokens used during service
registration on non-servers. On Unix-based platforms the files are written
with 0600 permissions so you should ensure only trusted processes can execute
as the same user as Consul. On Windows, you should ensure the directory has
2018-03-02 16:20:11 +00:00
suitable permissions configured as these will be inherited.
2014-02-18 23:30:07 +00:00
2017-04-13 05:05:38 +00:00
* < a name = "_datacenter" ></ a >< a href = "#_datacenter" > `-datacenter`</ a > - This flag controls the datacenter in
which the agent is running. If not provided,
it defaults to "dc1". Consul has first-class support for multiple datacenters, but
it relies on proper configuration. Nodes in the same datacenter should be on a single
LAN.
2015-12-27 15:45:59 +00:00
* < a name = "_dev" ></ a >< a href = "#_dev" > `-dev`</ a > - Enable development server
mode. This is useful for quickly starting a Consul agent with all persistence
options turned off, enabling an in-memory server which can be used for rapid
2018-10-11 09:44:42 +00:00
prototyping or developing against the API. In this mode, [Connect is
enabled](/docs/connect/configuration.html) and will by default create a new
root CA certificate on startup. This mode is **not** intended for production
use as it does not write any data to disk. The gRPC port is also defaulted to
`8502` in this mode.
2015-12-27 15:45:59 +00:00
2017-04-13 05:05:38 +00:00
* < a name = "_disable_host_node_id" ></ a >< a href = "#_disable_host_node_id" > `-disable-host-node-id`</ a > - Setting
this to true will prevent Consul from using information from the host to generate a deterministic node ID,
and will instead generate a random node ID which will be persisted in the data directory. This is useful
2017-06-24 16:36:53 +00:00
when running multiple Consul agents on the same host for testing. This defaults to false in Consul prior
to version 0.8.5 and in 0.8.5 and later defaults to true, so you must opt-in for host-based IDs. Host-based
IDs are generated using https://github.com/shirou/gopsutil/tree/master/host, which is shared with HashiCorp's
[Nomad ](https://www.nomadproject.io/ ), so if you opt-in to host-based IDs then Consul and Nomad will use
information on the host to automatically assign the same ID in both systems.
2014-02-18 23:30:07 +00:00
2017-07-17 18:20:35 +00:00
* < a name = "_disable_keyring_file" ></ a >< a href = "#_disable_keyring_file" > `-disable-keyring-file`</ a > - If set,
the keyring will not be persisted to a file. Any installed keys will be lost on shutdown, and only the given
`-encrypt` key will be available on startup. This defaults to false.
2016-08-05 19:36:01 +00:00
* < a name = "_dns_port" ></ a >< a href = "#_dns_port" > `-dns-port`</ a > - the DNS port to listen on.
2016-09-02 05:18:34 +00:00
This overrides the default port 8600. This is available in Consul 0.7 and later.
2016-08-05 19:36:01 +00:00
2015-03-20 14:22:13 +00:00
* < a name = "_domain" ></ a >< a href = "#_domain" > `-domain`</ a > - By default, Consul responds to DNS queries
in the "consul." domain. This flag can be used to change that domain. All queries in this domain
are assumed to be handled by Consul and will not be recursively resolved.
2018-11-27 17:15:01 +00:00
* < a name = "_enable_script_checks" ></ a >< a
href="#_enable_script_checks">`-enable-script-checks`< / a > This controls
whether [health checks that execute scripts ](/docs/agent/checks.html ) are
enabled on this agent, and defaults to `false` so operators must opt-in to
allowing these. This was added in Consul 0.9.0.
2018-12-06 21:51:49 +00:00
2018-11-27 17:15:01 +00:00
~> **Security Warning:** Enabling script checks in some configurations may
introduce a remote execution vulnerability which is known to be targeted by
malware. We strongly recommend `-enable-local-script-checks` instead. See [this
blog post](https://www.hashicorp.com/blog/protecting-consul-from-rce-risk-in-specific-configurations)
for more details.
2018-10-11 12:22:11 +00:00
2018-10-19 20:26:31 +00:00
* < a name = "_enable_local_script_checks" ></ a >< a href = "#_enable_local_script_checks" > `-enable-local-script-checks`</ a >
2018-10-11 12:22:11 +00:00
Like [`enable_script_checks` ](#_enable_script_checks ), but only enable them when they are defined in the local
2018-11-27 17:15:01 +00:00
configuration files. Script checks defined in HTTP API registrations will still not be allowed.
2017-07-17 18:20:35 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "_encrypt" ></ a >< a href = "#_encrypt" > `-encrypt`</ a > - Specifies the secret key to
use for encryption of Consul
2015-02-13 20:19:17 +00:00
network traffic. This key must be 16-bytes that are Base64-encoded. The
2015-02-24 17:30:17 +00:00
easiest way to create an encryption key is to use
[`consul keygen` ](/docs/commands/keygen.html ). All
2014-08-22 22:08:15 +00:00
nodes within a cluster must share the same encryption key to communicate.
2015-02-13 19:58:05 +00:00
The provided key is automatically persisted to the data directory and loaded
2014-10-04 21:10:57 +00:00
automatically whenever the agent is restarted. This means that to encrypt
Consul's gossip protocol, this option only needs to be provided once on each
agent's initial startup sequence. If it is provided after Consul has been
2014-10-09 22:28:38 +00:00
initialized with an encryption key, then the provided key is ignored and
a warning will be displayed.
2014-08-22 22:08:15 +00:00
2018-10-11 09:44:42 +00:00
* < a name = "_grpc_port" ></ a >< a href = "#_grpc_port" > `-grpc-port`</ a > - the gRPC API
port to listen on. Default -1 (gRPC disabled). See [ports ](#ports )
documentation for more detail.
2017-09-25 18:40:42 +00:00
* < a name = "_hcl" ></ a >< a href = "#_hcl" > `-hcl`</ a > - A HCL configuration fragment.
This HCL configuration fragment is appended to the configuration and allows
to specify the full range of options of a config file on the command line.
This option can be specified multiple times. This was added in Consul 1.0.
2015-09-02 04:28:55 +00:00
* < a name = "_http_port" ></ a >< a href = "#_http_port" > `-http-port`</ a > - the HTTP API port to listen on.
This overrides the default port 8500. This option is very useful when deploying Consul
to an environment which communicates the HTTP port through the environment e.g. PaaS like CloudFoundry, allowing
you to set the port directly via a Procfile.
2018-10-11 09:44:42 +00:00
2018-10-29 16:29:14 +00:00
* < a name = "_log_file" ></ a >< a href = "#_log_file" > `-log-file`</ a > - to redirect all the Consul agent log messages to a file. This can be specified with the complete path along with the name of the log. In case the path doesn't have the filename, the filename defaults to `consul-{timestamp}.log` . Can be combined with < a href = "#_log_rotate_bytes" > -log-rotate-bytes</ a > and < a href = "#_log_rotate_duration" > -log-rotate-duration </ a > for a fine-grained log rotation experience.
2018-08-29 20:56:58 +00:00
* < a name = "_log_rotate_bytes" ></ a >< a href = "#_log_rotate_bytes" > `-log-rotate-bytes`</ a > - to specify the number of bytes that should be written to a log before it needs to be rotated. Unless specified, there is no limit to the number of bytes that can be written to a log file.
2018-10-04 18:28:26 +00:00
* < a name = "_log_rotate_duration" ></ a >< a href = "#_log_rotate_duration" > `-log-rotate-duration`</ a > - to specify the maximum duration a log should be written to before it needs to be rotated. Unless specified, logs are rotated on a daily basis (24 hrs).
2015-09-02 04:28:55 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "_join" ></ a >< a href = "#_join" > `-join`</ a > - Address of another agent
to join upon starting up. This can be
2014-04-11 23:59:16 +00:00
specified multiple times to specify multiple agents to join. If Consul is
unable to join with any of the specified addresses, agent startup will
fail. By default, the agent won't join any nodes when it starts up.
2017-04-13 17:03:26 +00:00
Note that using
< a href = "#retry_join" > `retry_join`< / a > could be more appropriate to help
mitigate node startup race conditions when automating a Consul cluster
2018-05-10 13:56:48 +00:00
deployment.
2018-06-06 20:35:44 +00:00
2018-05-10 23:04:40 +00:00
In Consul 1.1.0 and later this can be set to a
[go-sockaddr ](https://godoc.org/github.com/hashicorp/go-sockaddr/template )
template
2014-04-11 23:59:16 +00:00
2017-08-10 04:14:56 +00:00
< a name = "_retry_join" > < / a >
* `-retry-join` - Similar to [`-join` ](#_join ) but allows retrying a join if the
first attempt fails. This is useful for cases where you know the address will
2018-05-10 13:56:48 +00:00
eventually be available. The list can contain IPv4, IPv6, or DNS addresses. In
Consul 1.1.0 and later this can be set to a
[go-sockaddr ](https://godoc.org/github.com/hashicorp/go-sockaddr/template )
template. If Consul is running on the non-default Serf LAN port, this must be
specified as well. IPv6 must use the "bracketed" syntax. If multiple values
are given, they are tried and retried in the order listed until the first
succeeds. Here are some examples:
2017-08-10 04:14:56 +00:00
```sh
# Using a DNS entry
$ consul agent -retry-join "consul.domain.internal"
```
2017-08-04 00:03:00 +00:00
2017-08-10 04:14:56 +00:00
```sh
# Using IPv4
$ consul agent -retry-join "10.0.4.67"
```
2017-07-15 21:15:59 +00:00
2017-08-10 04:14:56 +00:00
```sh
# Using IPv6
$ consul agent -retry-join "[::1]:8301"
```
2017-07-15 21:15:59 +00:00
2017-08-10 04:14:56 +00:00
### Cloud Auto-Joining
2017-07-15 21:15:59 +00:00
2017-08-10 04:14:56 +00:00
As of Consul 0.9.1, `retry-join` accepts a unified interface using the
[go-discover ](https://github.com/hashicorp/go-discover ) library for doing
2018-05-10 23:04:40 +00:00
automatic cluster joining using cloud metadata. For more information, see
the [Cloud Auto-join page ](/docs/agent/cloud-auto-join.html ).
2017-10-31 22:03:54 +00:00
```sh
2018-05-10 23:04:40 +00:00
# Using Cloud Auto-Joining
$ consul agent -retry-join "provider=aws tag_key=..."
2017-10-31 22:03:54 +00:00
```
2016-11-03 17:04:42 +00:00
* < a name = "_retry_interval" ></ a >< a href = "#_retry_interval" > `-retry-interval`</ a > - Time
to wait between join attempts. Defaults to 30s.
* < a name = "_retry_max" ></ a >< a href = "#_retry_max" > `-retry-max`</ a > - The maximum number
of [`-join` ](#_join ) attempts to be made before exiting
with return code 1. By default, this is set to 0 which is interpreted as infinite
retries.
2018-05-10 13:56:48 +00:00
* < a name = "_join_wan" ></ a >< a href = "#_join_wan" > `-join-wan`</ a > - Address of
another wan agent to join upon starting up. This can be specified multiple
times to specify multiple WAN agents to join. If Consul is unable to join with
any of the specified addresses, agent startup will fail. By default, the agent
won't [`-join-wan` ](#_join_wan ) any nodes when it starts up.
2018-06-06 20:35:44 +00:00
2018-05-10 23:04:40 +00:00
In Consul 1.1.0 and later this can be set to a
[go-sockaddr ](https://godoc.org/github.com/hashicorp/go-sockaddr/template )
template.
2014-11-14 15:02:42 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "_retry_join_wan" ></ a >< a href = "#_retry_join_wan" > `-retry-join-wan`</ a > - Similar
to [`retry-join` ](#_retry_join ) but allows retrying a wan join if the first attempt fails.
2017-10-31 22:03:54 +00:00
This is useful for cases where we know the address will become available eventually.
2017-08-23 16:23:16 +00:00
As of Consul 0.9.3 [Cloud Auto-Joining ](#cloud-auto-joining ) is supported as well.
2014-11-14 15:02:42 +00:00
2018-05-10 23:04:40 +00:00
In Consul 1.1.0 and later this can be set to a
[go-sockaddr ](https://godoc.org/github.com/hashicorp/go-sockaddr/template )
template
2018-05-10 13:56:48 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "_retry_interval_wan" ></ a >< a href = "#_retry_interval_wan" > `-retry-interval-wan`</ a > - Time
to wait between [`-join-wan` ](#_join_wan ) attempts.
2015-02-17 00:48:49 +00:00
Defaults to 30s.
2014-11-14 15:02:42 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "_retry_max_wan" ></ a >< a href = "#_retry_max_wan" > `-retry-max-wan`</ a > - The maximum
number of [`-join-wan` ](#_join_wan ) attempts to be made before exiting with return code 1.
By default, this is set to 0 which is interpreted as infinite retries.
* < a name = "_log_level" ></ a >< a href = "#_log_level" > `-log-level`</ a > - The level of logging to
show after the Consul agent has started. This defaults to "info". The available log levels are
2016-11-25 16:00:02 +00:00
"trace", "debug", "info", "warn", and "err". You can always connect to an
2015-02-24 17:30:17 +00:00
agent via [`consul monitor` ](/docs/commands/monitor.html ) and use any log level. Also, the
log level can be changed during a config reload.
2014-11-14 15:02:42 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "_node" ></ a >< a href = "#_node" > `-node`</ a > - The name of this node in the cluster.
This must be unique within the cluster. By default this is the hostname of the machine.
2014-02-18 23:30:07 +00:00
2017-01-18 06:20:11 +00:00
* < a name = "_node_id" ></ a >< a href = "#_node_id" > `-node-id`</ a > - Available in Consul 0.7.3 and later, this
is a unique identifier for this node across all time, even if the name of the node or address
changes. This must be in the form of a hex string, 36 characters long, such as
`adf4238a-882b-9ddc-4a9d-5b6758e4159e` . If this isn't supplied, which is the most common case, then
the agent will generate an identifier at startup and persist it in the < a href = "#_data_dir" > data directory< / a >
2017-04-13 05:05:38 +00:00
so that it will remain the same across agent restarts. Information from the host will be used to
generate a deterministic node ID if possible, unless [`-disable-host-node-id` ](#_disable_host_node_id ) is
set to true.
2017-01-18 06:20:11 +00:00
2017-01-11 23:44:13 +00:00
* < a name = "_node_meta" ></ a >< a href = "#_node_meta" > `-node-meta`</ a > - Available in Consul 0.7.3 and later,
this specifies an arbitrary metadata key/value pair to associate with the node, of the form `key:value` .
This can be specified multiple times. Node metadata pairs have the following restrictions:
2017-01-11 22:52:31 +00:00
- A maximum of 64 key/value pairs can be registered per node.
- Metadata keys must be between 1 and 128 characters (inclusive) in length
- Metadata keys must contain only alphanumeric, `-` , and `_` characters.
- Metadata keys must not begin with the `consul-` prefix; that is reserved for internal use by Consul.
- Metadata values must be between 0 and 512 (inclusive) characters in length.
2018-03-19 16:56:00 +00:00
- Metadata values for keys beginning with `rfc1035-` are encoded verbatim in DNS TXT requests, otherwise
2017-08-11 03:04:08 +00:00
the metadata kv-pair is encoded according [RFC1464 ](https://www.ietf.org/rfc/rfc1464.txt ).
2017-01-11 22:52:31 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "_pid_file" ></ a >< a href = "#_pid_file" > `-pid-file`</ a > - This flag provides the file
path for the agent to store its PID. This is useful for sending signals (for example, `SIGINT`
2015-09-11 19:24:54 +00:00
to close the agent or `SIGHUP` to update check definite
2014-02-18 23:30:07 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "_protocol" ></ a >< a href = "#_protocol" > `-protocol`</ a > - The Consul protocol version to
use. This defaults to the latest version. This should be set only when [upgrading ](/docs/upgrading.html ).
2014-04-25 14:09:17 +00:00
You can view the protocol versions supported by Consul by running `consul -v` .
2014-02-18 23:30:07 +00:00
2017-03-07 00:02:19 +00:00
* < a name = "_raft_protocol" ></ a >< a href = "#_raft_protocol" > `-raft-protocol`</ a > - This controls the internal
2017-09-25 22:27:04 +00:00
version of the Raft consensus protocol used for server communications. This must be set to 3 in order to
gain access to Autopilot features, with the exception of [`cleanup_dead_servers` ](#cleanup_dead_servers ).
Defaults to 3 in Consul 1.0.0 and later (defaulted to 2 previously). See
[Raft Protocol Version Compatibility ](/docs/upgrade-specific.html#raft-protocol-version-compatibility )
for more details.
2017-03-01 22:04:40 +00:00
2018-05-11 14:52:17 +00:00
* < a name = "_raft_snapshot_threshold" ></ a >< a href = "#_raft_snapshot_threshold" > `-raft-snapshot-threshold`</ a > - This controls the
minimum number of raft commit entries between snapshots that are saved to disk. This is a low-level parameter that should
rarely need to be changed. Very busy clusters experiencing excessive disk IO may increase this value to reduce disk IO, and minimize
the chances of all servers taking snapshots at the same time. Increasing this trades off disk IO for disk space since the log will
grow much larger and the space in the raft.db file can't be reclaimed till the next snapshot. Servers may take longer to recover from
2018-05-25 23:17:43 +00:00
crashes or failover if this is increased significantly as more logs will need to be replayed. In Consul 1.1.0 and later this
defaults to 16384, and in prior versions it was set to 8192.
2018-05-11 14:52:17 +00:00
* < a name = "_raft_snapshot_interval" ></ a >< a href = "#_raft_snapshot_interval" > `-raft-snapshot-interval`</ a > - This controls how often servers
check if they need to save a snapshot to disk. his is a low-level parameter that should rarely need to be changed. Very busy clusters
experiencing excessive disk IO may increase this value to reduce disk IO, and minimize the chances of all servers taking snapshots at the same time.
Increasing this trades off disk IO for disk space since the log will grow much larger and the space in the raft.db file can't be reclaimed
till the next snapshot. Servers may take longer to recover from crashes or failover if this is increased significantly as more logs
2018-05-25 23:17:43 +00:00
will need to be replayed. In Consul 1.1.0 and later this defaults to `30s` , and in prior versions it was set to `5s` .
2018-05-10 15:16:38 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "_recursor" ></ a >< a href = "#_recursor" > `-recursor`</ a > - Specifies the address of an upstream DNS
2015-02-23 18:43:15 +00:00
server. This option may be provided multiple times, and is functionally
2015-02-24 17:30:17 +00:00
equivalent to the [`recursors` configuration option ](#recursors ).
2015-02-23 18:43:15 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "_rejoin" ></ a >< a href = "#_rejoin" > `-rejoin`</ a > - When provided, Consul will ignore a
previous leave and attempt to rejoin the cluster when starting. By default, Consul treats leave
as a permanent intent and does not attempt to join the cluster again when starting. This flag
2014-05-21 19:32:24 +00:00
allows the previous state to be used to rejoin the cluster.
2017-08-31 18:19:08 +00:00
* < a name = "_segment" ></ a >< a href = "#_segment" > `-segment`</ a > - (Enterprise-only) This flag is used to set
the name of the network segment the agent belongs to. An agent can only join and communicate with other agents
within its network segment. See the [Network Segments Guide ](/docs/guides/segments.html ) for more details.
By default, this is an empty string, which is the default network segment.
2018-07-06 18:05:06 +00:00
* < a name = "_serf_lan_port" ></ a >< a href = "#_serf_lan_port" > `-serf-lan-port`</ a > - the Serf LAN port to listen on.
This overrides the default Serf LAN port 8301. This is available in Consul 1.2.2 and later.
* < a name = "_serf_wan_port" ></ a >< a href = "#_serf_wan_port" > `-serf-wan-port`</ a > - the Serf WAN port to listen on.
This overrides the default Serf WAN port 8302. This is available in Consul 1.2.2 and later.
2015-02-24 17:30:17 +00:00
* < a name = "_server" ></ a >< a href = "#_server" > `-server`</ a > - This flag is used to control if an
agent is in server or client mode. When provided,
2015-02-13 19:58:05 +00:00
an agent will act as a Consul server. Each Consul cluster must have at least one server and ideally
2015-02-19 22:45:47 +00:00
no more than 5 per datacenter. All servers participate in the Raft consensus algorithm to ensure that
2014-04-30 19:26:07 +00:00
transactions occur in a consistent, linearizable manner. Transactions modify cluster state, which
2014-02-18 23:30:07 +00:00
is maintained on all server nodes to ensure availability in the case of node failure. Server nodes also
2015-02-19 22:45:47 +00:00
participate in a WAN gossip pool with server nodes in other datacenters. Servers act as gateways
to other datacenters and forward traffic as appropriate.
2014-02-18 23:30:07 +00:00
2018-07-06 18:05:06 +00:00
* < a name = "_server_port" ></ a >< a href = "#_server_port" > `-server-port`</ a > - the server RPC port to listen on.
This overrides the default server RPC port 8300. This is available in Consul 1.2.2 and later.
2017-03-21 23:36:44 +00:00
* < a name = "_non_voting_server" ></ a >< a href = "#_non_voting_server" > `-non-voting-server`</ a > - (Enterprise-only)
This flag is used to make the server not participate in the Raft quorum, and have it only receive the data
replication stream. This can be used to add read scalability to a cluster in cases where a high volume of
reads to servers are needed.
2015-02-24 17:30:17 +00:00
* < a name = "_syslog" ></ a >< a href = "#_syslog" > `-syslog`</ a > - This flag enables logging to syslog. This
is only supported on Linux and OSX. It will result in an error if provided on Windows.
2014-05-21 19:06:03 +00:00
2015-12-22 17:46:36 +00:00
* < a name = "_ui" ></ a >< a href = "#_ui" > `-ui`</ a > - Enables the built-in web UI
server and the required HTTP routes. This eliminates the need to maintain the
Consul web UI files separately from the binary.
2015-02-24 17:30:17 +00:00
* < a name = "_ui_dir" ></ a >< a href = "#_ui_dir" > `-ui-dir`</ a > - This flag provides the directory containing
2015-12-22 17:46:36 +00:00
the Web UI resources for Consul. This will automatically enable the Web UI. The directory must be
2016-12-07 04:57:40 +00:00
readable to the agent. Starting with Consul version 0.7.0 and later, the Web UI assets are included in the binary so this flag is no longer necessary; specifying only the `-ui` flag is enough to enable the Web UI. Specifying both the '-ui' and '-ui-dir' flags will result in an error.
2014-04-23 19:40:11 +00:00
2015-02-24 17:30:17 +00:00
## <a name="configuration_files"></a>Configuration Files
2014-02-08 00:41:03 +00:00
In addition to the command-line options, configuration can be put into
2014-02-19 01:33:44 +00:00
files. This may be easier in certain situations, for example when Consul is
2014-02-08 00:41:03 +00:00
being configured using a configuration management system.
The configuration files are JSON formatted, making them easily readable
and editable by both humans and computers. The configuration is formatted
2014-12-28 04:53:19 +00:00
as a single JSON object with configuration within it.
2014-02-08 00:41:03 +00:00
2014-02-18 23:30:07 +00:00
Configuration files are used for more than just setting up the agent,
they are also used to provide check and service definitions. These are used
to announce the availability of system servers to the rest of the cluster.
2014-11-05 04:01:45 +00:00
They are documented separately under [check configuration ](/docs/agent/checks.html ) and
2014-02-23 02:53:31 +00:00
[service configuration ](/docs/agent/services.html ) respectively. The service and check
definitions support being updated during a reload.
2014-02-18 23:30:07 +00:00
2014-02-08 00:41:03 +00:00
#### Example Configuration File
2014-10-18 22:43:42 +00:00
```javascript
2014-02-08 00:41:03 +00:00
{
2015-02-13 20:19:17 +00:00
"datacenter": "east-aws",
2014-02-18 23:30:07 +00:00
"data_dir": "/opt/consul",
"log_level": "INFO",
"node_name": "foobar",
2014-08-22 00:25:42 +00:00
"server": true,
"watches": [
{
"type": "checks",
"handler": "/usr/bin/health-check-handler.sh"
}
2015-10-08 19:45:45 +00:00
],
"telemetry": {
"statsite_address": "127.0.0.1:2180"
}
2014-02-08 00:41:03 +00:00
}
2014-10-18 22:43:42 +00:00
```
2014-02-08 00:41:03 +00:00
2016-02-17 05:24:37 +00:00
#### Example Configuration File, with TLS
```javascript
{
2016-03-01 21:01:13 +00:00
"datacenter": "east-aws",
2016-02-17 05:24:37 +00:00
"data_dir": "/opt/consul",
"log_level": "INFO",
2016-03-01 21:01:13 +00:00
"node_name": "foobar",
2016-02-17 05:24:37 +00:00
"server": true,
"addresses": {
"https": "0.0.0.0"
},
"ports": {
2018-10-11 09:44:42 +00:00
"https": 8501
2016-02-17 05:24:37 +00:00
},
"key_file": "/etc/pki/tls/private/my.key",
"cert_file": "/etc/pki/tls/certs/my.crt",
"ca_file": "/etc/pki/tls/certs/ca-bundle.crt"
}
```
2016-11-25 16:00:02 +00:00
See, especially, the use of the `ports` setting:
2016-02-17 05:24:37 +00:00
```javascript
"ports": {
2018-10-11 09:44:42 +00:00
"https": 8501
2016-02-17 05:24:37 +00:00
}
```
2018-10-11 09:44:42 +00:00
Consul will not enable TLS for the HTTP API unless the `https` port has been
assigned a port number `> 0` . We recommend using `8501` for `https` as this
default will automatically work with some tooling.
2016-02-17 05:24:37 +00:00
2014-02-08 00:41:03 +00:00
#### Configuration Key Reference
2018-10-19 20:26:31 +00:00
* < a name = "acl" ></ a >< a href = "#acl" > `acl`</ a > - This object allows a number
of sub-keys to be set which controls the ACL system. Configuring the
ACL system within the ACL stanza was added in Consul 1.4.0
The following sub-keys are available:
* < a name = "acl_enabled" ></ a >< a href = "#acl_enabled" > `enabled`</ a > - Enables ACLs.
* < a name = "acl_policy_ttl" ></ a >< a href = "#acl_policy_ttl" > `policy_ttl`</ a > - Used to control
Time-To-Live caching of ACL policies. By default, this is 30 seconds. This setting has a
major performance impact: reducing it will cause more frequent refreshes while increasing
it reduces the number of refreshes. However, because the caches are not actively invalidated,
ACL policy may be stale up to the TTL value.
* < a name = "acl_token_ttl" ></ a >< a href = "#acl_token_ttl" > `token_ttl`</ a > - Used to control
Time-To-Live caching of ACL tokens. By default, this is 30 seconds. This setting has a
major performance impact: reducing it will cause more frequent refreshes while increasing
it reduces the number of refreshes. However, because the caches are not actively invalidated,
ACL token may be stale up to the TTL value.
* < a name = "acl_down_policy" ></ a >< a href = "#acl_down_policy" > `down_policy`</ a > - Either
"allow", "deny", "extend-cache" or "async-cache"; "extend-cache" is the default. In the case that a
policy or token cannot be read from the [`primary_datacenter` ](#primary_datacenter ) or leader
node, the down policy is applied. In "allow" mode, all actions are permitted, "deny" restricts
all operations, and "extend-cache" allows any cached objects to be used, ignoring their TTL
values. If a non-cached ACL is used, "extend-cache" acts like "deny".
The value "async-cache" acts the same way as "extend-cache" but performs updates
asynchronously when ACL is present but its TTL is expired, thus, if latency is bad between
the primary and secondary datacenters, latency of operations is not impacted.
* < a name = "acl_default_policy" ></ a >< a href = "#acl_default_policy" > `default_policy`</ a > - Either
"allow" or "deny"; defaults to "allow" but this will be changed in a future major release.
The default policy controls the behavior of a token when there is no matching rule. In "allow" mode,
ACLs are a blacklist: any operation not specifically prohibited is allowed. In "deny" mode, ACLs are
a whitelist: any operation not specifically allowed is blocked. *Note* : this will not take effect until
you've enabled ACLs.
2019-01-30 22:47:32 +00:00
* < a name = "acl_enable_key_list" ></ a >< a href = "#acl_enable_key_list" > `enable_key_list`</ a > - Either "enabled" or "disabled", defaults to "disabled". When enabled, the `list` permission will be required on the prefix being recursively read from the KV store. Regardless of being enabled, the full set of KV entries under the prefix will be filtered to remove any entries that the request's ACL token does not grant at least read persmissions. This option is only available in Consul 1.0 and newer.
2018-10-19 20:26:31 +00:00
* < a name = `acl_enable_token_replication" ></ a >< a href = "#acl_enable_token_replication" > `enable_token_replication`</ a > - By
default secondary Consul datacenters will perform replication of only ACL policies. Setting this configuration will
also enable ACL token replication.
* < a name = "acl_tokens" ></ a >< a href = "#acl_tokens" > `tokens`</ a > - This object holds
all of the configured ACL tokens for the agents usage.
* < a name = "acl_tokens_master" ></ a >< a href = "#acl_tokens_master" > `master`</ a > - Only used
for servers in the [`primary_datacenter` ](#primary_datacenter ). This token will be created with management-level
permissions if it does not exist. It allows operators to bootstrap the ACL system
with a token Secret ID that is well-known.
< br / > < br / >
The `master` token is only installed when a server acquires cluster leadership. If
you would like to install or change the `acl_master_token` , set the new value for `master`
in the configuration for all servers. Once this is done, restart the current leader to force a
leader election. If the `master` token is not supplied, then the servers do not create a master
2019-01-22 16:20:05 +00:00
token. When you provide a value, it should be a UUID. To maintain backwards compatibility
2018-10-19 20:26:31 +00:00
and an upgrade path this restriction is not currently enforced but will be in a future major
Consul release.
* < a name = "acl_tokens_default" ></ a >< a href = "#acl_tokens_default" > `default`</ a > - When provided,
the agent will use this token when making requests to the Consul servers. Clients can
override this token on a per-request basis by providing the "?token" query parameter.
When not provided, the empty token, which maps to the 'anonymous' ACL token, is used.
* < a name = "acl_tokens_agent" ></ a >< a href = "#acl_tokens_agent" > `agent`</ a > - Used for clients
and servers to perform internal operations. If this isn't specified, then the
< a href = "#acl_tokens_default" > `default`< / a > will be used. This was added in Consul
< br / > < br / >
This token must at least have write access to the node name it will register as in order to set any
of the node-level information in the catalog such as metadata, or the node's tagged addresses. There
are other places this token is used, please see [ACL Agent Token ](/docs/guides/acl.html#acl-agent-token )
for more details.
* < a name = "acl_tokens_agent_master" ></ a >< a href = "#acl_tokens_agent_master" > `agent_master`</ a > -
Used to access < a href = "/api/agent.html" > agent endpoints< / a > that require agent read
or write privileges, or node read privileges, even if Consul servers aren't present to validate
any tokens. This should only be used by operators during outages, regular ACL tokens should normally
be used by applications.
* < a name = "acl_tokens_replication" ></ a >< a href = "#acl_tokens_replication" > `replication`</ a > -
The ACL token used to authorize secondary datacenters with the primary datacenter for replication
operations. This token is required for servers outside the [`primary_datacenter` ](#primary_datacenter ) when
ACLs are enabled. This token may be provided later using the [agent token API ](/api/agent.html#update-acl-tokens )
2018-12-06 21:51:49 +00:00
on each server. This token must have at least "read" permissions on ACL data but if ACL
token replication is enabled then it must have "write" permissions. This also enables
Connect replication in Consul Enterprise, for which the token will require both operator
2018-11-07 17:22:23 +00:00
"write" and intention "read" permissions for replicating CA and Intention data.
2018-10-19 20:26:31 +00:00
2018-10-15 16:17:48 +00:00
* < a name = "acl_datacenter" ></ a >< a href = "#acl_datacenter" > `acl_datacenter`</ a > - **This field is
deprecated in Consul 1.4.0. See the [`primary_datacenter` ](#primary_datacenter ) field instead.**
This designates the datacenter which is authoritative for ACL information. It must be provided to enable ACLs. All servers and datacenters must agree on the ACL datacenter. Setting it on the servers is all you need for cluster-level enforcement, but for the APIs to forward properly from the clients,
it must be set on them too. In Consul 0.8 and later, this also enables agent-level enforcement
of ACLs. Please see the [ACL Guide ](/docs/guides/acl.html ) for more details.
2015-02-24 17:30:17 +00:00
2018-10-19 20:26:31 +00:00
* < a name = "acl_default_policy_legacy" ></ a >< a href = "#acl_default_policy_legacy" > `acl_default_policy`</ a > - **Deprecated in Consul 1.4.0.
See the [`acl.default_policy` ](#acl_default_policy ) field instead.** Either
2015-02-24 17:30:17 +00:00
"allow" or "deny"; defaults to "allow". The default policy controls the behavior of a token when
there is no matching rule. In "allow" mode, ACLs are a blacklist: any operation not specifically
2014-11-05 04:01:45 +00:00
prohibited is allowed. In "deny" mode, ACLs are a whitelist: any operation not
2018-10-15 16:17:48 +00:00
specifically allowed is blocked. *Note* : this will not take effect until you've set `primary_datacenter`
2015-12-18 22:26:35 +00:00
to enable ACL support.
2014-02-08 00:41:03 +00:00
2018-10-19 20:26:31 +00:00
* < a name = "acl_down_policy_legacy" ></ a >< a href = "#acl_down_policy_legacy" > `acl_down_policy`</ a > - **Deprecated in Consul 1.4.0.
See the [`acl.down_policy` ](#acl_down_policy ) field instead.**Either
2018-07-01 18:00:20 +00:00
"allow", "deny", "extend-cache" or "async-cache"; "extend-cache" is the default. In the case that the
2018-10-15 16:17:48 +00:00
policy for a token cannot be read from the [`primary_datacenter` ](#primary_datacenter ) or leader
2015-02-24 17:30:17 +00:00
node, the down policy is applied. In "allow" mode, all actions are permitted, "deny" restricts
all operations, and "extend-cache" allows any cached ACLs to be used, ignoring their TTL
values. If a non-cached ACL is used, "extend-cache" acts like "deny".
2018-07-01 21:37:40 +00:00
The value "async-cache" acts the same way as "extend-cache" but performs updates
asynchronously when ACL is present but its TTL is expired, thus, if latency is bad between
ACL authoritative and other datacenters, latency of operations is not impacted.
2015-02-24 17:30:17 +00:00
2018-10-19 20:26:31 +00:00
* < a name = "acl_agent_master_token_legacy" ></ a >< a href = "#acl_agent_master_token_legacy" > `acl_agent_master_token`</ a > -
**Deprecated in Consul 1.4.0. See the [`acl.tokens.agent_master`](#acl_tokens_agent_master) field instead.**
2017-04-04 16:33:22 +00:00
Used to access < a href = "/api/agent.html" > agent endpoints< / a > that require agent read
2017-07-17 03:08:26 +00:00
or write privileges, or node read privileges, even if Consul servers aren't present to validate
any tokens. This should only be used by operators during outages, regular ACL tokens should normally
be used by applications. This was added in Consul 0.7.2 and is only used when
2017-07-25 05:37:12 +00:00
< a href = "#acl_enforce_version_8" > `acl_enforce_version_8`< / a > is set to true. Please see
[ACL Agent Master Token ](/docs/guides/acl.html#acl-agent-master-token ) for more details.
2016-12-14 07:21:14 +00:00
2018-10-19 20:26:31 +00:00
* < a name = "acl_agent_token_legacy" ></ a >< a href = "#acl_agent_token_legacy" > `acl_agent_token`</ a > -
**Deprecated in Consul 1.4.0. See the [`acl.tokens.agent`](#acl_tokens_agent) field instead.**
Used for clients and servers to perform internal operations. If this isn't specified, then the
2017-08-04 00:03:00 +00:00
< a href = "#acl_token" > `acl_token`< / a > will be used. This was added in Consul 0.7.2.
This token must at least have write access to the node name it will register as in order to set any
of the node-level information in the catalog such as metadata, or the node's tagged addresses. There
are other places this token is used, please see [ACL Agent Token ](/docs/guides/acl.html#acl-agent-token )
for more details.
2016-12-11 19:24:44 +00:00
2016-12-02 03:14:08 +00:00
* < a name = "acl_enforce_version_8" ></ a >< a href = "#acl_enforce_version_8" > `acl_enforce_version_8`</ a > -
2018-10-19 20:26:31 +00:00
**Deprecated in Consul 1.4.0**
2016-12-02 03:14:08 +00:00
Used for clients and servers to determine if enforcement should occur for new ACL policies being
2017-04-05 04:13:18 +00:00
previewed before Consul 0.8. Added in Consul 0.7.2, this defaults to false in versions of
Consul prior to 0.8, and defaults to true in Consul 0.8 and later. This helps ease the
2016-12-02 03:14:08 +00:00
transition to the new ACL features by allowing policies to be in place before enforcement begins.
2017-04-05 04:13:18 +00:00
Please see the [ACL Guide ](/docs/guides/acl.html#version_8_acls ) for more details.
2016-12-02 03:14:08 +00:00
2018-10-19 20:26:31 +00:00
* < a name = "acl_master_token_legacy" ></ a >< a href = "#acl_master_token_legacy" > `acl_master_token`</ a > -
**Deprecated in Consul 1.4.0. See the [`acl.tokens.master`](#acl_tokens_master) field instead.** Only used
2018-10-15 16:17:48 +00:00
for servers in the [`primary_datacenter` ](#primary_datacenter ). This token will be created with management-level
2017-08-04 00:03:00 +00:00
permissions if it does not exist. It allows operators to bootstrap the ACL system
with a token ID that is well-known.
The `acl_master_token` is only installed when a server acquires cluster leadership. If
you would like to install or change the `acl_master_token` , set the new value for `acl_master_token`
in the configuration for all servers. Once this is done, restart the current leader to force a
leader election. If the `acl_master_token` is not supplied, then the servers do not create a master
token. When you provide a value, it can be any string value. Using a UUID would ensure that it looks
the same as the other tokens, but isn't strictly necessary.
2018-10-19 20:26:31 +00:00
* < a name = "acl_replication_token_legacy" ></ a >< a href = "#acl_replication_token_legacy" > `acl_replication_token`</ a > -
**Deprecated in Consul 1.4.0. See the [`acl.tokens.replication`](#acl_tokens_replication) field instead.**
2018-10-15 16:17:48 +00:00
Only used for servers outside the [`primary_datacenter` ](#primary_datacenter ) running Consul 0.7 or later.
2017-08-04 00:03:00 +00:00
When provided, this will enable [ACL replication ](/docs/guides/acl.html#replication ) using this
token to retrieve and replicate the ACLs to the non-authoritative local datacenter. In Consul 0.9.1
and later you can enable ACL replication using [`enable_acl_replication` ](#enable_acl_replication )
and then set the token later using the [agent token API ](/api/agent.html#update-acl-tokens ) on each
server. If the `acl_replication_token` is set in the config, it will automatically set
[`enable_acl_replication` ](#enable_acl_replication ) to true for backward compatibility.
If there's a partition or other outage affecting the authoritative datacenter, and the
[`acl_down_policy` ](/docs/agent/options.html#acl_down_policy ) is set to "extend-cache", tokens not
in the cache can be resolved during the outage using the replicated set of ACLs. Please see the
[ACL Guide ](/docs/guides/acl.html#replication ) replication section for more details.
2016-08-05 07:23:28 +00:00
2018-10-19 20:26:31 +00:00
* < a name = "acl_token_legacy" ></ a >< a href = "#acl_token_legacy" > `acl_token`</ a > -
**Deprecated in Consul 1.4.0. See the [`acl.tokens.default`](#acl_tokens_default) field instead.**
When provided, the agent will use this
2015-02-24 17:30:17 +00:00
token when making requests to the Consul servers. Clients can override this token on a per-request
basis by providing the "?token" query parameter. When not provided, the empty token, which maps to
the 'anonymous' ACL policy, is used.
2018-10-19 20:26:31 +00:00
* < a name = "acl_ttl_legacy" ></ a >< a href = "#acl_ttl_legacy" > `acl_ttl`</ a > -
**Deprecated in Consul 1.4.0. See the [`acl.token_ttl` ](#acl_token_ttl ) field instead.**Used to control Time-To-Live caching of ACLs.
2015-02-24 17:30:17 +00:00
By default, this is 30 seconds. This setting has a major performance impact: reducing it will cause
2017-05-05 15:51:46 +00:00
more frequent refreshes while increasing it reduces the number of refreshes. However, because the caches
2015-02-24 17:30:17 +00:00
are not actively invalidated, ACL policy may be stale up to the TTL value.
2017-08-04 00:03:00 +00:00
* < a name = "addresses" ></ a >< a href = "#addresses" > `addresses`</ a > - This is a nested object that allows
2017-09-27 22:30:30 +00:00
setting bind addresses. In Consul 1.0 and later these can be set to a space-separated list of
2017-09-27 22:40:00 +00:00
addresses to bind to, or a [go-sockaddr ](https://godoc.org/github.com/hashicorp/go-sockaddr/template )
template that can potentially resolve to multiple addresses.
2017-08-04 00:03:00 +00:00
2018-10-11 09:44:42 +00:00
`http` , `https` and `grpc` all support binding to a Unix domain socket. A
socket can be specified in the form `unix:///path/to/socket` . A new domain
socket will be created at the given path. If the specified file path already
exists, Consul will attempt to clear the file and create the domain socket
in its place. The permissions of the socket file are tunable via the
[`unix_sockets` config construct ](#unix_sockets ).
2017-08-04 00:03:00 +00:00
When running Consul agent commands against Unix socket interfaces, use the
`-http-addr` argument to specify the path to the socket. You can also place
the desired values in the `CONSUL_HTTP_ADDR` environment variable.
2018-10-11 09:44:42 +00:00
For TCP addresses, the environment variable value should be an IP address
_with the port_ . For example: `10.0.0.1:8500` and not `10.0.0.1` . However,
ports are set separately in the < a href = "#ports" > `ports`< / a > structure when
defining them in a configuration file.
2017-08-04 00:03:00 +00:00
The following keys are valid:
- `dns` - The DNS server. Defaults to `client_addr`
- `http` - The HTTP API. Defaults to `client_addr`
- `https` - The HTTPS API. Defaults to `client_addr`
2018-10-11 09:44:42 +00:00
- `grpc` - The gRPC API. Defaults to `client_addr`
2017-08-04 00:03:00 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "advertise_addr" ></ a >< a href = "#advertise_addr" > `advertise_addr`</ a > Equivalent to
the [`-advertise` command-line flag ](#_advertise ).
2014-02-18 23:30:07 +00:00
2017-12-12 12:52:14 +00:00
* < a name = "serf_wan" ></ a >< a href = "#serf_wan_bind" > `serf_wan`</ a > Equivalent to
2016-11-03 19:58:58 +00:00
the [`-serf-wan-bind` command-line flag ](#_serf_wan_bind ).
2017-12-12 12:52:14 +00:00
* < a name = "serf_lan" ></ a >< a href = "#serf_lan_bind" > `serf_lan`</ a > Equivalent to
2016-11-03 19:58:58 +00:00
the [`-serf-lan-bind` command-line flag ](#_serf_lan_bind ).
2015-03-28 15:04:09 +00:00
* < a name = "advertise_addr_wan" ></ a >< a href = "#advertise_addr_wan" > `advertise_addr_wan`</ a > Equivalent to
the [`-advertise-wan` command-line flag ](#_advertise-wan ).
2017-08-04 00:03:00 +00:00
* < a name = "autopilot" ></ a >< a href = "#autopilot" > `autopilot`</ a > Added in Consul 0.8, this object
allows a number of sub-keys to be set which can configure operator-friendly settings for Consul servers.
For more information about Autopilot, see the [Autopilot Guide ](/docs/guides/autopilot.html ).
2017-02-22 21:11:01 +00:00
2017-08-04 00:03:00 +00:00
The following sub-keys are available:
2017-02-22 21:11:01 +00:00
2017-08-04 00:03:00 +00:00
* < a name = "cleanup_dead_servers" ></ a >< a href = "#cleanup_dead_servers" > `cleanup_dead_servers`</ a > - This controls
the automatic removal of dead server nodes periodically and whenever a new server is added to the cluster.
Defaults to `true` .
2017-03-01 22:04:40 +00:00
2017-08-04 00:03:00 +00:00
* < a name = "last_contact_threshold" ></ a >< a href = "#last_contact_threshold" > `last_contact_threshold`</ a > - Controls
the maximum amount of time a server can go without contact from the leader before being considered unhealthy.
Must be a duration value such as `10s` . Defaults to `200ms` .
2017-03-01 22:04:40 +00:00
2017-08-04 00:03:00 +00:00
* < a name = "max_trailing_logs" ></ a >< a href = "#max_trailing_logs" > `max_trailing_logs`</ a > - Controls
the maximum number of log entries that a server can trail the leader by before being considered unhealthy. Defaults
to 250.
2017-03-01 22:04:40 +00:00
2017-08-04 00:03:00 +00:00
* < a name = "server_stabilization_time" ></ a >< a href = "#server_stabilization_time" > `server_stabilization_time`</ a > -
Controls the minimum amount of time a server must be stable in the 'healthy' state before being added to the
cluster. Only takes effect if all servers are running Raft protocol version 3 or higher. Must be a duration value
such as `30s` . Defaults to `10s` .
2017-03-21 23:36:44 +00:00
2017-08-04 00:03:00 +00:00
* < a name = "redundancy_zone_tag" ></ a >< a href = "#redundancy_zone_tag" > `redundancy_zone_tag`</ a > - (Enterprise-only)
This controls the [`-node-meta` ](#_node_meta ) key to use when Autopilot is separating servers into zones for
redundancy. Only one server in each zone can be a voting member at one time. If left blank (the default), this
feature will be disabled.
* < a name = "disable_upgrade_migration" ></ a >< a href = "#disable_upgrade_migration" > `disable_upgrade_migration`</ a > - (Enterprise-only)
If set to `true` , this setting will disable Autopilot's upgrade migration strategy in Consul Enterprise of waiting
until enough newer-versioned servers have been added to the cluster before promoting any of them to voters. Defaults
to `false` .
2017-03-21 23:36:44 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "bootstrap" ></ a >< a href = "#bootstrap" > `bootstrap`</ a > Equivalent to the
[`-bootstrap` command-line flag ](#_bootstrap ).
2014-05-21 19:06:03 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "bootstrap_expect" ></ a >< a href = "#bootstrap_expect" > `bootstrap_expect`</ a > Equivalent
to the [`-bootstrap-expect` command-line flag ](#_bootstrap_expect ).
2014-08-31 02:03:01 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "bind_addr" ></ a >< a href = "#bind_addr" > `bind_addr`</ a > Equivalent to the
[`-bind` command-line flag ](#_bind ).
2014-05-21 19:32:24 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "ca_file" ></ a >< a href = "#ca_file" > `ca_file`</ a > This provides a file path to a PEM-encoded
certificate authority. The certificate authority is used to check the authenticity of client and
server connections with the appropriate [`verify_incoming` ](#verify_incoming ) or
2015-02-17 00:48:49 +00:00
[`verify_outgoing` ](#verify_outgoing ) flags.
2014-02-08 00:41:03 +00:00
2017-04-27 08:29:39 +00:00
* < a name = "ca_path" ></ a >< a href = "#ca_path" > `ca_path`</ a > This provides a path to a directory of PEM-encoded
certificate authority files. These certificate authorities are used to check the authenticity of client and
server connections with the appropriate [`verify_incoming` ](#verify_incoming ) or
[`verify_outgoing` ](#verify_outgoing ) flags.
2015-02-24 17:30:17 +00:00
* < a name = "cert_file" ></ a >< a href = "#cert_file" > `cert_file`</ a > This provides a file path to a
PEM-encoded certificate. The certificate is provided to clients or servers to verify the agent's
authenticity. It must be provided along with [`key_file` ](#key_file ).
2014-02-08 00:41:03 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "check_update_interval" ></ a >< a href = "#check_update_interval" > `check_update_interval`</ a >
This interval controls how often check output from
2014-11-05 04:01:45 +00:00
checks in a steady state is synchronized with the server. By default, this is
2014-06-09 19:51:12 +00:00
set to 5 minutes ("5m"). Many checks which are in a steady state produce
slightly different output per run (timestamps, etc) which cause constant writes.
2014-11-05 04:01:45 +00:00
This configuration allows deferring the sync of check output for a given interval to
2014-06-09 19:51:12 +00:00
reduce write pressure. If a check ever changes state, the new state and associated
2014-11-05 04:01:45 +00:00
output is synchronized immediately. To disable this behavior, set the value to "0s".
2014-06-09 19:51:12 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "client_addr" ></ a >< a href = "#client_addr" > `client_addr`</ a > Equivalent to the
[`-client` command-line flag ](#_client ).
2014-08-31 02:03:01 +00:00
2018-06-06 17:49:37 +00:00
* < a name = "connect" ></ a >< a href = "#connect" > `connect`</ a >
This object allows setting options for the Connect feature.
The following sub-keys are available:
* < a name = "connect_enabled" ></ a >< a href = "#connect_enabled" > `enabled`</ a > Controls whether
Connect features are enabled on this agent. Should be enabled on all clients and
servers in the cluster in order for Connect to function properly. Defaults to false.
* < a name = "connect_ca_provider" ></ a >< a href = "#connect_ca_provider" > `ca_provider`</ a > Controls
2018-06-20 00:51:21 +00:00
which CA provider to use for Connect's CA. Currently only the `consul` and `vault` providers
2018-07-26 23:30:24 +00:00
are supported. This is only used when initially bootstrapping the cluster. For an existing
2018-06-20 00:51:21 +00:00
cluster, use the [Update CA Configuration Endpoint ](/api/connect/ca.html#update-ca-configuration ).
2018-06-06 17:49:37 +00:00
* < a name = "connect_ca_config" ></ a >< a href = "#connect_ca_config" > `ca_config`</ a > An object which
allows setting different config options based on the CA provider chosen. This is only
used when initially bootstrapping the cluster. For an existing cluster, use the [Update CA
Configuration Endpoint](/api/connect/ca.html#update-ca-configuration).
The following providers are supported:
2018-06-20 00:51:21 +00:00
#### Consul CA Provider (`ca_provider = "consul"`)
2018-06-06 17:49:37 +00:00
* < a name = "consul_ca_private_key" ></ a >< a href = "#consul_ca_private_key" > `private_key`</ a > The
PEM contents of the private key to use for the CA.
* < a name = "consul_ca_root_cert" ></ a >< a href = "#consul_ca_root_cert" > `root_cert`</ a > The
PEM contents of the root certificate to use for the CA.
2018-06-20 00:51:21 +00:00
#### Vault CA Provider (`ca_provider = "vault"`)
2018-07-26 23:30:24 +00:00
* < a name = "vault_ca_address" ></ a >< a href = "#vault_ca_address" > `address`</ a > The address of the Vault
2018-06-20 00:51:21 +00:00
server to connect to.
* < a name = "vault_ca_token" ></ a >< a href = "#vault_ca_token" > `token`</ a > The Vault token to use.
* < a name = "vault_ca_root_pki" ></ a >< a href = "#vault_ca_root_pki" > `root_pki_path`</ a > The
path to use for the root CA pki backend in Vault. This can be an existing backend with a CA already
configured, or a blank/unmounted backend in which case Connect will automatically mount/generate the CA.
The Vault token given above must have `sudo` access to this backend, as well as permission to mount
the backend at this path if it is not already mounted.
2018-07-26 23:30:24 +00:00
* < a name = "vault_ca_intermediate_pki" ></ a >< a href = "#vault_ca_intermediate_pki" > `intermediate_pki_path`</ a >
2018-06-20 00:51:21 +00:00
The path to use for the temporary intermediate CA pki backend in Vault. *Connect will overwrite any data
2018-07-26 23:30:24 +00:00
at this path in order to generate a temporary intermediate CA*. The Vault token given above must have
`write` access to this backend, as well as permission to mount the backend at this path if it is not
2018-06-20 00:51:21 +00:00
already mounted.
2018-07-16 09:46:23 +00:00
#### Common CA Config Options
< p > There are also a number of common configuration options supported by all providers:< / p >
2018-10-11 12:22:11 +00:00
2018-07-20 23:04:04 +00:00
* < a name = "ca_leaf_cert_ttl" ></ a >< a href = "#ca_leaf_cert_ttl" > `leaf_cert_ttl`</ a > The upper bound on the
2019-01-22 17:19:36 +00:00
lease duration of a leaf certificate issued for a service. In most
cases a new leaf certificate will be requested by a proxy before this
limit is reached. This is also the effective limit on how long a
server outage can last (with no leader) before network connections
will start being rejected, and as a result the defaults is `72h` to
last through a weekend without intervention. This value cannot be
lower than 1 hour or higher than 1 year.
This value is also used when rotating out old root certificates from
the cluster. When a root certificate has been inactive (rotated out)
for more than twice the *current* `leaf_cert_ttl` , it will be removed
from the trusted list.
* < a name = "ca_csr_max_per_second" ></ a >< a
href="#ca_csr_max_per_second">`csr_max_per_second`< / a > Sets a rate
limit on the maximum number of Certificate Signing Requests (CSRs) the
servers will accept. This is used to prevent CA rotation from causing
unbounded CPU usage on servers. It defaults to 50 which is
conservative - a 2017 Macbook can process about 100 per second using
only ~40% of one CPU core - but sufficient for deployments up to ~1500
service instances before the time it takes to rotate is impacted. For
larger deployments we recommend increasing this based on the expected
number of server instances and server resources, or use
`csr_max_concurrent` instead if servers have more than one core.
Setting this to zero disables rate limiting. Added in 1.4.1.
* < a name = "ca_csr_max_concurrent" ></ a >< a
href="#ca_csr_max_concurrent">`csr_max_concurrent`< / a > Sets a limit
on how many Certificate Signing Requests will be processed
concurrently. Defaults to 0 (disabled). This is useful when you have
more than one or two cores available to the server. For example on an
8 core server, setting this to 1 will ensure that even during a CA
rotation no more than one server core on the leader will be consumed
at a time with generating new certificates. Setting this is
recommended _instead_ of `csr_max_per_second` where you know there are
multiple cores available since it is simpler to reason about limiting
CSR resources this way without artificially slowing down rotations.
Added in 1.4.1.
* < a name = "connect_proxy" ></ a >< a href = "#connect_proxy" > `proxy`</ a >
[**Deprecated** ](/docs/connect/proxies/managed-deprecated.html ) This
object allows setting options for the Connect proxies. The following
sub-keys are available:
* < a name = "connect_proxy_allow_managed_registration" ></ a >< a
href="#connect_proxy_allow_managed_registration">`allow_managed_api_registration`< / a >
[**Deprecated** ](/docs/connect/proxies/managed-deprecated.html )
Allows managed proxies to be configured with services that are
registered via the Agent HTTP API. Enabling this would allow anyone
with permission to register a service to define a command to execute
for the proxy. By default, this is false to protect against
arbitrary process execution.
* < a name = "connect_proxy_allow_managed_root" ></ a >< a
href="#connect_proxy_allow_managed_root">`allow_managed_root`< / a >
[**Deprecated** ](/docs/connect/proxies/managed-deprecated.html )
Allows Consul to start managed proxies if Consul is running as root
(EUID of the process is zero). We recommend running Consul as a
non-root user. By default, this is false to protect inadvertently
running external processes as root.
* < a name = "connect_proxy_defaults" ></ a >< a
href="#connect_proxy_defaults">`proxy_defaults`< / a >
[**Deprecated** ](/docs/connect/proxies/managed-deprecated.html ) This
object configures the default proxy settings for service definitions
with [managed proxies ](/docs/connect/proxies/managed-deprecated.html )
(now deprecated). It accepts the fields `exec_mode` , `daemon_command` ,
and `config` . These are used as default values for the respective
fields in the service definition.
2018-06-06 17:49:37 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "datacenter" ></ a >< a href = "#datacenter" > `datacenter`</ a > Equivalent to the
2016-03-18 14:44:35 +00:00
[`-datacenter` command-line flag ](#_datacenter ).
2014-08-31 02:03:01 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "data_dir" ></ a >< a href = "#data_dir" > `data_dir`</ a > Equivalent to the
[`-data-dir` command-line flag ](#_data_dir ).
2014-02-08 00:41:03 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "disable_anonymous_signature" ></ a >< a href = "#disable_anonymous_signature" >
`disable_anonymous_signature` </ a > Disables providing an anonymous signature for de-duplication
with the update check. See [`disable_update_check` ](#disable_update_check ).
2014-09-02 21:36:25 +00:00
2017-04-13 05:05:38 +00:00
* < a name = "disable_host_node_id" ></ a >< a href = "#disable_host_node_id" > `disable_host_node_id`</ a >
Equivalent to the [`-disable-host-node-id` command-line flag ](#_disable_host_node_id ).
2018-07-26 12:53:39 +00:00
* < a name = "disable_http_unprintable_char_filter" ></ a >< a href = "#disable_http_unprintable_char_filter" > `disable_http_unprintable_char_filter`</ a >
Defaults to false. Consul 1.0.3 fixed a potential security vulnerability where
malicious users could craft KV keys with unprintable chars that would confuse
operators using the CLI or UI into taking wrong actions. Users who had data
written in older versions of Consul that did not have this restriction will be
unable to delete those values by default in 1.0.3 or later. This setting
enables those users to _temporarily_ disable the filter such that delete
operations can work on those keys again to get back to a healthy state. It is
strongly recommended that this filter is not disabled permanently as it
exposes the original security vulnerability.
2015-02-24 17:30:17 +00:00
* < a name = "disable_remote_exec" ></ a >< a href = "#disable_remote_exec" > `disable_remote_exec`</ a >
Disables support for remote execution. When set to true, the agent will ignore any incoming
2017-03-30 16:25:12 +00:00
remote exec requests. In versions of Consul prior to 0.8, this defaulted to false. In Consul
0.8 the default was changed to true, to make remote exec opt-in instead of opt-out.
2014-09-01 22:03:37 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "disable_update_check" ></ a >< a href = "#disable_update_check" > `disable_update_check`</ a >
2018-06-06 20:35:44 +00:00
Disables automatic checking for security bulletins and new version releases. This is disabled in
2018-02-05 21:25:28 +00:00
Consul Enterprise.
2014-09-02 21:36:25 +00:00
2017-10-11 00:04:52 +00:00
* < a name = "discard_check_output" ></ a >< a href = "#discard_check_output" > `discard_check_output`</ a >
Discards the output of health checks before storing them. This reduces the number of writes
to the Consul raft log in environments where health checks have volatile output like
timestamps, process ids, ...
2018-06-26 19:09:14 +00:00
* < a name = "discovery_max_stale" ></ a >< a href = "#discovery_max_stale" > `discovery_max_stale`</ a > - Enables
2018-05-15 12:59:15 +00:00
stale requests for all service discovery HTTP endpoints. This is equivalent to the
[`max_stale` ](#max_stale ) configuration for DNS requests. If this value is zero (default), all service
discovery HTTP endpoints are forwarded to the leader. If this value is greater than zero, any Consul server
can handle the service discovery request. If a Consul server is behind the leader by more than `discovery_max_stale` ,
the query will be re-evaluated on the leader to get more up-to-date results. Consul agents also add a new
`X-Consul-Effective-Consistency` response header which indicates if the agent did a stale read. `discover-max-stale`
was introduced in Consul 1.0.7 as a way for Consul operators to force stale requests from clients at the agent level,
and defaults to zero which matches default consistency behavior in earlier Consul versions.
2017-08-04 00:03:00 +00:00
* < a name = "dns_config" ></ a >< a href = "#dns_config" > `dns_config`</ a > This object allows a number
of sub-keys to be set which can tune how DNS queries are serviced. See this guide on
[DNS caching ](/docs/guides/dns-cache.html ) for more detail.
The following sub-keys are available:
* < a name = "allow_stale" ></ a >< a href = "#allow_stale" > `allow_stale`</ a > - Enables a stale query
for DNS information. This allows any Consul server, rather than only the leader, to service
the request. The advantage of this is you get linear read scalability with Consul servers.
In versions of Consul prior to 0.7, this defaulted to false, meaning all requests are serviced
by the leader, providing stronger consistency but less throughput and higher latency. In Consul
0.7 and later, this defaults to true for better utilization of available servers.
* < a name = "max_stale" ></ a >< a href = "#max_stale" > `max_stale`</ a > - When [`allow_stale` ](#allow_stale )
is specified, this is used to limit how stale results are allowed to be. If a Consul server is
behind the leader by more than `max_stale` , the query will be re-evaluated on the leader to get
more up-to-date results. Prior to Consul 0.7.1 this defaulted to 5 seconds; in Consul 0.7.1
and later this defaults to 10 years ("87600h") which effectively allows DNS queries to be answered
by any server, no matter how stale. In practice, servers are usually only milliseconds behind the
leader, so this lets Consul continue serving requests in long outage scenarios where no leader can
be elected.
* < a name = "node_ttl" ></ a >< a href = "#node_ttl" > `node_ttl`</ a > - By default, this is "0s", so all
node lookups are served with a 0 TTL value. DNS caching for node lookups can be enabled by
setting this value. This should be specified with the "s" suffix for second or "m" for minute.
* < a name = "service_ttl" ></ a >< a href = "#service_ttl" > `service_ttl`</ a > - This is a sub-object
which allows for setting a TTL on service lookups with a per-service policy. The "*" wildcard
service can be used when there is no specific policy available for a service. By default, all
services are served with a 0 TTL value. DNS caching for service lookups can be enabled by
setting this value.
* < a name = "enable_truncate" ></ a >< a href = "#enable_truncate" > `enable_truncate`</ a > - If set to
true, a UDP DNS query that would return more than 3 records, or more than would fit into a valid
UDP response, will set the truncated flag, indicating to clients that they should re-query
using TCP to get the full set of records.
* < a name = "only_passing" ></ a >< a href = "#only_passing" > `only_passing`</ a > - If set to true, any
nodes whose health checks are warning or critical will be excluded from DNS results. If false,
the default, only nodes whose healthchecks are failing as critical will be excluded. For
service lookups, the health checks of the node itself, as well as the service-specific checks
are considered. For example, if a node has a health check that is critical then all services on
that node will be excluded because they are also considered critical.
* < a name = "recursor_timeout" ></ a >< a href = "#recursor_timeout" > `recursor_timeout`</ a > - Timeout used
by Consul when recursively querying an upstream DNS server. See < a href = "#recursors" > `recursors`< / a >
for more details. Default is 2s. This is available in Consul 0.7 and later.
* < a name = "disable_compression" ></ a >< a href = "#disable_compression" > `disable_compression`</ a > - If
set to true, DNS responses will not be compressed. Compression was added and enabled by default
in Consul 0.7.
* < a name = "udp_answer_limit" ></ a >< a href = "#udp_answer_limit" > `udp_answer_limit`</ a > - Limit the number of
resource records contained in the answer section of a UDP-based DNS
2018-06-06 20:35:44 +00:00
response. This parameter applies only to UDP DNS queries that are less than 512 bytes. This setting is deprecated
2018-03-08 17:23:07 +00:00
and replaced in Consul 1.0.7 by < a href = "#a_record_limit" > `a_record_limit`< / a > .
2018-03-08 17:02:40 +00:00
* < a name = "a_record_limit" ></ a >< a href = "#a_record_limit" > `a_record_limit`</ a > - Limit the number of
2018-03-08 17:23:07 +00:00
resource records contained in the answer section of a A, AAAA or ANY DNS response (both TCP and UDP).
2018-03-08 17:02:40 +00:00
When answering a question, Consul will use the complete list of
2017-08-04 00:03:00 +00:00
matching hosts, shuffle the list randomly, and then limit the number of
2018-03-08 17:02:40 +00:00
answers to `a_record_limit` (default: no limit). This limit does not apply to SRV records.
2018-05-15 12:59:15 +00:00
2018-07-09 13:39:20 +00:00
In environments where [RFC 3484 Section 6 ](https://tools.ietf.org/html/rfc3484#section-6 ) Rule 9
2017-08-04 00:03:00 +00:00
is implemented and enforced (i.e. DNS answers are always sorted and
therefore never random), clients may need to set this value to `1` to
preserve the expected randomized distribution behavior (note:
[RFC 3484 ](https://tools.ietf.org/html/rfc3484 ) has been obsoleted by
[RFC 6724 ](https://tools.ietf.org/html/rfc6724 ) and as a result it should
be increasingly uncommon to need to change this value with modern
resolvers).
2018-07-26 23:30:24 +00:00
2018-07-09 13:39:20 +00:00
* < a name = "enable_additional_node_meta_txt" ></ a >< a href = "#enable_additional_node_meta_txt" > `enable_additional_node_meta_txt`</ a > -
2018-06-19 14:08:16 +00:00
When set to true, Consul will add TXT records for Node metadata into the Additional section of the DNS responses for several
2018-07-25 20:32:36 +00:00
query types such as SRV queries. When set to false those records are not emitted. This does not impact the behavior of those
2018-06-19 14:08:16 +00:00
same TXT records when they would be added to the Answer section of the response like when querying with type TXT or ANY. This
defaults to true.
2016-02-12 07:58:48 +00:00
Added SOA configuration for DNS settings. (#4714)
This will allow to fine TUNE SOA settings sent by Consul in DNS responses,
for instance to be able to control negative ttl.
Will fix: https://github.com/hashicorp/consul/issues/4713
# Example
Override all settings:
* min_ttl: 0 => 60s
* retry: 600 (10m) => 300s (5 minutes),
* expire: 86400 (24h) => 43200 (12h)
* refresh: 3600 (1h) => 1800 (30 minutes)
```
consul agent -dev -hcl 'dns_config={soa={min_ttl=60,retry=300,expire=43200,refresh=1800}}'
```
Result:
```
dig +multiline @localhost -p 8600 service.consul
; <<>> DiG 9.12.1 <<>> +multiline @localhost -p 8600 service.consul
; (2 servers found)
;; global options: +cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NXDOMAIN, id: 36557
;; flags: qr aa rd; QUERY: 1, ANSWER: 0, AUTHORITY: 1, ADDITIONAL: 1
;; WARNING: recursion requested but not available
;; OPT PSEUDOSECTION:
; EDNS: version: 0, flags:; udp: 4096
;; QUESTION SECTION:
;service.consul. IN A
;; AUTHORITY SECTION:
consul. 0 IN SOA ns.consul. hostmaster.consul. (
1537959133 ; serial
1800 ; refresh (30 minutes)
300 ; retry (5 minutes)
43200 ; expire (12 hours)
60 ; minimum (1 minute)
)
;; Query time: 4 msec
;; SERVER: 127.0.0.1#8600(127.0.0.1)
;; WHEN: Wed Sep 26 12:52:13 CEST 2018
;; MSG SIZE rcvd: 93
```
2018-10-10 19:50:56 +00:00
* < a name = "soa" ></ a >< a href = "#soa" > `soa`</ a > Allow to tune the setting set up in SOA.
Non specified values fallback to their default values, all values are integers and
expressed as seconds.
2019-01-30 22:47:32 +00:00
< br / > < br / >
Added SOA configuration for DNS settings. (#4714)
This will allow to fine TUNE SOA settings sent by Consul in DNS responses,
for instance to be able to control negative ttl.
Will fix: https://github.com/hashicorp/consul/issues/4713
# Example
Override all settings:
* min_ttl: 0 => 60s
* retry: 600 (10m) => 300s (5 minutes),
* expire: 86400 (24h) => 43200 (12h)
* refresh: 3600 (1h) => 1800 (30 minutes)
```
consul agent -dev -hcl 'dns_config={soa={min_ttl=60,retry=300,expire=43200,refresh=1800}}'
```
Result:
```
dig +multiline @localhost -p 8600 service.consul
; <<>> DiG 9.12.1 <<>> +multiline @localhost -p 8600 service.consul
; (2 servers found)
;; global options: +cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NXDOMAIN, id: 36557
;; flags: qr aa rd; QUERY: 1, ANSWER: 0, AUTHORITY: 1, ADDITIONAL: 1
;; WARNING: recursion requested but not available
;; OPT PSEUDOSECTION:
; EDNS: version: 0, flags:; udp: 4096
;; QUESTION SECTION:
;service.consul. IN A
;; AUTHORITY SECTION:
consul. 0 IN SOA ns.consul. hostmaster.consul. (
1537959133 ; serial
1800 ; refresh (30 minutes)
300 ; retry (5 minutes)
43200 ; expire (12 hours)
60 ; minimum (1 minute)
)
;; Query time: 4 msec
;; SERVER: 127.0.0.1#8600(127.0.0.1)
;; WHEN: Wed Sep 26 12:52:13 CEST 2018
;; MSG SIZE rcvd: 93
```
2018-10-10 19:50:56 +00:00
The following settings are available:
2019-01-30 22:47:32 +00:00
* < a name = "soa_expire" ></ a >< a href = "#soa_expire" > `expire`</ a > -
Added SOA configuration for DNS settings. (#4714)
This will allow to fine TUNE SOA settings sent by Consul in DNS responses,
for instance to be able to control negative ttl.
Will fix: https://github.com/hashicorp/consul/issues/4713
# Example
Override all settings:
* min_ttl: 0 => 60s
* retry: 600 (10m) => 300s (5 minutes),
* expire: 86400 (24h) => 43200 (12h)
* refresh: 3600 (1h) => 1800 (30 minutes)
```
consul agent -dev -hcl 'dns_config={soa={min_ttl=60,retry=300,expire=43200,refresh=1800}}'
```
Result:
```
dig +multiline @localhost -p 8600 service.consul
; <<>> DiG 9.12.1 <<>> +multiline @localhost -p 8600 service.consul
; (2 servers found)
;; global options: +cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NXDOMAIN, id: 36557
;; flags: qr aa rd; QUERY: 1, ANSWER: 0, AUTHORITY: 1, ADDITIONAL: 1
;; WARNING: recursion requested but not available
;; OPT PSEUDOSECTION:
; EDNS: version: 0, flags:; udp: 4096
;; QUESTION SECTION:
;service.consul. IN A
;; AUTHORITY SECTION:
consul. 0 IN SOA ns.consul. hostmaster.consul. (
1537959133 ; serial
1800 ; refresh (30 minutes)
300 ; retry (5 minutes)
43200 ; expire (12 hours)
60 ; minimum (1 minute)
)
;; Query time: 4 msec
;; SERVER: 127.0.0.1#8600(127.0.0.1)
;; WHEN: Wed Sep 26 12:52:13 CEST 2018
;; MSG SIZE rcvd: 93
```
2018-10-10 19:50:56 +00:00
Configure SOA Expire duration in seconds, default value is 86400, ie: 24 hours.
2018-10-26 17:55:12 +00:00
* < a name = "soa_min_ttl" ></ a >< a href = "#soa_min_ttl" > `min_ttl`</ a > -
Added SOA configuration for DNS settings. (#4714)
This will allow to fine TUNE SOA settings sent by Consul in DNS responses,
for instance to be able to control negative ttl.
Will fix: https://github.com/hashicorp/consul/issues/4713
# Example
Override all settings:
* min_ttl: 0 => 60s
* retry: 600 (10m) => 300s (5 minutes),
* expire: 86400 (24h) => 43200 (12h)
* refresh: 3600 (1h) => 1800 (30 minutes)
```
consul agent -dev -hcl 'dns_config={soa={min_ttl=60,retry=300,expire=43200,refresh=1800}}'
```
Result:
```
dig +multiline @localhost -p 8600 service.consul
; <<>> DiG 9.12.1 <<>> +multiline @localhost -p 8600 service.consul
; (2 servers found)
;; global options: +cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NXDOMAIN, id: 36557
;; flags: qr aa rd; QUERY: 1, ANSWER: 0, AUTHORITY: 1, ADDITIONAL: 1
;; WARNING: recursion requested but not available
;; OPT PSEUDOSECTION:
; EDNS: version: 0, flags:; udp: 4096
;; QUESTION SECTION:
;service.consul. IN A
;; AUTHORITY SECTION:
consul. 0 IN SOA ns.consul. hostmaster.consul. (
1537959133 ; serial
1800 ; refresh (30 minutes)
300 ; retry (5 minutes)
43200 ; expire (12 hours)
60 ; minimum (1 minute)
)
;; Query time: 4 msec
;; SERVER: 127.0.0.1#8600(127.0.0.1)
;; WHEN: Wed Sep 26 12:52:13 CEST 2018
;; MSG SIZE rcvd: 93
```
2018-10-10 19:50:56 +00:00
Configure SOA DNS minimum TTL.
As explained in [RFC-2308 ](https://tools.ietf.org/html/rfc2308 ) this also controls
negative cache TTL in most implementations. Default value is 0, ie: no minimum
delay or negative TTL.
2019-01-30 22:47:32 +00:00
* < a name = "soa_refresh" ></ a >< a href = "#soa_refresh" > `refresh`</ a > -
Added SOA configuration for DNS settings. (#4714)
This will allow to fine TUNE SOA settings sent by Consul in DNS responses,
for instance to be able to control negative ttl.
Will fix: https://github.com/hashicorp/consul/issues/4713
# Example
Override all settings:
* min_ttl: 0 => 60s
* retry: 600 (10m) => 300s (5 minutes),
* expire: 86400 (24h) => 43200 (12h)
* refresh: 3600 (1h) => 1800 (30 minutes)
```
consul agent -dev -hcl 'dns_config={soa={min_ttl=60,retry=300,expire=43200,refresh=1800}}'
```
Result:
```
dig +multiline @localhost -p 8600 service.consul
; <<>> DiG 9.12.1 <<>> +multiline @localhost -p 8600 service.consul
; (2 servers found)
;; global options: +cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NXDOMAIN, id: 36557
;; flags: qr aa rd; QUERY: 1, ANSWER: 0, AUTHORITY: 1, ADDITIONAL: 1
;; WARNING: recursion requested but not available
;; OPT PSEUDOSECTION:
; EDNS: version: 0, flags:; udp: 4096
;; QUESTION SECTION:
;service.consul. IN A
;; AUTHORITY SECTION:
consul. 0 IN SOA ns.consul. hostmaster.consul. (
1537959133 ; serial
1800 ; refresh (30 minutes)
300 ; retry (5 minutes)
43200 ; expire (12 hours)
60 ; minimum (1 minute)
)
;; Query time: 4 msec
;; SERVER: 127.0.0.1#8600(127.0.0.1)
;; WHEN: Wed Sep 26 12:52:13 CEST 2018
;; MSG SIZE rcvd: 93
```
2018-10-10 19:50:56 +00:00
Configure SOA Refresh duration in seconds, default value is `3600` , ie: 1 hour.
2019-01-30 22:47:32 +00:00
* < a name = "soa_retry" ></ a >< a href = "#soa_retry" > `retry`</ a > -
Added SOA configuration for DNS settings. (#4714)
This will allow to fine TUNE SOA settings sent by Consul in DNS responses,
for instance to be able to control negative ttl.
Will fix: https://github.com/hashicorp/consul/issues/4713
# Example
Override all settings:
* min_ttl: 0 => 60s
* retry: 600 (10m) => 300s (5 minutes),
* expire: 86400 (24h) => 43200 (12h)
* refresh: 3600 (1h) => 1800 (30 minutes)
```
consul agent -dev -hcl 'dns_config={soa={min_ttl=60,retry=300,expire=43200,refresh=1800}}'
```
Result:
```
dig +multiline @localhost -p 8600 service.consul
; <<>> DiG 9.12.1 <<>> +multiline @localhost -p 8600 service.consul
; (2 servers found)
;; global options: +cmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NXDOMAIN, id: 36557
;; flags: qr aa rd; QUERY: 1, ANSWER: 0, AUTHORITY: 1, ADDITIONAL: 1
;; WARNING: recursion requested but not available
;; OPT PSEUDOSECTION:
; EDNS: version: 0, flags:; udp: 4096
;; QUESTION SECTION:
;service.consul. IN A
;; AUTHORITY SECTION:
consul. 0 IN SOA ns.consul. hostmaster.consul. (
1537959133 ; serial
1800 ; refresh (30 minutes)
300 ; retry (5 minutes)
43200 ; expire (12 hours)
60 ; minimum (1 minute)
)
;; Query time: 4 msec
;; SERVER: 127.0.0.1#8600(127.0.0.1)
;; WHEN: Wed Sep 26 12:52:13 CEST 2018
;; MSG SIZE rcvd: 93
```
2018-10-10 19:50:56 +00:00
Configures the Retry duration expressed in seconds, default value is
600, ie: 10 minutes.
2019-02-25 19:06:01 +00:00
* < a name = "dns_use_cache" ></ a >< a href = "dns_use_cache" > `use_cache`</ a > - When set to true, DNS resolution will use the agent cache described
in [agent caching ](/api/index.html#agent-caching ). This setting affects all service and prepared queries DNS requests. Implies [`allow_stale` ](#allow_stale )
* < a name = "dns_cache_max_age" ></ a >< a href = "dns_cache_max_age" > `dns_max_age`</ a > - When [use_cache ](#dns_use_cache ) is enabled, the agent
will attempt to re-fetch the result from the servers if the cached value is older than this duration. See: [agent caching ](/api/index.html#agent-caching ).
2015-03-20 14:22:13 +00:00
* < a name = "domain" ></ a >< a href = "#domain" > `domain`</ a > Equivalent to the
[`-domain` command-line flag ](#_domain ).
2014-08-31 02:03:01 +00:00
2017-08-03 22:39:31 +00:00
* < a name = "enable_acl_replication" ></ a >< a href = "#enable_acl_replication" > `enable_acl_replication`</ a > When
set on a Consul server, enables [ACL replication ](/docs/guides/acl.html#replication ) without having to set
the replication token via [`acl_replication_token` ](#acl_replication_token ). Instead, enable ACL replication
and then introduce the token using the [agent token API ](/api/agent.html#update-acl-tokens ) on each server.
See [`acl_replication_token` ](#acl_replication_token ) for more details.
2017-11-08 02:22:09 +00:00
* < a name = "enable_agent_tls_for_checks" ></ a >< a href = "#enable_agent_tls_for_checks" > `enable_agent_tls_for_checks`</ a >
When set, uses a subset of the agent's TLS configuration (`key_file`, `cert_file` , `ca_file` , `ca_path` , and
2018-12-19 00:47:52 +00:00
`server_name` ) to set up the client for HTTP or gRPC health checks. This allows services requiring 2-way TLS to
2017-11-08 02:22:09 +00:00
be checked using the agent's credentials. This was added in Consul 1.0.1 and defaults to false.
2015-02-24 17:30:17 +00:00
* < a name = "enable_debug" ></ a >< a href = "#enable_debug" > `enable_debug`</ a > When set, enables some
2018-10-17 20:20:35 +00:00
additional debugging features. Currently, this is only used to access runtime profiling HTTP endpoints, which
are available with an `operator:read` ACL regardles of the value of `enable_debug` .
2014-04-11 23:23:16 +00:00
2017-07-17 18:20:35 +00:00
* < a name = "enable_script_checks" ></ a >< a href = "#enable_script_checks" > `enable_script_checks`</ a > Equivalent to the
[`-enable-script-checks` command-line flag ](#_enable_script_checks ).
2018-11-27 17:15:01 +00:00
~> **Security Warning:** Enabling script checks in some configurations may
introduce a remote execution vulnerability which is known to be targeted by
malware. We strongly recommend `enable_local_script_checks` instead. See [this
blog post](https://www.hashicorp.com/blog/protecting-consul-from-rce-risk-in-specific-configurations)
for more details.
* < a name = "enable_local_script_checks" ></ a >< a href = "#enable_local_script_checks" > `enable_local_script_checks`</ a > Equivalent to the
[`-enable-local-script-checks` command-line flag ](#_enable_local_script_checks ).
2015-02-24 17:30:17 +00:00
* < a name = "enable_syslog" ></ a >< a href = "#enable_syslog" > `enable_syslog`</ a > Equivalent to
the [`-syslog` command-line flag ](#_syslog ).
2014-08-31 02:03:01 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "encrypt" ></ a >< a href = "#encrypt" > `encrypt`</ a > Equivalent to the
[`-encrypt` command-line flag ](#_encrypt ).
2014-04-11 23:23:16 +00:00
2017-05-30 15:51:37 +00:00
* < a name = "encrypt_verify_incoming" ></ a >< a href = "#encrypt_verify_incoming" > `encrypt_verify_incoming`</ a > -
This is an optional parameter that can be used to disable enforcing encryption for incoming gossip in order
to upshift from unencrypted to encrypted gossip on a running cluster. See [this section]
(/docs/agent/encryption.html#configuring-gossip-encryption-on-an-existing-cluster) for more information.
Defaults to true.
* < a name = "encrypt_verify_outgoing" ></ a >< a href = "#encrypt_verify_outgoing" > `encrypt_verify_outgoing`</ a > -
This is an optional parameter that can be used to disable enforcing encryption for outgoing gossip in order
to upshift from unencrypted to encrypted gossip on a running cluster. See [this section]
(/docs/agent/encryption.html#configuring-gossip-encryption-on-an-existing-cluster) for more information.
Defaults to true.
2017-06-15 22:24:04 +00:00
* < a name = "disable_keyring_file" ></ a >< a href = "#disable_keyring_file" > `disable_keyring_file`</ a > - Equivalent to the
[`-disable-keyring-file` command-line flag ](#_disable_keyring_file ).
2018-07-26 15:39:49 +00:00
* < a name = "gossip_lan" ></ a >< a href = "#gossip_lan" > `gossip_lan`</ a > - ** (Advanced)** This object contains a number of sub-keys
2018-10-11 12:22:11 +00:00
which can be set to tune the LAN gossip communications. These are only provided for users running especially large
2018-07-26 15:39:49 +00:00
clusters that need fine tuning and are prepared to spend significant effort correctly tuning them for their
environment and workload. **Tuning these improperly can cause Consul to fail in unexpected ways** .
The default values are appropriate in almost all deployments.
2018-10-11 12:22:11 +00:00
2018-07-26 15:39:49 +00:00
* < a name = "gossip_nodes" ></ a >< a href = "#gossip_nodes" > `gossip_nodes`</ a > - The number of random nodes to send
2018-10-11 12:22:11 +00:00
gossip messages to per gossip_interval. Increasing this number causes the gossip messages to propagate
2018-07-26 15:39:49 +00:00
across the cluster more quickly at the expense of increased bandwidth. The default is 3.
2018-10-11 12:22:11 +00:00
2018-07-26 15:39:49 +00:00
* < a name = "gossip_interval" ></ a >< a href = "#gossip_interval" > `gossip_interval`</ a > - The interval between sending
2018-10-11 12:22:11 +00:00
messages that need to be gossiped that haven't been able to piggyback on probing messages. If this is set to
2018-07-26 15:39:49 +00:00
zero, non-piggyback gossip is disabled. By lowering this value (more frequent) gossip messages are propagated
across the cluster more quickly at the expense of increased bandwidth. The default is 200ms.
2018-10-11 12:22:11 +00:00
2018-07-26 15:39:49 +00:00
* < a name = "probe_interval" ></ a >< a href = "#probe_interval" > `probe_interval`</ a > - The interval between random node
2018-10-11 12:22:11 +00:00
probes. Setting this lower (more frequent) will cause the cluster to detect failed nodes more quickly
2018-07-26 15:39:49 +00:00
at the expense of increased bandwidth usage. The default is 1s.
2018-10-11 12:22:11 +00:00
2018-07-26 15:39:49 +00:00
* < a name = "probe_timeout" ></ a >< a href = "#probe_timeout" > `probe_timeout`</ a > - The timeout to wait for an ack from
a probed node before assuming it is unhealthy. This should be at least the 99-percentile of RTT (round-trip time) on
your network. The default is 500ms and is a conservative value suitable for almost all realistic deployments.
2018-10-11 12:22:11 +00:00
* < a name = "retransmit_mult" ></ a >< a href = "#retransmit_mult" > `retransmit_mult`</ a > - The multiplier for the number
2018-07-26 15:39:49 +00:00
of retransmissions that are attempted for messages broadcasted over gossip. The number of retransmits is scaled
using this multiplier and the cluster size. The higher the multiplier, the more likely a failed broadcast is to
converge at the expense of increased bandwidth. The default is 4.
2018-10-11 12:22:11 +00:00
2018-07-26 15:39:49 +00:00
* < a name = "suspicion_mult" ></ a >< a href = "#suspicion_mult" > `suspicion_mult`</ a > - The multiplier for determining the
time an inaccessible node is considered suspect before declaring it dead. The timeout is scaled with the cluster
2018-10-11 12:22:11 +00:00
size and the probe_interval. This allows the timeout to scale properly with expected propagation delay with a
larger cluster size. The higher the multiplier, the longer an inaccessible node is considered part of the
2018-07-26 15:39:49 +00:00
cluster before declaring it dead, giving that suspect node more time to refute if it is indeed still alive. The
default is 4.
2018-10-11 12:22:11 +00:00
2018-07-26 15:39:49 +00:00
* < a name = "gossip_wan" ></ a >< a href = "#gossip_wan" > `gossip_wan`</ a > - ** (Advanced)** This object contains a number of sub-keys
2018-10-11 12:22:11 +00:00
which can be set to tune the WAN gossip communications. These are only provided for users running especially large
2018-07-26 15:39:49 +00:00
clusters that need fine tuning and are prepared to spend significant effort correctly tuning them for their
environment and workload. **Tuning these improperly can cause Consul to fail in unexpected ways** .
The default values are appropriate in almost all deployments.
2018-10-11 12:22:11 +00:00
2018-07-26 15:39:49 +00:00
* < a name = "gossip_nodes" ></ a >< a href = "#gossip_nodes" > `gossip_nodes`</ a > - The number of random nodes to send
2018-10-11 12:22:11 +00:00
gossip messages to per gossip_interval. Increasing this number causes the gossip messages to propagate
2018-07-26 15:39:49 +00:00
across the cluster more quickly at the expense of increased bandwidth. The default is 3.
2018-10-11 12:22:11 +00:00
2018-07-26 15:39:49 +00:00
* < a name = "gossip_interval" ></ a >< a href = "#gossip_interval" > `gossip_interval`</ a > - The interval between sending
2018-10-11 12:22:11 +00:00
messages that need to be gossiped that haven't been able to piggyback on probing messages. If this is set to
2018-07-26 15:39:49 +00:00
zero, non-piggyback gossip is disabled. By lowering this value (more frequent) gossip messages are propagated
across the cluster more quickly at the expense of increased bandwidth. The default is 200ms.
2018-10-11 12:22:11 +00:00
2018-07-26 15:39:49 +00:00
* < a name = "probe_interval" ></ a >< a href = "#probe_interval" > `probe_interval`</ a > - The interval between random node
2018-10-11 12:22:11 +00:00
probes. Setting this lower (more frequent) will cause the cluster to detect failed nodes more quickly
2018-07-26 15:39:49 +00:00
at the expense of increased bandwidth usage. The default is 1s.
2018-10-11 12:22:11 +00:00
2018-07-26 15:39:49 +00:00
* < a name = "probe_timeout" ></ a >< a href = "#probe_timeout" > `probe_timeout`</ a > - The timeout to wait for an ack from
a probed node before assuming it is unhealthy. This should be at least the 99-percentile of RTT (round-trip time) on
your network. The default is 500ms and is a conservative value suitable for almost all realistic deployments.
2018-10-11 12:22:11 +00:00
* < a name = "retransmit_mult" ></ a >< a href = "#retransmit_mult" > `retransmit_mult`</ a > - The multiplier for the number
2018-07-26 15:39:49 +00:00
of retransmissions that are attempted for messages broadcasted over gossip. The number of retransmits is scaled
using this multiplier and the cluster size. The higher the multiplier, the more likely a failed broadcast is to
converge at the expense of increased bandwidth. The default is 4.
2018-10-11 12:22:11 +00:00
2018-07-26 15:39:49 +00:00
* < a name = "suspicion_mult" ></ a >< a href = "#suspicion_mult" > `suspicion_mult`</ a > - The multiplier for determining the
time an inaccessible node is considered suspect before declaring it dead. The timeout is scaled with the cluster
2018-10-11 12:22:11 +00:00
size and the probe_interval. This allows the timeout to scale properly with expected propagation delay with a
larger cluster size. The higher the multiplier, the longer an inaccessible node is considered part of the
2018-07-26 15:39:49 +00:00
cluster before declaring it dead, giving that suspect node more time to refute if it is indeed still alive. The
default is 4.
2015-02-24 17:30:17 +00:00
* < a name = "key_file" ></ a >< a href = "#key_file" > `key_file`</ a > This provides a the file path to a
PEM-encoded private key. The key is used with the certificate to verify the agent's authenticity.
2015-02-17 00:48:49 +00:00
This must be provided along with [`cert_file` ](#cert_file ).
2014-02-08 00:41:03 +00:00
2017-08-04 00:03:00 +00:00
* < a name = "http_config" ></ a >< a href = "#http_config" > `http_config`</ a >
This object allows setting options for the HTTP API.
The following sub-keys are available:
* < a name = "block_endpoints" ></ a >< a href = "#block_endpoints" > `block_endpoints`</ a >
This object is a list of HTTP API endpoint prefixes to block on the agent, and defaults to
an empty list, meaning all endpoints are enabled. Any endpoint that has a common prefix
with one of the entries on this list will be blocked and will return a 403 response code
when accessed. For example, to block all of the V1 ACL endpoints, set this to
`["/v1/acl"]` , which will block `/v1/acl/create` , `/v1/acl/update` , and the other ACL
endpoints that begin with `/v1/acl` . This only works with API endpoints, not `/ui` or
`/debug` , those must be disabled with their respective configuration options. Any CLI
commands that use disabled endpoints will no longer function as well. For more general
access control, Consul's [ACL system ](/docs/guides/acl.html ) should be used, but this option
is useful for removing access to HTTP API endpoints completely, or on specific agents. This
is available in Consul 0.9.0 and later.
* < a name = "response_headers" ></ a >< a href = "#response_headers" > `response_headers`</ a >
This object allows adding headers to the HTTP API responses.
For example, the following config can be used to enable
[CORS ](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing ) on
the HTTP API endpoints:
```javascript
{
"http_config": {
"response_headers": {
"Access-Control-Allow-Origin": "*"
}
}
2017-06-16 11:58:19 +00:00
}
2017-08-04 00:03:00 +00:00
```
2019-01-10 14:27:26 +00:00
* < a name = "allow_write_http_from" ></ a >< a href = "#allow_write_http_from" > `allow_write_http_from`</ a >
This object is a list of networks in CIDR notation (eg "127.0.0.0/8") that are allowed
to call the agent write endpoints. It defaults to an empty list, which means all networks
are allowed.
This is used to make the agent read-only, except for select ip ranges.
* To block write calls from anywhere, use `[ "255.255.255.255/32" ]` .
* To only allow write calls from localhost, use `[ "127.0.0.0/8" ]`
* To only allow specific IPs, use `[ "10.0.0.1/32", "10.0.0.2/32" ]`
2017-06-16 11:58:19 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "leave_on_terminate" ></ a >< a href = "#leave_on_terminate" > `leave_on_terminate`</ a > If
2016-09-01 06:39:11 +00:00
enabled, when the agent receives a TERM signal, it will send a `Leave` message to the rest
of the cluster and gracefully leave. The default behavior for this feature varies based on
whether or not the agent is running as a client or a server (prior to Consul 0.7 the default
value was unconditionally set to `false` ). On agents in client-mode, this defaults to `true`
and for agents in server-mode, this defaults to `false` .
2014-02-08 00:41:03 +00:00
2017-09-01 22:02:50 +00:00
* < a name = "limits" ></ a >< a href = "#limits" > `limits`</ a > Available in Consul 0.9.3 and later, this
is a nested object that configures limits that are enforced by the agent. Currently, this only
applies to agents in client mode, not Consul servers. The following parameters are available:
* < a name = "rpc_rate" ></ a >< a href = "#rpc_rate" > `rpc_rate`</ a > - Configures the RPC rate
limiter by setting the maximum request rate that this agent is allowed to make for RPC
requests to Consul servers, in requests per second. Defaults to infinite, which disables
rate limiting.
2017-09-01 22:07:18 +00:00
* < a name = "rpc_rate" ></ a >< a href = "#rpc_max_burst" > `rpc_max_burst`</ a > - The size of the token
2017-09-01 22:02:50 +00:00
bucket used to recharge the RPC rate limiter. Defaults to 1000 tokens, and each token is
good for a single RPC call to a Consul server. See https://en.wikipedia.org/wiki/Token_bucket
for more details about how token bucket rate limiters operate.
2015-02-24 17:30:17 +00:00
* < a name = "log_level" ></ a >< a href = "#log_level" > `log_level`</ a > Equivalent to the
[`-log-level` command-line flag ](#_log_level ).
2014-08-31 02:03:01 +00:00
2017-01-18 06:20:11 +00:00
* < a name = "node_id" ></ a >< a href = "#node_id" > `node_id`</ a > Equivalent to the
[`-node-id` command-line flag ](#_node_id ).
2015-02-24 17:30:17 +00:00
* < a name = "node_name" ></ a >< a href = "#node_name" > `node_name`</ a > Equivalent to the
[`-node` command-line flag ](#_node ).
2014-08-31 02:03:01 +00:00
2017-01-11 23:44:13 +00:00
* < a name = "node_meta" ></ a >< a href = "#node_meta" > `node_meta`</ a > Available in Consul 0.7.3 and later,
This object allows associating arbitrary metadata key/value pairs with the local node, which can
then be used for filtering results from certain catalog endpoints. See the
[`-node-meta` command-line flag ](#_node_meta ) for more information.
```javascript
{
"node_meta": {
"instance_type": "t2.medium"
}
}
```
2017-01-11 22:52:31 +00:00
2017-08-04 00:03:00 +00:00
* < a name = "performance" ></ a >< a href = "#performance" > `performance`</ a > Available in Consul 0.7 and
later, this is a nested object that allows tuning the performance of different subsystems in
Consul. See the [Server Performance ](/docs/guides/performance.html ) guide for more details. The
following parameters are available:
2017-10-10 22:19:50 +00:00
* < a name = "leave_drain_time" ></ a >< a href = "#leave_drain_time" > `leave_drain_time`</ a > - A duration
that a server will dwell during a graceful leave in order to allow requests to be retried against
other Consul servers. Under normal circumstances, this can prevent clients from experiencing
"no leader" errors when performing a rolling update of the Consul servers. This was added in
Consul 1.0. Must be a duration value such as 10s. Defaults to 5s.
2017-08-04 00:03:00 +00:00
* < a name = "raft_multiplier" ></ a >< a href = "#raft_multiplier" > `raft_multiplier`</ a > - An integer
multiplier used by Consul servers to scale key Raft timing parameters. Omitting this value
or setting it to 0 uses default timing described below. Lower values are used to tighten
timing and increase sensitivity while higher values relax timings and reduce sensitivity.
Tuning this affects the time it takes Consul to detect leader failures and to perform
leader elections, at the expense of requiring more network and CPU resources for better
performance.
By default, Consul will use a lower-performance timing that's suitable
2018-03-19 16:56:00 +00:00
for [minimal Consul servers ](/docs/guides/performance.html#minimum ), currently equivalent
2017-08-04 00:03:00 +00:00
to setting this to a value of 5 (this default may be changed in future versions of Consul,
depending if the target minimum server profile changes). Setting this to a value of 1 will
configure Raft to its highest-performance mode, equivalent to the default timing of Consul
prior to 0.7, and is recommended for [production Consul servers ](/docs/guides/performance.html#production ).
See the note on [last contact ](/docs/guides/performance.html#last-contact ) timing for more
details on tuning this parameter. The maximum allowed value is 10.
2016-08-25 00:33:53 +00:00
2017-10-10 22:19:50 +00:00
* < a name = "rpc_hold_timeout" ></ a >< a href = "#rpc_hold_timeout" > `rpc_hold_timeout`</ a > - A duration
that a client or server will retry internal RPC requests during leader elections. Under normal
circumstances, this can prevent clients from experiencing "no leader" errors. This was added in
Consul 1.0. Must be a duration value such as 10s. Defaults to 7s.
2015-02-24 17:30:17 +00:00
* < a name = "ports" ></ a >< a href = "#ports" > `ports`</ a > This is a nested object that allows setting
the bind ports for the following keys:
* < a name = "dns_port" ></ a >< a href = "#dns_port" > `dns`</ a > - The DNS server, -1 to disable. Default 8600.
* < a name = "http_port" ></ a >< a href = "#http_port" > `http`</ a > - The HTTP API, -1 to disable. Default 8500.
2018-10-11 09:44:42 +00:00
* < a name = "https_port" ></ a >< a href = "#https_port" > `https`</ a > - The HTTPS
API, -1 to disable. Default -1 (disabled). **We recommend using `8501`** for
`https` by convention as some tooling will work automatically with this.
* < a name = "grpc_port" ></ a >< a href = "#grpc_port" > `grpc`</ a > - The gRPC API, -1
to disable. Default -1 (disabled). **We recommend using `8502`** for
`grpc` by convention as some tooling will work automatically with this.
This is set to `8502` by default when the agent runs in `-dev` mode.
Currently gRPC is only used to expose Envoy xDS API to Envoy proxies.
2015-02-24 17:30:17 +00:00
* < a name = "serf_lan_port" ></ a >< a href = "#serf_lan_port" > `serf_lan`</ a > - The Serf LAN port. Default 8301.
2018-03-29 15:19:21 +00:00
* < a name = "serf_wan_port" ></ a >< a href = "#serf_wan_port" > `serf_wan`</ a > - The Serf WAN port. Default 8302. Set to -1
to disable. **Note** : this will disable WAN federation which is not recommended. Various catalog and WAN related
endpoints will return errors or empty results.
2015-02-24 17:30:17 +00:00
* < a name = "server_rpc_port" ></ a >< a href = "#server_rpc_port" > `server`</ a > - Server RPC address. Default 8300.
2018-10-11 09:44:42 +00:00
* < a name = "proxy_min_port" ></ a >< a href = "#proxy_min_port" > `proxy_min_port`</ a > [**Deprecated** ](/docs/connect/proxies/managed-deprecated.html ) - Minimum port number to use for automatically assigned [managed proxies ](/docs/connect/proxies/managed-deprecated.html ). Default 20000.
* < a name = "proxy_max_port" ></ a >< a href = "#proxy_max_port" > `proxy_max_port`</ a > [**Deprecated** ](/docs/connect/proxies/managed-deprecated.html ) - Maximum port number to use for automatically assigned [managed proxies ](/docs/connect/proxies/managed-deprecated.html ). Default 20255.
* < a name = "sidecar_min_port" ></ a >< a
href="#sidecar_min_port">`sidecar_min_port`< / a > - Inclusive minimum port
number to use for automatically assigned [sidecar service
registrations](/docs/connect/proxies/sidecar-service.html). Default 21000.
Set to `0` to disable automatic port assignment.
* < a name = "sidecar_max_port" ></ a >< a
href="#sidecar_max_port">`sidecar_max_port`< / a > - Inclusive maximum port
number to use for automatically assigned [sidecar service
registrations](/docs/connect/proxies/sidecar-service.html). Default 21255.
Set to `0` to disable automatic port assignment.
2014-04-11 23:31:33 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "protocol" ></ a >< a href = "#protocol" > `protocol`</ a > Equivalent to the
[`-protocol` command-line flag ](#_protocol ).
2014-08-31 02:03:01 +00:00
2018-10-19 20:26:31 +00:00
* < a name = "primary_datacenter" ></ a >< a href = "#primary_datacenter" > `primary_datacenter`</ a > - This
2018-10-15 16:17:48 +00:00
designates the datacenter which is authoritative for ACL information, intentions and is the root
Certificate Authority for Connect. It must be provided to enable ACLs. All servers and datacenters
must agree on the primary datacenter. Setting it on the servers is all you need for cluster-level enforcement, but for the APIs to forward properly from the clients, it must be set on them too. In
Consul 0.8 and later, this also enables agent-level enforcement of ACLs. Please see the [ACL Guide ](/docs/guides/acl.html ) for more details.
2017-03-01 22:04:40 +00:00
* < a name = "raft_protocol" ></ a >< a href = "#raft_protocol" > `raft_protocol`</ a > Equivalent to the
[`-raft-protocol` command-line flag ](#_raft_protocol ).
2018-05-10 15:16:38 +00:00
* < a name = "raft_snapshot_threshold" ></ a >< a href = "#raft_snapshot_threshold" > `raft_snapshot_threshold`</ a > Equivalent to the
2018-05-10 22:06:47 +00:00
[`-raft-snapshot-threshold` command-line flag ](#_raft_snapshot_threshold ).
* < a name = "raft_snapshot_interval" ></ a >< a href = "#raft_snapshot_interval" > `raft_snapshot_interval`</ a > Equivalent to the
[`-raft-snapshot-interval` command-line flag ](#_raft_snapshot_interval ).
2018-05-10 15:16:38 +00:00
2016-01-07 06:29:03 +00:00
* < a name = "reap" ></ a >< a href = "#reap" > `reap`</ a > This controls Consul's automatic reaping of child processes,
which is useful if Consul is running as PID 1 in a Docker container. If this isn't specified, then Consul will
automatically reap child processes if it detects it is running as PID 1. If this is set to true or false, then
2016-10-07 04:38:29 +00:00
it controls reaping regardless of Consul's PID (forces reaping on or off, respectively). This option was removed
in Consul 0.7.1. For later versions of Consul, you will need to reap processes using a wrapper, please see the
[Consul Docker image entry point script ](https://github.com/hashicorp/docker-consul/blob/master/0.X/docker-entrypoint.sh )
2017-08-07 08:49:40 +00:00
for an example. If you are using Docker 1.13.0 or later, you can use the new `--init` option of the `docker run` command
and docker will enable an init process with PID 1 that reaps child processes for the container.
More info on [Docker docs ](https://docs.docker.com/engine/reference/commandline/run/#options ).
2015-12-22 18:28:10 +00:00
2016-04-11 05:46:07 +00:00
* < a name = "reconnect_timeout" ></ a >< a href = "#reconnect_timeout" > `reconnect_timeout`</ a > This controls
how long it takes for a failed node to be completely removed from the cluster. This defaults to
72 hours and it is recommended that this is set to at least double the maximum expected recoverable
2016-04-11 06:31:16 +00:00
outage time for a node or network partition. WARNING: Setting this time too low could cause Consul
servers to be removed from quorum during an extended node failure or partition, which could complicate
recovery of the cluster. The value is a time with a unit suffix, which can be "s", "m", "h" for seconds,
minutes, or hours. The value must be >= 8 hours.
2016-04-11 05:46:07 +00:00
* < a name = "reconnect_timeout_wan" ></ a >< a href = "#reconnect_timeout_wan" > `reconnect_timeout_wan`</ a > This
is the WAN equivalent of the < a href = "#reconnect_timeout" > `reconnect_timeout`< / a > parameter, which
controls how long it takes for a failed server to be completely removed from the WAN pool. This also
2016-04-11 06:31:16 +00:00
defaults to 72 hours, and must be >= 8 hours.
2016-04-11 05:46:07 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "recursors" ></ a >< a href = "#recursors" > `recursors`</ a > This flag provides addresses of
upstream DNS servers that are used to recursively resolve queries if they are not inside the service
2016-09-02 04:50:46 +00:00
domain for Consul. For example, a node can use Consul directly as a DNS server, and if the record is
2017-10-20 13:40:38 +00:00
outside of the "consul." domain, the query will be resolved upstream. As of Consul 1.0.1 recursors
2017-10-31 22:03:54 +00:00
can be provided as IP addresses or as go-sockaddr templates. IP addresses are resolved in order,
2017-10-20 18:06:33 +00:00
and duplicates are ignored.
2014-04-11 23:23:16 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "rejoin_after_leave" ></ a >< a href = "#rejoin_after_leave" > `rejoin_after_leave`</ a > Equivalent
to the [`-rejoin` command-line flag ](#_rejoin ).
2014-08-31 02:03:01 +00:00
2017-08-10 04:27:17 +00:00
* `retry_join` - Equivalent to the [`-retry-join` ](#retry-join ) command-line flag.
2017-08-04 00:03:00 +00:00
2016-11-03 17:04:42 +00:00
* < a name = "retry_interval" ></ a >< a href = "#retry_interval" > `retry_interval`</ a > Equivalent to the
[`-retry-interval` command-line flag ](#_retry_interval ).
* < a name = "retry_join_wan" ></ a >< a href = "#retry_join_wan" > `retry_join_wan`</ a > Equivalent to the
[`-retry-join-wan` command-line flag ](#_retry_join_wan ). Takes a list
of addresses to attempt joining to WAN every [`retry_interval_wan` ](#_retry_interval_wan ) until at least one
2016-11-03 21:22:46 +00:00
join works.
2016-11-03 17:04:42 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "retry_interval_wan" ></ a >< a href = "#retry_interval_wan" > `retry_interval_wan`</ a > Equivalent to the
[`-retry-interval-wan` command-line flag ](#_retry_interval_wan ).
2014-11-14 15:02:42 +00:00
2017-08-31 18:19:08 +00:00
* < a name = "segment" ></ a >< a href = "#segment" > `segment`</ a > (Enterprise-only) Equivalent to the
[`-segment` command-line flag ](#_segment ).
* < a name = "segments" ></ a >< a href = "#segments" > `segments`</ a > (Enterprise-only) This is a list of nested objects that allows setting
2017-09-01 18:19:39 +00:00
the bind/advertise information for network segments. This can only be set on servers. See the
[Network Segments Guide ](/docs/guides/segments.html ) for more details.
2017-08-31 18:19:08 +00:00
* < a name = "segment_name" ></ a >< a href = "#segment_name" > `name`</ a > - The name of the segment. Must be a string between
1 and 64 characters in length.
* < a name = "segment_bind" ></ a >< a href = "#segment_bind" > `bind`</ a > - The bind address to use for the segment's gossip layer.
Defaults to the [`-bind` ](#_bind ) value if not provided.
2017-09-27 00:57:34 +00:00
* < a name = "segment_port" ></ a >< a href = "#segment_port" > `port`</ a > - The port to use for the segment's gossip layer (required).
2017-08-31 18:19:08 +00:00
* < a name = "segment_advertise" ></ a >< a href = "#segment_advertise" > `advertise`</ a > - The advertise address to use for the
segment's gossip layer. Defaults to the [`-advertise` ](#_advertise ) value if not provided.
* < a name = "segment_rpc_listener" ></ a >< a href = "#segment_rpc_listener" > `rpc_listener`</ a > - If true, a separate RPC listener will
be started on this segment's [`-bind` ](#_bind ) address on the rpc port. Only valid if the segment's bind address differs from the
[`-bind` ](#_bind ) address. Defaults to false.
2015-02-24 17:30:17 +00:00
* < a name = "server" ></ a >< a href = "#server" > `server`</ a > Equivalent to the
[`-server` command-line flag ](#_server ).
2014-08-31 02:03:01 +00:00
2017-03-28 18:56:21 +00:00
* < a name = "non_voting_server" ></ a >< a href = "#non_voting_server" > `non_voting_server`</ a > - Equivalent to the
[`-non-voting-server` command-line flag ](#_non_voting_server ).
2015-02-24 17:30:17 +00:00
* < a name = "server_name" ></ a >< a href = "#server_name" > `server_name`</ a > When provided, this overrides
the [`node_name` ](#_node ) for the TLS certificate. It can be used to ensure that the certificate
name matches the hostname we declare.
2014-08-31 02:03:01 +00:00
2015-03-27 18:34:27 +00:00
* < a name = "session_ttl_min" ></ a >< a href = "#session_ttl_min" > `session_ttl_min`</ a >
The minimum allowed session TTL. This ensures sessions are not created with
TTL's shorter than the specified limit. It is recommended to keep this limit
at or above the default to encourage clients to send infrequent heartbeats.
Defaults to 10s.
2016-04-01 00:45:14 +00:00
* < a name = "skip_leave_on_interrupt" ></ a >< a
href="#skip_leave_on_interrupt">`skip_leave_on_interrupt`< / a > This is
similar to [`leave_on_terminate` ](#leave_on_terminate ) but only affects
2016-11-25 18:25:09 +00:00
interrupt handling. When Consul receives an interrupt signal (such as
2016-04-01 00:45:14 +00:00
hitting Control-C in a terminal), Consul will gracefully leave the cluster.
2016-11-25 18:25:09 +00:00
Setting this to `true` disables that behavior. The default behavior for
2016-04-01 00:45:14 +00:00
this feature varies based on whether or not the agent is running as a
2016-04-01 01:06:58 +00:00
client or a server (prior to Consul 0.7 the default value was
2016-11-25 18:25:09 +00:00
unconditionally set to `false` ). On agents in client-mode, this defaults
2016-04-01 01:06:58 +00:00
to `false` and for agents in server-mode, this defaults to `true`
(i.e. Ctrl-C on a server will keep the server in the cluster and therefore
quorum, and Ctrl-C on a client will gracefully leave).
2014-02-08 00:41:03 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "start_join" ></ a >< a href = "#start_join" > `start_join`</ a > An array of strings specifying addresses
2017-04-13 17:03:26 +00:00
of nodes to [`-join` ](#_join ) upon startup. Note that using
< a href = "#retry_join" > `retry_join`< / a > could be more appropriate to help
mitigate node startup race conditions when automating a Consul cluster
deployment.
2014-04-11 23:59:16 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "start_join_wan" ></ a >< a href = "#start_join_wan" > `start_join_wan`</ a > An array of strings specifying
addresses of WAN nodes to [`-join-wan` ](#_join_wan ) upon startup.
2014-11-14 15:02:42 +00:00
2017-08-04 00:03:00 +00:00
* < a name = "telemetry" ></ a >< a href = "#telemetry" > `telemetry`</ a > This is a nested object that configures where Consul
sends its runtime telemetry, and contains the following keys:
2015-10-08 19:45:45 +00:00
2017-08-04 00:03:00 +00:00
* < a name = "telemetry-circonus_api_token" ></ a >< a href = "#telemetry-circonus_api_token" > `circonus_api_token`</ a >
A valid API Token used to create/manage check. If provided, metric management is enabled.
2016-07-19 22:54:52 +00:00
2017-08-04 00:03:00 +00:00
* < a name = "telemetry-circonus_api_app" ></ a >< a href = "#telemetry-circonus_api_app" > `circonus_api_app`</ a >
A valid app name associated with the API token. By default, this is set to "consul".
2016-07-18 20:24:49 +00:00
2017-08-04 00:03:00 +00:00
* < a name = "telemetry-circonus_api_url" ></ a >< a href = "#telemetry-circonus_api_url" > `circonus_api_url`</ a >
The base URL to use for contacting the Circonus API. By default, this is set to "https://api.circonus.com/v2".
2016-07-18 20:24:49 +00:00
2017-08-04 00:03:00 +00:00
* < a name = "telemetry-circonus_submission_interval" ></ a >< a href = "#telemetry-circonus_submission_interval" > `circonus_submission_interval`</ a >
The interval at which metrics are submitted to Circonus. By default, this is set to "10s" (ten seconds).
2016-07-18 20:24:49 +00:00
2017-08-04 00:03:00 +00:00
* < a name = "telemetry-circonus_submission_url" ></ a >< a href = "#telemetry-circonus_submission_url" > `circonus_submission_url`</ a >
The `check.config.submission_url` field, of a Check API object, from a previously created HTTPTRAP check.
2016-07-18 20:24:49 +00:00
2017-08-04 00:03:00 +00:00
* < a name = "telemetry-circonus_check_id" ></ a >< a href = "#telemetry-circonus_check_id" > `circonus_check_id`</ a >
The Check ID (not **check bundle** ) from a previously created HTTPTRAP check. The numeric portion of the `check._cid` field in the Check API object.
2016-07-18 20:24:49 +00:00
2017-08-04 00:03:00 +00:00
* < a name = "telemetry-circonus_check_force_metric_activation" ></ a >< a href = "#telemetry-circonus_check_force_metric_activation" > `circonus_check_force_metric_activation`</ a >
2018-03-19 16:56:00 +00:00
Force activation of metrics which already exist and are not currently active. If check management is enabled, the default behavior is to add new metrics as they are encountered. If the metric already exists in the check, it will **not** be activated. This setting overrides that behavior. By default, this is set to false.
2016-07-18 20:24:49 +00:00
2017-08-04 00:03:00 +00:00
* < a name = "telemetry-circonus_check_instance_id" ></ a >< a href = "#telemetry-circonus_check_instance_id" > `circonus_check_instance_id`</ a >
Uniquely identifies the metrics coming from this *instance* . It can be used to maintain metric continuity with transient or ephemeral instances as they move around within an infrastructure. By default, this is set to hostname:application name (e.g. "host123:consul").
2016-07-18 20:24:49 +00:00
2017-08-04 00:03:00 +00:00
* < a name = "telemetry-circonus_check_search_tag" ></ a >< a href = "#telemetry-circonus_check_search_tag" > `circonus_check_search_tag`</ a >
A special tag which, when coupled with the instance id, helps to narrow down the search results when neither a Submission URL or Check ID is provided. By default, this is set to service:application name (e.g. "service:consul").
2016-07-18 20:24:49 +00:00
2018-07-26 23:30:24 +00:00
* < a name = "telemetry-circonus_check_display_name" ></ a >< a href = "#telemetry-circonus_check_display_name" > `circonus_check_display_name`</ a >
2017-08-04 00:03:00 +00:00
Specifies a name to give a check when it is created. This name is displayed in the Circonus UI Checks list. Available in Consul 0.7.2 and later.
2016-11-09 20:33:37 +00:00
2018-07-26 23:30:24 +00:00
* < a name = "telemetry-circonus_check_tags" ></ a >< a href = "#telemetry-circonus_check_tags" > `circonus_check_tags`</ a >
2017-08-04 00:03:00 +00:00
Comma separated list of additional tags to add to a check when it is created. Available in Consul 0.7.2 and later.
2016-11-09 20:33:37 +00:00
2017-08-04 00:03:00 +00:00
* < a name = "telemetry-circonus_broker_id" ></ a >< a href = "#telemetry-circonus_broker_id" > `circonus_broker_id`</ a >
The ID of a specific Circonus Broker to use when creating a new check. The numeric portion of `broker._cid` field in a Broker API object. If metric management is enabled and neither a Submission URL nor Check ID is provided, an attempt will be made to search for an existing check using Instance ID and Search Tag. If one is not found, a new HTTPTRAP check will be created. By default, this is not used and a random Enterprise Broker is selected, or the default Circonus Public Broker.
2016-07-18 20:24:49 +00:00
2017-08-04 00:03:00 +00:00
* < a name = "telemetry-circonus_broker_select_tag" ></ a >< a href = "#telemetry-circonus_broker_select_tag" > `circonus_broker_select_tag`</ a >
A special tag which will be used to select a Circonus Broker when a Broker ID is not provided. The best use of this is to as a hint for which broker should be used based on *where* this particular instance is running (e.g. a specific geo location or datacenter, dc:sfo). By default, this is left blank and not used.
2016-07-18 20:24:49 +00:00
2017-09-27 00:49:55 +00:00
* < a name = "telemetry-disable_hostname" ></ a >< a href = "#telemetry-disable_hostname" > `disable_hostname`</ a >
This controls whether or not to prepend runtime telemetry with the machine's hostname, defaults to false.
* < a name = "telemetry-dogstatsd_addr" ></ a >< a href = "#telemetry-dogstatsd_addr" > `dogstatsd_addr`</ a > This provides the
address of a DogStatsD instance in the format `host:port` . DogStatsD is a protocol-compatible flavor of
statsd, with the added ability to decorate metrics with tags and event information. If provided, Consul will
send various telemetry information to that instance for aggregation. This can be used to capture runtime
information.
* < a name = "telemetry-dogstatsd_tags" ></ a >< a href = "#telemetry-dogstatsd_tags" > `dogstatsd_tags`</ a > This provides a list of global tags
that will be added to all telemetry packets sent to DogStatsD. It is a list of strings, where each string
looks like "my_tag_name:my_tag_value".
* < a name = "telemetry-filter_default" ></ a >< a href = "#telemetry-filter_default" > `filter_default`</ a >
This controls whether to allow metrics that have not been specified by the filter. Defaults to `true` , which will
allow all metrics when no filters are provided. When set to `false` with no filters, no metrics will be sent.
* < a name = "telemetry-metrics_prefix" ></ a >< a href = "#telemetry-metrics_prefix" > `metrics_prefix`</ a >
2017-09-27 22:55:46 +00:00
The prefix used while writing all telemetry data. By default, this is set to "consul". This was added
in Consul 1.0. For previous versions of Consul, use the config option `statsite_prefix` in this
same structure. This was renamed in Consul 1.0 since this prefix applied to all telemetry providers,
not just statsite.
2017-09-27 00:49:55 +00:00
* < a name = "telemetry-prefix_filter" ></ a >< a href = "#telemetry-prefix_filter" > `prefix_filter`</ a >
This is a list of filter rules to apply for allowing/blocking metrics by prefix in the following format:
```javascript
[
"+consul.raft.apply",
"-consul.http",
"+consul.http.GET"
]
```
A leading "< b > +< / b > " will enable any metrics with the given prefix, and a leading "< b > -< / b > " will block them. If there
is overlap between two rules, the more specific rule will take precedence. Blocking will take priority if the same
prefix is listed multiple times.
2018-05-11 19:22:55 +00:00
* < a name = "telemetry-prometheus_retention_time" ></ a >< a href = "#telemetry-prometheus_retention_time" > prometheus_retention_time</ a >
2018-04-06 12:50:03 +00:00
If the value is greater than `0s` (the default), this enables [Prometheus ](https://prometheus.io/ ) export of metrics.
The duration can be expressed using the duration semantics and will aggregates all counters for the duration specified
2018-04-09 11:16:45 +00:00
(it might have an impact on Consul's memory usage). A good value for this parameter is at least 2 times the interval of scrape
of Prometheus, but you might also put a very high retention time such as a few days (for instance 744h to enable retention
to 31 days).
2018-10-26 19:11:57 +00:00
Fetching the metrics using prometheus can then be performed using the [`/v1/agent/metrics?format=prometheus` ](/api/agent.html#view-metrics ) endpoint.
2018-04-06 12:50:03 +00:00
The format is compatible natively with prometheus. When running in this mode, it is recommended to also enable the option
< a href = "#telemetry-disable_hostname" > `disable_hostname`< / a > to avoid having prefixed metrics with hostname.
2018-07-25 23:17:38 +00:00
Consul does not use the default Prometheus path, so Prometheus must be configured as follows.
Note that using ?format=prometheus in the path won't work as ? will be escaped, so it must be specified as a parameter.
```yaml
metrics_path: "/v1/agent/metrics"
params:
format: ['prometheus']
```
2018-04-06 12:50:03 +00:00
2017-09-27 00:49:55 +00:00
* < a name = "telemetry-statsd_address" ></ a >< a href = "#telemetry-statsd_address" > `statsd_address`</ a > This provides the
address of a statsd instance in the format `host:port` . If provided, Consul will send various telemetry information to that instance for
aggregation. This can be used to capture runtime information. This sends UDP packets only and can be used with
statsd or statsite.
* < a name = "telemetry-statsite_address" ></ a >< a href = "#telemetry-statsite_address" > `statsite_address`</ a > This provides
the address of a statsite instance in the format `host:port` . If provided, Consul will stream various telemetry information to that instance
for aggregation. This can be used to capture runtime information. This streams via TCP and can only be used with
statsite.
2015-02-24 17:30:17 +00:00
* < a name = "syslog_facility" ></ a >< a href = "#syslog_facility" > `syslog_facility`</ a > When
[`enable_syslog` ](#enable_syslog ) is provided, this controls to which
2015-02-15 05:43:01 +00:00
facility messages are sent. By default, `LOCAL0` will be used.
2014-06-11 17:18:19 +00:00
2017-02-01 20:52:04 +00:00
* < a name = "tls_min_version" ></ a >< a href = "#tls_min_version" > `tls_min_version`</ a > Added in Consul
0.7.4, this specifies the minimum supported version of TLS. Accepted values are "tls10", "tls11"
or "tls12". This defaults to "tls10". WARNING: TLS 1.1 and lower are generally considered less
secure; avoid using these if possible. This will be changed to default to "tls12" in Consul 0.8.0.
2017-04-27 08:29:39 +00:00
* < a name = "tls_cipher_suites" ></ a >< a href = "#tls_cipher_suites" > `tls_cipher_suites`</ a > Added in Consul
0.8.2, this specifies the list of supported ciphersuites as a comma-separated-list. The list of all
2018-03-19 16:50:52 +00:00
supported ciphersuites is available in the [source code ](https://github.com/hashicorp/consul/blob/master/tlsutil/config.go#L363 ).
2017-04-27 08:29:39 +00:00
* < a name = "tls_prefer_server_cipher_suites" ></ a >< a href = "#tls_prefer_server_cipher_suites" >
`tls_prefer_server_cipher_suites` </ a > Added in Consul 0.8.2, this will cause Consul to prefer the
server's ciphersuite over the client ciphersuites.
2018-07-26 23:30:24 +00:00
* < a name = "translate_wan_addrs" ></ a >< a href = "#translate_wan_addrs" > `translate_wan_addrs`</ a > If
2017-08-04 00:03:00 +00:00
set to true, Consul will prefer a node's configured < a href = "#_advertise-wan" > WAN address< / a >
when servicing DNS and HTTP requests for a node in a remote datacenter. This allows the node to
be reached within its own datacenter using its local address, and reached from other datacenters
using its WAN address, which is useful in hybrid setups with mixed networks. This is disabled by
default.
Starting in Consul 0.7 and later, node addresses in responses to HTTP requests will also prefer a
node's configured < a href = "#_advertise-wan" > WAN address< / a > when querying for a node in a remote
2017-09-02 05:25:28 +00:00
datacenter. An [`X-Consul-Translate-Addresses` ](/api/index.html#translated-addresses ) header
2017-08-04 00:03:00 +00:00
will be present on all responses when translation is enabled to help clients know that the addresses
may be translated. The `TaggedAddresses` field in responses also have a `lan` address for clients that
need knowledge of that address, regardless of translation.
The following endpoints translate addresses:
- [`/v1/catalog/nodes` ](/api/catalog.html#catalog_nodes )
- [`/v1/catalog/node/<node>` ](/api/catalog.html#catalog_node )
- [`/v1/catalog/service/<service>` ](/api/catalog.html#catalog_service )
- [`/v1/health/service/<service>` ](/api/health.html#health_service )
- [`/v1/query/<query or name>/execute` ](/api/query.html#execute )
2016-02-07 18:56:47 +00:00
2015-12-22 17:46:36 +00:00
* < a name = "ui" ></ a >< a href = "#ui" > `ui`</ a > - Equivalent to the [`-ui` ](#_ui )
command-line flag.
2015-02-24 17:30:17 +00:00
* < a name = "ui_dir" ></ a >< a href = "#ui_dir" > `ui_dir`</ a > - Equivalent to the
2016-12-07 04:57:40 +00:00
[`-ui-dir` ](#_ui_dir ) command-line flag. This configuration key is not required as of Consul version 0.7.0 and later. Specifying this configuration key will enable the web UI. There is no need to specify both ui-dir and ui. Specifying both will result in an error.
2014-08-31 02:03:01 +00:00
2017-08-04 00:03:00 +00:00
* < a name = "unix_sockets" ></ a >< a href = "#unix_sockets" > `unix_sockets`</ a > - This
allows tuning the ownership and permissions of the
Unix domain socket files created by Consul. Domain sockets are only used if
the HTTP address is configured with the `unix://` prefix.
It is important to note that this option may have different effects on
different operating systems. Linux generally observes socket file permissions
while many BSD variants ignore permissions on the socket file itself. It is
important to test this feature on your specific distribution. This feature is
currently not functional on Windows hosts.
The following options are valid within this construct and apply globally to all
sockets created by Consul:
- `user` - The name or ID of the user who will own the socket file.
- `group` - The group ID ownership of the socket file. This option
currently only supports numeric IDs.
- `mode` - The permission bits to set on the file.
2015-01-21 00:29:22 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "verify_incoming" ></ a >< a href = "#verify_incoming" > `verify_incoming`</ a > - If
set to true, Consul requires that all incoming
2015-02-15 05:43:01 +00:00
connections make use of TLS and that the client provides a certificate signed
2017-04-28 23:15:55 +00:00
by a Certificate Authority from the [`ca_file` ](#ca_file ) or [`ca_path` ](#ca_path ).
This applies to both server RPC and to the HTTPS API. By default, this is false, and
Consul will not enforce the use of TLS or verify a client's authenticity.
* < a name = "verify_incoming_rpc" ></ a >< a href = "#verify_incoming_rpc" > `verify_incoming_rpc`</ a > - If
set to true, Consul requires that all incoming RPC
connections make use of TLS and that the client provides a certificate signed
by a Certificate Authority from the [`ca_file` ](#ca_file ) or [`ca_path` ](#ca_path ). By default,
this is false, and Consul will not enforce the use of TLS or verify a client's authenticity.
* < a name = "verify_incoming_https" ></ a >< a href = "#verify_incoming_https" > `verify_incoming_https`</ a > - If
set to true, Consul requires that all incoming HTTPS
connections make use of TLS and that the client provides a certificate signed
by a Certificate Authority from the [`ca_file` ](#ca_file ) or [`ca_path` ](#ca_path ). By default,
this is false, and Consul will not enforce the use of TLS or verify a client's authenticity. To
enable the HTTPS API, you must define an HTTPS port via the [`ports` ](#ports ) configuration. By
default, HTTPS is disabled.
2014-04-07 21:46:13 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "verify_outgoing" ></ a >< a href = "#verify_outgoing" > `verify_outgoing`</ a > - If set to
2018-12-06 21:51:49 +00:00
true, Consul requires that all outgoing connections from this agent
2015-02-15 05:43:01 +00:00
make use of TLS and that the server provides a certificate that is signed by
2017-04-28 23:15:55 +00:00
a Certificate Authority from the [`ca_file` ](#ca_file ) or [`ca_path` ](#ca_path ). By default,
this is false, and Consul will not make use of TLS for outgoing connections. This applies to clients
and servers as both will make outgoing connections.
2014-08-04 00:51:43 +00:00
2018-12-06 21:51:49 +00:00
~> **Security Note:** Note that servers that specify `verify_outgoing =
true` will always talk to other servers over TLS, but they still _accept_
non-TLS connections to allow for a transition of all clients to TLS.
Currently the only way to enforce that no client can communicate with a
server unencrypted is to also enable `verify_incoming` which requires client
certificates too.
* < a name = "verify_server_hostname" ></ a >< a
href="#verify_server_hostname">`verify_server_hostname`< / a > - If set to true,
Consul verifies for all outgoing TLS connections that the TLS certificate
presented by the servers matches "server.< datacenter> .< domain> "
hostname. By default, this is false, and Consul does not verify the hostname
of the certificate, only that it is signed by a trusted CA. This setting is
_critical_ to prevent a compromised client from being restarted as a server
and having all cluster state _including all ACL tokens and Connect CA root keys_
replicated to it. This is new in 0.5.1.
~> **Security Note:** From versions 0.5.1 to 1.4.0, due to a bug, setting
this flag alone _does not_ imply `verify_outgoing` and leaves client to server
and server to server RPCs unencrypted despite the documentation stating otherwise. See
[CVE-2018-19653 ](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2018-19653 )
for more details. For those versions you **must also set `verify_outgoing =
true`** to ensure encrypted RPC connections.
2015-05-11 23:22:10 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "watches" ></ a >< a href = "#watches" > `watches`</ a > - Watches is a list of watch
specifications which allow an external process to be automatically invoked when a
particular data view is updated. See the
2015-02-15 05:43:01 +00:00
[watch documentation ](/docs/agent/watches.html ) for more detail. Watches can be
modified when the configuration is reloaded.
2014-08-22 00:25:42 +00:00
2018-03-29 15:19:21 +00:00
## <a id="ports-used"></a>Ports Used
2014-08-04 00:51:43 +00:00
2017-07-06 20:50:12 +00:00
Consul requires up to 6 different ports to work properly, some on
2014-08-05 17:46:52 +00:00
TCP, UDP, or both protocols. Below we document the requirements for each
port.
2014-08-04 00:52:36 +00:00
2014-08-05 17:46:52 +00:00
* Server RPC (Default 8300). This is used by servers to handle incoming
requests from other agents. TCP only.
2014-08-04 00:52:36 +00:00
2014-08-05 17:46:52 +00:00
* Serf LAN (Default 8301). This is used to handle gossip in the LAN.
2015-02-15 05:47:52 +00:00
Required by all agents. TCP and UDP.
2014-08-04 00:52:36 +00:00
2018-08-02 17:25:25 +00:00
* Serf WAN (Default 8302). This is used by servers to gossip over the WAN, to
other servers. TCP and UDP. As of Consul 0.8 the WAN join flooding feature requires
the Serf WAN port (TCP/UDP) to be listening on both WAN and LAN interfaces. See also:
[Consul 0.8.0 CHANGELOG ](https://github.com/hashicorp/consul/blob/master/CHANGELOG.md#080-april-5-2017 ) and [GH-3058 ](https://github.com/hashicorp/consul/issues/3058 )
2014-08-04 00:52:36 +00:00
2014-08-05 17:46:52 +00:00
* HTTP API (Default 8500). This is used by clients to talk to the HTTP
API. TCP only.
* DNS Interface (Default 8600). Used to resolve DNS queries. TCP and UDP.
2014-08-04 00:52:36 +00:00
2016-03-10 05:21:49 +00:00
## <a id="reloadable-configuration"></a>Reloadable Configuration
2014-11-26 03:03:14 +00:00
Reloading configuration does not reload all configuration items. The
items which are reloaded include:
* Log level
* Checks
* Services
* Watches
* HTTP Client Address
2017-03-24 17:29:39 +00:00
* < a href = "#node_meta" > Node Metadata</ a >
2018-01-05 22:19:33 +00:00
* < a href = "#telemetry-prefix_filter" > Metric Prefix Filter</ a >
2017-10-11 00:04:52 +00:00
* < a href = "#discard_check_output" > Discard Check Output</ a >
2018-06-26 19:09:14 +00:00
* < a href = "#limits" > RPC rate limiting</ a >
