diff --git a/CHANGELOG.md b/CHANGELOG.md index 0190af3..20b3ea3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,362 +1,399 @@ # Changelog All notable changes to this project will be documented in this file. Each new release typically also includes the latest modulesync defaults. These should not affect the functionality of the module. +## [v7.0.0](https://github.com/voxpupuli/puppet-letsencrypt/tree/v7.0.0) (2021-12-10) + +[Full Changelog](https://github.com/voxpupuli/puppet-letsencrypt/compare/v6.0.0...v7.0.0) + +**Breaking changes:** + +- Drop VCS install method support [\#246](https://github.com/voxpupuli/puppet-letsencrypt/issues/246) +- Update FreeBSD package name [\#253](https://github.com/voxpupuli/puppet-letsencrypt/pull/253) ([smortex](https://github.com/smortex)) +- Drop support for Debian 9, Ubuntu 16.04 and FreeBSD 11 \(EOL\) [\#251](https://github.com/voxpupuli/puppet-letsencrypt/pull/251) ([smortex](https://github.com/smortex)) +- modulesync 4.1.0 / Drop EoL Puppet 5 / Drop VCS install method [\#235](https://github.com/voxpupuli/puppet-letsencrypt/pull/235) ([bastelfreak](https://github.com/bastelfreak)) + +**Implemented enhancements:** + +- Add support for Debian 11 and FreeBSD 13 [\#252](https://github.com/voxpupuli/puppet-letsencrypt/pull/252) ([smortex](https://github.com/smortex)) +- support for Ubuntu 20.04 [\#247](https://github.com/voxpupuli/puppet-letsencrypt/pull/247) ([lschierer](https://github.com/lschierer)) + +**Closed issues:** + +- Raise compatible puppet version from \<7.0 to \<8.0 [\#245](https://github.com/voxpupuli/puppet-letsencrypt/issues/245) +- certbot-auto no longer works on any OS [\#240](https://github.com/voxpupuli/puppet-letsencrypt/issues/240) +- Logrotate for the letsencrypt logs [\#237](https://github.com/voxpupuli/puppet-letsencrypt/issues/237) +- RHEL8 support for dns-rfc2136 [\#236](https://github.com/voxpupuli/puppet-letsencrypt/issues/236) +- Cut new version with puppet-epel dependency? [\#232](https://github.com/voxpupuli/puppet-letsencrypt/issues/232) +- module complains about missing provider variable [\#209](https://github.com/voxpupuli/puppet-letsencrypt/issues/209) +- wrong initialize script [\#154](https://github.com/voxpupuli/puppet-letsencrypt/issues/154) + +**Merged pull requests:** + +- Allow epel 4 [\#261](https://github.com/voxpupuli/puppet-letsencrypt/pull/261) ([msalway](https://github.com/msalway)) +- remove .sync.yml with only Travis settings [\#260](https://github.com/voxpupuli/puppet-letsencrypt/pull/260) ([kenyon](https://github.com/kenyon)) +- docs: wording updates due to removal of VCS install method [\#259](https://github.com/voxpupuli/puppet-letsencrypt/pull/259) ([kenyon](https://github.com/kenyon)) +- init.pp: remove unused param $manage\_dependencies [\#258](https://github.com/voxpupuli/puppet-letsencrypt/pull/258) ([kenyon](https://github.com/kenyon)) +- README: not installing from source anymore; fix staging URL [\#257](https://github.com/voxpupuli/puppet-letsencrypt/pull/257) ([kenyon](https://github.com/kenyon)) +- dns\_rfc2136\_spec, dns\_route53\_spec: add Fedora 32, drop Fedora 30, 31 [\#256](https://github.com/voxpupuli/puppet-letsencrypt/pull/256) ([kenyon](https://github.com/kenyon)) +- Add support for RHEL 8 and AlmaLinux 8 [\#254](https://github.com/voxpupuli/puppet-letsencrypt/pull/254) ([yachub](https://github.com/yachub)) +- Allow up-to-date dependencies [\#248](https://github.com/voxpupuli/puppet-letsencrypt/pull/248) ([smortex](https://github.com/smortex)) +- Add quote marks to class names in readme [\#242](https://github.com/voxpupuli/puppet-letsencrypt/pull/242) ([thebeanogamer](https://github.com/thebeanogamer)) + ## [v6.0.0](https://github.com/voxpupuli/puppet-letsencrypt/tree/v6.0.0) (2020-09-11) [Full Changelog](https://github.com/voxpupuli/puppet-letsencrypt/compare/v5.0.0...v6.0.0) **Breaking changes:** - modulesync 2.10.0 / Drop FreeBSD 10 / Add FreeBSD 12 [\#213](https://github.com/voxpupuli/puppet-letsencrypt/pull/213) ([dhoppe](https://github.com/dhoppe)) **Implemented enhancements:** - add manifest to install dns-route53 plugin, along with tests [\#225](https://github.com/voxpupuli/puppet-letsencrypt/pull/225) ([aripringle](https://github.com/aripringle)) - Add `cert_name` parameter to `letsencrypt::certonly` [\#219](https://github.com/voxpupuli/puppet-letsencrypt/pull/219) ([saimonn](https://github.com/saimonn)) **Closed issues:** - typo in example [\#227](https://github.com/voxpupuli/puppet-letsencrypt/issues/227) - update metadata.json [\#218](https://github.com/voxpupuli/puppet-letsencrypt/issues/218) **Merged pull requests:** - modulesync 3.0.0 & puppet-lint updates [\#229](https://github.com/voxpupuli/puppet-letsencrypt/pull/229) ([bastelfreak](https://github.com/bastelfreak)) - fix typo in renew example [\#228](https://github.com/voxpupuli/puppet-letsencrypt/pull/228) ([milesstoetzner](https://github.com/milesstoetzner)) - Use voxpupuli-acceptance [\#224](https://github.com/voxpupuli/puppet-letsencrypt/pull/224) ([ekohl](https://github.com/ekohl)) - Ensure EPEL is configured before installing plugin [\#222](https://github.com/voxpupuli/puppet-letsencrypt/pull/222) ([alexjfisher](https://github.com/alexjfisher)) - \#218 Switch to puppet-epel [\#221](https://github.com/voxpupuli/puppet-letsencrypt/pull/221) ([kallies](https://github.com/kallies)) - Add Fedora 31, drop Fedora 29 [\#216](https://github.com/voxpupuli/puppet-letsencrypt/pull/216) ([ekohl](https://github.com/ekohl)) - delete legacy travis directory [\#214](https://github.com/voxpupuli/puppet-letsencrypt/pull/214) ([bastelfreak](https://github.com/bastelfreak)) - add --keep-until-expiring closer to letsencrypt command in cron [\#211](https://github.com/voxpupuli/puppet-letsencrypt/pull/211) ([pulecp](https://github.com/pulecp)) - allow puppetlabs/inifile 4.x [\#210](https://github.com/voxpupuli/puppet-letsencrypt/pull/210) ([bastelfreak](https://github.com/bastelfreak)) ## [v5.0.0](https://github.com/voxpupuli/puppet-letsencrypt/tree/v5.0.0) (2019-10-09) [Full Changelog](https://github.com/voxpupuli/puppet-letsencrypt/compare/v4.0.0...v5.0.0) **Breaking changes:** - remove params.pp and change some defaults values [\#205](https://github.com/voxpupuli/puppet-letsencrypt/pull/205) ([Dan33l](https://github.com/Dan33l)) - Drop Ubuntu 14.04 & add Debian 9/10 / Fedora 29/30 support [\#193](https://github.com/voxpupuli/puppet-letsencrypt/pull/193) ([ekohl](https://github.com/ekohl)) **Implemented enhancements:** - replace server urls with v2 urls [\#196](https://github.com/voxpupuli/puppet-letsencrypt/issues/196) - Option to clean up cronjobs for removed domains [\#175](https://github.com/voxpupuli/puppet-letsencrypt/issues/175) - update version shiped with vcs method to 0.39.0 [\#207](https://github.com/voxpupuli/puppet-letsencrypt/pull/207) ([Dan33l](https://github.com/Dan33l)) - use ACME API v2 [\#206](https://github.com/voxpupuli/puppet-letsencrypt/pull/206) ([Dan33l](https://github.com/Dan33l)) - feat\(facts\): add facts about certificates [\#187](https://github.com/voxpupuli/puppet-letsencrypt/pull/187) ([minorOffense](https://github.com/minorOffense)) **Fixed bugs:** - fix modulesync config file [\#201](https://github.com/voxpupuli/puppet-letsencrypt/pull/201) ([bastelfreak](https://github.com/bastelfreak)) **Closed issues:** - python2-certbot-dns-rfc2136 doesn't exist in debian buster [\#191](https://github.com/voxpupuli/puppet-letsencrypt/issues/191) - letsencrypt failed to generate certificate [\#184](https://github.com/voxpupuli/puppet-letsencrypt/issues/184) - `$letsencrypt::venv_path` is undocumented [\#21](https://github.com/voxpupuli/puppet-letsencrypt/issues/21) **Merged pull requests:** -- release 5.0.0 [\#208](https://github.com/voxpupuli/puppet-letsencrypt/pull/208) ([Dan33l](https://github.com/Dan33l)) - use puppet strings [\#204](https://github.com/voxpupuli/puppet-letsencrypt/pull/204) ([Dan33l](https://github.com/Dan33l)) - Raise upper bound version of stdlib & vcsrepo [\#202](https://github.com/voxpupuli/puppet-letsencrypt/pull/202) ([mfaure](https://github.com/mfaure)) - Fix type in readme: deploy\_hooks\_commands -\> deploy\_hook\_commands [\#188](https://github.com/voxpupuli/puppet-letsencrypt/pull/188) ([2ZZ](https://github.com/2ZZ)) - Allow puppetlabs/inifile 3.x [\#186](https://github.com/voxpupuli/puppet-letsencrypt/pull/186) ([dhoppe](https://github.com/dhoppe)) ## [v4.0.0](https://github.com/voxpupuli/puppet-letsencrypt/tree/v4.0.0) (2019-03-29) [Full Changelog](https://github.com/voxpupuli/puppet-letsencrypt/compare/v3.0.0...v4.0.0) **Breaking changes:** - Rework letsencrypt::certonly for \#175 [\#177](https://github.com/voxpupuli/puppet-letsencrypt/pull/177) ([cFire](https://github.com/cFire)) - Certonly: Refactor manage\_cron to ensure\_cron with appropriate data type [\#161](https://github.com/voxpupuli/puppet-letsencrypt/pull/161) ([craigwatson](https://github.com/craigwatson)) **Implemented enhancements:** - Add support for certbot renew and hooks [\#174](https://github.com/voxpupuli/puppet-letsencrypt/pull/174) ([Rathios](https://github.com/Rathios)) - Add support for wildcard certs [\#171](https://github.com/voxpupuli/puppet-letsencrypt/pull/171) ([Rathios](https://github.com/Rathios)) - Add support for dns-rfc2136 plugin [\#169](https://github.com/voxpupuli/puppet-letsencrypt/pull/169) ([Rathios](https://github.com/Rathios)) - Add ability to control keysize. Default to 4096. [\#165](https://github.com/voxpupuli/puppet-letsencrypt/pull/165) ([treveradams](https://github.com/treveradams)) **Fixed bugs:** - Fix for $live\_path variable [\#180](https://github.com/voxpupuli/puppet-letsencrypt/pull/180) ([cFire](https://github.com/cFire)) - \#178 Add single quote around all domains names in shell commands [\#179](https://github.com/voxpupuli/puppet-letsencrypt/pull/179) ([Turgon37](https://github.com/Turgon37)) - Fedora doesn't use EPEL for certbot/letsencrypt. [\#166](https://github.com/voxpupuli/puppet-letsencrypt/pull/166) ([treveradams](https://github.com/treveradams)) - Fix exec onlyif logic [\#151](https://github.com/voxpupuli/puppet-letsencrypt/pull/151) ([baurmatt](https://github.com/baurmatt)) **Closed issues:** - Domain wildcard should be escaped or quoted in shell commands [\#178](https://github.com/voxpupuli/puppet-letsencrypt/issues/178) - Upgrade letsencrypt to 0.30.2 [\#172](https://github.com/voxpupuli/puppet-letsencrypt/issues/172) - Disabling manage-cron does not remove crontab record [\#139](https://github.com/voxpupuli/puppet-letsencrypt/issues/139) - Add support for certbot hooks [\#56](https://github.com/voxpupuli/puppet-letsencrypt/issues/56) **Merged pull requests:** - surfacing package\_ensure in README [\#181](https://github.com/voxpupuli/puppet-letsencrypt/pull/181) ([Dan33l](https://github.com/Dan33l)) - Upgrade vcs version to 0.30.2 [\#173](https://github.com/voxpupuli/puppet-letsencrypt/pull/173) ([baurmatt](https://github.com/baurmatt)) - Add Fedora to tested systems list. [\#168](https://github.com/voxpupuli/puppet-letsencrypt/pull/168) ([treveradams](https://github.com/treveradams)) ## [v3.0.0](https://github.com/voxpupuli/puppet-letsencrypt/tree/v3.0.0) (2019-01-14) [Full Changelog](https://github.com/voxpupuli/puppet-letsencrypt/compare/v2.5.0...v3.0.0) **Breaking changes:** - vcs method, bump version of certbot to v0.30.0 [\#159](https://github.com/voxpupuli/puppet-letsencrypt/pull/159) ([Dan33l](https://github.com/Dan33l)) - modulesync 2.5.0 and drop Puppet4 support [\#156](https://github.com/voxpupuli/puppet-letsencrypt/pull/156) ([bastelfreak](https://github.com/bastelfreak)) **Implemented enhancements:** - Update to support puppetlabs/vcsrepo 2 [\#98](https://github.com/voxpupuli/puppet-letsencrypt/issues/98) - Update to support puppetlabs/inifile 2 [\#97](https://github.com/voxpupuli/puppet-letsencrypt/issues/97) - Improve performance of unless [\#148](https://github.com/voxpupuli/puppet-letsencrypt/pull/148) ([baurmatt](https://github.com/baurmatt)) - Add cron day of month parameter [\#146](https://github.com/voxpupuli/puppet-letsencrypt/pull/146) ([brigriffin](https://github.com/brigriffin)) - Added support for dns-cloudflare CertBot plugin. [\#145](https://github.com/voxpupuli/puppet-letsencrypt/pull/145) ([nick-dasilva](https://github.com/nick-dasilva)) - make the module compatible with FreeBSD [\#143](https://github.com/voxpupuli/puppet-letsencrypt/pull/143) ([Wayneoween](https://github.com/Wayneoween)) - Allow wildcard domains for certonly::domains [\#142](https://github.com/voxpupuli/puppet-letsencrypt/pull/142) ([Wimmesberger](https://github.com/Wimmesberger)) - Add cron time parameters [\#122](https://github.com/voxpupuli/puppet-letsencrypt/pull/122) ([matonb](https://github.com/matonb)) **Fixed bugs:** - Using a space in the letsencrypt::certonly title creates a cron script that will never run. [\#91](https://github.com/voxpupuli/puppet-letsencrypt/issues/91) - \#91: Cron should also run with space in certonly title [\#113](https://github.com/voxpupuli/puppet-letsencrypt/pull/113) ([siebrand](https://github.com/siebrand)) **Closed issues:** - wrong repository for EFF's tool to obtain certs from Let's Encrypt [\#153](https://github.com/voxpupuli/puppet-letsencrypt/issues/153) - Add support for Certbot dns\_cloudflare plugin. [\#144](https://github.com/voxpupuli/puppet-letsencrypt/issues/144) - Cronjob needs the options --text --non-interactive [\#55](https://github.com/voxpupuli/puppet-letsencrypt/issues/55) - This module should not manage git package [\#53](https://github.com/voxpupuli/puppet-letsencrypt/issues/53) - Add dependencies as a parameter [\#52](https://github.com/voxpupuli/puppet-letsencrypt/issues/52) - Spec tests break on the "certbot -h" command [\#44](https://github.com/voxpupuli/puppet-letsencrypt/issues/44) - Testing: Change the server or use --staging? [\#43](https://github.com/voxpupuli/puppet-letsencrypt/issues/43) - letsencrypt package is now called certbot [\#41](https://github.com/voxpupuli/puppet-letsencrypt/issues/41) - No letsencrypt package for centos 6? [\#31](https://github.com/voxpupuli/puppet-letsencrypt/issues/31) - rebuild module [\#20](https://github.com/voxpupuli/puppet-letsencrypt/issues/20) **Merged pull requests:** - add ubuntu 18.04 as supported OS [\#158](https://github.com/voxpupuli/puppet-letsencrypt/pull/158) ([Dan33l](https://github.com/Dan33l)) - use certbot repository [\#155](https://github.com/voxpupuli/puppet-letsencrypt/pull/155) ([Dan33l](https://github.com/Dan33l)) ## [v2.5.0](https://github.com/voxpupuli/puppet-letsencrypt/tree/v2.5.0) (2018-10-14) [Full Changelog](https://github.com/voxpupuli/puppet-letsencrypt/compare/v2.4.0...v2.5.0) **Implemented enhancements:** - Migrate letsencrypt::config::ini helper to native Puppet 4 [\#136](https://github.com/voxpupuli/puppet-letsencrypt/pull/136) ([baurmatt](https://github.com/baurmatt)) - Add support for dns-google plugin support [\#134](https://github.com/voxpupuli/puppet-letsencrypt/pull/134) ([jocado](https://github.com/jocado)) **Fixed bugs:** - Adding extra domain fails [\#94](https://github.com/voxpupuli/puppet-letsencrypt/issues/94) - Bug/proper domain validation [\#137](https://github.com/voxpupuli/puppet-letsencrypt/pull/137) ([baurmatt](https://github.com/baurmatt)) **Closed issues:** - Support certbot dns-google plugin [\#133](https://github.com/voxpupuli/puppet-letsencrypt/issues/133) - Don't use cron::environment [\#125](https://github.com/voxpupuli/puppet-letsencrypt/issues/125) **Merged pull requests:** - modulesync 2.2.0 and allow puppet 6.x [\#140](https://github.com/voxpupuli/puppet-letsencrypt/pull/140) ([bastelfreak](https://github.com/bastelfreak)) - allow puppetlabs/stdlib 5.x [\#135](https://github.com/voxpupuli/puppet-letsencrypt/pull/135) ([bastelfreak](https://github.com/bastelfreak)) - Fix cron environment leaking [\#126](https://github.com/voxpupuli/puppet-letsencrypt/pull/126) ([baurmatt](https://github.com/baurmatt)) ## [v2.4.0](https://github.com/voxpupuli/puppet-letsencrypt/tree/v2.4.0) (2018-06-19) [Full Changelog](https://github.com/voxpupuli/puppet-letsencrypt/compare/v2.3.0...v2.4.0) **Implemented enhancements:** - Support dns-route53 plugin [\#123](https://github.com/voxpupuli/puppet-letsencrypt/pull/123) ([jwm](https://github.com/jwm)) - Allow custom config dir; FreeBSD support [\#117](https://github.com/voxpupuli/puppet-letsencrypt/pull/117) ([a01fe](https://github.com/a01fe)) - Fixes \#81 added -n flag to certbot to run in unattended mode. [\#112](https://github.com/voxpupuli/puppet-letsencrypt/pull/112) ([K0HAX](https://github.com/K0HAX)) **Closed issues:** - route53 plugin support [\#118](https://github.com/voxpupuli/puppet-letsencrypt/issues/118) **Merged pull requests:** - Remove docker nodesets [\#121](https://github.com/voxpupuli/puppet-letsencrypt/pull/121) ([bastelfreak](https://github.com/bastelfreak)) - drop EOL OSs; fix puppet version range [\#120](https://github.com/voxpupuli/puppet-letsencrypt/pull/120) ([bastelfreak](https://github.com/bastelfreak)) ## [v2.3.0](https://github.com/voxpupuli/puppet-letsencrypt/tree/v2.3.0) (2018-02-28) [Full Changelog](https://github.com/voxpupuli/puppet-letsencrypt/compare/v2.2.0...v2.3.0) **Implemented enhancements:** - Add OpenBSD support [\#114](https://github.com/voxpupuli/puppet-letsencrypt/pull/114) ([arthurbarton](https://github.com/arthurbarton)) **Closed issues:** - Run fails on prompt during certonly if certs are not yet due for renewal [\#81](https://github.com/voxpupuli/puppet-letsencrypt/issues/81) ## [v2.2.0](https://github.com/voxpupuli/puppet-letsencrypt/tree/v2.2.0) (2018-01-04) [Full Changelog](https://github.com/voxpupuli/puppet-letsencrypt/compare/v2.1.0...v2.2.0) **Merged pull requests:** - bump inifile dependency to allow 2.x [\#109](https://github.com/voxpupuli/puppet-letsencrypt/pull/109) ([bastelfreak](https://github.com/bastelfreak)) - release 2.2.0 [\#108](https://github.com/voxpupuli/puppet-letsencrypt/pull/108) ([bastelfreak](https://github.com/bastelfreak)) - Update vcsrepo requirement \(smaller 3\) [\#107](https://github.com/voxpupuli/puppet-letsencrypt/pull/107) ([kallies](https://github.com/kallies)) - Remove EOL operatingsystems [\#106](https://github.com/voxpupuli/puppet-letsencrypt/pull/106) ([ekohl](https://github.com/ekohl)) ## [v2.1.0](https://github.com/voxpupuli/puppet-letsencrypt/tree/v2.1.0) (2017-11-13) [Full Changelog](https://github.com/voxpupuli/puppet-letsencrypt/compare/v2.0.1...v2.1.0) **Implemented enhancements:** - Added custom\_plugin param in certonly to disable use of '-a' flag. [\#84](https://github.com/voxpupuli/puppet-letsencrypt/pull/84) ([Lavaburn](https://github.com/Lavaburn)) **Closed issues:** - Puppet support in readme and metadata.json conflicts [\#102](https://github.com/voxpupuli/puppet-letsencrypt/issues/102) - Could not find declared class ::letsencrypt [\#101](https://github.com/voxpupuli/puppet-letsencrypt/issues/101) - Please issue a new release [\#54](https://github.com/voxpupuli/puppet-letsencrypt/issues/54) ## [v2.0.1](https://github.com/voxpupuli/puppet-letsencrypt/tree/v2.0.1) (2017-09-17) [Full Changelog](https://github.com/voxpupuli/puppet-letsencrypt/compare/v2.0.0...v2.0.1) **Merged pull requests:** - fixed randomness if the domain is almost same [\#96](https://github.com/voxpupuli/puppet-letsencrypt/pull/96) ([ashish1099](https://github.com/ashish1099)) ## [v2.0.0](https://github.com/voxpupuli/puppet-letsencrypt/tree/v2.0.0) (2017-06-22) [Full Changelog](https://github.com/voxpupuli/puppet-letsencrypt/compare/v1.1.0...v2.0.0) **Merged pull requests:** - release 2.0.0 [\#95](https://github.com/voxpupuli/puppet-letsencrypt/pull/95) ([bastelfreak](https://github.com/bastelfreak)) - replace validate\_\* with proper puppet4 datatypes [\#93](https://github.com/voxpupuli/puppet-letsencrypt/pull/93) ([bastelfreak](https://github.com/bastelfreak)) - Use the correct package names on Debian [\#88](https://github.com/voxpupuli/puppet-letsencrypt/pull/88) ([ekohl](https://github.com/ekohl)) - fix "-":12: command too long. errors in crontab file, can't install. [\#87](https://github.com/voxpupuli/puppet-letsencrypt/pull/87) ([saimonn](https://github.com/saimonn)) - Added ability to suppress cron output [\#79](https://github.com/voxpupuli/puppet-letsencrypt/pull/79) ([grega](https://github.com/grega)) ## [v1.1.0](https://github.com/voxpupuli/puppet-letsencrypt/tree/v1.1.0) (2017-02-11) [Full Changelog](https://github.com/voxpupuli/puppet-letsencrypt/compare/v1.0.1...v1.1.0) **Merged pull requests:** - Removing --quiet from certonly cron [\#74](https://github.com/voxpupuli/puppet-letsencrypt/pull/74) ([craigwatson](https://github.com/craigwatson)) - unbreak console output by ensuring actual text output [\#65](https://github.com/voxpupuli/puppet-letsencrypt/pull/65) ([igalic](https://github.com/igalic)) - Add cron\_before\_command [\#48](https://github.com/voxpupuli/puppet-letsencrypt/pull/48) ([gkopylov](https://github.com/gkopylov)) ## [v1.0.1](https://github.com/voxpupuli/puppet-letsencrypt/tree/v1.0.1) (2016-12-23) [Full Changelog](https://github.com/voxpupuli/puppet-letsencrypt/compare/v999.999.999...v1.0.1) **Merged pull requests:** - Bump minimum version dependencies \(for Puppet 4\) [\#72](https://github.com/voxpupuli/puppet-letsencrypt/pull/72) ([juniorsysadmin](https://github.com/juniorsysadmin)) - release 1.0.1 [\#71](https://github.com/voxpupuli/puppet-letsencrypt/pull/71) ([bastelfreak](https://github.com/bastelfreak)) ## [v999.999.999](https://github.com/voxpupuli/puppet-letsencrypt/tree/v999.999.999) (2016-12-20) [Full Changelog](https://github.com/voxpupuli/puppet-letsencrypt/compare/v1.0.0...v999.999.999) **Closed issues:** - 1.0.0 and 0.4.0 packages in puppetforge broken [\#46](https://github.com/voxpupuli/puppet-letsencrypt/issues/46) - undefined method `cycle' [\#37](https://github.com/voxpupuli/puppet-letsencrypt/issues/37) - Duplicate declaration: Package\[git\] is already declared in file [\#29](https://github.com/voxpupuli/puppet-letsencrypt/issues/29) - Using certonly in webroot mode fails with "can't convert Enumerable::Enumerator into Array" [\#28](https://github.com/voxpupuli/puppet-letsencrypt/issues/28) - Command Questions [\#26](https://github.com/voxpupuli/puppet-letsencrypt/issues/26) - Invalid resource type ini\_setting [\#22](https://github.com/voxpupuli/puppet-letsencrypt/issues/22) - Folders "\~/.local\..." bug [\#19](https://github.com/voxpupuli/puppet-letsencrypt/issues/19) - vcs-installed letsencrypt-auto creates '~' directory [\#16](https://github.com/voxpupuli/puppet-letsencrypt/issues/16) - Update to the latest lets-encrypt version: v0.4.0 [\#14](https://github.com/voxpupuli/puppet-letsencrypt/issues/14) - Alternative Puppet Module [\#4](https://github.com/voxpupuli/puppet-letsencrypt/issues/4) **Merged pull requests:** - Bump LetsEncrypt version to 0.9.3 \(latest as of Oct 2016\) [\#61](https://github.com/voxpupuli/puppet-letsencrypt/pull/61) ([jethrocarr](https://github.com/jethrocarr)) - Fix cronspam [\#60](https://github.com/voxpupuli/puppet-letsencrypt/pull/60) ([jethrocarr](https://github.com/jethrocarr)) - Fix failing builds [\#57](https://github.com/voxpupuli/puppet-letsencrypt/pull/57) ([jethrocarr](https://github.com/jethrocarr)) - Remove webroot\_paths cycling to match domains list [\#42](https://github.com/voxpupuli/puppet-letsencrypt/pull/42) ([danzilio](https://github.com/danzilio)) - Validate presence of webroot\_paths with webroot plugin [\#39](https://github.com/voxpupuli/puppet-letsencrypt/pull/39) ([domcleal](https://github.com/domcleal)) - Fix validation of letsencrypt\_command [\#38](https://github.com/voxpupuli/puppet-letsencrypt/pull/38) ([domcleal](https://github.com/domcleal)) - Various smaller fixes. [\#36](https://github.com/voxpupuli/puppet-letsencrypt/pull/36) ([thomasvs](https://github.com/thomasvs)) - Change EL7 package and command to certbot [\#35](https://github.com/voxpupuli/puppet-letsencrypt/pull/35) ([domcleal](https://github.com/domcleal)) - Add a way to change package name and command [\#34](https://github.com/voxpupuli/puppet-letsencrypt/pull/34) ([glorpen](https://github.com/glorpen)) - Defaults for el7 [\#33](https://github.com/voxpupuli/puppet-letsencrypt/pull/33) ([danzilio](https://github.com/danzilio)) - Closes \#18: merging @mheistermann's changes [\#32](https://github.com/voxpupuli/puppet-letsencrypt/pull/32) ([danzilio](https://github.com/danzilio)) - Added optional 'environment' parameter to init and certonly. Specced. [\#30](https://github.com/voxpupuli/puppet-letsencrypt/pull/30) ([tomgillett](https://github.com/tomgillett)) - Split letsencrypt commands, so -auto is only used once [\#27](https://github.com/voxpupuli/puppet-letsencrypt/pull/27) ([lazyfrosch](https://github.com/lazyfrosch)) - Fixing test failures when STRICT\_VARIABLES is set to true [\#25](https://github.com/voxpupuli/puppet-letsencrypt/pull/25) ([danzilio](https://github.com/danzilio)) - Update client [\#24](https://github.com/voxpupuli/puppet-letsencrypt/pull/24) ([lazyfrosch](https://github.com/lazyfrosch)) - Fix \#16 by specifying VENV\_PATH when running letsencrypt. [\#17](https://github.com/voxpupuli/puppet-letsencrypt/pull/17) ([mheistermann](https://github.com/mheistermann)) - Changing default version to 0.4.0 [\#15](https://github.com/voxpupuli/puppet-letsencrypt/pull/15) ([as0bu](https://github.com/as0bu)) ## [v1.0.0](https://github.com/voxpupuli/puppet-letsencrypt/tree/v1.0.0) (2016-02-22) [Full Changelog](https://github.com/voxpupuli/puppet-letsencrypt/compare/v0.4.0...v1.0.0) **Merged pull requests:** - updating changelog and prepping metadata for release as 1.0 [\#13](https://github.com/voxpupuli/puppet-letsencrypt/pull/13) ([danzilio](https://github.com/danzilio)) - Change Puppet 4 specifics to support 3.4+ [\#12](https://github.com/voxpupuli/puppet-letsencrypt/pull/12) ([domcleal](https://github.com/domcleal)) - Install LE package on EL7, Ubuntu 16.04 and Debian 9+ [\#11](https://github.com/voxpupuli/puppet-letsencrypt/pull/11) ([domcleal](https://github.com/domcleal)) ## [v0.4.0](https://github.com/voxpupuli/puppet-letsencrypt/tree/v0.4.0) (2016-02-01) [Full Changelog](https://github.com/voxpupuli/puppet-letsencrypt/compare/v0.3.2...v0.4.0) **Merged pull requests:** - Added webroot\_paths parameter [\#10](https://github.com/voxpupuli/puppet-letsencrypt/pull/10) ([stephenwade](https://github.com/stephenwade)) - Add --agree-tos to commands [\#9](https://github.com/voxpupuli/puppet-letsencrypt/pull/9) ([stephenwade](https://github.com/stephenwade)) - add optional cron job for certificate renewal [\#8](https://github.com/voxpupuli/puppet-letsencrypt/pull/8) ([hdeadman](https://github.com/hdeadman)) ## [v0.3.2](https://github.com/voxpupuli/puppet-letsencrypt/tree/v0.3.2) (2015-12-14) [Full Changelog](https://github.com/voxpupuli/puppet-letsencrypt/compare/v0.3.1...v0.3.2) **Merged pull requests:** - use -a to define plugin [\#7](https://github.com/voxpupuli/puppet-letsencrypt/pull/7) ([timogoebel](https://github.com/timogoebel)) - Replace package with ensure\_packages [\#6](https://github.com/voxpupuli/puppet-letsencrypt/pull/6) ([AndreaGiardini](https://github.com/AndreaGiardini)) ## [v0.3.1](https://github.com/voxpupuli/puppet-letsencrypt/tree/v0.3.1) (2015-12-08) [Full Changelog](https://github.com/voxpupuli/puppet-letsencrypt/compare/v0.3.0...v0.3.1) ## [v0.3.0](https://github.com/voxpupuli/puppet-letsencrypt/tree/v0.3.0) (2015-12-08) [Full Changelog](https://github.com/voxpupuli/puppet-letsencrypt/compare/v0.2.0...v0.3.0) **Merged pull requests:** - Adding support for RedHat and improving config [\#5](https://github.com/voxpupuli/puppet-letsencrypt/pull/5) ([danzilio](https://github.com/danzilio)) - Fix style in examples [\#3](https://github.com/voxpupuli/puppet-letsencrypt/pull/3) ([ghoneycutt](https://github.com/ghoneycutt)) - Fix test context with not supported operating systems [\#2](https://github.com/voxpupuli/puppet-letsencrypt/pull/2) ([AndreaGiardini](https://github.com/AndreaGiardini)) - A collection of commits working toward getting this to v1 [\#1](https://github.com/voxpupuli/puppet-letsencrypt/pull/1) ([ghoneycutt](https://github.com/ghoneycutt)) ## [v0.2.0](https://github.com/voxpupuli/puppet-letsencrypt/tree/v0.2.0) (2015-12-03) [Full Changelog](https://github.com/voxpupuli/puppet-letsencrypt/compare/v0.1.0...v0.2.0) ## [v0.1.0](https://github.com/voxpupuli/puppet-letsencrypt/tree/v0.1.0) (2015-12-03) [Full Changelog](https://github.com/voxpupuli/puppet-letsencrypt/compare/12019701ec328a3e8ed152ef4eb8a6f0f7524467...v0.1.0) -\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)* +\* *This Changelog was automatically generated by [github_changelog_generator] (https://github.com/github-changelog-generator/github-changelog-generator)* diff --git a/REFERENCE.md b/REFERENCE.md index 2bb4533..002c398 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -1,861 +1,757 @@ # Reference - ## Table of Contents -### Classes +**Classes** -#### Public Classes +_Public Classes_ * [`letsencrypt`](#letsencrypt): Install and configure Certbot, the LetsEncrypt client * [`letsencrypt::install`](#letsencryptinstall): Installs the Let's Encrypt client. * [`letsencrypt::plugin::dns_rfc2136`](#letsencryptplugindns_rfc2136): Installs and configures the dns-rfc2136 plugin * [`letsencrypt::plugin::dns_route53`](#letsencryptplugindns_route53): Installs and configures the dns-route53 plugin * [`letsencrypt::renew`](#letsencryptrenew): Configures renewal of Let's Encrypt certificates using Certbot -#### Private Classes +_Private Classes_ * `letsencrypt::config`: Configures the Let's Encrypt client. -### Defined types +**Defined types** * [`letsencrypt::certonly`](#letsencryptcertonly): Request a certificate using the `certonly` installer * [`letsencrypt::hook`](#letsencrypthook): Creates hook scripts. -### Functions +**Functions** -* [`letsencrypt::letsencrypt_lookup`](#letsencryptletsencrypt_lookup) +* [`letsencrypt::letsencrypt_lookup`](#letsencryptletsencrypt_lookup): -### Data types +**Data types** * [`Letsencrypt::Cron::Hour`](#letsencryptcronhour): mimic hour setting in cron as defined in man 5 crontab * [`Letsencrypt::Cron::Minute`](#letsencryptcronminute): mimic minute setting in cron as defined in man 5 crontab * [`Letsencrypt::Cron::Monthday`](#letsencryptcronmonthday): mimic monthday setting in cron as defined in man 5 crontab * [`Letsencrypt::Plugin`](#letsencryptplugin): List of accepted plugins ## Classes -### `letsencrypt` +### letsencrypt Install and configure Certbot, the LetsEncrypt client #### Examples ##### ```puppet class { 'letsencrypt' : email => 'letsregister@example.com', config => { 'server' => 'https://acme-staging-v02.api.letsencrypt.org/directory', }, } ``` #### Parameters -The following parameters are available in the `letsencrypt` class: - -* [`email`](#email) -* [`environment`](#environment) -* [`package_name`](#package_name) -* [`package_ensure`](#package_ensure) -* [`package_command`](#package_command) -* [`config_file`](#config_file) -* [`config`](#config) -* [`cron_scripts_path`](#cron_scripts_path) -* [`cron_owner_group`](#cron_owner_group) -* [`manage_config`](#manage_config) -* [`manage_install`](#manage_install) -* [`manage_dependencies`](#manage_dependencies) -* [`configure_epel`](#configure_epel) -* [`agree_tos`](#agree_tos) -* [`unsafe_registration`](#unsafe_registration) -* [`config_dir`](#config_dir) -* [`key_size`](#key_size) -* [`renew_pre_hook_commands`](#renew_pre_hook_commands) -* [`renew_post_hook_commands`](#renew_post_hook_commands) -* [`renew_deploy_hook_commands`](#renew_deploy_hook_commands) -* [`renew_additional_args`](#renew_additional_args) -* [`renew_cron_ensure`](#renew_cron_ensure) -* [`renew_cron_hour`](#renew_cron_hour) -* [`renew_cron_minute`](#renew_cron_minute) -* [`renew_cron_monthday`](#renew_cron_monthday) - -##### `email` +The following parameters are available in the `letsencrypt` class. + +##### `email` Data type: `Optional[String]` The email address to use to register with Let's Encrypt. This takes precedence over an 'email' setting defined in $config. -Default value: ``undef`` +Default value: `undef` -##### `environment` +##### `environment` Data type: `Array` An optional array of environment variables -Default value: `[]` +Default value: [] -##### `package_name` +##### `package_name` Data type: `String` -Name of package and command to use when installing the client with the `package` method. +Name of package and command to use when installing the client package. -Default value: `'certbot'` +Default value: 'certbot' -##### `package_ensure` +##### `package_ensure` Data type: `Any` -The value passed to `ensure` when installing the client with the `package` method. +The value passed to `ensure` when installing the client package. -Default value: `'installed'` +Default value: 'installed' -##### `package_command` +##### `package_command` Data type: `String` -Path or name for letsencrypt executable when installing the client with the `package` method. +Path or name for letsencrypt executable. -Default value: `'certbot'` +Default value: 'certbot' -##### `config_file` +##### `config_file` Data type: `String` The path to the configuration file for the letsencrypt cli. -Default value: `"${config_dir}/cli.ini"` +Default value: "${config_dir}/cli.ini" -##### `config` +##### `config` Data type: `Hash` A hash representation of the letsencrypt configuration file. -Default value: `{ 'server' => 'https://acme-v02.api.letsencrypt.org/directory' }` +Default value: { 'server' => 'https://acme-v02.api.letsencrypt.org/directory' } -##### `cron_scripts_path` +##### `cron_scripts_path` Data type: `String` The path for renewal scripts called by cron -Default value: `"${facts['puppet_vardir']}/letsencrypt"` +Default value: "${facts['puppet_vardir']}/letsencrypt" -##### `cron_owner_group` +##### `cron_owner_group` Data type: `String` Group owner of cron renew scripts. -Default value: `'root'` +Default value: 'root' -##### `manage_config` +##### `manage_config` Data type: `Boolean` A feature flag to toggle the management of the letsencrypt configuration file. -Default value: ``true`` +Default value: `true` -##### `manage_install` +##### `manage_install` Data type: `Boolean` A feature flag to toggle the management of the letsencrypt client installation. -Default value: ``true`` - -##### `manage_dependencies` - -Data type: `Boolean` - -A feature flag to toggle the management of the letsencrypt dependencies. - -Default value: ``true`` +Default value: `true` -##### `configure_epel` +##### `configure_epel` Data type: `Boolean` A feature flag to include the 'epel' class and depend on it for package installation. -##### `agree_tos` +##### `agree_tos` Data type: `Boolean` A flag to agree to the Let's Encrypt Terms of Service. -Default value: ``true`` +Default value: `true` -##### `unsafe_registration` +##### `unsafe_registration` Data type: `Boolean` A flag to allow using the 'register-unsafely-without-email' flag. -Default value: ``false`` +Default value: `false` -##### `config_dir` +##### `config_dir` Data type: `Stdlib::Unixpath` The path to the configuration directory. -Default value: `'/etc/letsencrypt'` +Default value: '/etc/letsencrypt' -##### `key_size` +##### `key_size` Data type: `Integer[2048]` Size for the RSA public key -Default value: `4096` +Default value: 4096 -##### `renew_pre_hook_commands` +##### `renew_pre_hook_commands` Data type: `Any` Array of commands to run in a shell before obtaining/renewing any certificates. -Default value: `[]` +Default value: [] -##### `renew_post_hook_commands` +##### `renew_post_hook_commands` Data type: `Any` Array of commands to run in a shell after attempting to obtain/renew certificates. -Default value: `[]` +Default value: [] -##### `renew_deploy_hook_commands` +##### `renew_deploy_hook_commands` Data type: `Any` Array of commands to run in a shell once for each successfully issued/renewed certificate. Two environmental variables are supplied by certbot: - $RENEWED_LINEAGE: Points to the live directory with the cert files and key. Example: /etc/letsencrypt/live/example.com - $RENEWED_DOMAINS: A space-delimited list of renewed certificate domains. Example: "example.com www.example.com" -Default value: `[]` +Default value: [] -##### `renew_additional_args` +##### `renew_additional_args` Data type: `Any` Array of additional command line arguments to pass to 'certbot renew'. -Default value: `[]` +Default value: [] -##### `renew_cron_ensure` +##### `renew_cron_ensure` Data type: `Any` Intended state of the cron resource running certbot renew. -Default value: `'absent'` +Default value: 'absent' -##### `renew_cron_hour` +##### `renew_cron_hour` Data type: `Any` Optional string, integer or array of hour(s) the renewal command should run. E.g. '[0,12]' to execute at midnight and midday. hour. -Default value: `fqdn_rand(24)` +Default value: fqdn_rand(24) -##### `renew_cron_minute` +##### `renew_cron_minute` Data type: `Any` Optional string, integer or array of minute(s) the renewal command should run. E.g. 0 or '00' or [0,30]. -Default value: `fqdn_rand(60, fqdn_rand_string(10))` +Default value: fqdn_rand(60, fqdn_rand_string(10)) -##### `renew_cron_monthday` +##### `renew_cron_monthday` Data type: `Any` Optional string, integer or array of monthday(s) the renewal command should run. E.g. '2-30/2' to run on even days. -Default value: `'*'` +Default value: '*' -### `letsencrypt::install` +### letsencrypt::install Installs the Let's Encrypt client. #### Parameters -The following parameters are available in the `letsencrypt::install` class: +The following parameters are available in the `letsencrypt::install` class. -* [`configure_epel`](#configure_epel) -* [`package_ensure`](#package_ensure) -* [`package_name`](#package_name) - -##### `configure_epel` +##### `configure_epel` Data type: `Boolean` A feature flag to include the 'epel' class and depend on it for package installation. -Default value: `$letsencrypt::configure_epel` +Default value: $letsencrypt::configure_epel -##### `package_ensure` +##### `package_ensure` Data type: `String` -The value passed to `ensure` when installing the client with the `package` method. +The value passed to `ensure` when installing the client package. -Default value: `$letsencrypt::package_ensure` +Default value: $letsencrypt::package_ensure -##### `package_name` +##### `package_name` Data type: `String` -Name of package to use when installing the client with the `package` method. +Name of package to use when installing the client package. -Default value: `$letsencrypt::package_name` +Default value: $letsencrypt::package_name -### `letsencrypt::plugin::dns_rfc2136` +### letsencrypt::plugin::dns_rfc2136 This class installs and configures the Let's Encrypt dns-rfc2136 plugin. https://certbot-dns-rfc2136.readthedocs.io #### Parameters -The following parameters are available in the `letsencrypt::plugin::dns_rfc2136` class: - -* [`server`](#server) -* [`key_name`](#key_name) -* [`key_secret`](#key_secret) -* [`key_algorithm`](#key_algorithm) -* [`port`](#port) -* [`propagation_seconds`](#propagation_seconds) -* [`manage_package`](#manage_package) -* [`package_name`](#package_name) -* [`config_dir`](#config_dir) +The following parameters are available in the `letsencrypt::plugin::dns_rfc2136` class. -##### `server` +##### `server` Data type: `Stdlib::Host` Target DNS server. -##### `key_name` +##### `key_name` Data type: `String[1]` TSIG key name. -##### `key_secret` +##### `key_secret` Data type: `String[1]` TSIG key secret. -##### `key_algorithm` +##### `key_algorithm` Data type: `String[1]` TSIG key algorithm. -Default value: `'HMAC-SHA512'` +Default value: 'HMAC-SHA512' -##### `port` +##### `port` Data type: `Stdlib::Port` Target DNS port. -Default value: `53` +Default value: 53 -##### `propagation_seconds` +##### `propagation_seconds` Data type: `Integer` Number of seconds to wait for the DNS server to propagate the DNS-01 challenge. -Default value: `10` +Default value: 10 -##### `manage_package` +##### `manage_package` Data type: `Boolean` Manage the plugin package. -Default value: ``true`` +Default value: `true` -##### `package_name` +##### `package_name` Data type: `String[1]` The name of the package to install when $manage_package is true. -##### `config_dir` +##### `config_dir` Data type: `Stdlib::Absolutepath` The path to the configuration directory. -Default value: `$letsencrypt::config_dir` +Default value: $letsencrypt::config_dir -### `letsencrypt::plugin::dns_route53` +### letsencrypt::plugin::dns_route53 This class installs and configures the Let's Encrypt dns-route53 plugin. https://certbot-dns-route53.readthedocs.io #### Parameters -The following parameters are available in the `letsencrypt::plugin::dns_route53` class: - -* [`propagation_seconds`](#propagation_seconds) -* [`manage_package`](#manage_package) -* [`package_name`](#package_name) +The following parameters are available in the `letsencrypt::plugin::dns_route53` class. -##### `propagation_seconds` +##### `propagation_seconds` Data type: `Integer` Number of seconds to wait for the DNS server to propagate the DNS-01 challenge. -Default value: `10` +Default value: 10 -##### `manage_package` +##### `manage_package` Data type: `Boolean` Manage the plugin package. -Default value: ``true`` +Default value: `true` -##### `package_name` +##### `package_name` Data type: `String[1]` The name of the package to install when $manage_package is true. -### `letsencrypt::renew` +### letsencrypt::renew Configures renewal of Let's Encrypt certificates using the certbot renew command. Note: Hooks set here will run before/after/for ALL certificates, including any not managed by Puppet. If you want to create hooks for specific certificates only, create them using letsencrypt::certonly. #### Parameters -The following parameters are available in the `letsencrypt::renew` class: +The following parameters are available in the `letsencrypt::renew` class. -* [`pre_hook_commands`](#pre_hook_commands) -* [`post_hook_commands`](#post_hook_commands) -* [`deploy_hook_commands`](#deploy_hook_commands) -* [`additional_args`](#additional_args) -* [`cron_ensure`](#cron_ensure) -* [`cron_hour`](#cron_hour) -* [`cron_minute`](#cron_minute) -* [`cron_monthday`](#cron_monthday) - -##### `pre_hook_commands` +##### `pre_hook_commands` Data type: `Variant[String[1], Array[String[1]]]` Array of commands to run in a shell before obtaining/renewing any certificates. -Default value: `$letsencrypt::renew_pre_hook_commands` +Default value: $letsencrypt::renew_pre_hook_commands -##### `post_hook_commands` +##### `post_hook_commands` Data type: `Variant[String[1], Array[String[1]]]` Array of commands to run in a shell after attempting to obtain/renew certificates. -Default value: `$letsencrypt::renew_post_hook_commands` +Default value: $letsencrypt::renew_post_hook_commands -##### `deploy_hook_commands` +##### `deploy_hook_commands` Data type: `Variant[String[1], Array[String[1]]]` Array of commands to run in a shell once for each successfully issued/renewed certificate. Two environmental variables are supplied by certbot: - $RENEWED_LINEAGE: Points to the live directory with the cert files and key. Example: /etc/letsencrypt/live/example.com - $RENEWED_DOMAINS: A space-delimited list of renewed certificate domains. Example: "example.com www.example.com" -Default value: `$letsencrypt::renew_deploy_hook_commands` +Default value: $letsencrypt::renew_deploy_hook_commands -##### `additional_args` +##### `additional_args` Data type: `Array[String[1]]` Array of additional command line arguments to pass to 'certbot renew'. -Default value: `$letsencrypt::renew_additional_args` +Default value: $letsencrypt::renew_additional_args -##### `cron_ensure` +##### `cron_ensure` Data type: `Enum['present', 'absent']` Intended state of the cron resource running certbot renew -Default value: `$letsencrypt::renew_cron_ensure` +Default value: $letsencrypt::renew_cron_ensure -##### `cron_hour` +##### `cron_hour` Data type: `Letsencrypt::Cron::Hour` Optional string, integer or array of hour(s) the renewal command should run. E.g. '[0,12]' to execute at midnight and midday. Default: fqdn-seeded random hour. -Default value: `$letsencrypt::renew_cron_hour` +Default value: $letsencrypt::renew_cron_hour -##### `cron_minute` +##### `cron_minute` Data type: `Letsencrypt::Cron::Minute` Optional string, integer or array of minute(s) the renewal command should run. E.g. 0 or '00' or [0,30]. Default: fqdn-seeded random minute. -Default value: `$letsencrypt::renew_cron_minute` +Default value: $letsencrypt::renew_cron_minute -##### `cron_monthday` +##### `cron_monthday` Data type: `Letsencrypt::Cron::Monthday` Optional string, integer or array of monthday(s) the renewal command should run. E.g. '2-30/2' to run on even days. Default: Every day. -Default value: `$letsencrypt::renew_cron_monthday` +Default value: $letsencrypt::renew_cron_monthday ## Defined types -### `letsencrypt::certonly` +### letsencrypt::certonly This type can be used to request a certificate using the `certonly` installer. #### Parameters -The following parameters are available in the `letsencrypt::certonly` defined type: - -* [`ensure`](#ensure) -* [`domains`](#domains) -* [`custom_plugin`](#custom_plugin) -* [`plugin`](#plugin) -* [`webroot_paths`](#webroot_paths) -* [`letsencrypt_command`](#letsencrypt_command) -* [`additional_args`](#additional_args) -* [`environment`](#environment) -* [`key_size`](#key_size) -* [`manage_cron`](#manage_cron) -* [`suppress_cron_output`](#suppress_cron_output) -* [`cron_before_command`](#cron_before_command) -* [`cron_success_command`](#cron_success_command) -* [`cron_hour`](#cron_hour) -* [`cron_minute`](#cron_minute) -* [`cron_monthday`](#cron_monthday) -* [`config_dir`](#config_dir) -* [`pre_hook_commands`](#pre_hook_commands) -* [`post_hook_commands`](#post_hook_commands) -* [`deploy_hook_commands`](#deploy_hook_commands) -* [`cert_name`](#cert_name) - -##### `ensure` +The following parameters are available in the `letsencrypt::certonly` defined type. + +##### `ensure` Data type: `Enum['present','absent']` Intended state of the resource Will remove certificates for specified domains if set to 'absent'. Will also remove cronjobs and renewal scripts if `manage_cron` is set to 'true'. -Default value: `'present'` +Default value: 'present' -##### `domains` +##### `domains` Data type: `Array[String[1]]` An array of domains to include in the CSR. -Default value: `[$title]` +Default value: [$title] -##### `custom_plugin` +##### `custom_plugin` Data type: `Boolean` Whether to use a custom plugin in additional_args and disable -a flag. -Default value: ``false`` +Default value: `false` -##### `plugin` +##### `plugin` Data type: `Letsencrypt::Plugin` The authenticator plugin to use when requesting the certificate. -Default value: `'standalone'` +Default value: 'standalone' -##### `webroot_paths` +##### `webroot_paths` Data type: `Array[Stdlib::Unixpath]` An array of webroot paths for the domains in `domains`. Required if using `plugin => 'webroot'`. If `domains` and `webroot_paths` are not the same length, the last `webroot_paths` element will be used for all subsequent domains. -Default value: `[]` +Default value: [] -##### `letsencrypt_command` +##### `letsencrypt_command` Data type: `String[1]` Command to run letsencrypt -Default value: `$letsencrypt::command` +Default value: $letsencrypt::command -##### `additional_args` +##### `additional_args` Data type: `Array[String[1]]` An array of additional command line arguments to pass to the `letsencrypt` command. -Default value: `[]` +Default value: [] -##### `environment` +##### `environment` Data type: `Array[String[1]]` An optional array of environment variables -Default value: `[]` +Default value: [] -##### `key_size` +##### `key_size` Data type: `Integer[2048]` Size for the RSA public key -Default value: `$letsencrypt::key_size` +Default value: $letsencrypt::key_size -##### `manage_cron` +##### `manage_cron` Data type: `Boolean` Indicating whether or not to schedule cron job for renewal. Runs daily but only renews if near expiration, e.g. within 10 days. -Default value: ``false`` +Default value: `false` -##### `suppress_cron_output` +##### `suppress_cron_output` Data type: `Boolean` Redirect cron output to devnull -Default value: ``false`` +Default value: `false` -##### `cron_before_command` +##### `cron_before_command` Data type: `Optional[String[1]]` Representation of a command that should be run before renewal command -Default value: ``undef`` +Default value: `undef` -##### `cron_success_command` +##### `cron_success_command` Data type: `Optional[String[1]]` Representation of a command that should be run if the renewal command succeeds. -Default value: ``undef`` +Default value: `undef` -##### `cron_hour` +##### `cron_hour` Data type: `Variant[Integer[0,23], String, Array]` Optional hour(s) that the renewal command should execute. e.g. '[0,12]' execute at midnight and midday. Default - seeded random hour. -Default value: `fqdn_rand(24, $title)` +Default value: fqdn_rand(24, $title) -##### `cron_minute` +##### `cron_minute` Data type: `Variant[Integer[0,59], String, Array]` Optional minute(s) that the renewal command should execute. e.g. 0 or '00' or [0,30]. Default - seeded random minute. -Default value: `fqdn_rand(60, fqdn_rand_string(10, $title))` +Default value: fqdn_rand(60, fqdn_rand_string(10, $title)) -##### `cron_monthday` +##### `cron_monthday` Data type: `Array[Variant[Integer[0, 59], String[1]]]` Optional string, integer or array of monthday(s) the renewal command should run. E.g. '2-30/2' to run on even days. Default: Every day. -Default value: `['*']` +Default value: ['*'] -##### `config_dir` +##### `config_dir` Data type: `Stdlib::Unixpath` The path to the configuration directory. -Default value: `$letsencrypt::config_dir` +Default value: $letsencrypt::config_dir -##### `pre_hook_commands` +##### `pre_hook_commands` Data type: `Variant[String[1], Array[String[1]]]` Array of commands to run in a shell before attempting to obtain/renew the certificate. -Default value: `[]` +Default value: [] -##### `post_hook_commands` +##### `post_hook_commands` Data type: `Variant[String[1], Array[String[1]]]` Array of command(s) to run in a shell after attempting to obtain/renew the certificate. -Default value: `[]` +Default value: [] -##### `deploy_hook_commands` +##### `deploy_hook_commands` Data type: `Variant[String[1], Array[String[1]]]` Array of command(s) to run in a shell once if the certificate is successfully issued. Two environmental variables are supplied by certbot: - $RENEWED_LINEAGE: Points to the live directory with the cert files and key. Example: /etc/letsencrypt/live/example.com - $RENEWED_DOMAINS: A space-delimited list of renewed certificate domains. Example: "example.com www.example.com" -Default value: `[]` +Default value: [] -##### `cert_name` +##### `cert_name` Data type: `String[1]` -Default value: `$title` +Default value: $title -### `letsencrypt::hook` +### letsencrypt::hook This type is used by letsencrypt::renew and letsencrypt::certonly to create hook scripts. #### Parameters -The following parameters are available in the `letsencrypt::hook` defined type: - -* [`type`](#type) -* [`hook_file`](#hook_file) -* [`commands`](#commands) +The following parameters are available in the `letsencrypt::hook` defined type. -##### `type` +##### `type` Data type: `Enum['pre', 'post', 'deploy']` Hook type. -##### `hook_file` +##### `hook_file` Data type: `String[1]` Path to deploy hook script. -##### `commands` +##### `commands` Data type: `Variant[String[1],Array[String[1]]]` Bash commands to execute when the hook is run by certbot. ## Functions -### `letsencrypt::letsencrypt_lookup` +### letsencrypt::letsencrypt_lookup Type: Ruby 4.x API The letsencrypt::letsencrypt_lookup function. #### `letsencrypt::letsencrypt_lookup(Any $cn)` The letsencrypt::letsencrypt_lookup function. Returns: `Any` ##### `cn` Data type: `Any` ## Data types -### `Letsencrypt::Cron::Hour` +### Letsencrypt::Cron::Hour mimic hour setting in cron as defined in man 5 crontab -Alias of - -```puppet -Variant[Integer[0,23], String[1], Array[ +Alias of `Variant[Integer[0,23], String[1], Array[ Variant[ Integer[0,23], String[1], ] - ]] -``` + ]]` -### `Letsencrypt::Cron::Minute` +### Letsencrypt::Cron::Minute mimic minute setting in cron as defined in man 5 crontab -Alias of - -```puppet -Variant[Integer[0,59], String[1], Array[ +Alias of `Variant[Integer[0,59], String[1], Array[ Variant[ Integer[0,59], String[1], ] - ]] -``` + ]]` -### `Letsencrypt::Cron::Monthday` +### Letsencrypt::Cron::Monthday mimic monthday setting in cron as defined in man 5 crontab -Alias of - -```puppet -Variant[Integer[0,31], String[1], Array[ +Alias of `Variant[Integer[0,31], String[1], Array[ Variant[ Integer[0,31], String[1], ] - ]] -``` + ]]` -### `Letsencrypt::Plugin` +### Letsencrypt::Plugin List of accepted plugins -Alias of - -```puppet -Enum['apache', 'standalone', 'webroot', 'nginx', 'dns-route53', 'dns-google', 'dns-cloudflare', 'dns-rfc2136'] -``` +Alias of `Enum['apache', 'standalone', 'webroot', 'nginx', 'dns-route53', 'dns-google', 'dns-cloudflare', 'dns-rfc2136']` diff --git a/metadata.json b/metadata.json index 73c9cd3..1e983b8 100644 --- a/metadata.json +++ b/metadata.json @@ -1,90 +1,90 @@ { "name": "puppet-letsencrypt", - "version": "6.0.1-rc0", + "version": "7.0.0", "author": "Vox Pupuli", "summary": "Manages lets-encrypt and certbot + related certs", "license": "Apache-2.0", "source": "https://github.com/voxpupuli/puppet-letsencrypt", "project_page": "https://github.com/voxpupuli/puppet-letsencrypt", "issues_url": "https://github.com/voxpupuli/puppet-letsencrypt/issues", "tags": [ "letsencrypt", "let's encrypt", "certbot", "acme" ], "operatingsystem_support": [ { "operatingsystem": "AlmaLinux", "operatingsystemrelease": [ "8" ] }, { "operatingsystem": "CentOS", "operatingsystemrelease": [ "7" ] }, { "operatingsystem": "RedHat", "operatingsystemrelease": [ "7", "8" ] }, { "operatingsystem": "Fedora", "operatingsystemrelease": [ "32" ] }, { "operatingsystem": "Ubuntu", "operatingsystemrelease": [ "18.04", "20.04" ] }, { "operatingsystem": "Debian", "operatingsystemrelease": [ "10", "11" ] }, { "operatingsystem": "OpenBSD", "operatingsystemrelease": [ "6.2" ] }, { "operatingsystem": "FreeBSD", "operatingsystemrelease": [ "12", "13" ] } ], "requirements": [ { "name": "puppet", "version_requirement": ">= 6.1.0 < 8.0.0" } ], "dependencies": [ { "name": "puppetlabs/stdlib", "version_requirement": ">= 4.13.1 < 9.0.0" }, { "name": "puppetlabs/inifile", "version_requirement": ">= 2.0.0 < 6.0.0" }, { "name": "puppet/epel", "version_requirement": ">= 3.0.1 < 5.0.0" } ] }