Docs
Reference

Nomad Variables

Path-addressed variables with compare-and-set writes, decrypted on read.

Path-addressed variables with compare-and-set writes, decrypted on read.

The connection

WhatThis provider
VendorHashiCorp
Keynomad-variables
Availabilityavailable. You can connect it today.
Credential penv holdsnomad-token
Values read backyes
Activationon-next-deploy

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

on-next-deploy. A new value waits there and arrives with your next deploy.

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 variables:list, read, write and destroy in this namespace.

What the connection asks for

Fixed when you connect, and shared by every mapping on it.

FieldLabelKindRequiredAdvancedWhat it is
addressNomad addresstextyesnoMust be reachable from the internet for us to write to it.
namespaceNamespacetextnoyesThe ACL token's own namespace, if it is not default. Starts at default.

What a mapping asks for

Answered once per environment you map.

FieldLabelKindRequiredAdvancedWhat it is
pathPrefixPath prefixtextyesnoA sync owns one prefix. One penv secret is one variable path under it, and pruning deletes every path in reach, including ones this sync did not write.

Permissions it needs

penv probes for these when it verifies the connection.

PermissionDirectionsBlockingWithout it
variables:listevery directionyesPreview cannot list the paths under the prefix.
variables:readimportyesImport cannot read a variable's items.
variables:writeexportyesExport cannot create or change a variable.
variables:destroyexportyesThe overwrite_and_prune policy cannot remove a variable.