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
2014-02-18 23:30:07 +00:00
When loading configuration, Consul loads the configuration from files
2015-02-13 19:58:05 +00:00
and directories in lexical order. For example, configuration file `basic_config.json`
2015-12-09 02:42:32 +00:00
will be processed before `extra_config.json` . Configuration specified later
2014-02-08 00:41:03 +00:00
will be merged into configuration specified earlier. In most cases,
2015-02-13 19:58:05 +00:00
"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
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.
2015-02-24 17:30:17 +00:00
* < a name = "_advertise" ></ a >< a href = "#_advertise" > `-advertise`</ a > - The advertise
address is used to change the address that we
2015-02-23 20:34:46 +00:00
advertise to other nodes in the cluster. By default, the [`-bind` ](#_bind ) address is
2014-05-16 17:49:36 +00:00
advertised. However, in some cases, there may be a routable address that cannot
2015-02-13 19:58:05 +00:00
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
2014-05-16 17:49:36 +00:00
as other nodes will treat the non-routability as a failure.
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
with < a href = "#translate_wan_addrs" > `translate_wan_addrs`< / a > .
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-03-15 00:56:33 +00:00
This flag implies 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
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
IPv6 address. If there are multiple public IPv6 addresses available, Consul
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
2015-02-13 19:58:05 +00:00
have any firewalls, be sure to allow both protocols.
2014-02-18 23:30:07 +00:00
2016-11-03 19:58:58 +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.
* < 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.
2015-02-24 17:30:17 +00:00
* < a name = "_client" ></ a >< a href = "#_client" > `-client`</ a > - The address to which
2017-02-28 21:41:09 +00:00
Consul will bind client interfaces, including the HTTP and DNS servers. By default,
this is "127.0.0.1", allowing only loopback connections.
2014-02-08 00:41:03 +00:00
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
2015-02-13 20:19:17 +00:00
load all files in this directory with the suffix ".json". 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
2015-02-24 17:30:17 +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.
2014-02-18 23:30:07 +00:00
This is required for all agents. The directory should be durable across reboots.
2015-02-13 19:58:05 +00:00
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
2014-08-22 21:58:10 +00:00
the use of filesystem locking, meaning some types of mounted folders (e.g. VirtualBox
shared folders) may not be suitable.
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
prototyping or developing against the API. This mode is **not** intended for
production use as it does not write any data to disk.
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
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.
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
2017-06-15 22:24:04 +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.
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.
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
deployment.\
2014-04-11 23:59:16 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "_retry_join" ></ a >< a href = "#_retry_join" > `-retry-join`</ a > - Similar
to [`-join` ](#_join ) but allows retrying a join if the first
2016-10-20 18:14:55 +00:00
attempt fails. The list should contain IPv4 addresses with optional Serf
LAN port number also specified or bracketed IPv6 addresses with optional
port number — for example: `[::1]:8301` . This is useful for cases where we
know the address will become available eventually.
2014-10-12 19:31:47 +00:00
2016-11-02 18:35:37 +00:00
* < a name = "_retry_join_ec2_tag_key" ></ a >< a href = "#_retry_join_ec2_tag_key" > `-retry-join-ec2-tag-key`
< / a > - The Amazon EC2 instance tag key to filter on. When used with
[`-retry-join-ec2-tag-value` ](#_retry_join_ec2_tag_value ), Consul will attempt to join EC2
instances with the given tag key and value on startup.
< / br > < / br > For AWS authentication the following methods are supported, in order:
- Static credentials (from the config file)
- Environment variables (`AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` )
- Shared credentials file (`~/.aws/credentials` or the path specified by `AWS_SHARED_CREDENTIALS_FILE` )
2016-11-02 22:48:15 +00:00
- ECS task role metadata (container-specific).
- EC2 instance role metadata.
2017-06-16 11:58:19 +00:00
2017-01-20 22:13:28 +00:00
The only required IAM permission is `ec2:DescribeInstances` , and it is recommended you make a dedicated
key used only for auto-joining.
2016-11-02 18:35:37 +00:00
* < a name = "_retry_join_ec2_tag_value" ></ a >< a href = "#_retry_join_ec2_tag_value" > `-retry-join-ec2-tag-value`
< / a > - The Amazon EC2 instance tag value to filter on.
* < a name = "_retry_join_ec2_region" ></ a >< a href = "#_retry_join_ec2_region" > `-retry-join-ec2-region`
< / a > - (Optional) The Amazon EC2 region to use. If not specified, Consul
will use the local instance's [EC2 metadata endpoint ](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-identity-documents.html )
to discover the region.
2016-12-05 08:07:53 +00:00
* < a name = "_retry_join_gce_tag_value" ></ a >< a href = "#_retry_join_gce_tag_value" > `-retry-join-gce-tag-value`
< / a > - A Google Compute Engine instance tag to filter on. Much like the
`-retry-join-ec2-*` options, this gives Consul the option of doing server
discovery on [Google Compute Engine ](https://cloud.google.com/compute/ ) by
2017-01-12 03:37:22 +00:00
searching the tags assigned to any particular instance.
2016-12-05 08:07:53 +00:00
* < a name = "_retry_join_gce_project_name" ></ a >< a href = "#_retry_join_gce_project_name" > `-retry-join-gce-project-name`
< / a > - The project to search in for the tag supplied by
[`-retry-join-gce-tag-value` ](#_retry_join_gce_tag_value ). If this is run
from within a GCE instance, the default is the project the instance is
located in.
* < a name = "_retry_join_gce_zone_pattern" ></ a >< a href = "#_retry_join_gce_zone_pattern" > `-retry-join-gce-zone-pattern`
< / a > - A regular expression that indicates the zones the tag should be
searched in. For example, while `us-west1-a` would only search in
`us-west1-a` , `us-west1-.*` would search in `us-west1-a` and `us-west1-b` .
The default is to search globally.
* < a name = "_retry_join_gce_credentials_file" ></ a >< a href = "#_retry_join_gce_credentials_file" > `-retry-join-gce-credentials-file`
< / a > - The path to the JSON credentials file of the [GCE Service
Account](https://cloud.google.com/compute/docs/access/service-accounts) that
will be used to search for instances. Note that this can also reside in the
following locations:
- A path supplied by the `GOOGLE_APPLICATION_CREDENTIALS` environment
variable
- The `%APPDATA%/gcloud/application_default_credentials.json` file (Windows)
or `$HOME/.config/gcloud/application_default_credentials.json` (Linux and
other systems)
- If none of these exist and discovery is being run from a GCE instance, the
instance's configured service account will be used.
2017-05-24 07:19:23 +00:00
* < a name = "_retry_join_azure_tag_name" ></ a >< a href = "#_retry_join_azure_tag_name" > `-retry-join-azure-tag-name`
< / a > - The Azure instance tag name to filter on. When used with
[`-retry-join-azure-tag-value` ](#_retry_join_azure_tag_value ), Consul will attempt to join Azure
instances with the given tag name and value on startup.
< / br > < / br > For Azure authentication the following methods are supported, in order:
- Static credentials (from the config file)
The only permission needed is the ListAll method for NetworkInterfaces. It is recommended you make a dedicated key used only for auto-joining.
* < a name = "_retry_join_azure_tag_value" ></ a >< a href = "#_retry_join_azure_tag_value" > `-retry-join-azure-tag-value`
< / a > - The Azure instance tag value to filter on.
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.
2015-02-24 17:30:17 +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
2015-02-13 19:58:05 +00:00
specified multiple times to specify multiple WAN agents to join. If Consul is
2014-11-14 15:02:42 +00:00
unable to join with any of the specified addresses, agent startup will
2015-02-24 17:30:17 +00:00
fail. By default, the agent won't [`-join-wan` ](#_join_wan ) any nodes when it starts up.
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.
This is useful for cases where we know the address will become
2014-11-14 15:02:42 +00:00
available eventually.
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.
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-03-01 22:04:40 +00:00
version of the Raft consensus protocol used for server communications. This defaults to 2 but must
be set to 3 in order to gain access to Autopilot features, with the exception of
[`cleanup_dead_servers` ](#cleanup_dead_servers ).
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.
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
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": {
"https": 8080
},
"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": {
"https": 8080
}
```
Consul will not enable TLS for the HTTP API unless the `https` port has been assigned a port number `> 0` .
2014-02-08 00:41:03 +00:00
#### Configuration Key Reference
2017-03-29 19:24:42 +00:00
* < a name = "acl_datacenter" ></ a >< a href = "#acl_datacenter" > `acl_datacenter`</ a > - 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
2017-04-05 01:51:47 +00:00
of ACLs. Please see the [ACL Guide ](/docs/guides/acl.html ) for more details.
2015-02-24 17:30:17 +00:00
* < a name = "acl_default_policy" ></ a >< a href = "#acl_default_policy" > `acl_default_policy`</ a > - Either
"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
2017-06-16 11:58:19 +00:00
specifically allowed is blocked. *Note* : this will not take effect until you've set `acl_datacenter`
2015-12-18 22:26:35 +00:00
to enable ACL support.
2014-02-08 00:41:03 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "acl_down_policy" ></ a >< a href = "#acl_down_policy" > `acl_down_policy`</ a > - Either
"allow", "deny" or "extend-cache"; "extend-cache" is the default. In the case that the
policy for a token cannot be read from the [`acl_datacenter` ](#acl_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 ACLs to be used, ignoring their TTL
values. If a non-cached ACL is used, "extend-cache" acts like "deny".
2016-12-14 07:21:14 +00:00
* < a name = "acl_agent_master_token" ></ a >< a href = "#acl_agent_master_token" > `acl_agent_master_token`</ a > -
2017-04-04 16:33:22 +00:00
Used to access < a href = "/api/agent.html" > agent endpoints< / a > that require agent read
2016-12-14 07:21:14 +00:00
or write 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 < a href = "#acl_enforce_version_8" > `acl_enforce_version_8`< / a >
is set to true.
* < a name = "acl_agent_token" ></ a >< a href = "#acl_agent_token" > `acl_agent_token`</ a > - Used for clients
2016-12-11 19:24:44 +00:00
and servers to perform internal operations to the service catalog. If this isn't specified, then
the < a href = "#acl_token" > `acl_token`< / a > will be used. This was added in Consul 0.7.2.
< br > < br >
2017-03-23 20:34:30 +00:00
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.
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 > -
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
2015-02-24 17:30:17 +00:00
* < a name = "acl_master_token" ></ a >< a href = "#acl_master_token" > `acl_master_token`</ a > - Only used
for servers in the [`acl_datacenter` ](#acl_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 ID that is well-known.
2015-03-03 16:31:56 +00:00
< br > < br >
2016-11-25 16:00:02 +00:00
The `acl_master_token` is only installed when a server acquires cluster leadership. If
2015-03-03 16:46:57 +00:00
you would like to install or change the `acl_master_token` , set the new value for `acl_master_token`
2015-03-03 16:31:56 +00:00
in the configuration for all servers. Once this is done, restart the current leader to force a
2016-11-25 16:00:02 +00:00
leader election. If the `acl_master_token` is not supplied, then the servers do not create a master
2015-07-01 19:34:35 +00:00
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.
2015-02-24 17:30:17 +00:00
2016-08-05 07:23:28 +00:00
* < a name = "acl_replication_token" ></ a >< a href = "#acl_replication_token" > `acl_replication_token`</ a > -
Only used for servers outside the [`acl_datacenter` ](#acl_datacenter ) running Consul 0.7 or later.
2017-04-05 01:51:47 +00:00
When provided, this will enable [ACL replication ](/docs/guides/acl.html#replication ) using this
2016-08-05 07:23:28 +00:00
token to retrieve and replicate the ACLs to the non-authoritative local datacenter.
< br > < br >
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
2017-04-05 01:51:47 +00:00
[ACL Guide ](/docs/guides/acl.html#replication ) replication section for more details.
2016-08-05 07:23:28 +00:00
2015-02-24 17:30:17 +00:00
* < a name = "acl_token" ></ a >< a href = "#acl_token" > `acl_token`</ 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 policy, is used.
* < a name = "acl_ttl" ></ a >< a href = "#acl_ttl" > `acl_ttl`</ a > - Used to control Time-To-Live caching of ACLs.
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.
* < a name = "addresses" ></ a >< a href = "#addresses" > `addresses`</ a > - This is a nested object that allows
setting bind addresses.
2015-01-16 21:06:49 +00:00
< br > < br >
2017-02-28 21:41:09 +00:00
`http` supports binding to a Unix domain socket. A socket can be
2015-01-16 21:06:49 +00:00
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
2016-03-01 21:01:13 +00:00
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 ).
2015-01-16 21:06:49 +00:00
< br > < br >
2015-01-16 17:14:52 +00:00
When running Consul agent commands against Unix socket interfaces, use the
2017-02-28 21:41:09 +00:00
`-http-addr` argument to specify the path to the socket. You can also place
the desired values in the `CONSUL_HTTP_ADDR` environment variable.
2016-03-01 21:01:13 +00:00
< br > < br >
2016-09-29 16:50:00 +00:00
For TCP addresses, the variable values 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.
2015-01-16 21:06:49 +00:00
< br > < br >
2015-01-16 17:14:52 +00:00
The following keys are valid:
2015-01-16 21:06:49 +00:00
* `dns` - The DNS server. Defaults to `client_addr`
* `http` - The HTTP API. Defaults to `client_addr`
2015-03-18 21:22:36 +00:00
* `https` - The HTTPS API. Defaults to `client_addr`
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
2016-11-03 19:58:58 +00:00
* < a name = "serf_wan_bind" ></ a >< a href = "#serf_wan_bind" > `serf_wan_bind`</ a > Equivalent to
the [`-serf-wan-bind` command-line flag ](#_serf_wan_bind ).
* < a name = "serf_lan_bind" ></ a >< a href = "#serf_lan_bind" > `serf_lan_bind`</ a > Equivalent to
the [`-serf-lan-bind` command-line flag ](#_serf_lan_bind ).
2015-06-05 11:44:42 +00:00
* < a name = "advertise_addrs" ></ a >< a href = "#advertise_addrs" > `advertise_addrs`</ a > Allows to set
the advertised addresses for SerfLan, SerfWan and RPC together with the port. This gives
2016-03-01 21:01:13 +00:00
you more control than < a href = "#_advertise" > `-advertise`< / a > or < a href = "#_advertise-wan" > `-advertise-wan`< / a >
while it serves the same purpose. These settings might override < a href = "#_advertise" > `-advertise`< / a > or
< a href = "#_advertise-wan" > `-advertise-wan`< / a >
2015-06-05 11:44:42 +00:00
< br > < br >
This is a nested setting that allows the following keys:
* `serf_lan` - The SerfLan address. Accepts values in the form of "host:port" like "10.23.31.101:8301".
* `serf_wan` - The SerfWan address. Accepts values in the form of "host:port" like "10.23.31.101:8302".
2016-03-16 07:10:54 +00:00
* `rpc` - The server RPC address. Accepts values in the form of "host:port" like "10.23.31.101:8300".
2015-06-05 11:44:42 +00:00
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-02-22 21:11:01 +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.
2017-03-10 22:55:18 +00:00
For more information about Autopilot, see the [Autopilot Guide ](/docs/guides/autopilot.html ).
2017-02-22 21:11:01 +00:00
< br > < br >
The following sub-keys are available:
2017-02-28 22:23:14 +00:00
* < a name = "cleanup_dead_servers" ></ a >< a href = "#cleanup_dead_servers" > `cleanup_dead_servers`</ a > - This controls
2017-03-10 00:43:07 +00:00
the automatic removal of dead server nodes periodically and whenever a new server is added to the cluster.
Defaults to `true` .
2017-02-22 21:11:01 +00:00
2017-03-01 22:04:40 +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-04-11 12:58:15 +00:00
* < a name = "max_trailing_logs" ></ a >< a href = "#max_trailing_logs" > `max_trailing_logs`</ a > - Controls
2017-03-01 22:04:40 +00:00
the maximum number of log entries that a server can trail the leader by before being considered unhealthy. Defaults
to 250.
* < 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
2017-03-10 00:43:07 +00:00
such as `30s` . Defaults to `10s` .
2017-03-01 22:04:40 +00:00
2017-03-21 23:36:44 +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` .
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
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 ).
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 >
Disables automatic checking for security bulletins and new version releases.
2014-09-02 21:36:25 +00:00
2015-02-24 17:30:17 +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.
2015-02-15 05:43:01 +00:00
< br > < br >
2014-06-09 00:26:41 +00:00
The following sub-keys are available:
2015-02-24 17:30:17 +00:00
* < 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.
2016-08-30 20:40:43 +00:00
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.
2014-06-09 00:26:41 +00:00
2016-11-08 19:45:12 +00:00
* < 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
2015-02-24 17:30:17 +00:00
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.
2014-08-31 02:03:01 +00:00
2016-11-08 19:45:12 +00:00
* < a name = "service_ttl" ></ a >< a href = "#service_ttl" > `service_ttl`</ a > - This is a sub-object
2015-02-24 17:30:17 +00:00
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.
2014-08-31 02:03:01 +00:00
2016-11-08 19:45:12 +00:00
* < a name = "enable_truncate" ></ a >< a href = "#enable_truncate" > `enable_truncate`</ a > - If set to
2016-03-09 20:41:49 +00:00
true, a UDP DNS query that would return more than 3 records, or more than would fit into a valid
2016-02-18 00:54:28 +00:00
UDP response, will set the truncated flag, indicating to clients that they should re-query
using TCP to get the full set of records.
2014-09-30 19:31:28 +00:00
2016-11-08 19:45:12 +00:00
* < a name = "only_passing" ></ a >< a href = "#only_passing" > `only_passing`</ a > - If set to true, any
2016-04-27 21:55:38 +00:00
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.
2015-01-10 12:11:32 +00:00
2016-11-08 19:45:12 +00:00
* < a name = "recursor_timeout" ></ a >< a href = "#recursor_timeout" > `recursor_timeout`</ a > - Timeout used
2016-09-02 04:50:46 +00:00
by Consul when recursively querying an upstream DNS server. See < a href = "#recursors" > `recursors`< / a >
2016-09-02 05:18:34 +00:00
for more details. Default is 2s. This is available in Consul 0.7 and later.
2016-08-29 18:41:30 +00:00
2016-11-08 19:45:12 +00:00
* < a name = "disable_compression" ></ a >< a href = "#disable_compression" > `disable_compression`</ a > - If
2016-08-11 23:24:44 +00:00
set to true, DNS responses will not be compressed. Compression was added and enabled by default
in Consul 0.7.
2016-02-12 07:58:48 +00:00
* < a name = "udp_answer_limit" ></ a >< a
2016-03-30 02:27:02 +00:00
href="#udp_answer_limit">`udp_answer_limit`< / a > - Limit the number of
resource records contained in the answer section of a UDP-based DNS
2016-11-25 18:25:09 +00:00
response. When answering a question, Consul will use the complete list of
2016-03-30 06:48:22 +00:00
matching hosts, shuffle the list randomly, and then limit the number of
2016-11-25 18:25:09 +00:00
answers to `udp_answer_limit` (default `3` ). In environments where
2016-02-12 07:58:48 +00:00
[RFC 3484 Section 6 ](https://tools.ietf.org/html/rfc3484#section-6 ) Rule 9
2016-03-30 02:27:02 +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
2016-03-30 06:48:22 +00:00
preserve the expected randomized distribution behavior (note:
2016-04-20 22:46:01 +00:00
[RFC 3484 ](https://tools.ietf.org/html/rfc3484 ) has been obsoleted by
2016-03-30 06:48:22 +00:00
[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).
2016-02-12 07:58:48 +00:00
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
2015-02-24 17:30:17 +00:00
* < a name = "enable_debug" ></ a >< a href = "#enable_debug" > `enable_debug`</ a > When set, enables some
additional debugging features. Currently, this is only used to set the runtime profiling HTTP endpoints.
2014-04-11 23:23:16 +00:00
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 ).
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
2015-02-24 17:30:17 +00:00
* < a name = "http_api_response_headers" ></ a >< a href = "#http_api_response_headers" > `http_api_response_headers`</ a >
This object allows adding headers to the HTTP API
2015-02-15 05:43:01 +00:00
responses. For example, the following config can be used to enable
2016-01-13 22:44:01 +00:00
[CORS ](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing ) on
2014-12-28 04:53:19 +00:00
the HTTP API endpoints:
```javascript
{
"http_api_response_headers": {
"Access-Control-Allow-Origin": "*"
}
}
```
2017-06-24 22:28:23 +00:00
This has been deprecated in Consul 0.8.5. Setting this value will set `http_config.response_headers`
2017-06-16 11:58:19 +00:00
instead for backwards compatibility.
* < a name = "http_config" ></ a >< a href = "#http_config" > `http_config`</ a >
This object allows setting options for the HTTP API.
< br > < br >
The following sub-keys are available:
* < 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": "*"
}
}
}
```
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
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
2016-08-25 00:33:53 +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:
2016-09-01 06:39:11 +00:00
2017-01-17 12:59:18 +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.< br > < br > By default, Consul will use a lower-performance timing that's suitable
for [minimal Consul servers ](/docs/guides/performance.html#minumum ), currently equivalent
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
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.
* < a name = "https_port" ></ a >< a href = "#https_port" > `https`</ a > - The HTTPS API, -1 to disable. Default -1 (disabled).
2017-03-24 17:23:45 +00:00
* < a name = "rpc_port" ></ a >< a href = "#rpc_port" > `rpc`</ a > - The CLI RPC endpoint. Default 8400. This is deprecated
in Consul 0.8 and later.
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.
* < a name = "serf_wan_port" ></ a >< a href = "#serf_wan_port" > `serf_wan`</ a > - The Serf WAN port. Default 8302.
* < a name = "server_rpc_port" ></ a >< a href = "#server_rpc_port" > `server`</ a > - Server RPC address. Default 8300.
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
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 ).
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 )
for an example.
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 = "recursor" ></ a >< a href = "#recursor" > `recursor`</ a > Provides a single recursor address.
This has been deprecated, and the value is appended to the [`recursors` ](#recursors ) list for
backwards compatibility.
2014-11-03 19:28:21 +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
2015-02-24 17:30:17 +00:00
outside of the "consul." domain, the query will be resolved upstream.
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
2015-02-24 17:30:17 +00:00
* < a name = "retry_join" ></ a >< a href = "#retry_join" > `retry_join`</ a > Equivalent to the
[`-retry-join` command-line flag ](#_retry_join ). Takes a list
2015-02-23 20:34:46 +00:00
of addresses to attempt joining every [`retry_interval` ](#_retry_interval ) until at least one
2016-11-03 21:22:46 +00:00
join works. The list should contain IPv4 addresses with optional Serf LAN port number also specified or bracketed IPv6 addresses with optional port number — for example: `[::1]:8301` .
2014-10-23 23:39:23 +00:00
2016-11-02 18:35:37 +00:00
* < a name = "retry_join_ec2" ></ a >< a href = "#retry_join_ec2" > `retry_join_ec2`</ a > - This is a nested object
that allows the setting of EC2-related [`-retry-join` ](#_retry_join ) options.
< br > < br >
The following keys are valid:
* `region` - The AWS region. Equivalent to the
[`-retry-join-ec2-region` command-line flag ](#_retry_join_ec2_region ).
* `tag_key` - The EC2 instance tag key to filter on. Equivalent to the</ br >
[`-retry-join-ec2-tag-key` command-line flag ](#_retry_join_ec2_tag_key ).
* `tag_value` - The EC2 instance tag value to filter on. Equivalent to the</ br >
[`-retry-join-ec2-tag-value` command-line flag ](#_retry_join_ec2_tag_value ).
* `access_key_id` - The AWS access key ID to use for authentication.
* `secret_access_key` - The AWS secret access key to use for authentication.
2016-12-05 08:07:53 +00:00
* < a name = "retry_join_gce" ></ a >< a href = "#retry_join_gce" > `retry_join_gce`</ a > - This is a nested object
that allows the setting of GCE-related [`-retry-join` ](#_retry_join ) options.
< br > < br >
The following keys are valid:
* `project_name` - The GCE project name. Equivalent to the< br >
[`-retry-join-gce-project-name` command-line
flag](#_retry_join_gce_project_name).
* `zone_pattern` - The regular expression indicating the zones to search in.
Equivalent to the < br >
[`-retry-join-gce-zone-pattern` command-line
flag](#_retry_join_gce_zone_pattern).
* `tag_value` - The GCE instance tag value to filter on. Equivalent to the < br >
[`-retry-join-gce-tag-value` command-line
flag](#_retry_join_gce_tag_value).
* `credentials_file` - The path to the GCE service account credentials file.
Equivalent to the < br >
[`-retry-join-gce-credentials-file` command-line
flag](#_retry_join_gce_credentials_file).
2017-05-24 07:19:23 +00:00
* < a name = "retry_join_azure" ></ a >< a href = "#retry_join_azure" > `retry_join_azure`</ a > - This is a nested object
that allows the setting of Azure-related [`-retry-join` ](#_retry_join ) options.
< br > < br >
The following keys are valid:
* `tag_name` - The Azure instance tag name to filter on. Equivalent to the</ br >
[`-retry-join-azure-tag-name` command-line flag ](#_retry_join_azure_tag_name ).
* `tag_value` - The Azure instance tag value to filter on. Equivalent to the</ br >
[`-retry-join-azure-tag-value` command-line flag ](#_retry_join_azure_tag_value ).
* `subscription_id` - The Azure Subscription ID to use for authentication.
* `tenant_id` - The Azure Tenant ID to use for authentication.
* `client_id` - The Azure Client ID to use for authentication.
* `secret_access_key` - The Azure secret access key to use for authentication.
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
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
2016-02-07 06:07:11 +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
* < a name = "telemetry-statsd_address" ></ a >< a href = "#telemetry-statsd_address" > `statsd_address`</ a > This provides the
2016-11-25 18:25:09 +00:00
address of a statsd instance in the format `host:port` . If provided, Consul will send various telemetry information to that instance for
2015-10-08 19:45:45 +00:00
aggregation. This can be used to capture runtime information. This sends UDP packets only and can be used with
statsd or statsite.
2016-02-07 06:07:11 +00:00
2015-10-08 19:45:45 +00:00
* < a name = "telemetry-statsite_address" ></ a >< a href = "#telemetry-statsite_address" > `statsite_address`</ a > This provides
2016-05-24 19:55:23 +00:00
the address of a statsite instance in the format `host:port` . If provided, Consul will stream various telemetry information to that instance
2015-10-08 19:45:45 +00:00
for aggregation. This can be used to capture runtime information. This streams via TCP and can only be used with
statsite.
2016-02-07 06:07:11 +00:00
2015-10-08 19:45:45 +00:00
* < a name = "telemetry-statsite_prefix" ></ a >< a href = "#telemetry-statsite_prefix" > `statsite_prefix`</ a >
The prefix used while writing all telemetry data to statsite. By default, this is set to "consul".
2016-02-07 06:07:11 +00:00
2015-10-08 19:45:45 +00:00
* < 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.
2016-02-07 06:07:11 +00:00
2015-10-08 19:45:45 +00:00
* < 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".
2016-02-07 06:07:11 +00:00
2015-10-08 19:45:45 +00:00
* < a name = "telemetry-disable_hostname" ></ a >< a href = "#telemetry-disable_hostname" > `disable_hostname`</ a >
2016-02-07 06:07:11 +00:00
This controls whether or not to prepend runtime telemetry with the machine's hostname, defaults to false.
2016-07-18 20:24:49 +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
2016-07-18 20:24:49 +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".
* < 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".
* < 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).
* < 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.
* < 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.
* < a name = "telemetry-circonus_check_force_metric_activation" ></ a >< a href = "#telemetry-circonus_check_force_metric_activation" > `circonus_check_force_metric_activation`</ a >
2016-07-19 22:54:52 +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 encoutered. 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
* < a name = "telemetry-circonus_check_instance_id" ></ a >< a href = "#telemetry-circonus_check_instance_id" > `circonus_check_instance_id`</ a >
2016-11-25 18:25:09 +00:00
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
* < a name = "telemetry-circonus_check_search_tag" ></ a >< a href = "#telemetry-circonus_check_search_tag" > `circonus_check_search_tag`</ a >
2016-07-19 22:54:52 +00:00
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
2016-11-09 20:33:37 +00:00
* < a name = "telemetry-circonus_check_display_name" </ a >< a href = "#telemetry-circonus_check_display_name" > `circonus_check_display_name`</ a >
2016-12-01 05:35:54 +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
2016-12-06 02:49:40 +00:00
* < a name = "telemetry-circonus_check_tags" </ a >< a href = "#telemetry-circonus_check_tags" > `circonus_check_tags`</ a >
2016-12-01 05:35:54 +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
2016-07-18 20:24:49 +00:00
* < a name = "telemetry-circonus_broker_id" ></ a >< a href = "#telemetry-circonus_broker_id" > `circonus_broker_id`</ a >
2016-07-19 22:54:52 +00:00
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
2016-07-20 15:44:38 +00:00
* < a name = "telemetry-circonus_broker_select_tag" ></ a >< a href = "#telemetry-circonus_broker_select_tag" > `circonus_broker_select_tag`</ a >
2016-07-19 22:54:52 +00:00
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
2015-10-08 19:45:45 +00:00
* < a name = "statsd_addr" ></ a >< a href = "#statsd_addr" > `statsd_addr`</ a > Deprecated, see
2016-02-07 06:07:11 +00:00
the < a href = "#telemetry" > telemetry< / a > structure
2015-10-08 19:45:45 +00:00
* < a name = "statsite_addr" ></ a >< a href = "#statsite_addr" > `statsite_addr`</ a > Deprecated, see
2016-02-07 06:07:11 +00:00
the < a href = "#telemetry" > telemetry< / a > structure
2015-10-08 19:45:45 +00:00
* < a name = "statsite_prefix" ></ a >< a href = "#statsite_prefix" > `statsite_prefix`</ a > Deprecated, see
2016-02-07 06:07:11 +00:00
the < a href = "#telemetry" > telemetry< / a > structure
2015-10-08 19:45:45 +00:00
* < a name = "dogstatsd_addr" ></ a >< a href = "#dogstatsd_addr" > `dogstatsd_addr`</ a > Deprecated, see
2016-11-16 15:58:24 +00:00
the < a href = "#telemetry" > telemetry< / a > structure
2015-10-08 19:45:45 +00:00
* < a name = "dogstatsd_tags" ></ a >< a href = "#dogstatsd_tags" > `dogstatsd_tags`</ a > Deprecated, see
2016-02-07 06:07:11 +00:00
the < a href = "#telemetry" > telemetry< / a > structure
2015-05-03 23:54:19 +00:00
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
available ciphersuites is available in the [Golang TLS documentation ](https://golang.org/src/crypto/tls/cipher_suites.go ).
* < 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.
2016-02-07 18:56:47 +00:00
* < a name = "translate_wan_addrs" </ a >< a href = "#translate_wan_addrs" > `translate_wan_addrs`</ a > If
set to true, Consul will prefer a node's configured < a href = "#_advertise-wan" > WAN address< / a >
2016-08-15 22:47:15 +00:00
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.
< br >
< br >
2016-08-16 18:31:41 +00:00
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-04-04 16:52:00 +00:00
datacenter. An [`X-Consul-Translate-Addresses` ](/api/index.html#translate_header ) header
2016-08-16 18:31:41 +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.
< br >
< br > The following endpoints translate addresses:
2016-08-15 22:47:15 +00:00
< br >
2017-04-04 16:33:22 +00:00
* [`/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
2015-02-24 17:30:17 +00:00
* < a name = "unix_sockets" ></ a >< a href = "#unix_sockets" > `unix_sockets`</ a > - This
allows tuning the ownership and permissions of the
2015-01-21 00:29:22 +00:00
Unix domain socket files created by Consul. Domain sockets are only used if
2017-02-28 21:41:09 +00:00
the HTTP address is configured with the `unix://` prefix.
2015-01-21 00:29:22 +00:00
< br >
2015-01-21 03:16:12 +00:00
< br >
It is important to note that this option may have different effects on
2015-02-15 05:43:01 +00:00
different operating systems. Linux generally observes socket file permissions
2015-01-21 03:16:12 +00:00
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.
2016-08-15 22:47:15 +00:00
< br >
< br >
The following options are valid within this construct and apply globally to all
sockets created by Consul:
< br >
* `user` - The name or ID of the user who will own the socket file.
2016-11-25 16:00:02 +00:00
* `group` - The group ID ownership of the socket file. This option
2016-08-15 22:47:15 +00:00
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
true, Consul requires that all outgoing connections
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
2015-05-11 23:22:10 +00:00
* < a name = "verify_server_hostname" ></ a >< a href = "#verify_server_hostname" > `verify_server_hostname`</ a > - If set to
true, Consul verifies for all outgoing connections that the TLS certificate presented by the servers
2016-07-20 22:53:35 +00:00
matches "server.< datacenter> .< domain> " hostname. This implies `verify_outgoing` .
2015-05-11 23:22:10 +00:00
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 important to prevent a compromised
client from being restarted as a server, and thus being able to perform a MITM attack
or to be added as a Raft peer. This is new in 0.5.1.
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
2016-03-10 05:21:49 +00:00
## <a id="ports"></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
2014-11-05 04:01:45 +00:00
* Serf WAN (Default 8302). This is used by servers to gossip over the
2014-08-05 17:46:52 +00:00
WAN to other servers. TCP and UDP.
2014-08-04 00:52:36 +00:00
2017-03-24 17:23:45 +00:00
* CLI RPC (Default 8400). This is used by all agents to handle RPC
from the CLI, but is deprecated in Consul 0.8 and later. TCP only.
In Consul 0.8 all CLI commands were changed to use the HTTP API and
the RPC interface was completely removed.
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 >
