Reference
Consul KV
Cluster key-value entries with compare-and-set writes.
Cluster key-value entries with compare-and-set writes.
Connection
| What | This provider |
|---|---|
| Vendor | HashiCorp |
| Key | consul-kv |
| Availability | available. You can connect it today. |
| Credential we hold | consul-token |
| Values read back | yes |
| Activation | immediate |
Directions
| Direction | What it does |
|---|---|
import | We read names and values out of the store into your environment. |
export | We write names and values from your environment into the store. |
Activation
immediate. The running app sees a new value at once.
Conflict policies
| Direction | Policies you can pick |
|---|---|
import | skip_existing, new_version, fail |
export | create_only, overwrite, overwrite_and_prune |
How syncs work says what each one does.
Connect
Paste a credential from the vendor. We seal it and never show it again.
| Field | Label | Kind | Required | What it is |
|---|---|---|---|---|
token | ACL token | secret; we mask it here and seal it | yes | Needs key:read on the prefix, and key:write to export. |
Connection fields
You set these when you connect. Every mapping on the connection shares them.
| Field | Label | Kind | Required | Advanced | What it is |
|---|---|---|---|---|---|
address | Consul address | text | yes | no | Must be reachable from the internet. We refuse a loopback or private cluster address. |
datacenter | Datacenter | text | no | yes | Leave empty to use the agent's own datacenter. |
namespace | Namespace | text | no | yes | Enterprise only. |
partition | Admin partition | text | no | yes | Enterprise only. |
Mapping fields
You answer these once per environment you map.
| Field | Label | Kind | Required | Advanced | What it is |
|---|---|---|---|---|---|
pathPrefix | Key prefix | text | yes | no | A sync owns one prefix. Pruning deletes every key under it, including ones this sync did not write. |
Required permissions
We probe for these when we verify the connection.
| Permission | Directions | Blocking | Without it |
|---|---|---|---|
key:read | every direction | yes | Preview cannot list the keys under the prefix. |
key:write | export | yes | Export cannot write or remove a key. |