Docs
Reference

Consul KV

Cluster key-value entries with compare-and-set writes.

Cluster key-value entries with compare-and-set writes.

The connection

WhatThis provider
VendorHashiCorp
Keyconsul-kv
Availabilityavailable. You can connect it today.
Credential penv holdsconsul-token
Values read backyes
Activationimmediate

What it moves

DirectionWhat it does
importReads names and values out of the store into penv.
exportWrites 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

DirectionPolicies you can pick
importskip_existing, new_version, fail
exportcreate_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.

FieldLabelKindRequiredWhat it is
tokenACL tokensecret, masked here and sealedyesNeeds 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.

FieldLabelKindRequiredAdvancedWhat it is
addressConsul addresstextyesnoMust be reachable from the internet. A loopback or private cluster address is refused.
datacenterDatacentertextnoyesLeave empty to use the agent's own datacenter.
namespaceNamespacetextnoyesEnterprise only.
partitionAdmin partitiontextnoyesEnterprise only.

What a mapping asks for

Answered once per environment you map.

FieldLabelKindRequiredAdvancedWhat it is
pathPrefixKey prefixtextyesnoA 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.

PermissionDirectionsBlockingWithout it
key:readevery directionyesPreview cannot list the keys under the prefix.
key:writeexportyesExport cannot write or remove a key.