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 developed for the [gostint](https://goethite.github.io/gostint/)
project.

## Installation

```bash
sudo pip install hashivault-vars
```

## Enable in Ansible
Symlink from ansible's vars plugins folder to `hashivault_vars.py`, e.g.:
```bash
$ cd /usr/local/lib/python2.7/dist-packages/ansible/plugins/vars
$ sudo ln -s /usr/local/lib/python2.7/dist-packages/hashivault_vars/hashivault_vars.py .
```

On Alpine Linux:
```bash
pip install hvac hashivault-vars && \
ln -s /usr/lib/python2.7/site-packages/hashivault_vars/hashivault_vars.py \
/usr/lib/python2.7/site-packages/ansible/plugins/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/example.com`
* `/secret/ansible/{connection}/hosts/hosta.example.com`

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
```bash
$ ./setup.py sdist bdist_wheel
$ twine upload dist/*
```


Project details


Download files

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

Source Distribution

hashivault_vars-0.1.15.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

hashivault_vars-0.1.15-py2-none-any.whl (6.8 kB view details)

Uploaded Python 2

File details

Details for the file hashivault_vars-0.1.15.tar.gz.

File metadata

  • Download URL: hashivault_vars-0.1.15.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/2.7.15rc1

File hashes

Hashes for hashivault_vars-0.1.15.tar.gz
Algorithm Hash digest
SHA256 407eada8801dc71b5b91d73425b9b449ab30437ba48ebc6b39030bc5570be8af
MD5 82d4bde74e3df3b6f021c17368962954
BLAKE2b-256 eb3b6b002ec8d1e0c5e0bc6edee0897d983357ddcac72819f6d42458c04998dc

See more details on using hashes here.

File details

Details for the file hashivault_vars-0.1.15-py2-none-any.whl.

File metadata

  • Download URL: hashivault_vars-0.1.15-py2-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/2.7.15rc1

File hashes

Hashes for hashivault_vars-0.1.15-py2-none-any.whl
Algorithm Hash digest
SHA256 884bb783250bac2cf1c787c8b5f66152d26b863478044f2885e5ba68bd8deec7
MD5 64d7189cbf997dccb18bef9761b176ba
BLAKE2b-256 6e63cca70a40e6ed6fcede2456378f9e2a0369302947dd9315490b198db93831

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page