Compare commits

...
Author SHA1 Message Date
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
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 GeerlingandGitHub 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 GeerlingandGitHub cfd9655ed0 Merge pull request #192 from fapdash/patch-1
Run hooks only for standalone mode
2023-06-17 22:22:43 -05:00
Jeff GeerlingandGitHub 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 GeerlingandGitHub 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
FAPandGitHub 2deba31679 Check for both conditions (squash me) 2023-02-20 12:26:44 +01:00
FAPandGitHub 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 GeerlingandGitHub 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 GeerlingandGitHub 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
2cad2addcd Update defaults/main.yml
Co-authored-by: Jeff Geerling <geerlingguy@mac.com>
2021-11-22 07:25:31 +01:00
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 PorteandSimon Spannagel 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 PorteandSimon Spannagel 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
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 FairclothandSimon Spannagel 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 FairclothandSimon Spannagel 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 GeerlingandGitHub 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 GeerlingandGitHub aaf3dbd40a Merge pull request #159 from jivanpal/snapd-start
Ensure snapd is started immediately
2021-10-25 10:04:22 -05:00
Jeff GeerlingandGitHub 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 GeerlingandGitHub 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 GeerlingandGitHub 515e8af98b Update tasks/create-cert-standalone.yml 2021-05-28 14:39:45 -05:00
Jeff GeerlingandGitHub 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 GeerlingandGitHub 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 GeerlingandGitHub 9090d7d431 Merge pull request #127 from wzzrd/patch-1
Only enable PowerTools on CentOS
2020-12-27 00:05:59 -06:00
Jeff GeerlingandGitHub 7c66dc3eed Merge pull request #137 from GuillaumeRemyCSI/patch-1
Fixed issue with PowerTools DNF module
2020-12-27 00:05:52 -06:00
GuillaumeRemyCSIandGitHub 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 BurgerhoutandGitHub 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 GeerlingandGitHub 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 HeeswijkandGitHub 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 GeerlingandGitHub 09b5bd20e9 Merge pull request #63 from adrianmoisey/patch-1
Fix path for example
2018-10-02 22:10:22 -05:00
Jeff GeerlingandGitHub e130839734 Merge pull request #62 from mbiberhofer/master
Fixed syntax issue in main/defaults.yml
2018-10-02 22:09:24 -05:00
Adrian MoiseyandGitHub 6b519ffc4d Fix path for example 2018-10-02 16:29:59 +02:00
Mario Biberhofer 260a85222e Fixed syntax issue in main/defaults.yml
v3.0.0 has introduced usage of the folded block scalar syntax
(see https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html)
for the certbot_create_command variable. The usage of quotes in this
case is wrong, resulting in a command not found error.
2018-10-02 10:20:22 +02:00
Jeff Geerling 974fc81c9c Update README wildcard docs. [ci skip] 2018-09-28 20:05:09 -05:00
Jeff Geerling a2348fdd64 Add note on Wildcard Certificates and Let's Encrypt. [ci skip] 2018-09-27 22:10:58 -05:00
Jeff GeerlingandGitHub d8beca4c1a Merge pull request #60 from michaelpporter/master
Supports check of wildcard certs
2018-09-27 21:59:28 -05:00
Jeff Geerling 53b02421c0 Fix Ansible lint issues. 2018-09-26 21:53:44 -05:00
Jeff Geerling 0611410c3b Fix Ansible lint issues. 2018-09-26 21:41:04 -05:00
Jeff Geerling 5da6dd18cd Fix Ansible lint issues. 2018-09-26 21:32:28 -05:00
Jeff Geerling e14d6eb04a Switch tests to use Molecule. 2018-09-26 21:25:42 -05:00
Michael PorterandGitHub ce4dacf632 Supports check of wildcard certs
Adds support to check for wildcard certs to not re-make them on subsequent runs
2018-09-23 14:58:52 -05:00
Jeff Geerling 3f1a802d71 Fixes #25: Suggest using source install for more pleasant experience. [ci skip] 2017-12-11 22:40:31 -06:00
Jeff GeerlingandGitHub 9a8c9ae417 Merge pull request #38 from geerlingguy/12-standalone-cert-generation
Issue #12: Add basic standalone certbot cert generation.
2017-12-11 22:27:14 -06:00
27 changed files with 502 additions and 115 deletions
+3
View File
@@ -0,0 +1,3 @@
skip_list:
- 'yaml'
- 'role-name'
+4
View File
@@ -0,0 +1,4 @@
# These are supported funding model platforms
---
github: geerlingguy
patreon: geerlingguy
+79
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: ubuntu2004
playbook: converge.yml
experimental: false
- distro: debian10
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
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
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 }}
+4 -1
View File
@@ -1,2 +1,5 @@
*.retry
tests/test.sh
*/__pycache__
*.pyc
.cache
-23
View File
@@ -1,23 +0,0 @@
---
services: docker
env:
- distro: centos7
- distro: centos6
playbook: test-source-install.yml
- distro: ubuntu1604
- distro: ubuntu1404
playbook: test-source-install.yml
- distro: debian8
playbook: test-source-install.yml
script:
# Download test shim.
- wget -O ${PWD}/tests/test.sh https://gist.githubusercontent.com/geerlingguy/73ef1e5ee45d8694570f334be385e181/raw/
- chmod +x ${PWD}/tests/test.sh
# Run tests.
- ${PWD}/tests/test.sh
notifications:
webhooks: https://galaxy.ansible.com/api/v1/notifications/
+13
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
+51 -18
View File
@@ -1,6 +1,6 @@
# 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/workflows/CI/badge.svg?event=push)](https://github.com/geerlingguy/ansible-role-certbot/actions?query=workflow%3ACI)
Installs and configures Certbot (for Let's Encrypt).
@@ -8,28 +8,43 @@ Installs and configures Certbot (for Let's Encrypt).
If installing from source, Git is required. You can install Git using the `geerlingguy.git` role.
Generally, installing from source (see section `Source Installation from Git`) leads to a better experience using Certbot and Let's Encrypt, especially if you're using an older OS release.
## 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_user: "{{ ansible_user }}"
certbot_auto_renew_hour: 3
certbot_auto_renew_minute: 30
certbot_auto_renew_options: "--quiet --no-self-upgrade"
certbot_auto_renew_user: "{{ ansible_user | default(lookup('env', 'USER')) }}"
certbot_auto_renew_hour: "3"
certbot_auto_renew_minute: "30"
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.
### 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
Set `certbot_create_if_missing` to `yes` or `True` to let this role generate certs.
certbot_create_if_missing: no
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
@@ -37,17 +52,18 @@ The email address used to agree to Let's Encrypt's TOS and subscribe to cert-rel
certbot_certs: []
# - email: janedoe@example.com
# webroot: "/var/www/html"
# domains:
# - example1.com
# - example2.com
# - domains:
# - 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(',') }}"
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
@@ -58,21 +74,38 @@ 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.
### 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
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: no
certbot_repo: https://github.com/certbot/certbot.git
certbot_version: master
certbot_keep_updated: yes
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
The directory inside which Certbot will be cloned.
### Wildcard Certificates
Let's Encrypt supports [generating wildcard certificates](https://community.letsencrypt.org/t/acme-v2-and-wildcard-certificate-support-is-live/55579), but the process for generating and using them is slightly more involved. See comments in [this pull request](https://github.com/geerlingguy/ansible-role-certbot/pull/60#issuecomment-423919284) for an example of how to use this role to maintain wildcard certs.
Michael Porter also has a walkthrough of [Creating A Let’s Encrypt Wildcard Cert With Ansible](https://www.michaelpporter.com/2018/09/creating-a-wildcard-cert-with-ansible/), specifically with Cloudflare.
## Dependencies
None.
@@ -83,8 +116,8 @@ None.
vars:
certbot_auto_renew_user: your_username_here
certbot_auto_renew_minute: 20
certbot_auto_renew_hour: 5
certbot_auto_renew_minute: "20"
certbot_auto_renew_hour: "5"
roles:
- geerlingguy.certbot
+43 -16
View File
@@ -1,34 +1,61 @@
---
# Certbot auto-renew cron job configuration (for certificate renewals).
certbot_auto_renew: true
certbot_auto_renew_user: "{{ ansible_user }}"
certbot_auto_renew_hour: 3
certbot_auto_renew_minute: 30
certbot_auto_renew_options: "--quiet --no-self-upgrade"
certbot_auto_renew_user: "{{ ansible_user | default(lookup('env', 'USER')) }}"
certbot_auto_renew_hour: "3"
certbot_auto_renew_minute: "30"
certbot_auto_renew_options: "--quiet"
certbot_testmode: false
certbot_hsts: false
# Parameters used when creating new Certbot certs.
certbot_create_if_missing: no
certbot_create_if_missing: false
certbot_create_method: standalone
certbot_admin_email: email@example.com
# Default webroot, overwritten by individual per-cert webroot directories
certbot_webroot: /var/www/letsencrypt
certbot_certs: []
# - email: janedoe@example.com
# domains:
# - example1.com
# - example2.com
# - domains:
# - example3.com
certbot_create_command: "{{ certbot_script }} certonly --standalone --noninteractive --agree-tos --email {{ cert_item.email | default(certbot_admin_email) }} -d {{ cert_item.domains | join(',') }}"
# - email: janedoe@example.com
# webroot: "/var/www/html/"
# domains:
# - example1.com
# - example2.com
# - domains:
# - example3.com
certbot_create_command: >-
{{ 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) }}
{{ '--webroot-path ' if certbot_create_method == 'webroot' else '' }}
{{ cert_item.webroot | default(certbot_webroot) if certbot_create_method == 'webroot' else '' }}
{{ certbot_create_extra_args }}
-d {{ cert_item.domains | join(',') }}
{{ '--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 '' }}
certbot_create_standalone_stop_services:
- nginx
# - apache
# - varnish
# To install from source (on older OSes or if you need a specific or newer
# version of Certbot), set this variable to `yes` and configure other options.
certbot_install_from_source: no
# Available options: 'package', 'snap', 'source'.
certbot_install_method: 'package'
# Source install configuration.
certbot_repo: https://github.com/certbot/certbot.git
certbot_version: master
certbot_keep_updated: yes
certbot_keep_updated: true
# Where to put Certbot when installing from source.
certbot_dir: /opt/certbot
+2 -5
View File
@@ -2,16 +2,13 @@
dependencies: []
galaxy_info:
role_name: certbot
author: geerlingguy
description: "Installs and configures Certbot (for Let's Encrypt)."
company: "Midwestern Mac, LLC"
license: "license (BSD, MIT)"
min_ansible_version: 2.4
min_ansible_version: 2.10
platforms:
- name: EL
versions:
- 6
- 7
- name: Fedora
versions:
- all
@@ -1,5 +1,10 @@
---
- hosts: all
- name: Converge
hosts: all
become: true
vars:
certbot_auto_renew_user: root
pre_tasks:
- name: Update apt cache.
@@ -8,15 +13,16 @@
changed_when: false
- name: Install dependencies (RedHat).
yum: name={{ item }} state=present
when: ansible_os_family == 'RedHat'
with_items:
yum:
name:
- cronie
- epel-release
state: present
when: ansible_os_family == 'RedHat'
- name: Install cron (Debian).
apt: name=cron state=present
when: ansible_os_family == 'Debian'
roles:
- role_under_test
- geerlingguy.certbot
+21
View File
@@ -0,0 +1,21 @@
---
role_name_check: 1
dependency:
name: galaxy
options:
ignore-errors: true
driver:
name: docker
platforms:
- name: instance
image: "geerlingguy/docker-${MOLECULE_DISTRO:-rockylinux9}-ansible:latest"
command: ${MOLECULE_DOCKER_COMMAND:-""}
volumes:
- /sys/fs/cgroup:/sys/fs/cgroup:rw
cgroupns_mode: host
privileged: true
pre_build_image: true
provisioner:
name: ansible
playbooks:
converge: ${MOLECULE_PLAYBOOK:-converge.yml}
@@ -1,8 +1,11 @@
---
- hosts: all
- name: Converge
hosts: all
become: true
vars:
certbot_install_from_source: yes
certbot_install_method: 'snap'
certbot_auto_renew_user: root
pre_tasks:
- name: Update apt cache.
@@ -20,4 +23,4 @@
roles:
- geerlingguy.git
- role_under_test
- geerlingguy.certbot
@@ -0,0 +1,26 @@
---
- name: Converge
hosts: all
become: true
vars:
certbot_install_method: 'source'
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
@@ -9,7 +9,7 @@
# Play 1: Provision EC2 instance and A record.
- hosts: localhost
connection: local
gather_facts: no
gather_facts: false
tasks:
- name: Configure EC2 Security Group.
@@ -40,7 +40,8 @@
region: "us-east-1"
name: certbot_test
key_material: "{{ item }}"
with_file: ~/.ssh/id_rsa.pub
with_file:
- ~/.ssh/id_rsa.pub
- name: Provision EC2 instance.
ec2:
@@ -50,9 +51,10 @@
Name: "certbot-standalone-nginx-test"
group: ['default', 'certbot_test_http']
instance_type: t2.micro
image: ami-02e98f78 # CentOS Linux 7 x86_64 HVM EBS
# CentOS Linux 7 x86_64 HVM EBS
image: ami-02e98f78
region: "us-east-1"
wait: yes
wait: true
wait_timeout: 500
exact_count: 1
count_tag:
@@ -68,25 +70,25 @@
type: A
ttl: 300
value: "{{ created_instance.tagged_instances.0.public_ip }}"
wait: yes
overwrite: yes
wait: true
overwrite: true
- name: Add EC2 instance to inventory groups.
add_host:
name: "certbot-test.servercheck.in"
groups: "aws,aws_nginx"
ansible_ssh_user: centos
host_key_checking: False
host_key_checking: false
when: created_instance.tagged_instances.0.id is defined
# Play 2: Configure EC2 instance with Certbot and Nginx.
- hosts: aws_nginx
gather_facts: yes
become: yes
gather_facts: true
become: true
vars:
certbot_admin_email: https@servercheck.in
certbot_create_if_missing: yes
certbot_create_if_missing: true
certbot_create_standalone_stop_services: []
certbot_certs:
- domains:
@@ -107,7 +109,7 @@
pre_tasks:
- name: Update apt cache.
apt: update_cache=yes cache_valid_time=600
apt: update_cache=true cache_valid_time=600
when: ansible_os_family == 'Debian'
changed_when: false
@@ -135,12 +137,12 @@
url: https://certbot-test.servercheck.in/
status_code: 200
delegate_to: localhost
become: no
become: false
# Play 3: Tear down EC2 instance and A record.
- hosts: localhost
connection: local
gather_facts: no
gather_facts: false
tasks:
- name: Destroy EC2 instance.
@@ -149,7 +151,7 @@
instance_ids: ["{{ created_instance.tagged_instances.0.id }}"]
region: "us-east-1"
state: absent
wait: yes
wait: true
wait_timeout: 500
- name: Delete Security Group.
+34 -15
View File
@@ -1,23 +1,42 @@
---
- name: Check if certificate already exists.
stat:
path: /etc/letsencrypt/live/{{ cert_item.domains | first }}/cert.pem
path: /etc/letsencrypt/live/{{ cert_item.domains | first | replace('*.', '') }}/cert.pem
register: letsencrypt_cert
- name: Stop services to allow certbot to generate a cert.
service:
name: "{{ item }}"
state: stopped
when: not letsencrypt_cert.stat.exists
with_items: "{{ certbot_create_standalone_stop_services }}"
- name: Ensure pre and post hook folders exist.
file:
path: /etc/letsencrypt/renewal-hooks/{{ item }}
state: directory
mode: 0755
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: Generate new certificate if one doesn't exist.
shell: "{{ certbot_create_command }}"
command: "{{ certbot_create_command }}"
when: not letsencrypt_cert.stat.exists
- 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 }}"
+14
View File
@@ -0,0 +1,14 @@
---
- name: Check if certificate already exists.
stat:
path: /etc/letsencrypt/live/{{ cert_item.domains | first }}/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: Generate new certificate if one doesn't exist.
command: "{{ certbot_create_command }}"
when: not letsencrypt_cert.stat.exists
+1 -1
View File
@@ -5,7 +5,7 @@
dest: "{{ certbot_dir }}"
version: "{{ certbot_version }}"
update: "{{ certbot_keep_updated }}"
force: yes
force: true
- name: Set Certbot script variable.
set_fact:
+41
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
+16 -2
View File
@@ -1,11 +1,17 @@
---
- import_tasks: include-vars.yml
- import_tasks: setup-RedHat.yml
when: ansible_os_family == 'RedHat'
- 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
when: certbot_install_from_source
when: certbot_install_method == 'source'
- include_tasks: create-cert-standalone.yml
with_items: "{{ certbot_certs }}"
@@ -15,5 +21,13 @@
loop_control:
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
when: certbot_auto_renew
+11
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
+15
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 %}
+15
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 %}
-11
View File
@@ -1,11 +0,0 @@
# Ansible Role tests
To run the test playbook(s) in this directory:
1. Install and start Docker.
1. Download the test shim (see .travis.yml file for the URL) into `tests/test.sh`:
- `wget -O tests/test.sh https://gist.githubusercontent.com/geerlingguy/73ef1e5ee45d8694570f334be385e181/raw/`
1. Make the test shim executable: `chmod +x tests/test.sh`.
1. Run (from the role root directory) `distro=[distro] playbook=[playbook] ./tests/test.sh`
If you don't want the container to be automatically deleted after the test playbook is run, add the following environment variables: `cleanup=false container_id=$(date +%s)`
+1
View File
@@ -1 +1,2 @@
---
certbot_package: letsencrypt