https://github.com/robertdebock/ansible-role-vault_snapshot
Configure vault_snapshot on Vault.
https://github.com/robertdebock/ansible-role-vault_snapshot
ansible molecule playbook security snapshot tox vaultsnapshot
Last synced: 5 months ago
JSON representation
Configure vault_snapshot on Vault.
- Host: GitHub
- URL: https://github.com/robertdebock/ansible-role-vault_snapshot
- Owner: robertdebock
- License: apache-2.0
- Created: 2023-02-18T07:12:03.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-11-03T05:44:36.000Z (8 months ago)
- Last Synced: 2025-11-03T07:17:46.295Z (8 months ago)
- Topics: ansible, molecule, playbook, security, snapshot, tox, vaultsnapshot
- Homepage: https://robertdebock.nl/
- Size: 89.8 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# [Ansible role vault_snapshot](#ansible-role-vault_snapshot)
Configure vault_snapshot on Vault.
|GitHub|GitLab|Downloads|Version|
|------|------|---------|-------|
|[](https://github.com/robertdebock/ansible-role-vault_snapshot/actions)|[](https://gitlab.com/robertdebock-iac/ansible-role-vault_snapshot)|[](https://galaxy.ansible.com/robertdebock/vault_snapshot)|[](https://github.com/robertdebock/ansible-role-vault_snapshot/releases/)|
## [Example Playbook](#example-playbook)
This example is taken from [`molecule/default/converge.yml`](https://github.com/robertdebock/ansible-role-vault_snapshot/blob/master/molecule/default/converge.yml) and is tested on each push, pull request and release.
```yaml
---
- name: Converge
hosts: all
become: true
gather_facts: true
pre_tasks:
- name: Read token from remote machine
ansible.builtin.slurp:
src: /root/.vault-token
register: token_raw
roles:
- role: robertdebock.vault_snapshot
vault_snapshot_token: "{{ token_raw['content'] | b64decode }}"
vault_snapshot_ssl_verify: false
vault_snapshot_schedules:
- name: hourly
interval_seconds: 3600
retain: 24
path_prefix: /opt/vault/snapshots/
storage_type: local
local_max_space: 1073741824
# - name: hourly-aws
# interval_seconds: 3600
# retain: 24
# path_prefix: /hourly
# storage_type: aws-s3
# aws_s3_bucket: my-bucket
# aws_s3_region: eu-central-1
# aws_access_key_id: some_key
# aws_secret_access_key: some_secret
# aws_s3_enable_kms: false
# - name: hourly-azure
# interval_seconds: 3600
# retain: 24
# path_prefix: /hourly/
# storage_type: azure-blob
# azure_container_name: my-blob
# azure_account_name: some_account
# azure_account_key: some_key
```
The machine needs to be prepared. In CI this is done using [`molecule/default/prepare.yml`](https://github.com/robertdebock/ansible-role-vault_snapshot/blob/master/molecule/default/prepare.yml):
```yaml
---
- name: Prepare
hosts: all
become: true
gather_facts: false
roles:
- role: robertdebock.bootstrap
- role: robertdebock.core_dependencies
- role: robertdebock.hashicorp
- role: robertdebock.vault
vault_type: ent
vault_hardening_disable_swap: false
- role: robertdebock.vault_configuration
vault_configuration_license: "{{ lookup('ansible.builtin.env', 'VAULT_LICENSE') }}"
vault_configuration_listener_tcp:
address: "127.0.0.1:8200"
cluster_address: "127.0.0.1:8201"
tls_disable: true
vault_configuration_storage_raft:
path: "/opt/vault/data"
node_id: "{{ ansible_hostname }}"
tasks:
- name: Flush handlers
ansible.builtin.meta: flush_handlers
- name: Start Vault
ansible.builtin.service:
name: vault
state: started
- name: Initialize Vault
ansible.builtin.command:
cmd: vault operator init -format=yaml
register: vault_init_raw
environment:
VAULT_ADDR: "https://localhost:8200"
VAULT_SKIP_VERIFY: "true"
changed_when: true
- name: Store vault_init_raw output as YAML
ansible.builtin.set_fact:
vault_init: "{{ vault_init_raw.stdout | from_yaml }}"
- name: Store root_token
ansible.builtin.copy:
content: "{{ vault_init.root_token }}"
dest: /root/.vault-token
owner: root
group: root
mode: "0640"
- name: Unseal Vault
ansible.builtin.command:
cmd: vault operator unseal {{ item }}
loop: "{{ vault_init.unseal_keys_b64 }}"
environment:
VAULT_ADDR: "https://localhost:8200"
VAULT_SKIP_VERIFY: "true"
changed_when: true
no_log: true
```
Also see a [full explanation and example](https://robertdebock.nl/how-to-use-these-roles.html) on how to use these roles.
## [Role Variables](#role-variables)
The default values for the variables are set in [`defaults/main.yml`](https://github.com/robertdebock/ansible-role-vault_snapshot/blob/master/defaults/main.yml):
```yaml
---
# defaults file for vault_snapshot
# Set the vault instance address. Similar to `VAULT_ADDR`.
vault_snapshot_address: "https://localhost:8200"
# Set a token to connect to Vault. Similar to `VAULT_TOKEN`.
vault_snapshot_token: ""
# A list of snapshots to configure. Please have look in `molecule/default/converge.yml` for a complete example.
vault_snapshot_schedules: []
# Should SSL certificate verification be disabled?
vault_snapshot_ssl_verify: true
```
## [Requirements](#requirements)
- pip packages listed in [requirements.txt](https://github.com/robertdebock/ansible-role-vault_snapshot/blob/master/requirements.txt).
## [State of used roles](#state-of-used-roles)
The following roles are used to prepare a system. You can prepare your system in another way.
| Requirement | GitHub | GitLab |
|-------------|--------|--------|
|[robertdebock.bootstrap](https://galaxy.ansible.com/robertdebock/bootstrap)|[](https://github.com/robertdebock/ansible-role-bootstrap/actions)|[](https://gitlab.com/robertdebock-iac/ansible-role-bootstrap)|
|[robertdebock.core_dependencies](https://galaxy.ansible.com/robertdebock/core_dependencies)|[](https://github.com/robertdebock/ansible-role-core_dependencies/actions)|[](https://gitlab.com/robertdebock-iac/ansible-role-core_dependencies)|
|[robertdebock.hashicorp](https://galaxy.ansible.com/robertdebock/hashicorp)|[](https://github.com/robertdebock/ansible-role-hashicorp/actions)|[](https://gitlab.com/robertdebock-iac/ansible-role-hashicorp)|
|[robertdebock.vault](https://galaxy.ansible.com/robertdebock/vault)|[](https://github.com/robertdebock/ansible-role-vault/actions)|[](https://gitlab.com/robertdebock-iac/ansible-role-vault)|
|[robertdebock.vault_configuration](https://galaxy.ansible.com/robertdebock/vault_configuration)|[](https://github.com/robertdebock/ansible-role-vault_configuration/actions)|[](https://gitlab.com/robertdebock-iac/ansible-role-vault_configuration)|
## [Context](#context)
This role is part of many compatible roles. Have a look at [the documentation of these roles](https://robertdebock.nl/) for further information.
Here is an overview of related roles:
## [Compatibility](#compatibility)
This role has been tested on these [container images](https://hub.docker.com/u/robertdebock):
|container|tags|
|---------|----|
|[Debian](https://hub.docker.com/r/robertdebock/debian)|all|
|[EL](https://hub.docker.com/r/robertdebock/enterpriselinux)|9|
|[Fedora](https://hub.docker.com/r/robertdebock/fedora)|all|
|[Ubuntu](https://hub.docker.com/r/robertdebock/ubuntu)|noble, jammy|
The minimum version of Ansible required is 2.12, tests have been done on:
- The previous version.
- The current version.
- The development version.
If you find issues, please register them on [GitHub](https://github.com/robertdebock/ansible-role-vault_snapshot/issues).
## [License](#license)
[Apache-2.0](https://github.com/robertdebock/ansible-role-vault_snapshot/blob/master/LICENSE).
## [Author Information](#author-information)
[robertdebock](https://robertdebock.nl/)
Please consider [sponsoring me](https://github.com/sponsors/robertdebock).