consul_kv – Fetch metadata from a Consul key value store

• Synopsis
• Requirements
• Parameters
• Examples
• Return Values
• Status

Synopsis

• Lookup metadata for a playbook from the key value store in a Consul cluster. Values can be easily set in the kv store with simple rest commands
• curl -X PUT -d 'some-value' http://localhost:8500/v1/kv/ansible/somedata

Requirements

The below requirements are needed on the local master node that executes this lookup.

• python-consul python library https://python-consul.readthedocs.io/en/latest/#installation

Parameters

Examples

- debug:
    msg: 'key contains {{item}}'
  with_consul_kv:
    - 'key/to/retrieve'

- name: Parameters can be provided after the key be more specific about what to retrieve
  debug:
    msg: 'key contains {{item}}'
  with_consul_kv:
    - 'key/to recurse=true token=E6C060A9-26FB-407A-B83E-12DDAFCB4D98'

- name: retrieving a KV from a remote cluster on non default port
  debug:
    msg: "{{ lookup('consul_kv', 'my/key', host='10.10.10.10', port='2000') }}"

Return Values

Common return values are documented here, the following are the fields unique to this lookup:

Status

• This lookup is not guaranteed to have a backwards compatible interface. [preview]
• This lookup is maintained by the Ansible Community. [community]

Authors

• UNKNOWN