mirror of
https://github.com/krislamo/puppet-acme_vault
synced 2024-11-09 20:30:36 +00:00
232 lines
5.3 KiB
Markdown
232 lines
5.3 KiB
Markdown
|
|
# acme_vault
|
|
|
|
#### Table of Contents
|
|
|
|
1. [Description](#description)
|
|
2. [Setup - The basics of getting started with acme_vault](#setup)
|
|
* [What acme_vault affects](#what-acme_vault-affects)
|
|
* [Beginning with acme_vault](#beginning-with-acme_vault)
|
|
3. [Usage - Configuration options and additional functionality](#usage)
|
|
4. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
|
|
5. [Limitations - OS compatibility, etc.](#limitations)
|
|
6. [Development - Guide for contributing to the module](#development)
|
|
|
|
## Description
|
|
|
|
This module uses [acme.sh](https://github.com/Neilpang/acme.sh) to request
|
|
letsencrypt certificates using the DNS-01 challenge. Once valid certificates
|
|
are recieved, they are stored in [Hashicorp
|
|
vault](https://www.vaultproject.io/) where they can be retrieved by any
|
|
appropriate machine.
|
|
|
|
This module consists of a common class, a request class, and a deploy class.
|
|
The request class is intented to be enabled on a single machine that will
|
|
handle all the certificate request and validation. The deploy class is then
|
|
enabled on any machine that requires the requested certificates.
|
|
|
|
## Setup
|
|
|
|
### What acme_vault affects
|
|
|
|
This module will create a new system user that is used to request and deploy
|
|
certificates. It uses [lexicon](https://github.com/AnalogJ/lexicon) to make
|
|
api requests for dns changes. We use namecheap, so the required namecheap
|
|
python library is also included. Both are installed via pip.
|
|
|
|
This module also assumes a working installation of vault.
|
|
|
|
### Beginning with acme_vault
|
|
|
|
Just include the appropriate modules for the appropriate machines, and make
|
|
sure the required values are provided via hiera or class. Note: the common
|
|
module must be included before either.
|
|
|
|
Typically this would involve a profile like:
|
|
|
|
```puppet
|
|
class profiles::acme_request {
|
|
|
|
include ::acme_vault::common
|
|
include ::acme_vault::request
|
|
|
|
}
|
|
|
|
```
|
|
|
|
## Usage
|
|
|
|
This section is where you describe how to customize, configure, and do the fancy stuff with your module here. It's especially helpful if you include usage examples and code samples for doing things with your module.
|
|
|
|
## Reference
|
|
|
|
**Classes:**
|
|
|
|
* [acme_vault::common](#acme_vaultcommon)
|
|
* [acme_vault::request](#acme_vaultrequest)
|
|
* [acme_vault::deploy](#acme_vaultdeploy)
|
|
|
|
### Classes
|
|
|
|
#### acme_vault::common
|
|
|
|
|
|
#### acme_vault::request
|
|
|
|
Note: it does not automatically trigger requesting certs, but relies on cron
|
|
coordination to eventually reach the desired end state. Since certificate
|
|
renewal has a large time window, this is acceptable.
|
|
|
|
#### Parameters inherited from common, but can be overriden:
|
|
|
|
##### `user`
|
|
|
|
user to be created to request/deploy certs
|
|
|
|
Default value: `acme_vault`
|
|
|
|
##### `group`
|
|
|
|
group that the user belongs to. For deploy, this should probably be the webserver group
|
|
|
|
Default value: `acme_vault`
|
|
|
|
##### `home_dir`
|
|
|
|
home dir of the above user, where scripts and config will be stored.
|
|
|
|
Default value: `/home/$user`
|
|
|
|
##### `contact_email`
|
|
|
|
contact email used for cert registration, also used as MAILTO variable for cron jobs
|
|
|
|
Default value: `''`
|
|
|
|
##### `domains`
|
|
|
|
mapping of domains to be included in the cert. The key is the "main" domain,
|
|
and the value is the list of extra names to be requested. Both the main domain
|
|
and the list of domains are included.
|
|
|
|
REQUIRED
|
|
|
|
|
|
#### Parameters only for request:
|
|
|
|
#### `staging`
|
|
|
|
whether to use the acme staging endpoint
|
|
|
|
Valid values: `true`, `false`
|
|
|
|
Default value: `false`
|
|
|
|
#### `staging_url`
|
|
|
|
url to acme staging endpoint
|
|
|
|
Default value: `https://acme-staging-v02.api.letsencrypt.org/directory`
|
|
|
|
#### `prod_url`
|
|
|
|
url to the acme prod endpoint
|
|
|
|
Default value: `https://acme-v02.api.letsencrypt.org/directory`
|
|
|
|
#### `acme_revision`
|
|
|
|
git revision/tag to be used to checkout acme.sh repository.
|
|
|
|
Default value: `HEAD`
|
|
|
|
#### `acme_repo_path`
|
|
|
|
where the repo should be checked out.
|
|
|
|
Default value: `$home_dir/acme.sh`
|
|
|
|
#### `acme_script`
|
|
|
|
path the the acme.sh script itself
|
|
|
|
Default value: `$acme_repo_path/acme.sh`
|
|
|
|
#### `lexicon_provider`
|
|
|
|
provider for lexicon to use for dns-01 challanges.
|
|
|
|
REQUIRED
|
|
|
|
#### `lexicon_username`
|
|
|
|
username for lexicon dns.
|
|
|
|
REQUIRED
|
|
|
|
#### `lexicon_token`
|
|
|
|
token for lexicon user.
|
|
|
|
REQUIRED
|
|
|
|
### acme_vault::deploy
|
|
|
|
#### Parameters inherited from common, but can be overriden:
|
|
|
|
##### `user`
|
|
|
|
user to be created to request/deploy certs
|
|
|
|
Default value: `acme_vault`
|
|
|
|
##### `group`
|
|
|
|
group that the user belongs to. For deploy, this should probably be the webserver group
|
|
|
|
Default value: `acme_vault`
|
|
|
|
##### `home_dir`
|
|
|
|
home dir of the above user, where scripts and config will be stored.
|
|
|
|
Default value: `/home/$user`
|
|
|
|
##### `domains`
|
|
|
|
mapping of domains to be included in the cert. The key is the "main" domain,
|
|
and the value is the list of extra names to be requested. Both the main domain
|
|
and the list of domains are included.
|
|
|
|
REQUIRED
|
|
|
|
#### Parameters only for deplay:
|
|
|
|
##### `cert_destination_path`
|
|
|
|
where the cert should be deployed to. cert will end up in $cert_destination_path/$domain/.
|
|
|
|
Default value: `/etc/acme-vault`
|
|
|
|
##### `restart`
|
|
|
|
indicates if cron should include a restart after cert is deployed
|
|
|
|
Valid values: `true` `false`
|
|
|
|
##### `restart_command`
|
|
|
|
The command used restart any service after cert is deployed
|
|
|
|
Default value: `''`
|
|
|
|
|
|
## Limitations
|
|
|
|
Has only been tested on Centos 7
|
|
|
|
## Development
|
|
|
|
Contributions are welcome!
|
|
|