Sentinel for KV ACL Policy Enforcement
This feature requires Consul Enterprise(opens in new tab).
Consul 1.0 adds integration with Sentinel for policy enforcement. Sentinel policies help extend the ACL system in Consul beyond the static "read", "write", and "deny" policies to support full conditional logic and integration with external systems.
Sentinel in Consul
Sentinel policies are applied during writes to the KV Store.
An optional sentinel
field specifying code and enforcement level can be added to ACL policy definitions for Consul KV. The following policy ensures that the value written during a KV update must end with "dc1".
If the enforcementlevel
property is not set, it defaults to "hard-mandatory".
Imports
Consul imports all the standard imports from Sentinel except http
. All functions in these imports are available to be used in policies.
Injected Variables
Consul passes some context as variables into Sentinel, which are available to use inside any policies you write.
Variables injected during KV store writes
Variable Name | Type | Description |
---|---|---|
key | string | Key being written |
value | string | Value being written |
flags | uint64 | Flags |
Sentinel Examples
The following are two examples of ACL policies with Sentinel rules.
Required Key Suffix
Restricted Update Time