Consul Config Write

Command: consul config write

Corresponding HTTP API Endpoint: [PUT] /v1/config

The config write command creates or updates a centralized config entry. See the configuration entries docs for more details about configuration entries.

The table below shows this command's required ACLs. Configuration of blocking queries and agent caching are not supported from commands, but may be from the corresponding HTTP endpoint.

¹ The actual ACL required depends on the config entry kind being updated:

Usage

Usage: consul config write [options] FILE

API Options

• -ca-file=<value> - Path to a CA file to use for TLS when communicating with Consul. This can also be specified via the CONSUL_CACERT environment variable.

• -ca-path=<value> - Path to a directory of CA certificates to use for TLS when communicating with Consul. This can also be specified via the CONSUL_CAPATH environment variable.

• -client-cert=<value> - Path to a client cert file to use for TLS when verify_incoming is enabled. This can also be specified via the CONSUL_CLIENT_CERT environment variable.

• -client-key=<value> - Path to a client key file to use for TLS when verify_incoming is enabled. This can also be specified via the CONSUL_CLIENT_KEY environment variable.

• -http-addr=<addr> - Address of the Consul agent with the port. This can be an IP address or DNS address, but it must include the port. This can also be specified via the CONSUL_HTTP_ADDR environment variable. In Consul 0.8 and later, the default value is http://127.0.0.1:8500, and https can optionally be used instead. The scheme can also be set to HTTPS by setting the environment variable CONSUL_HTTP_SSL=true. This may be a unix domain socket using unix:///path/to/socket if the agent is configured to listen that way.

• -tls-server-name=<value> - The server name to use as the SNI host when connecting via TLS. This can also be specified via the CONSUL_TLS_SERVER_NAME environment variable.

• -token=<value> - ACL token to use in the request. This can also be specified via the CONSUL_HTTP_TOKEN environment variable. If unspecified, the query will default to the token of the Consul agent at the HTTP address.

• -token-file=<value> - File containing the ACL token to use in the request instead of one specified via the -token argument or CONSUL_HTTP_TOKEN environment variable. This can also be specified via the CONSUL_HTTP_TOKEN_FILE environment variable.

Enterprise Options

• -namespace=<string> - Specifies the namespace to query. If not provided, the namespace will be inferred from the request's ACL token, or will default to the default namespace. Namespaces are a Consul Enterprise feature added in v1.7.0.

• -partition=<string> - Specifies the partition to query. If not provided, the partition will be inferred from the request's ACL token, or will default to the default partition. Partitions are a Consul Enterprise feature added in v1.11.0.

Config Write Options

• -cas - Specifies to use a Check-And-Set operation. If the index is 0, Consul will only store the entry if it does not already exist. If the index is non-zero, the entry is only set if the current index matches the ModifyIndex of that entry.

Examples

From file:

$ consul config write web-defaults.json

From stdin:

$ consul config write -

Config Entry examples

All config entries must have a Kind when registered. See Service Mesh - Config Entries for the list of supported config entries.

Service defaults

Service defaults control default global values for a service, such as the protocol and Connect fields.

{
  "Kind": "service-defaults",
  "Name": "web",
  "Protocol": "http"
}

• Name - Sets the name of the config entry. For service defaults, this must be the name of the service being configured.

• Protocol - Sets the protocol of the service. This is used by Connect proxies for things like observability features.

• Connect - This block contains Connect-related fields for the service.

  • SidecarProxy - Sets whether or not instances of this service should get a sidecar proxy by default.

Proxy defaults

Proxy defaults allow for configuring global config defaults across all services for Connect proxy config. Currently, only one global entry is supported.

{
  "Kind": "proxy-defaults",
  "Name": "global",
  "Config": {
    "foo": 1
  }
}

• Name - Sets the name of the config entry. Currently, only a single proxy-defaults entry with the name global is supported.

• Config - An arbitrary map of configuration values used by Connect proxies.