Compare commits

..
64 Commits
Author SHA1 Message Date
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
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
Jeff Geerling c27861fddc Issue #12: New include techniques require Ansible 2.4 or later. [ci skip] 2017-12-11 22:26:46 -06:00
Jeff Geerling d3f98e4258 Fixes #12: Document how to generate certs automatically using certbot --standalone. 2017-12-11 22:17:25 -06:00
Jeff Geerling 5f7c9e046c Issue #12: Fix standalone cert generation, add full build-test-teardown playbook. 2017-12-10 22:47:54 -06:00
Jeff Geerling 7651f0ac0b Issue #12: Add basic standalone certbot cert generation. 2017-12-06 22:48:30 -06:00
Jeff Geerling 574c0843c8 Fixes #37: Make renew command configurable. 2017-10-31 10:09:41 -05:00
Jeff Geerling f00a0ba181 Issue #6: Add more documentation around automatically generating certs. 2017-07-26 15:56:22 -05:00
27 changed files with 721 additions and 71 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
+56
View File
@@ -0,0 +1,56 @@
# Configuration for probot-stale - https://github.com/probot/stale
# Number of days of inactivity before an Issue or Pull Request becomes stale
daysUntilStale: 90
# Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
daysUntilClose: 30
# Only issues or pull requests with all of these labels are check if stale. Defaults to `[]` (disabled)
onlyLabels: []
# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
exemptLabels:
- pinned
- security
- planned
# Set to true to ignore issues in a project (defaults to false)
exemptProjects: false
# Set to true to ignore issues in a milestone (defaults to false)
exemptMilestones: false
# Set to true to ignore issues with an assignee (defaults to false)
exemptAssignees: false
# Label to use when marking as stale
staleLabel: stale
# Limit the number of actions per hour, from 1-30. Default is 30
limitPerRun: 30
pulls:
markComment: |-
This pull request has been marked 'stale' due to lack of recent activity. If there is no further activity, the PR 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 pull requests as stale.
unmarkComment: >-
This pull request is no longer marked for closure.
closeComment: >-
This pull request has been closed due to inactivity. If you feel this is in error, please reopen the pull request or file a new PR with the relevant details.
issues:
markComment: |-
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.
unmarkComment: >-
This issue is no longer marked for closure.
closeComment: >-
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.
+85
View File
@@ -0,0 +1,85 @@
---
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@v2
with:
path: 'geerlingguy.certbot'
- name: Set up Python 3.
uses: actions/setup-python@v2
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: centos8
playbook: converge.yml
experimental: false
- distro: centos7
playbook: converge.yml
experimental: false
- distro: ubuntu1804
playbook: converge.yml
experimental: false
- distro: debian10
playbook: converge.yml
experimental: false
- distro: centos7
playbook: playbook-source-install.yml
experimental: false
- distro: centos7
playbook: playbook-snap-install.yml
experimental: true
steps:
- name: Check out the codebase.
uses: actions/checkout@v2
with:
path: 'geerlingguy.certbot'
- name: Set up Python 3.
uses: actions/setup-python@v2
with:
python-version: '3.x'
- name: Install test dependencies.
run: pip3 install ansible molecule[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 }}
+38
View File
@@ -0,0 +1,38 @@
---
# 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@v2
with:
path: 'geerlingguy.certbot'
- name: Set up Python 3.
uses: actions/setup-python@v2
with:
python-version: '3.x'
- name: Install Ansible.
run: pip3 install ansible-base
- 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)
+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/
+10
View File
@@ -0,0 +1,10 @@
---
extends: default
rules:
line-length:
max: 120
level: warning
ignore: |
.github/stale.yml
+88 -14
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,32 +8,88 @@ 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_user: "{{ ansible_user | default(lookup('env', 'USER')) }}"
certbot_auto_renew_hour: "3"
certbot_auto_renew_minute: "30"
certbot_auto_renew_options: "--quiet --no-self-upgrade"
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.
**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_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`.
certbot_admin_email: email@example.com
The email address used to agree to Let's Encrypt's TOS and subscribe to cert-related notifications. This should be customized and set to an email address that you or your organization regularly monitors.
certbot_certs: []
# - email: janedoe@example.com
# 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`.
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.
#### Standalone Certificate Generation
certbot_create_standalone_stop_services:
- nginx
Services that should be stopped while `certbot` runs it's own standalone server on ports 80 and 443. If you're running Apache, set this to `apache2` (Ubuntu), or `httpd` (RHEL), or if you have Nginx on port 443 and something else on port 80 (e.g. Varnish, a Java app, or something else), add it to the list so it is stopped when the certificate 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.
### 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.
@@ -44,19 +100,37 @@ 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
After installation, you can create certificates using the `certbot` (or `certbot-auto`) script, which by default is installed inside the configured `certbot_dir` (when using Git). Here are some example commands to configure certificates with Certbot:
See other examples in the `tests/` directory.
### Manually creating certificates with certbot
_Note: You can have this role automatically generate certificates; see the "Automatic Certificate Generation" documentation above._
You can manually create certificates using the `certbot` (or `certbot-auto`) script (use `letsencrypt` on Ubuntu 16.04, or use `/opt/certbot/certbot-auto` if installing from source/Git. Here are some example commands to configure certificates with Certbot:
# Automatically add certs for all Apache virtualhosts (use with caution!).
/opt/certbot/certbot-auto --apache
certbot --apache
# Generate certs, but don't modify Apache configuration (safer).
/opt/certbot/certbot-auto --apache certonly
certbot --apache certonly
If you want to fully automate the process of adding a new certificate, but don't want to use this role's built in functionality, you can do so using the command line options to register, accept the terms of service, and then generate a cert using the standalone server:
1. Make sure any services listening on ports 80 and 443 (Apache, Nginx, Varnish, etc.) are stopped.
2. Register with something like `certbot register --agree-tos --email [your-email@example.com]`
- Note: You won't need to do this step in the future, when generating additional certs on the same server.
3. Generate a cert for a domain whose DNS points to this server: `certbot certonly --noninteractive --standalone -d example.com -d www.example.com`
4. Re-start whatever was listening on ports 80 and 443 before.
5. Update your webserver's virtualhost TLS configuration to point at the new certificate (`fullchain.pem`) and private key (`privkey.pem`) Certbot just generated for the domain you passed in the `certbot` command.
6. Reload or restart your webserver so it uses the new HTTPS virtualhost configuration.
### Certbot certificate auto-renewal
By default, this role adds a cron job that will renew all installed certificates once per day at the hour and minute of your choosing.
+36 -7
View File
@@ -1,16 +1,45 @@
---
# 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_user: "{{ ansible_user | default(lookup('env', 'USER')) }}"
certbot_auto_renew_hour: "3"
certbot_auto_renew_minute: "30"
certbot_auto_renew_options: "--quiet --no-self-upgrade"
# 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
# Parameters used when creating new Certbot certs.
certbot_create_if_missing: false
certbot_create_method: standalone
certbot_admin_email: email@example.com
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(',') }}
{{ '--pre-hook /etc/letsencrypt/renewal-hooks/pre/stop_services'
if certbot_create_standalone_stop_services
else '' }}
{{ '--post-hook /etc/letsencrypt/renewal-hooks/post/start_services'
if certbot_create_standalone_stop_services
else '' }}
certbot_create_standalone_stop_services:
- nginx
# - apache
# - varnish
# 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
+3 -2
View File
@@ -2,16 +2,17 @@
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.0
min_ansible_version: 2.4
platforms:
- name: EL
versions:
- 6
- 7
- 8
- name: Fedora
versions:
- all
+28
View File
@@ -0,0 +1,28 @@
---
- name: Converge
hosts: all
become: true
vars:
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 dependencies (RedHat).
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:
- geerlingguy.certbot
+17
View File
@@ -0,0 +1,17 @@
---
dependency:
name: galaxy
driver:
name: docker
platforms:
- name: instance
image: "geerlingguy/docker-${MOLECULE_DISTRO:-centos7}-ansible:latest"
command: ${MOLECULE_DOCKER_COMMAND:-""}
volumes:
- /sys/fs/cgroup:/sys/fs/cgroup:ro
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
@@ -1,5 +1,11 @@
---
- hosts: all
- name: Converge
hosts: all
become: true
vars:
certbot_install_method: 'source'
certbot_auto_renew_user: root
pre_tasks:
- name: Update apt cache.
@@ -16,4 +22,5 @@
when: ansible_os_family == 'Debian'
roles:
- role_under_test
- geerlingguy.git
- geerlingguy.certbot
@@ -0,0 +1,180 @@
---
# To run:
# 1. Ensure Ansible and Boto are installed (pip install ansible boto).
# 2. Ensure you have AWS credentials stored where Boto can find them, and they
# are under the profile 'mm'.
# 3. Ensure you have a pubkey available at ~/.ssh/id_rsa.pub.
# 3. Run the playbook: ansible-playbook test-standalone-nginx-aws.yml
# Play 1: Provision EC2 instance and A record.
- hosts: localhost
connection: local
gather_facts: false
tasks:
- name: Configure EC2 Security Group.
ec2_group:
profile: mm
name: certbot_test_http
description: HTTP security group for Certbot testing.
region: "us-east-1"
state: present
rules:
- proto: tcp
from_port: 80
to_port: 80
cidr_ip: 0.0.0.0/0
- proto: tcp
from_port: 443
to_port: 443
cidr_ip: 0.0.0.0/0
- proto: tcp
from_port: 22
to_port: 22
cidr_ip: 0.0.0.0/0
rules_egress: []
- name: Add EC2 Key Pair.
ec2_key:
profile: mm
region: "us-east-1"
name: certbot_test
key_material: "{{ item }}"
with_file:
- ~/.ssh/id_rsa.pub
- name: Provision EC2 instance.
ec2:
profile: mm
key_name: certbot_test
instance_tags:
Name: "certbot-standalone-nginx-test"
group: ['default', 'certbot_test_http']
instance_type: t2.micro
# CentOS Linux 7 x86_64 HVM EBS
image: ami-02e98f78
region: "us-east-1"
wait: true
wait_timeout: 500
exact_count: 1
count_tag:
Name: "certbot-standalone-nginx-test"
register: created_instance
- name: Add A record for the new EC2 instance IP in Route53.
route53:
profile: mm
command: create
zone: servercheck.in
record: certbot-test.servercheck.in
type: A
ttl: 300
value: "{{ created_instance.tagged_instances.0.public_ip }}"
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
when: created_instance.tagged_instances.0.id is defined
# Play 2: Configure EC2 instance with Certbot and Nginx.
- hosts: aws_nginx
gather_facts: true
become: true
vars:
certbot_admin_email: https@servercheck.in
certbot_create_if_missing: true
certbot_create_standalone_stop_services: []
certbot_certs:
- domains:
- certbot-test.servercheck.in
nginx_vhosts:
- listen: "443 ssl http2"
server_name: "certbot-test.servercheck.in"
root: "/usr/share/nginx/html"
index: "index.html index.htm"
state: "present"
template: "{{ nginx_vhost_template }}"
filename: "certbot_test.conf"
extra_parameters: |
ssl_certificate /etc/letsencrypt/live/certbot-test.servercheck.in/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/certbot-test.servercheck.in/privkey.pem;
ssl_protocols TLSv1.1 TLSv1.2;
ssl_ciphers HIGH:!aNULL:!MD5;
pre_tasks:
- name: Update apt cache.
apt: update_cache=true cache_valid_time=600
when: ansible_os_family == 'Debian'
changed_when: false
- name: Install dependencies (RedHat).
yum: name={{ item }} state=present
when: ansible_os_family == 'RedHat'
with_items:
- cronie
- epel-release
- name: Install cron (Debian).
apt: name=cron state=present
when: ansible_os_family == 'Debian'
roles:
- geerlingguy.certbot
- geerlingguy.nginx
tasks:
- name: Flush handlers in case any configs have changed.
meta: flush_handlers
- name: Test secure connection to SSL domain.
uri:
url: https://certbot-test.servercheck.in/
status_code: 200
delegate_to: localhost
become: false
# Play 3: Tear down EC2 instance and A record.
- hosts: localhost
connection: local
gather_facts: false
tasks:
- name: Destroy EC2 instance.
ec2:
profile: mm
instance_ids: ["{{ created_instance.tagged_instances.0.id }}"]
region: "us-east-1"
state: absent
wait: true
wait_timeout: 500
- name: Delete Security Group.
ec2_group:
profile: mm
name: certbot_test_http
region: "us-east-1"
state: absent
- name: Delete Key Pair.
ec2_key:
profile: mm
name: certbot_test
region: "us-east-1"
state: absent
- name: Delete Route53 record.
route53:
profile: mm
state: delete
zone: servercheck.in
record: certbot-test.servercheck.in
type: A
ttl: 300
# See: https://github.com/ansible/ansible/pull/32297
value: []
@@ -1,2 +1,3 @@
---
- src: geerlingguy.git
- src: geerlingguy.nginx
+42
View File
@@ -0,0 +1,42 @@
---
- name: Check if certificate already exists.
stat:
path: /etc/letsencrypt/live/{{ cert_item.domains | first | replace('*.', '') }}/cert.pem
register: letsencrypt_cert
- 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.
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:
+38
View File
@@ -0,0 +1,38 @@
---
- name: Ensure snapd is installed.
package:
name: snapd
state: present
register: snapd_install
- name: Ensure snapd is enabled.
systemd:
name: snapd.socket
enabled: true
- name: Enable classic snap support.
file:
src: /var/lib/snapd/snap
dest: /snap
state: link
- 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
- name: Set Certbot script variable.
set_fact:
certbot_script: /usr/bin/certbot
+20 -6
View File
@@ -1,11 +1,25 @@
---
- include: include-vars.yml
- import_tasks: include-vars.yml
- include: install-with-package.yml
when: not certbot_install_from_source
- import_tasks: setup-RedHat.yml
when: ansible_os_family == 'RedHat'
- include: install-from-source.yml
when: certbot_install_from_source
- import_tasks: install-with-package.yml
when: certbot_install_method == 'package'
- include: renew-cron.yml
- import_tasks: install-with-snap.yml
when: certbot_install_method == 'snap'
- import_tasks: install-from-source.yml
when: certbot_install_method == 'source'
- include_tasks: create-cert-standalone.yml
with_items: "{{ certbot_certs }}"
when:
- certbot_create_if_missing
- certbot_create_method == 'standalone'
loop_control:
loop_var: cert_item
- import_tasks: renew-cron.yml
when: certbot_auto_renew
+1 -1
View File
@@ -2,7 +2,7 @@
- name: Add cron job for certbot renewal (if configured).
cron:
name: Certbot automatic renewal.
job: "{{ certbot_script }} renew --quiet --no-self-upgrade"
job: "{{ certbot_script }} renew {{ certbot_auto_renew_options }}"
minute: "{{ certbot_auto_renew_minute }}"
hour: "{{ certbot_auto_renew_hour }}"
user: "{{ certbot_auto_renew_user }}"
+20
View File
@@ -0,0 +1,20 @@
---
# See: https://github.com/geerlingguy/ansible-role-certbot/issues/107
- block:
- name: Ensure dnf-plugins are installed on CentOS 8+.
yum:
name: dnf-plugins-core
state: present
- name: Enable DNF module for CentOS 8+.
shell: |
dnf config-manager --set-enabled powertools
args:
warn: false
register: dnf_module_enable
changed_when: false
when:
- ansible_distribution == 'CentOS'
- ansible_distribution_major_version | int >= 8
+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