Merge pull request #19 from exploide/package-install

Install Certbot with package
pull/3/merge
Jeff Geerling 8 years ago committed by GitHub
commit 3b47bfb39e
  1. 5
      .travis.yml
  2. 37
      README.md
  3. 3
      defaults/main.yml
  4. 11
      meta/main.yml
  5. 8
      tasks/include-vars.yml
  6. 17
      tasks/install-from-source.yml
  7. 7
      tasks/install-with-package.yml
  8. 25
      tasks/main.yml
  9. 8
      tasks/renew-cron.yml
  10. 23
      tests/test-source-install.yml
  11. 1
      tests/test.yml
  12. 1
      vars/Ubuntu-16.04.yml
  13. 2
      vars/default.yml

@ -4,9 +4,12 @@ services: docker
env: env:
- distro: centos7 - distro: centos7
- distro: centos6 - distro: centos6
playbook: test-source-install.yml
- distro: ubuntu1604 - distro: ubuntu1604
- distro: ubuntu1404 - distro: ubuntu1404
- distro: ubuntu1204 playbook: test-source-install.yml
- distro: debian8
playbook: test-source-install.yml
script: script:
# Download test shim. # Download test shim.

@ -2,31 +2,40 @@
[![Build Status](https://travis-ci.org/geerlingguy/ansible-role-certbot.svg?branch=master)](https://travis-ci.org/geerlingguy/ansible-role-certbot) [![Build Status](https://travis-ci.org/geerlingguy/ansible-role-certbot.svg?branch=master)](https://travis-ci.org/geerlingguy/ansible-role-certbot)
Installs Certbot (for Let's Encrypt) for RHEL/CentOS or Debian/Ubuntu. Installs and configures Certbot (for Let's Encrypt).
## Requirements ## Requirements
Certbot requires Git to be installed. You can install Git using the `geerlingguy.git` role. If one wants to install Certbot from upstream Git repository instead of distribution's package management, this role requires Git to be installed. You can install Git using the `geerlingguy.git` role.
## 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_auto_renew: true
certbot_auto_renew_user: "{{ ansible_user }}"
certbot_auto_renew_hour: 3
certbot_auto_renew_minute: 30
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.
### Variables Relavant for Source Installation from Git
Instead of installing Certbot from distribution's package management, installing from Git repository is also an option. This might be useful in several cases, but especially when older LTS distributions don't ship Certbot yet. These include CentOS < 7, Ubuntu < 16.10 and Debian < 8. Debian 8 includes Certbot package when packports repository is enabled.
In case source installation from Git is intended, the following variables are relevant:
certbot_install_from_source: yes
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: yes certbot_keep_updated: yes
Certbot code repository options. This role clones the agent from the configured repo, then makes the `certbot-auto` script executable. Certbot Git repository options. 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_dir: /opt/certbot certbot_dir: /opt/certbot
The directory inside which Certbot will be cloned. The directory inside which Certbot will be cloned.
certbot_auto_renew: true
certbot_auto_renew_user: "{{ ansible_user }}"
certbot_auto_renew_hour: 3
certbot_auto_renew_minute: 30
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-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.
## Dependencies ## Dependencies
None. None.
@ -34,20 +43,20 @@ None.
## Example Playbook ## Example Playbook
- hosts: servers - hosts: servers
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
After installation, you can create certificates using the `certbot-auto` script, which by default is installed inside the configured `certbot_dir`, so by default, `/opt/certbot/certbot-auto`. Here are some example commands to configure certificates with 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:
# Automatically add certs for all Apache virtualhosts (use with caution!). # Automatically add certs for all Apache virtualhosts (use with caution!).
/opt/certbot/certbot-auto --apache /opt/certbot/certbot-auto --apache
# Generate certs, but don't modify Apache configuration (safer). # Generate certs, but don't modify Apache configuration (safer).
/opt/certbot/certbot-auto --apache certonly /opt/certbot/certbot-auto --apache certonly

@ -1,10 +1,11 @@
--- ---
# Where to get Certbot. # Where to get Certbot.
certbot_install_from_source: no
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: yes certbot_keep_updated: yes
# Where to put Certbot. # Where to put Certbot when cloning from Git.
certbot_dir: /opt/certbot certbot_dir: /opt/certbot
# How to keep Certbot certs up to date. # How to keep Certbot certs up to date.

@ -3,21 +3,24 @@ dependencies: []
galaxy_info: galaxy_info:
author: geerlingguy author: geerlingguy
description: "Certbot (for Let's Encrypt) for RHEL/CentOS and Debian/Ubuntu." 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: 1.8 min_ansible_version: 2.0
platforms: platforms:
- name: EL - name: EL
versions: versions:
- 6 - 6
- 7 - 7
- name: Fedora
versions:
- all
- name: Ubuntu - name: Ubuntu
versions: versions:
- all - all
- name: Debian - name: Debian
versions: versions:
- all - all
galaxy_tags: galaxy_tags:
- networking - networking
- system - system

@ -0,0 +1,8 @@
---
- name: Load a variable file based on the OS type, or a default if not found.
include_vars: "{{ item }}"
with_first_found:
- "{{ ansible_distribution }}-{{ ansible_distribution_version }}.yml"
- "{{ ansible_distribution }}.yml"
- "{{ ansible_os_family }}.yml"
- "default.yml"

@ -0,0 +1,17 @@
---
- name: Clone Certbot into configured directory.
git:
repo: "{{ certbot_repo }}"
dest: "{{ certbot_dir }}"
version: "{{ certbot_version }}"
update: "{{ certbot_keep_updated }}"
force: yes
- name: Set Certbot script variable.
set_fact:
certbot_script: "{{ certbot_dir }}/certbot-auto"
- name: Ensure certbot-auto is executable.
file:
path: "{{ certbot_script }}"
mode: 0755

@ -0,0 +1,7 @@
---
- name: Install Certbot.
package: "name={{ certbot_package }} state=present"
- name: Set Certbot script variable.
set_fact:
certbot_script: "{{ certbot_package }}"

@ -1,22 +1,11 @@
--- ---
- name: Clone Certbot into configured directory. - include: include-vars.yml
git:
repo: "{{ certbot_repo }}"
dest: "{{ certbot_dir }}"
version: "{{ certbot_version }}"
update: "{{ certbot_keep_updated }}"
force: yes
- name: Ensure certbot-auto is executable. - include: install-with-package.yml
file: when: not certbot_install_from_source
path: "{{ certbot_dir }}/certbot-auto"
mode: 0755
- name: Add cron job for 'certbot-auto renew' (if configured). - include: install-from-source.yml
cron: when: certbot_install_from_source
name: Certbot automatic renewal.
job: "{{ certbot_dir }}/certbot-auto renew --quiet --no-self-upgrade" - include: renew-cron.yml
minute: "{{ certbot_auto_renew_minute }}"
hour: "{{ certbot_auto_renew_hour }}"
user: "{{ certbot_auto_renew_user }}"
when: certbot_auto_renew when: certbot_auto_renew

@ -0,0 +1,8 @@
---
- name: Add cron job for certbot renewal (if configured).
cron:
name: Certbot automatic renewal.
job: "{{ certbot_script }} renew --quiet --no-self-upgrade"
minute: "{{ certbot_auto_renew_minute }}"
hour: "{{ certbot_auto_renew_hour }}"
user: "{{ certbot_auto_renew_user }}"

@ -0,0 +1,23 @@
---
- hosts: all
vars:
certbot_install_from_source: yes
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
- role_under_test

@ -16,5 +16,4 @@
when: ansible_os_family == 'Debian' when: ansible_os_family == 'Debian'
roles: roles:
- geerlingguy.git
- role_under_test - role_under_test

@ -0,0 +1 @@
certbot_package: letsencrypt

@ -0,0 +1,2 @@
---
certbot_package: certbot
Loading…
Cancel
Save