consul_policy

March 19, 2026 ยท View on GitHub

Manages Consul ACL policies using the Diplomat gem.

Actions

ActionDescription
:createCreates or updates policy (default)
:deleteRemoves the policy

Properties

PropertyTypeDefaultDescription
policy_nameStringnamePolicy name (name property)
urlString'http://localhost:8500'Consul HTTP API URL
auth_tokenStringrequiredAuthentication token
sslHash{}SSL options
descriptionString''Policy description
datacentersArray[]Datacenters scope
rulesString''Policy rules

Examples

Create a policy

consul_policy 'read-only' do
  auth_token 'master-token'
  description 'Read-only access'
  rules 'key_prefix "" { policy = "read" }'
end