Julien Riou
1c513981ac
All checks were successful
/ ansible-docsmith (push) Successful in 19s
Signed-off-by: Julien Riou <julien@riou.xyz>
77 lines
1.6 KiB
Markdown
77 lines
1.6 KiB
Markdown
# Ansible Role Certbot
|
|
|
|
## Table of content
|
|
|
|
<!-- ANSIBLE DOCSMITH TOC START -->
|
|
* [Role variables](#variables)
|
|
* [`certbot_email`](#variable-certbot_email)
|
|
* [`certbot_domain`](#variable-certbot_domain)
|
|
* [`certbot_molecule`](#variable-certbot_molecule)
|
|
<!-- ANSIBLE DOCSMITH TOC END -->
|
|
|
|
<!-- ANSIBLE DOCSMITH MAIN START -->
|
|
|
|
## Role variables<a id="variables"></a>
|
|
|
|
The following variables can be configured for this role:
|
|
|
|
| Variable | Type | Required | Default | Description (abstract) |
|
|
|----------|------|----------|---------|------------------------|
|
|
| `certbot_email` | `str` | Yes | N/A | E-mail to register the certificate. |
|
|
| `certbot_domain` | `str` | Yes | N/A | Domain name to register the certificate. |
|
|
| `certbot_molecule` | `bool` | No | `false` | Run the role with Ansible Molecule.<br><br>Disable cert generation in the CI. |
|
|
|
|
### `certbot_email`<a id="variable-certbot_email"></a>
|
|
|
|
[*⇑ Back to ToC ⇑*](#toc)
|
|
|
|
E-mail to register the certificate.
|
|
|
|
- **Type**: `str`
|
|
- **Required**: Yes
|
|
|
|
|
|
|
|
### `certbot_domain`<a id="variable-certbot_domain"></a>
|
|
|
|
[*⇑ Back to ToC ⇑*](#toc)
|
|
|
|
Domain name to register the certificate.
|
|
|
|
- **Type**: `str`
|
|
- **Required**: Yes
|
|
|
|
|
|
|
|
### `certbot_molecule`<a id="variable-certbot_molecule"></a>
|
|
|
|
[*⇑ Back to ToC ⇑*](#toc)
|
|
|
|
Run the role with Ansible Molecule.
|
|
|
|
Disable cert generation in the CI.
|
|
|
|
- **Type**: `bool`
|
|
- **Required**: No
|
|
- **Default**: `false`
|
|
|
|
|
|
|
|
|
|
<!-- ANSIBLE DOCSMITH MAIN END -->
|
|
|
|
## Usage
|
|
|
|
Playbook example:
|
|
|
|
```yaml
|
|
- hosts: all
|
|
roles:
|
|
- jriou.general.certbot
|
|
```
|
|
|
|
Then run the playbook:
|
|
|
|
```
|
|
ansible-playbook play.yml
|
|
```
|