From b398193b7c2bedddeffec88d5fa7ca983cc7edd9 Mon Sep 17 00:00:00 2001 From: Ewoud Kohl van Wijngaarden Date: Tue, 26 Sep 2023 17:17:32 +0200 Subject: [PATCH] Document certs::apache parameters --- manifests/apache.pp | 46 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/manifests/apache.pp b/manifests/apache.pp index 88d5b6a1..df592102 100644 --- a/manifests/apache.pp +++ b/manifests/apache.pp @@ -1,4 +1,50 @@ # Certs configurations for Apache +# +# === Parameters: +# +# $hostname:: The fqdn of the host the generated certificates +# should be for +# +# $cname:: The alternative names of the host the generated certificates +# should be for +# +# $server_cert:: Path to the ssl certificate for https +# if not specified, the default CA will generate one +# +# $server_key:: Path to the ssl key for https +# if not specified, the default CA will generate one +# +# $server_cert_req:: Path to the ssl certificate request for https +# if not specified, the default CA will generate one +# +# === Advanced parameters: +# +# $generate:: Should the generation of the certs be part of the +# configuration +# +# $regenerate:: Force regeneration of the certificates (excluding +# CA certificates) +# +# $deploy:: Deploy the certs on the configured system. False means +# we want to apply it to a different system +# +# $country:: Country attribute for managed certificates +# +# $state:: State attribute for managed certificates +# +# $city:: City attribute for managed certificates +# +# $org:: Org attribute for managed certificates +# +# $org_unit:: Org unit attribute for managed certificates +# +# $expiration:: Expiration attribute for managed certificates +# +# $pki_dir:: The PKI directory under which to place certs +# +# $ssl_build_dir:: The directory where SSL keys, certs and RPMs will be generated +# +# $group:: The group who should own the certs class certs::apache ( Stdlib::Fqdn $hostname = $certs::node_fqdn, Array[Stdlib::Fqdn] $cname = $certs::cname,