renew_vault_certificates/README.md

46 lines
1.5 KiB
Markdown
Raw Normal View History

2023-04-16 20:26:14 +00:00
Renew vault certificates
=========
> This repository is only a mirror. Development and testing is done on a private gitlab server.
2023-04-16 19:12:43 +00:00
2023-04-16 20:26:14 +00:00
This role install consul-template and configure a service to automate renewal of TLS certificates for Hashicorp Vault on **debian-based** distributions.
2023-04-16 19:12:43 +00:00
2023-04-16 20:26:14 +00:00
Requirements
------------
2023-04-16 19:12:43 +00:00
2023-04-16 20:26:14 +00:00
None.
2023-04-16 19:12:43 +00:00
2023-04-16 20:26:14 +00:00
Role Variables
--------------
Available variables are listed below, along with default values. A sample file for the default values is available in `default/hashicorp_vault.yml.sample` in case you need it for any `group_vars` or `host_vars` configuration.
2023-04-16 19:12:43 +00:00
2023-04-16 20:26:14 +00:00
```yaml
hashi_vault_install: true # by default, set to true
2023-04-16 19:12:43 +00:00
```
2023-04-16 20:26:14 +00:00
This variable defines if the vault package is to be installed or not before configuring. If you install vault using another task, you can set this to `false`.
2023-04-16 19:12:43 +00:00
2023-04-16 20:26:14 +00:00
Dependencies
------------
2023-04-16 19:12:43 +00:00
2023-04-16 20:26:14 +00:00
This role has a task that installs its own dependencies located in `task/prerequisites.yml`, so that you don't need to manage them. This role requires both `ednxzu.manage_repositories` and `ednxzu.manage_apt_packages` to install vault.
2023-04-16 19:12:43 +00:00
2023-04-16 20:26:14 +00:00
Example Playbook
----------------
2023-04-16 19:12:43 +00:00
2023-04-16 20:26:14 +00:00
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
```yaml
# calling the role inside a playbook with either the default or group_vars/host_vars
- hosts: servers
roles:
- ednxzu.hashicorp_vault
```
2023-04-16 19:12:43 +00:00
2023-04-16 20:26:14 +00:00
License
-------
2023-04-16 19:12:43 +00:00
2023-04-16 20:26:14 +00:00
MIT / BSD
2023-04-16 19:12:43 +00:00
2023-04-16 20:26:14 +00:00
Author Information
------------------
2023-04-16 19:12:43 +00:00
2023-04-16 20:26:14 +00:00
This role was created by Bertrand Lanson in 2023.