From 58da19be9b3b0041028d156636c169966da622bf Mon Sep 17 00:00:00 2001 From: Kenyon Ralph Date: Sun, 26 Nov 2023 14:43:57 -0800 Subject: [PATCH] install.pp: mark as private --- REFERENCE.md | 38 +------------------------------------- manifests/install.pp | 10 +++++++--- 2 files changed, 8 insertions(+), 40 deletions(-) diff --git a/REFERENCE.md b/REFERENCE.md index c7acece6..727f6f89 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -9,7 +9,6 @@ #### Public Classes * [`letsencrypt`](#letsencrypt): Install and configure Certbot, the LetsEncrypt client -* [`letsencrypt::install`](#letsencrypt--install): Installs the Let's Encrypt client. * [`letsencrypt::plugin::dns_cloudflare`](#letsencrypt--plugin--dns_cloudflare): Installs and configures the dns-cloudflare plugin * [`letsencrypt::plugin::dns_rfc2136`](#letsencrypt--plugin--dns_rfc2136): Installs and configures the dns-rfc2136 plugin * [`letsencrypt::plugin::dns_route53`](#letsencrypt--plugin--dns_route53): Installs and configures the dns-route53 plugin @@ -19,6 +18,7 @@ #### Private Classes * `letsencrypt::config`: Configures the Let's Encrypt client. +* `letsencrypt::install`: Installs the Let's Encrypt client. * `letsencrypt::scripts`: Deploy helper scripts scripts ### Defined types @@ -328,42 +328,6 @@ certificate. Two environmental variables are supplied by certbot: Default value: `[]` -### `letsencrypt::install` - -Installs the Let's Encrypt client. - -#### Parameters - -The following parameters are available in the `letsencrypt::install` class: - -* [`configure_epel`](#-letsencrypt--install--configure_epel) -* [`package_ensure`](#-letsencrypt--install--package_ensure) -* [`package_name`](#-letsencrypt--install--package_name) - -##### `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` - -##### `package_ensure` - -Data type: `String` - -The value passed to `ensure` when installing the client package. - -Default value: `$letsencrypt::package_ensure` - -##### `package_name` - -Data type: `String` - -Name of package to use when installing the client package. - -Default value: `$letsencrypt::package_name` - ### `letsencrypt::plugin::dns_cloudflare` This class installs and configures the Let's Encrypt dns-cloudflare plugin. diff --git a/manifests/install.pp b/manifests/install.pp index af1b47c3..a3efb5dc 100644 --- a/manifests/install.pp +++ b/manifests/install.pp @@ -4,11 +4,15 @@ # @param package_ensure The value passed to `ensure` when installing the client package. # @param package_name Name of package to use when installing the client package. # +# @api private +# class letsencrypt::install ( - Boolean $configure_epel = $letsencrypt::configure_epel, - String $package_name = $letsencrypt::package_name, - String $package_ensure = $letsencrypt::package_ensure, + Boolean $configure_epel = $letsencrypt::configure_epel, + String $package_name = $letsencrypt::package_name, + String $package_ensure = $letsencrypt::package_ensure, ) { + assert_private() + package { 'letsencrypt': ensure => $package_ensure, name => $package_name,