Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ansible-community/ansible-vault
:key: Ansible role for Hashicorp Vault
https://github.com/ansible-community/ansible-vault
ansible-role consul devops hacktoberfest hashicorp vagrant vault vault-enterprise vault-hsm vault-key vault-tls virtualbox
Last synced: 4 days ago
JSON representation
:key: Ansible role for Hashicorp Vault
- Host: GitHub
- URL: https://github.com/ansible-community/ansible-vault
- Owner: ansible-community
- License: bsd-2-clause
- Created: 2016-10-14T03:42:58.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-12-15T00:42:01.000Z (about 1 month ago)
- Last Synced: 2025-01-10T21:03:44.293Z (11 days ago)
- Topics: ansible-role, consul, devops, hacktoberfest, hashicorp, vagrant, vault, vault-enterprise, vault-hsm, vault-key, vault-tls, virtualbox
- Language: Jinja
- Homepage:
- Size: 671 KB
- Stars: 372
- Watchers: 13
- Forks: 192
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Ansible role to install Hashicorp Vault
[](https://github.com/ansible-community/ansible-vault/actions/workflows/ansible-lint.yml?query=branch%3Amaster)
[](https://github.com/ansible-community/ansible-vault/actions/workflows/molecule.yml?query=branch%3Amaster)
[](http://isitmaintained.com/project/ansible-community/ansible-vault "Average time to resolve an issue")
[](http://isitmaintained.com/project/ansible-community/ansible-vault "Percentage of issues still open")
This Ansible role performs a basic [Vault](https://vaultproject.io/)
installation, including filesystem structure and example configuration.
It can also bootstrap a minimal development or evaluation server or HA
Consul-backed cluster in a Vagrant based environment. See
[README_VAGRANT.md](https://github.com/ansible-community/ansible-vault/blob/master/examples/README_VAGRANT.md) and the associated [Vagrantfile](https://github.com/ansible-community/ansible-vault/blob/master/examples/Vagrantfile) for more details about the developer mode setup.
## Installation
This role resides on GitHub pending the integration with Ansible Galaxy. To install this role create a `roles/requirements.yml` file in your Ansible project folder with the following contents:
```yaml
- src: https://github.com/ansible-community/ansible-vault.git
name: ansible-community.ansible-vault
scm: git
version: master
```
You can use git tag in the version attribute. Also you can honor its legacy `name: brianshumate.ansible-vault`.
## Quick Start Guide
Basic installation is possible using the included [`site.yml`](examples/site.yml) playbook:
```
ansible-playbook -i hosts site.yml
```
You can also pass variables in using the `--extra-vars` option to the
`ansible-playbook` command:
```
ansible-playbook -i hosts site.yml --extra-vars "vault_datacenter=maui"
```
Specify a template file with a different backend definition
(see `templates/backend_consul.j2`):
```
ansible-playbook -i hosts site.yml --extra-vars "vault_backend_file=backend_file.j2"
```
You need to make sure that the template file `backend_file.j2` is in the
role directory for this to work.
## Requirements
This role requires Archlinux, AmazonLinux, FreeBSD, Debian or a RHEL based Linux distribution. It
might work with other software versions, but does work with the following
specific software and versions. Sorry, there is no planned support at the moment for Windows.
See the [molecule scenarios](https://github.com/ansible-community/ansible-vault/tree/master/molecule)
for currently tested distributions.
## Warning
By default, this role may restart `vault` service when played (when there's a
configuration change, OS Packages installed/updated)
When there's no auto-unseal setup on your cluster, the restart may lead to a
situation where all Vault instances will be sealed and your cluster will be
down.
To avoid this situation, the service restart by the playbook can be disabled
by using the `vault_service_restart` role variable.
Setting this `vault_service_restart` to `false` will disable the `vault`
service restart by the playbook. You may have to restart the service manually
to load any new configuration deployed.
## [Role Variables](role_variables.md)
## Misc
### [Vault Release Scheme](vault_releases.md)
## License
BSD-2-Clause
## Author Information
[Brian Shumate](http://brianshumate.com)
## Contributors
Special thanks to the folks listed in [CONTRIBUTORS.md](https://github.com/brianshumate/ansible-vault/blob/master/CONTRIBUTORS.md) for their
contributions to this project.