open-consul/website/pages/docs/commands/config/write.mdx

92 lines
2.1 KiB
Plaintext
Raw Normal View History

---
2020-04-07 18:55:19 +00:00
layout: docs
page_title: 'Commands: Config Write'
sidebar_title: write
---
# Consul Config Write
Command: `consul config write`
The `config write` command creates or updates a centralized config entry.
2020-04-09 23:46:54 +00:00
See the [configuration entries docs](/docs/agent/config_entries) for more
details about configuration entries.
## Usage
Usage: `consul config write [options] FILE`
#### API Options
2020-04-07 18:55:19 +00:00
@include 'http_api_options_client.mdx'
#### Enterprise Options
2020-04-07 18:55:19 +00:00
@include 'http_api_namespace_options.mdx'
#### Config Write Options
2020-04-07 18:55:19 +00:00
- `-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. Currently, the only
supported types are `service-defaults` and `proxy-defaults`.
#### Service defaults
Service defaults control default global values for a service, such as the
protocol and Connect fields.
```json
{
2020-04-07 18:55:19 +00:00
"Kind": "service-defaults",
"Name": "web",
"Protocol": "http"
}
```
2020-04-07 18:55:19 +00:00
- `Name` - Sets the name of the config entry. For service defaults, this must be
the name of the service being configured.
2020-04-07 18:55:19 +00:00
- `Protocol` - Sets the protocol of the service. This is used by Connect proxies
for things like observability features.
2020-04-07 18:55:19 +00:00
- `Connect` - This block contains Connect-related fields for the service.
2020-04-07 18:55:19 +00:00
- `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.
```json
{
2020-04-07 18:55:19 +00:00
"Kind": "proxy-defaults",
"Name": "global",
"Config": {
"foo": 1
}
}
```
2020-04-07 18:55:19 +00:00
- `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.