Skip to main content

Ansible Vars Plugin for Hashicorp Vault

Project description

Ansible Vars Plugin for Hashicorp Vault

An Ansible Vars Plugin for Hashicorp Vault to lookup credentials/secrets, injecting these into the playbook run (e.g. ansible_user, ansible_password, etc).

Use Hashicorp Vault like you would ansible-vault'ed group_vars, domain_vars [a new concept in this module!] and host_vars.

This module was originaly developed for the gostint project.


  • Ansible
  • You may need pip install urllib3
  • pip install hvac


sudo pip install hashivault-vars

Enable in Ansible

In ansible.cfg:

vars_plugins = /usr/local/lib/python2.7/dist-packages/hashivault_vars

Or, symlink from ansible's vars plugins folder to, e.g.:

$ cd /usr/local/lib/python2.7/dist-packages/ansible/plugins/vars
$ sudo ln -s /usr/local/lib/python2.7/dist-packages/hashivault_vars/ .

On Alpine Linux:

pip install hvac hashivault-vars && \
ln -s /usr/lib/python2.7/site-packages/hashivault_vars/ \

Vault Secret Paths

Root path in vault:

  • /secret/ansible/

Precendence (applied top to bottom, so last takes precendence):

  • Groups:

    • /secret/ansible/groups/all
    • /secret/ansible/groups/ungrouped
    • /secret/ansible/groups/your_inv_item_group
    • ...
  • Hosts/Domains:

    • /secret/ansible/{connection}/domains/com
    • /secret/ansible/{connection}/domains/
    • /secret/ansible/{connection}/hosts/

where {connection} is ansible_connection, e.g.: "ssh", "winrm", ... (this plugin attempts to make assumptions where ansible_connection is not set)

All values retrieved from these paths are mapped as ansible variables, e.g. ansible_user, ansible_password, etc.

The layered lookups are merged, with the last taking precendence over earlier lookups.

Lookups to the vault are cached for the run.

Developer Notes

Enable Debugging

(danger, will reveal retrieved vault secrets in the ansible log)

Set environment variable HASHIVAULT_VARS_DEBUG=1.

Release to PyPi

From vagrant (pip prereqs are required), e.g.:

$ ./ sdist bdist_wheel
$ twine upload dist/hashivault_vars-0.1.17*

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for hashivault-vars, version 0.1.19
Filename, size File type Python version Upload date Hashes
Filename, size hashivault_vars-0.1.19-py2-none-any.whl (6.0 kB) File type Wheel Python version py2 Upload date Hashes View hashes
Filename, size hashivault_vars-0.1.19.tar.gz (5.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page