Compare commits

...

129 Commits

Author SHA1 Message Date
Jeff Geerling
1749d0ace0
Merge pull request #230 from Hoeze/master
add --cert-name and --deploy-hook options
2025-03-25 09:19:31 -05:00
Florian R. Hölzlwimmer
d2e42ea198 remove duplicate 'certbot_create_extra_args' introduced in #227 2025-03-25 14:31:01 +01:00
Florian R. Hölzlwimmer
d5a1f4df3c move 'certbot_expand' back to original position in file 2025-03-25 14:27:35 +01:00
Florian R. Hölzlwimmer
de02f52275 Merge remote-tracking branch 'upstream/master' 2025-03-25 14:26:30 +01:00
Jeff Geerling
6ab7f2db23
Merge pull request #227 from almer-t/patch-1
Add missing default for certbot_create_extra_args
2025-03-24 16:11:24 -05:00
Florian R. Hölzlwimmer
32d18724a6 revert debian and ubuntu version changes in CI 2025-03-10 17:09:43 +01:00
Florian R. Hölzlwimmer
11ac393df5 merge upstream/master 2025-03-10 11:29:13 +01:00
Jeff Geerling
1278651f0d Update CI status badges. 2025-01-30 21:24:54 -06:00
Jeff Geerling
3d2fbc6202 Use more modern OS versions for testing. 2025-01-29 22:51:16 -06:00
Jeff Geerling
4f1179392e Don't use sudo inside molecule CI tests. 2025-01-29 21:39:13 -06:00
Florian R. Hölzlwimmer
b3ae28fb77 change certbot_expand default back to false 2025-01-29 15:45:25 +01:00
Florian R. Hölzlwimmer
943abd882d update to debian 11 2025-01-29 14:37:22 +01:00
Florian R. Hölzlwimmer
2fde934223 explicitly determine whether the domain list has changed 2025-01-29 14:22:03 +01:00
Florian R. Hölzlwimmer
851d2b9855 Fix escaping 2025-01-29 13:24:03 +01:00
Florian R. Hölzlwimmer
2d3cf2ad13 fix trailing space 2025-01-29 13:24:03 +01:00
Florian R. Hölzlwimmer
999372cc7e Update tests to include certificate name 2025-01-29 13:24:03 +01:00
Florian R. Hölzlwimmer
811fa11044 add --cert-name and --deploy-hook options 2025-01-29 13:24:03 +01:00
Jeff Geerling
e5bfeaf936 Attempt to get molecule CI tests running again. 2025-01-28 22:23:55 -06:00
Jeff Geerling
9045ec5a59
Merge pull request #208 from theS1LV3R/master
Allow for certificates to be expanded to include new domains
2025-01-28 22:10:40 -06:00
Jeff Geerling
98ea3238ed
Merge pull request #217 from rlenferink/fix-undefined-variable
[BUGFIX] Initialize 'certbot_create_extra_args' variable
2024-12-22 13:18:42 -06:00
Almer
06ca208bb6
Add missing default for certbot_create_extra_args 2024-11-02 11:40:20 +01:00
fliespl
49e18182a7
certbot expand in command 2024-09-20 22:46:37 +02:00
fliespl
48941fe2a0
handle certbot expand in webroot 2024-09-20 22:46:05 +02:00
fliespl
6230e82ba9
handle expand in standalone 2024-09-20 22:45:47 +02:00
fliespl
0b414a9d74
expand variable 2024-09-20 22:44:16 +02:00
Jeff Geerling
78f4cb5ad5 Use CRB not powertools on Alma and Rocky. 2024-07-30 23:24:23 -05:00
Jeff Geerling
d1cbcde4de Fixup CI versions. Drop all older RHEL releases which are broken. 2024-07-16 14:21:11 -05:00
Roy Lenferink
03f4cc3a99 Initialize 'certbot_create_extra_args' variable
This was introduced in 5a23e85f1cebfbc3999d896f25b99a8c2776f808 but no default was added, resulting in a 'undefined variable' error
2024-07-14 11:08:50 +02:00
theS1LV3R
63638f4471
Allow for certificates to be expanded to include new domains 2024-02-09 16:29:19 +01:00
Jeff Geerling
4be771f12a A wee bit of modernization. 2024-01-24 22:00:32 -06:00
Jeff Geerling
de52a1f4c8 Make local dev with molecule a little easier. 2024-01-24 21:48:33 -06:00
Jeff Geerling
cb3b03f435 PR #109 Follow-up: Document new variable inside other variable. 2024-01-04 19:38:53 -06:00
Jeff Geerling
5a23e85f1c
Merge pull request #109 from gagath/rsa-key-size
introduce certbot_create_extra_args (for custom RSA key size)
2024-01-04 19:35:27 -06:00
Jeff Geerling
08543f45b2 Stale bot is now Stale GitHub Action. 2023-07-10 17:47:30 -05:00
Jeff Geerling
84642924df Remove official support for RHEL. Rocky/Alma/Stream support is best-effort. 2023-06-23 10:56:00 -05:00
Jeff Geerling
cfd9655ed0
Merge pull request #192 from fapdash/patch-1
Run hooks only for standalone mode
2023-06-17 22:22:43 -05:00
Jeff Geerling
47203f3b92
Merge pull request #197 from markstos/no-self-upgrade
remove deprecated --no-self-upgrade flag
2023-06-17 22:21:03 -05:00
Jeff Geerling
a3b34ef499
Merge pull request #196 from Kaezon/fix-lint
fixed lint
2023-06-17 22:20:04 -05:00
Mark Stosberg
199f940604 remove deprecated --no-self-upgrade flag
Including it will generate warnings
2023-05-19 17:39:05 -04:00
Brett Costabile
1b04270982 fixed lint 2023-05-09 10:14:27 -04:00
Jeff Geerling
a056da763e Fix Molecule CI workflow since docker plugin has moved. 2023-04-20 17:27:06 -05:00
FAP
2deba31679
Check for both conditions (squash me) 2023-02-20 12:26:44 +01:00
FAP
d30ddd946a
Run hooks only for standalone mode
If the `certbot_create_method` is set to `webroot` the `stop_services` and `start_services` hook shouldn't be run.
2023-02-01 15:13:09 +01:00
Jeff Geerling
3d55be0a54 Fix Molecule CI workflow for Ubuntu 22.04 GitHub Actions. 2022-12-06 18:23:34 -06:00
Jeff Geerling
3f133ad7ab Remove deprecated warn arg from command and shell module invocations. 2022-11-26 22:51:08 -06:00
Jeff Geerling
c6297ddebb Add role_name_check skipping to all molecule test suites. 2022-06-01 22:20:31 -05:00
Romain Porte
3fcd4e0258 introduce certbot_create_extra_args 2022-02-20 07:05:41 +01:00
Jeff Geerling
eb4647ed9c
Merge pull request #166 from tobiashuste/fix-snap-initial-dry-run
Fix snap symlink task failing in initial dry-run
2022-01-19 08:48:29 -06:00
Jeff Geerling
31beafb338 Update release workflow for more consistency. 2021-12-27 11:34:47 -06:00
Tobias Huste
1fc3a76d34 Fix snap symlink task failing in initial dry-run
Due to the certbot package not being really installed on the initial
dry-run the symlink generation fails. The corresponding will be ignored
in check mode.
2021-11-24 11:11:03 +01:00
Jeff Geerling
dd1f8bd22c Tabs to spaces in README. 2021-11-22 10:58:43 -06:00
Jeff Geerling
de4cb90984
Merge pull request #97 from simonspa/webroot
Allow Webroot Certificate Creation
2021-11-22 10:57:37 -06:00
Simon Spannagel
955ec8b17e Update documentation 2021-11-22 07:35:38 +01:00
Simon Spannagel
a9a3ef77a3 Remove old deploy hook method superseded by pre-hook and post-hook methods 2021-11-22 07:27:48 +01:00
Simon Spannagel
e35a5d0fb9 Remove excess whitespace 2021-11-22 07:25:31 +01:00
Simon Spannagel
854a36e048 Rever changes made by linter to github workflow yaml 2021-11-22 07:25:31 +01:00
simonspa
2cad2addcd Update defaults/main.yml
Co-authored-by: Jeff Geerling <geerlingguy@mac.com>
2021-11-22 07:25:31 +01:00
simonspa
52a96f9bde Check for systemd list-unit-files before restarting services
Co-authored-by: Karl M. Davis <karl@justdavis.com>
2021-11-22 07:25:31 +01:00
Simon Spannagel
7a7c1f8b06 Fix linter suggestions 2021-11-22 07:25:31 +01:00
Romain Porte
40c4c1b433 webroot: install hook before creating certificates
The command that will create the certificates need the hook script
ansible.sh to exist before it is run, elsewise an error will occur in
case of first run on a new host.

