consul_kv - Fetch metadata from a Consul key value store.¶

New in version 1.9.

Synopsis
- Requirements
Parameters
Examples
Return Values
Status
- Author

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 http://python-consul.readthedocs.org/en/latest/#installation

Parameters ¶

Parameter	Choices/Defaults	Configuration	Comments
_raw required			List of key(s) to retrieve.
host	Default: localhost	env:ANSIBLE_CONSUL_URL	The target to connect to, must be a resolvable address.
index			If the key has a value with the specified index then this is returned allowing access to historical values.
port	Default: 8500		The port of the target host to connect to.
recurse	Default: no		If true, will retrieve all the values that have the given key as prefix.
token			The acl token to allow access to restricted values.

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:

Key	Returned	Description
_raw		Value(s) stored in consul.

Status ¶

Author ¶

UNKNOWN

Hint

If you notice any issues in this documentation you can edit this document to improve it.