Reference
Consul KV
Cluster key-value entries with compare-and-set writes.
Cluster key-value entries with compare-and-set writes.
The connection
| What | This provider |
|---|---|
| Vendor | HashiCorp |
| Key | consul-kv |
| Availability | available. You can connect it today. |
| Credential penv holds | consul-token |
| Values read back | yes |
| Activation | immediate |
What it moves
| Direction | What it does |
|---|---|
import | Reads names and values out of the store into penv. |
export | Writes names and values from penv into the store. |
When a written value goes live
immediate. The running app sees a new value at once.
What happens to a name that exists
| 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.
How you connect
You paste a credential you already hold. penv seals it and never shows it again.
| Field | Label | Kind | Required | What it is |
|---|---|---|---|---|
token | ACL token | secret, masked here and sealed | yes | Needs key:read on the prefix, and key:write to export. |
What the connection asks for
Fixed when you connect, and shared by every mapping on it.
| Field | Label | Kind | Required | Advanced | What it is |
|---|---|---|---|---|---|
address | Consul address | text | yes | no | Must be reachable from the internet. A loopback or private cluster address is refused. |
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. |
What a mapping asks for
Answered 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. |
Permissions it needs
penv probes for these when it verifies 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. |