Penv Cloud
Start free
Docs
Reference

Consul KV

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

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

Connection

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

Directions

DirectionWhat it does
importWe read names and values out of the store into your environment.
exportWe write names and values from your environment into the store.

Activation

immediate. The running app sees a new value at once.

Conflict policies

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

FieldLabelKindRequiredWhat it is
tokenACL tokensecret; we mask it here and seal ityesNeeds 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.

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

Mapping fields

You answer these 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.

Required permissions

We probe for these when we verify the connection.

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