Skip to content

Commit

Permalink
Document certs::apache parameters
Browse files Browse the repository at this point in the history
  • Loading branch information
ekohl committed Sep 26, 2023
1 parent 7242612 commit b398193
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions manifests/apache.pp
Original file line number Diff line number Diff line change
@@ -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,
Expand Down

0 comments on commit b398193

Please sign in to comment.