(cherry picked from commit 2346cd52a262bf2fa89419f29abba0e8ea95cdb7)
2021-11-22 07:25:31 +01:00
Romain Porte
bd58f8e72c optimize renewal-hook creation: run it only once and not per domain 2021-11-22 07:25:31 +01:00
Simon Spannagel
123facdbab Ensure deploy hook directory exists before using 2021-11-22 07:25:31 +01:00
Simon Spannagel
e1013946c5 Webroot: allow to set default webroot path, overwritten by per-cert path 2021-11-22 07:25:31 +01:00
Simon Spannagel
b37af73500 Move webroot definition further down 2021-11-22 07:25:31 +01:00
Simon Spannagel
23447ec217 Fix issue in certificate creation command 2021-11-22 07:25:31 +01:00
Simon Spannagel
50d8921ec2 Create webroot directory if it doesn't exist 2021-11-22 07:25:31 +01:00
simonspa
2e13cb13cf Update default deploy hook
Co-Authored-By: Kieren Evans <kierenevans@users.noreply.github.com>
2021-11-22 07:25:31 +01:00
Simon Spannagel
e669ab0ac4 Replace shell with command module 2021-11-22 07:25:31 +01:00
Simon Spannagel
ca46eab49f Fix linting issues 2021-11-22 07:25:29 +01:00
Simon Spannagel
5f476f829c Add default and document certbot_deployhook 2021-11-22 07:24:33 +01:00
Simon Spannagel
34949a63d9 Document webroot functionality 2021-11-22 07:24:33 +01:00
Simon Spannagel
061509319f Allow specification of different webroots per certificate 2021-11-22 07:24:31 +01:00
Ryan Faircloth
c7e5eec8cc Update create-cert-webroot.yml
Removed debug logging of var as it could have protected information
2021-11-22 07:22:25 +01:00
Ryan Faircloth
23f593aaaf Fixes #39 adding new script for webroot
Fixes #41 support deployhook (webroot only)
Fixes #41 support for test CA
2021-11-22 07:22:15 +01:00
Jeff Geerling
027af9b3b3
Merge pull request #152 from stackbuilders/fix_install_with_snap_debian
[#151] Skip "Enable classic snap support" on Debian
2021-10-25 10:20:54 -05:00
Jeff Geerling
7317dbcabe Fix lint warnings. 2021-10-25 10:19:58 -05:00
Jeff Geerling
5cfcc2d316 Disable source install test on CentOS 7 for now. 2021-10-25 10:04:52 -05:00
Jeff Geerling
aaf3dbd40a
Merge pull request #159 from jivanpal/snapd-start
Ensure snapd is started immediately
2021-10-25 10:04:22 -05:00
Jeff Geerling
96051f08f4
Merge pull request #160 from jivanpal/powertools-for-centos-8.2
Add conditional to handle old name of PowerTools repo for CentOS 8.2.2004 and earlier
2021-10-25 10:03:58 -05:00
Jivan Pal
6647174286 Add conditional to handle old name of PowerTools repo for CentOS 8.2.2004 and earlier 2021-09-18 01:40:09 +01:00
Jivan Pal
3f8533436b Ensure snapd is started immediately 2021-09-17 21:44:35 +01:00
Jeff Geerling
d1d517c5a4 Make sure bugs aren't automatically closed. 2021-08-23 08:52:55 -05:00
Jeff Geerling
7ad49929dd PR #80 touch-up for cosmetic purposes. 2021-05-28 14:49:49 -05:00
Jeff Geerling
6bb2ed6436
Merge pull request #80 from wvh-github/feature/create_pre_and_post_hook
create pre and post hooks
2021-05-28 14:47:32 -05:00
Jeff Geerling
515e8af98b
Update tasks/create-cert-standalone.yml 2021-05-28 14:39:45 -05:00
Jeff Geerling
b17976752c
Update tasks/create-cert-standalone.yml 2021-05-28 14:39:41 -05:00
Sebastián Estrella
02e1e4e148 [#151] Skip "Enable classic snap support" on Debian 2021-04-28 22:05:31 -05:00
Jeff Geerling
fdba1c4352
Merge pull request #142 from geerlingguy/134-snap-install-method
Issue #134: Snap install method.
2021-03-31 11:47:24 -05:00
Jeff Geerling
3c05ff5029 Use bools I guess. 2021-03-31 11:39:22 -05:00
Jeff Geerling
25a661157e Allow failure on snap-based install since containerization makes that hard to test. 2021-03-31 11:25:12 -05:00
Jeff Geerling
e93e175a7e Remove ansible-lint from roles. 2021-03-15 09:26:56 -05:00
Jeff Geerling
e10cfdaedb Make ansible-lint work again. 2021-02-22 16:12:59 -06:00
Jeff Geerling
e34a21f0eb Set certbot_script variable for snap-based install. 2021-02-21 09:03:18 -06:00
Jeff Geerling
4f22d025cd Slight tweak, but it still won't work. 2021-01-19 12:07:46 -06:00
Jeff Geerling
ea88bfa03c Attempt to get snap based install working correctly. 2021-01-19 11:56:58 -06:00
Jeff Geerling
56ba6ad847 Fix syntax error with file module usage. 2021-01-19 11:02:58 -06:00
Jeff Geerling
0ba7078e8c Issue #134: Snap install method. 2021-01-19 10:54:42 -06:00
Jeff Geerling
b96acd79ec Fix a deprecation warning in the Molecule playbook. 2020-12-27 00:17:01 -06:00
Jeff Geerling
9090d7d431
Merge pull request #127 from wzzrd/patch-1
Only enable PowerTools on CentOS
2020-12-27 00:05:59 -06:00
Jeff Geerling
7c66dc3eed
Merge pull request #137 from GuillaumeRemyCSI/patch-1
Fixed issue with PowerTools DNF module
2020-12-27 00:05:52 -06:00
GuillaumeRemyCSI
51ff0b14a3
Fixed issue with PowerTools DNF module
PowerTools has been renamed to powertools on CentOS 8
2020-12-18 15:38:56 +01:00
Jeff Geerling
8006878db7 Drop support for RedHat / CentOS 6. 2020-12-08 17:03:31 -06:00
Jeff Geerling
eb5f51182b Drop CentOS 6 testing. 2020-12-08 16:55:18 -06:00
Jeff Geerling
fe1716eced Fix GitHub Actions workflow syntax for CI. 2020-11-05 09:26:10 -06:00
Jeff Geerling
3624a21c45 Dump Travis CI and move to GitHub Actions. 2020-11-05 09:22:58 -06:00
Jeff Geerling
2bca213421 Switch to travis-ci.com. 2020-10-26 20:08:42 -05:00
Jeff Geerling
f5bbfd2ec7 Make sure docker driver is installed with molecule. 2020-10-15 17:02:21 -05:00
Maxim Burgerhout
a9609e1da6
Only enable PowerTools on CentOS
The PowerTools repo exists only on CentOS, but the current selector ansible_os_family == 'RedHat' also evaluates to true on Fedora and RHEL, making this role fail.

This patch switches the when statement to only evaluate to true if really running on CentOS, which I think was the intention
2020-09-30 08:52:43 +02:00
Jeff Geerling
5ac9b8da7c Ignore the tyranny of ansible-lint rule 106. 2020-08-20 19:19:27 -05:00
Jeff Geerling
50f9134287 Upgrade Travis CI docker version to fix Molecule tests. 2020-08-12 14:52:29 -05:00
Jeff Geerling
b3a886e9ee Ensure galaxy meta information is consistent on all my roles. 2020-05-26 09:43:13 -05:00
Jeff Geerling
09c8986636 Issue #107: PowerTools required to install via package on CentOS 8. 2020-04-20 16:56:03 -05:00
Jeff Geerling
60d805f41b Add probot/stale configuration to repository for stale issues. 2020-03-05 10:41:51 -06:00
Jeff Geerling
6d26c0628d Make sure molecule lint script has set -e option. 2020-02-24 09:42:33 -06:00
Jeff Geerling
b158105fad Fix ansible-lint issue with molecule test playbook. 2020-02-20 16:23:22 -06:00
Jeff Geerling
21462d7da9 Update molecule configuration to work with 3.0. 2020-02-20 15:52:21 -06:00
Jeff Geerling
724a3ed920 Update molecule configuration to work with 3.0. 2020-02-20 14:26:24 -06:00
Jeff Geerling
57702b3544 Update molecule configuration to work with 3.0. 2020-02-20 14:20:25 -06:00
Jeff Geerling
6e17af0ac5 Add CentOS 8 to supported platforms. 2019-12-11 15:51:22 -06:00
Jeff Geerling
7a8b82d139 Remove Ubuntu 14.04 test because it's now broken. Add CentOS 8 and Debian 10. 2019-12-11 15:51:05 -06:00
Jeff Geerling
980c3ea31d YAML syntax fix. 2019-12-11 11:19:15 -06:00
Jeff Geerling
6414a15183
Create FUNDING.yml 2019-12-11 10:01:54 -06:00
Jeff Geerling
a49d4e63a1 Fixes #91: Warnings for ints in string fields in Ansible 2.8.x. 2019-08-26 11:56:43 -05:00
Jeff Geerling
7efc6a50f5 Remove unused tests. 2019-05-16 22:07:42 -05:00
Wout van Heeswijk
8164566c4f
create pre and post hooks
* Move 'stop' services to pre-hook and post-hook. This way they will also be stopped and started when renewing.

- remove service stop/start tasks
- add pre-hook/post-hook templates
- add pre-hook/pos-hook template tasks
- create missing directories at first run
- run pre and post hook during first manual run
2019-04-19 10:30:48 +02:00
Jeff Geerling
00dc226101 Fixes E305 linting error: use shell only when required. 2018-12-06 16:15:09 -06:00
Jeff Geerling
be44ac2dcd Update tests for optimum efficiency. 2018-10-23 10:14:46 -05:00
Jeff Geerling
09b5bd20e9
Merge pull request #63 from adrianmoisey/patch-1
Fix path for example
2018-10-02 22:10:22 -05:00
Adrian Moisey
6b519ffc4d
Fix path for example 2018-10-02 16:29:59 +02:00
25 changed files with 493 additions and 123 deletions

3
.ansible-lint Normal file
View File

@ -0,0 +1,3 @@
skip_list:
- 'yaml'
- 'role-name'

4
.github/FUNDING.yml vendored Normal file
View File

@ -0,0 +1,4 @@
# These are supported funding model platforms
---
github: geerlingguy
patreon: geerlingguy

79
.github/workflows/ci.yml vendored Normal file
View File

@ -0,0 +1,79 @@
---
name: CI
'on':
pull_request:
push:
branches:
- master
schedule:
- cron: "30 2 * * 0"
defaults:
run:
working-directory: 'geerlingguy.certbot'
jobs:
lint:
name: Lint
runs-on: ubuntu-latest
steps:
- name: Check out the codebase.
uses: actions/checkout@v4
with:
path: 'geerlingguy.certbot'
- name: Set up Python 3.
uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Install test dependencies.
run: pip3 install yamllint
- name: Lint code.
run: |
yamllint .
molecule:
name: Molecule
runs-on: ubuntu-latest
strategy:
matrix:
include:
- distro: rockylinux9
playbook: converge.yml
experimental: false
- distro: ubuntu2404
playbook: converge.yml
experimental: false
- distro: debian12
playbook: converge.yml
experimental: false
- distro: rockylinux9
playbook: playbook-snap-install.yml
experimental: true
steps:
- name: Check out the codebase.
uses: actions/checkout@v4
with:
path: 'geerlingguy.certbot'
- name: Set up Python 3.
uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Install test dependencies.
run: pip3 install ansible molecule molecule-plugins[docker] docker
- name: Run Molecule tests.
run: molecule test
continue-on-error: ${{ matrix.experimental }}
env:
PY_COLORS: '1'
ANSIBLE_FORCE_COLOR: '1'
MOLECULE_DISTRO: ${{ matrix.distro }}
MOLECULE_PLAYBOOK: ${{ matrix.playbook }}

40
.github/workflows/release.yml vendored Normal file
View File

@ -0,0 +1,40 @@
---
# This workflow requires a GALAXY_API_KEY secret present in the GitHub
# repository or organization.
#
# See: https://github.com/marketplace/actions/publish-ansible-role-to-galaxy
# See: https://github.com/ansible/galaxy/issues/46
name: Release
'on':
push:
tags:
- '*'
defaults:
run:
working-directory: 'geerlingguy.certbot'
jobs:
release:
name: Release
runs-on: ubuntu-latest
steps:
- name: Check out the codebase.
uses: actions/checkout@v4
with:
path: 'geerlingguy.certbot'
- name: Set up Python 3.
uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Install Ansible.
run: pip3 install ansible-core
- name: Trigger a new import on Galaxy.
run: >-
ansible-galaxy role import --api-key ${{ secrets.GALAXY_API_KEY }}
$(echo ${{ github.repository }} | cut -d/ -f1) $(echo ${{ github.repository }} | cut -d/ -f2)

34
.github/workflows/stale.yml vendored Normal file
View File

@ -0,0 +1,34 @@
---
name: Close inactive issues
'on':
schedule:
- cron: "55 12 * * 1" # semi-random time
jobs:
close-issues:
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
steps:
- uses: actions/stale@v8
with:
days-before-stale: 120
days-before-close: 60
exempt-issue-labels: bug,pinned,security,planned
exempt-pr-labels: bug,pinned,security,planned
stale-issue-label: "stale"
stale-pr-label: "stale"
stale-issue-message: |
This issue has been marked 'stale' due to lack of recent activity. If there is no further activity, the issue will be closed in another 30 days. Thank you for your contribution!
Please read [this blog post](https://www.jeffgeerling.com/blog/2020/enabling-stale-issue-bot-on-my-github-repositories) to see the reasons why I mark issues as stale.
close-issue-message: |
This issue has been closed due to inactivity. If you feel this is in error, please reopen the issue or file a new issue with the relevant details.
stale-pr-message: |
This pr has been marked 'stale' due to lack of recent activity. If there is no further activity, the issue will be closed in another 30 days. Thank you for your contribution!
Please read [this blog post](https://www.jeffgeerling.com/blog/2020/enabling-stale-issue-bot-on-my-github-repositories) to see the reasons why I mark issues as stale.
close-pr-message: |
This pr has been closed due to inactivity. If you feel this is in error, please reopen the issue or file a new issue with the relevant details.
repo-token: ${{ secrets.GITHUB_TOKEN }}

2
.gitignore vendored
View File

@ -1,3 +1,5 @@
*.retry *.retry
*/__pycache__ */__pycache__
*.pyc *.pyc
.cache

View File

@ -1,33 +0,0 @@
---
language: python
services: docker
env:
global:
- ROLE_NAME: certbot
matrix:
- MOLECULE_DISTRO: centos7
MOLECULE_DOCKER_COMMAND: /usr/lib/systemd/systemd
- MOLECULE_DISTRO: centos6
MOLECULE_PLAYBOOK: playbook-source-install.yml
- MOLECULE_DISTRO: ubuntu1604
- MOLECULE_DISTRO: ubuntu1404
MOLECULE_PLAYBOOK: playbook-source-install.yml
- MOLECULE_DISTRO: debian9
install:
# Install test dependencies.
- pip install molecule docker
before_script:
# Use actual Ansible Galaxy role name for the project directory.
- cd ../
- mv ansible-role-$ROLE_NAME geerlingguy.$ROLE_NAME
- cd geerlingguy.$ROLE_NAME
script:
# Run tests.
- molecule test
notifications:
webhooks: https://galaxy.ansible.com/api/v1/notifications/

13
.yamllint Normal file
View File

@ -0,0 +1,13 @@
---
extends: default
rules:
line-length:
max: 180
level: warning
indentation:
spaces: 2
indent-sequences: consistent
ignore: |
.github/workflows/stale.yml

View File

@ -1,6 +1,6 @@
# Ansible Role: Certbot (for Let's Encrypt) # Ansible Role: Certbot (for Let's Encrypt)
[![Build Status](https://travis-ci.org/geerlingguy/ansible-role-certbot.svg?branch=master)](https://travis-ci.org/geerlingguy/ansible-role-certbot) [![CI](https://github.com/geerlingguy/ansible-role-certbot/actions/workflows/ci.yml/badge.svg)](https://github.com/geerlingguy/ansible-role-certbot/actions/workflows/ci.yml)
Installs and configures Certbot (for Let's Encrypt). Installs and configures Certbot (for Let's Encrypt).
@ -12,26 +12,39 @@ Generally, installing from source (see section `Source Installation from Git`) l
## Role Variables ## Role Variables
The variable `certbot_install_from_source` controls whether to install Certbot from Git or package management. The latter is the default, so the variable defaults to `no`. certbot_install_method: package
Controls how Certbot is installed. Available options are 'package', 'snap', and 'source'.
certbot_auto_renew: true certbot_auto_renew: true
certbot_auto_renew_user: "{{ ansible_user | default(lookup('env', 'USER')) }}" certbot_auto_renew_user: "{{ ansible_user | default(lookup('env', 'USER')) }}"
certbot_auto_renew_hour: 3 certbot_auto_renew_hour: "3"
certbot_auto_renew_minute: 30 certbot_auto_renew_minute: "30"
certbot_auto_renew_options: "--quiet --no-self-upgrade" certbot_auto_renew_options: "--quiet"
By default, this role configures a cron job to run under the provided user account at the given hour and minute, every day. The defaults run `certbot renew` (or `certbot-auto renew`) via cron every day at 03:30:00 by the user you use in your Ansible playbook. It's preferred that you set a custom user/hour/minute so the renewal is during a low-traffic period and done by a non-root user account. By default, this role configures a cron job to run under the provided user account at the given hour and minute, every day. The defaults run `certbot renew` (or `certbot-auto renew`) via cron every day at 03:30:00 by the user you use in your Ansible playbook. It's preferred that you set a custom user/hour/minute so the renewal is during a low-traffic period and done by a non-root user account.
### Automatic Certificate Generation ### Automatic Certificate Generation
Currently there is one built-in method for generating new certificates using this role: `standalone`. Other methods (e.g. using nginx or apache and a webroot) may be added in the future. Currently the `standalone` and `webroot` method are supported for generating new certificates using this role.
**For a complete example**: see the fully functional test playbook in [tests/test-standalone-nginx-aws.yml](tests/test-standalone-nginx-aws.yml). **For a complete example**: see the fully functional test playbook in [molecule/default/playbook-standalone-nginx-aws.yml](molecule/default/playbook-standalone-nginx-aws.yml).
certbot_create_if_missing: false certbot_create_if_missing: false
Set `certbot_create_if_missing` to `yes` or `True` to let this role generate certs.
certbot_create_method: standalone certbot_create_method: standalone
Set `certbot_create_if_missing` to `yes` or `True` to let this role generate certs. Set the method used for generating certs with the `certbot_create_method` variable—current allowed values include: `standalone`. Set the method used for generating certs with the `certbot_create_method` variable — current allowed values are: `standalone` or `webroot`.
certbot_testmode: false
Enable test mode to only run a test request without actually creating certificates.
certbot_hsts: false
Enable (HTTP Strict Transport Security) for the certificate generation.
certbot_admin_email: email@example.com certbot_admin_email: email@example.com
@ -39,17 +52,18 @@ The email address used to agree to Let's Encrypt's TOS and subscribe to cert-rel
certbot_certs: [] certbot_certs: []
# - email: janedoe@example.com # - email: janedoe@example.com
# webroot: "/var/www/html"
# domains: # domains:
# - example1.com # - example1.com
# - example2.com # - example2.com
# - domains: # - domains:
# - example3.com # - example3.com
A list of domains (and other data) for which certs should be generated. You can add an `email` key to any list item to override the `certbot_admin_email`. A list of domains (and other data) for which certs should be generated. You can add an `email` key to any list item to override the `certbot_admin_email`. When using the `webroot` creation method, a `webroot` item has to be provided, specifying which directory to use for the authentication. Make sure your webserver correctly delivers contents from this directory.
certbot_create_command: "{{ certbot_script }} certonly --standalone --noninteractive --agree-tos --email {{ cert_item.email | default(certbot_admin_email) }} -d {{ cert_item.domains | join(',') }}" certbot_create_command: "{{ certbot_script }} certonly --standalone --noninteractive --agree-tos --email {{ cert_item.email | default(certbot_admin_email) }} -d {{ cert_item.domains | join(',') }}"
The `certbot_create_command` defines the command used to generate the cert. The `certbot_create_command` defines the command used to generate the cert. See the full default command inside `defaults/main.yml` for a full example—and you can easily add in extra arguments that are not in the default command with the `certbot_create_extra_args` variable.
#### Standalone Certificate Generation #### Standalone Certificate Generation
@ -60,16 +74,27 @@ Services that should be stopped while `certbot` runs it's own standalone server
These services will only be stopped the first time a new cert is generated. These services will only be stopped the first time a new cert is generated.
### Snap Installation
Beginning in December 2020, the Certbot maintainers decided to recommend installing Certbot from Snap rather than maintain scripts like `certbot-auto`.
Setting `certbot_install_method: snap` configures this role to install Certbot via Snap.
This install method is currently experimental and may or may not work across all Linux distributions.
#### Webroot Certificate Generation
When using the `webroot` creation method, a `webroot` item has to be provided for every `certbot_certs` item, specifying which directory to use for the authentication. Also, make sure your webserver correctly delivers contents from this directory.
### Source Installation from Git ### Source Installation from Git
You can install Certbot from it's Git source repository if desired. This might be useful in several cases, but especially when older distributions don't have Certbot packages available (e.g. CentOS < 7, Ubuntu < 16.10 and Debian < 8). You can install Certbot from it's Git source repository if desired with `certbot_install_method: source`. This might be useful in several cases, but especially when older distributions don't have Certbot packages available (e.g. CentOS < 7, Ubuntu < 16.10 and Debian < 8).
certbot_install_from_source: false
certbot_repo: https://github.com/certbot/certbot.git certbot_repo: https://github.com/certbot/certbot.git
certbot_version: master certbot_version: master
certbot_keep_updated: true certbot_keep_updated: true
Certbot Git repository options. To install from source, set `certbot_install_from_source` to `yes`. This clones the configured `certbot_repo`, respecting the `certbot_version` setting. If `certbot_keep_updated` is set to `yes`, the repository is updated every time this role runs. Certbot Git repository options. If installing from source, the configured `certbot_repo` is cloned, respecting the `certbot_version` setting. If `certbot_keep_updated` is set to `yes`, the repository is updated every time this role runs.
certbot_dir: /opt/certbot certbot_dir: /opt/certbot
@ -91,8 +116,8 @@ None.
vars: vars:
certbot_auto_renew_user: your_username_here certbot_auto_renew_user: your_username_here
certbot_auto_renew_minute: 20 certbot_auto_renew_minute: "20"
certbot_auto_renew_hour: 5 certbot_auto_renew_hour: "5"
roles: roles:
- geerlingguy.certbot - geerlingguy.certbot

View File

@ -2,34 +2,66 @@
# Certbot auto-renew cron job configuration (for certificate renewals). # Certbot auto-renew cron job configuration (for certificate renewals).
certbot_auto_renew: true certbot_auto_renew: true
certbot_auto_renew_user: "{{ ansible_user | default(lookup('env', 'USER')) }}" certbot_auto_renew_user: "{{ ansible_user | default(lookup('env', 'USER')) }}"
certbot_auto_renew_hour: 3 certbot_auto_renew_hour: "3"
certbot_auto_renew_minute: 30 certbot_auto_renew_minute: "30"
certbot_auto_renew_options: "--quiet --no-self-upgrade" certbot_auto_renew_options: "--quiet"
certbot_testmode: false
certbot_hsts: false
# Parameters used when creating new Certbot certs. # Parameters used when creating new Certbot certs.
certbot_create_if_missing: false certbot_create_if_missing: false
certbot_create_method: standalone certbot_create_method: standalone
certbot_create_extra_args: ""
certbot_admin_email: email@example.com certbot_admin_email: email@example.com
certbot_expand: false
# Default webroot, overwritten by individual per-cert webroot directories
certbot_webroot: /var/www/letsencrypt
certbot_certs: [] certbot_certs: []
# - email: janedoe@example.com # - name: example.com
# email: janedoe@example.com
# webroot: "/var/www/html/"
# domains: # domains:
# - example1.com # - example1.com
# - example2.com # - example2.com
# - domains: # - domains:
# - example3.com # - example3.com
certbot_create_command: >- certbot_create_command: >-
{{ certbot_script }} certonly --standalone --noninteractive --agree-tos {{ certbot_script }} certonly --{{ certbot_create_method }}
{{ '--hsts' if certbot_hsts else '' }}
{{ '--test-cert' if certbot_testmode else '' }}
--noninteractive --agree-tos
--email {{ cert_item.email | default(certbot_admin_email) }} --email {{ cert_item.email | default(certbot_admin_email) }}
{{ '--expand' if certbot_expand else '' }}
{{ '--webroot-path ' if certbot_create_method == 'webroot' else '' }}
{{ cert_item.webroot | default(certbot_webroot) if certbot_create_method == 'webroot' else '' }}
{{ certbot_create_extra_args }}
--cert-name {{ cert_item_name }}
-d {{ cert_item.domains | join(',') }} -d {{ cert_item.domains | join(',') }}
{{ '--expand' if certbot_expand else '' }}
{{ '--pre-hook /etc/letsencrypt/renewal-hooks/pre/stop_services'
if certbot_create_standalone_stop_services and certbot_create_method == 'standalone'
else '' }}
{{ '--post-hook /etc/letsencrypt/renewal-hooks/post/start_services'
if certbot_create_standalone_stop_services and certbot_create_method == 'standalone'
else '' }}
{{ "--deploy-hook '" ~ cert_item.deploy_hook ~ "'"
if 'deploy_hook' in cert_item
else '' }}
certbot_create_standalone_stop_services: certbot_create_standalone_stop_services:
- nginx - nginx
# - apache # - apache
# - varnish # - varnish
# To install from source (on older OSes or if you need a specific or newer # Available options: 'package', 'snap', 'source'.
# version of Certbot), set this variable to `yes` and configure other options. certbot_install_method: 'package'
certbot_install_from_source: false
# Source install configuration.
certbot_repo: https://github.com/certbot/certbot.git certbot_repo: https://github.com/certbot/certbot.git
certbot_version: master certbot_version: master
certbot_keep_updated: true certbot_keep_updated: true

View File

@ -2,16 +2,13 @@
dependencies: [] dependencies: []
galaxy_info: galaxy_info:
role_name: certbot
author: geerlingguy author: geerlingguy
description: "Installs and configures Certbot (for Let's Encrypt)." description: "Installs and configures Certbot (for Let's Encrypt)."
company: "Midwestern Mac, LLC" company: "Midwestern Mac, LLC"
license: "license (BSD, MIT)" license: "license (BSD, MIT)"
min_ansible_version: 2.4 min_ansible_version: 2.10
platforms: platforms:
- name: EL
versions:
- 6
- 7
- name: Fedora - name: Fedora
versions: versions:
- all - all

View File

@ -1,7 +1,7 @@
--- ---
- name: Converge - name: Converge
hosts: all hosts: all
become: true # become: true
vars: vars:
certbot_auto_renew_user: root certbot_auto_renew_user: root
@ -13,11 +13,12 @@
changed_when: false changed_when: false
- name: Install dependencies (RedHat). - name: Install dependencies (RedHat).
yum: name={{ item }} state=present yum:
when: ansible_os_family == 'RedHat' name:
with_items:
- cronie - cronie
- epel-release - epel-release
state: present
when: ansible_os_family == 'RedHat'
- name: Install cron (Debian). - name: Install cron (Debian).
apt: name=cron state=present apt: name=cron state=present

View File

@ -1,27 +1,21 @@
--- ---
role_name_check: 1
dependency: dependency:
name: galaxy name: galaxy
options:
ignore-errors: true
driver: driver:
name: docker name: docker
lint:
name: yamllint
options:
config-file: molecule/default/yaml-lint.yml
platforms: platforms:
- name: instance - name: instance
image: geerlingguy/docker-${MOLECULE_DISTRO:-centos7}-ansible image: "geerlingguy/docker-${MOLECULE_DISTRO:-rockylinux9}-ansible:latest"
command: ${MOLECULE_DOCKER_COMMAND:-"sleep infinity"} command: ${MOLECULE_DOCKER_COMMAND:-""}
volumes:
- /sys/fs/cgroup:/sys/fs/cgroup:rw
cgroupns_mode: host
privileged: true privileged: true
pre_build_image: true pre_build_image: true
provisioner: provisioner:
name: ansible name: ansible
lint:
name: ansible-lint
playbooks: playbooks:
converge: ${MOLECULE_PLAYBOOK:-playbook.yml} converge: ${MOLECULE_PLAYBOOK:-converge.yml}
scenario:
name: default
verifier:
name: testinfra
lint:
name: flake8

View File

@ -0,0 +1,26 @@
---
- name: Converge
hosts: all
#become: true
vars:
certbot_install_method: 'snap'
certbot_auto_renew_user: root
pre_tasks:
- name: Update apt cache.
apt: update_cache=yes cache_valid_time=600
when: ansible_os_family == 'Debian'
changed_when: false
- name: Install cron (RedHat).
yum: name=cronie state=present
when: ansible_os_family == 'RedHat'
- name: Install cron (Debian).
apt: name=cron state=present
when: ansible_os_family == 'Debian'
roles:
- geerlingguy.git
- geerlingguy.certbot

View File

@ -1,10 +1,10 @@
--- ---
- name: Converge - name: Converge
hosts: all hosts: all
become: true #become: true
vars: vars:
certbot_install_from_source: true certbot_install_method: 'source'
certbot_auto_renew_user: root certbot_auto_renew_user: root
pre_tasks: pre_tasks:

View File

@ -40,7 +40,8 @@
region: "us-east-1" region: "us-east-1"
name: certbot_test name: certbot_test
key_material: "{{ item }}" key_material: "{{ item }}"
with_file: ~/.ssh/id_rsa.pub with_file:
- ~/.ssh/id_rsa.pub
- name: Provision EC2 instance. - name: Provision EC2 instance.
ec2: ec2:
@ -90,7 +91,8 @@
certbot_create_if_missing: true certbot_create_if_missing: true
certbot_create_standalone_stop_services: [] certbot_create_standalone_stop_services: []
certbot_certs: certbot_certs:
- domains: - name: certbot-test.servercheck.in
domains:
- certbot-test.servercheck.in - certbot-test.servercheck.in
nginx_vhosts: nginx_vhosts:
- listen: "443 ssl http2" - listen: "443 ssl http2"

View File

@ -1,14 +0,0 @@
import os
import testinfra.utils.ansible_runner
testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(
os.environ['MOLECULE_INVENTORY_FILE']).get_hosts('all')
def test_hosts_file(host):
f = host.file('/etc/hosts')
assert f.exists
assert f.user == 'root'
assert f.group == 'root'

View File

@ -1,6 +0,0 @@
---
extends: default
rules:
line-length:
max: 120
level: warning

View File

@ -1,23 +1,63 @@
--- ---
- name: Determine certificate name
set_fact:
cert_item_name: "{{ cert_item.name | default(cert_item.domains | first | replace('*.', '')) }}"
- name: Check if certificate already exists. - name: Check if certificate already exists.
stat: stat:
path: /etc/letsencrypt/live/{{ cert_item.domains | first | replace('*.', '') }}/cert.pem path: /etc/letsencrypt/live/{{ cert_item_name }}/cert.pem
register: letsencrypt_cert register: letsencrypt_cert
- name: Stop services to allow certbot to generate a cert. - name: Ensure pre and post hook folders exist.
service: file:
name: "{{ item }}" path: /etc/letsencrypt/renewal-hooks/{{ item }}
state: stopped state: directory
when: not letsencrypt_cert.stat.exists mode: 0755
with_items: "{{ certbot_create_standalone_stop_services }}" owner: root
group: root
with_items:
- pre
- post
- name: Create pre hook to stop services.
template:
src: stop_services.j2
dest: /etc/letsencrypt/renewal-hooks/pre/stop_services
owner: root
group: root
mode: 0750
when:
- certbot_create_standalone_stop_services is defined
- certbot_create_standalone_stop_services
- name: Create post hook to start services.
template:
src: start_services.j2
dest: /etc/letsencrypt/renewal-hooks/post/start_services
owner: root
group: root
mode: 0750
when:
- certbot_create_standalone_stop_services is defined
- certbot_create_standalone_stop_services
- name: Check if domains have changed
block:
- name: Register certificate domains
shell: "{{ certbot_script }} certificates --cert-name {{ cert_item_name }} | grep Domains | cut -d':' -f2"
changed_when: false
register: letsencrypt_cert_domains_dirty
- name: Cleanup domain list
set_fact:
letsencrypt_cert_domains: "{{ letsencrypt_cert_domains_dirty.stdout | trim | split(' ') | map('trim') | select('!=', '') | list | sort }}"
- name: Determine if domains have changed
set_fact:
letsencrypt_cert_domains_changed: "{{ letsencrypt_cert_domains != (cert_item.domains | map('trim') | select('!=', '') | list | sort) }}"
when: letsencrypt_cert.stat.exists
- name: Generate new certificate if one doesn't exist. - name: Generate new certificate if one doesn't exist.
shell: "{{ certbot_create_command }}" command: "{{ certbot_create_command }}"
when: not letsencrypt_cert.stat.exists when: not letsencrypt_cert.stat.exists or letsencrypt_cert_domains_changed | default(false)
- name: Start services after cert has been generated.
service:
name: "{{ item }}"
state: started
when: not letsencrypt_cert.stat.exists
with_items: "{{ certbot_create_standalone_stop_services }}"

View File

@ -0,0 +1,35 @@
---
- name: Determine certificate name
set_fact:
cert_item_name: "{{ cert_item.name | default(cert_item.domains | first | replace('*.', '')) }}"
- name: Check if certificate already exists.
stat:
path: /etc/letsencrypt/live/{{ cert_item_name }}/cert.pem
register: letsencrypt_cert
- name: Create webroot directory if it doesn't exist yet
file:
path: "{{ cert_item.webroot | default(certbot_webroot) }}"
state: directory
- name: Check if domains have changed
block:
- name: Register certificate domains
shell: "{{ certbot_script }} certificates --cert-name {{ cert_item_name }} | grep Domains | cut -d':' -f2"
changed_when: false
register: letsencrypt_cert_domains_dirty
- name: Cleanup domain list
set_fact:
letsencrypt_cert_domains: "{{ letsencrypt_cert_domains_dirty.stdout | trim | split(' ') | map('trim') | select('!=', '') | list | sort }}"
- name: Determine if domains have changed
set_fact:
letsencrypt_cert_domains_changed: "{{ letsencrypt_cert_domains != (cert_item.domains | map('trim') | select('!=', '') | list | sort) }}"
when: letsencrypt_cert.stat.exists
- name: Generate new certificate if one doesn't exist.
command: "{{ certbot_create_command }}"
when: not letsencrypt_cert.stat.exists or letsencrypt_cert_domains_changed | default(false)

View File

@ -0,0 +1,41 @@
---
- name: Ensure snapd is installed.
package:
name: snapd
state: present
register: snapd_install
- name: Ensure snapd is enabled.
systemd:
name: snapd.socket
enabled: true
state: started
- name: Enable classic snap support.
file:
src: /var/lib/snapd/snap
dest: /snap
state: link
when: ansible_os_family != "Debian"
- name: Update snap after install.
shell: snap install core; snap refresh core
changed_when: true
failed_when: false
when: snapd_install is changed
- name: Install certbot via snap.
snap:
name: certbot
classic: true
- name: Symlink certbot into place.
file:
src: /snap/bin/certbot
dest: /usr/bin/certbot
state: link
ignore_errors: "{{ ansible_check_mode }}"
- name: Set Certbot script variable.
set_fact:
certbot_script: /usr/bin/certbot

View File

@ -1,11 +1,17 @@
--- ---
- import_tasks: include-vars.yml - import_tasks: include-vars.yml
- import_tasks: setup-RedHat.yml
when: ansible_os_family == 'RedHat'
- import_tasks: install-with-package.yml - import_tasks: install-with-package.yml
when: not certbot_install_from_source when: certbot_install_method == 'package'
- import_tasks: install-with-snap.yml
when: certbot_install_method == 'snap'
- import_tasks: install-from-source.yml - import_tasks: install-from-source.yml
when: certbot_install_from_source when: certbot_install_method == 'source'
- include_tasks: create-cert-standalone.yml - include_tasks: create-cert-standalone.yml
with_items: "{{ certbot_certs }}" with_items: "{{ certbot_certs }}"
@ -15,5 +21,13 @@
loop_control: loop_control:
loop_var: cert_item loop_var: cert_item
- include_tasks: create-cert-webroot.yml
with_items: "{{ certbot_certs }}"
when:
- certbot_create_if_missing
- certbot_create_method == 'webroot'
loop_control:
loop_var: cert_item
- import_tasks: renew-cron.yml - import_tasks: renew-cron.yml
when: certbot_auto_renew when: certbot_auto_renew

11
tasks/setup-RedHat.yml Normal file
View File

@ -0,0 +1,11 @@
---
# See: https://github.com/geerlingguy/ansible-role-certbot/issues/107
- name: Ensure dnf-plugins are installed on Rocky/AlmaLinux.
yum:
name: dnf-plugins-core
state: present
- name: Enable DNF module for Rocky/AlmaLinux.
shell: |
dnf config-manager --set-enabled crb
changed_when: false

View File

@ -0,0 +1,15 @@
#!/bin/bash
# {{ ansible_managed }}
{% for item in certbot_create_standalone_stop_services %}
echo "starting service {{ item }}"
{% if ansible_service_mgr == 'systemd' %}
systemctl start {{ item }}
{% elif ansible_service_mgr == 'upstart' %}
initctl start {{ item }}
{% elif ansible_service_mgr == 'openrc' %}
rc-service {{ item }} start
{% else %}
service {{ item }} start
{% endif %}
{% endfor %}

View File

@ -0,0 +1,15 @@
#!/bin/bash
# {{ ansible_managed }}
{% for item in certbot_create_standalone_stop_services %}
echo "stopping service {{ item }}"
{% if ansible_service_mgr == 'systemd' %}
systemctl stop {{ item }}
{% elif ansible_service_mgr == 'upstart' %}
initctl stop {{ item }}
{% elif ansible_service_mgr == 'openrc' %}
rc-service {{ item }} stop
{% else %}
service {{ item }} stop
{% endif %}
{% endfor %}