import_vault_root_ca/README.md

52 lines
1.5 KiB
Markdown
Raw Normal View History

import_vault_root_ca
2023-05-21 18:12:26 +00:00
=========
2023-07-11 20:52:44 +00:00
> This repository is only a mirror. Development and testing is done on a private gitea server.
2023-05-21 18:01:00 +00:00
2023-05-21 18:12:26 +00:00
This role imports root CA certificates from Vault to the trust store on **debian-based** distributions.
2023-05-21 18:01:00 +00:00
2023-05-21 18:12:26 +00:00
Requirements
------------
2023-05-21 18:01:00 +00:00
2023-05-21 18:12:26 +00:00
None.
2023-05-21 18:01:00 +00:00
2023-05-21 18:12:26 +00:00
Role Variables
--------------
2023-05-22 20:22:11 +00:00
Available variables are listed below, along with default values. A sample file for the default values is available in `default/import_vault_root_ca.yml.sample` in case you need it for any `group_vars` or `host_vars` configuration.
```yaml
2023-05-24 21:00:18 +00:00
import_vault_root_ca_certificate_force_download: false # by default, set to false
```
This variable defines whether the role should always download the provided certificate even if it already exists. This can be useful if you want to replace an existing CA, but note that **it breaks idempotence**.
2023-05-24 21:00:18 +00:00
```yaml
import_vault_root_ca_certificate_list: [] # by default, set to an empty dict
2023-05-22 20:22:11 +00:00
- url: <someurl>
cert_name: <name_of_ca>
```
This variable defines which CA certificate to install on the machine, it is only tested with CA from Hashicorp Vault pki engine, but should work with any CA that can be downloaded from a webserver.
2023-05-21 18:01:00 +00:00
2023-05-21 18:12:26 +00:00
Dependencies
------------
2023-05-21 18:01:00 +00:00
2024-02-05 21:57:10 +00:00
`ednz_cloud.manage_apt_packages` to install consul-template.
2023-05-21 18:01:00 +00:00
2023-05-21 18:12:26 +00:00
Example Playbook
----------------
2023-05-21 18:01:00 +00:00
2023-05-21 18:12:26 +00:00
```yaml
# calling the role inside a playbook with either the default or group_vars/host_vars
- hosts: servers
roles:
2024-02-05 21:57:10 +00:00
- ednz_cloud.import_vault_root_ca
2023-05-21 18:01:00 +00:00
```
2023-05-21 18:12:26 +00:00
License
-------
2023-05-21 18:01:00 +00:00
2023-05-21 18:12:26 +00:00
MIT / BSD
2023-05-21 18:01:00 +00:00
2023-05-21 18:12:26 +00:00
Author Information
------------------
2023-05-21 18:01:00 +00:00
2023-05-21 18:12:26 +00:00
This role was created by Bertrand Lanson in 2023.