system-config/playbooks/roles/letsencrypt-config-certcheck/README.rst

Generate SSL check list

This role automatically generates a list of domains for the
certificate validation checks.  This ensures our certificates are
valid and are being renewed as expected.

This role must run after ``letsencrypt-request-certs`` role, as that
builds the ``letsencrypt_certcheck_domains`` variable for each
host and certificate.  It must also run on a host that has already run
the ``install-certcheck`` role.

**Role Variables**

.. zuul:rolevar:: letsencrypt_certcheck_domain_list
   :default: /var/lib/certcheck/ssldomains

   The ssl-cert-check domain configuration file to write.  See also
   the ``install-certcheck`` role.

.. zuul:rolevar:: letsencrypt_certcheck_additional_domains
   :default: []

   A list of additional domains to check for hosts not using the
   ``letsencrypt-*`` roles.  Each entry should be in the format
   ``hostname port``.
Generate ssl check list directly from letsencrypt variables This autogenerates the list of ssl domains for the ssl-cert-check tool directly from the letsencrypt list. The first step is the install-certcheck role that replaces the puppet-ssl_cert_check module that does the same. The reason for this is so that during gate testing we can test this on the test bridge.openstack.org server, and avoid adding another node as a requirement for this test. letsencrypt-request-certs is updated to set a fact letsencrypt_certcheck_domains for each host that is generating a certificate. As described in the comments, this defaults to the first host specified for the certificate and the listening port can be indicated (if set, this new port value is stripped when generating certs as is not necessary for certificate generation). The new letsencrypt-config-certcheck role runs and iterates all letsencrypt hosts to build the final list of domains that should be checked. This is then extended with the letsencrypt_certcheck_additional_domains value that covers any hosts using certificates not provisioned by letsencrypt using this mechanism. These additional domains are pre-populated from the openstack.org domains in the extant check file, minus those openstack.org domain certificates we are generating via letsencrypt (see letsencrypt-create-certs/handlers/main.yaml). Additionally, we update some of the certificate variables in host_vars that are listening on port !443. As mentioned, bridge.openstack.org is placed in the new certcheck group for gate testing, so the tool and config file will be deployed to it. For production, cacti is added to the group, which is where the tool currently runs. The extant puppet installation is disabled, pending removal in a follow-on change. Change-Id: Idbe084f13f3684021e8efd9ac69b63fe31484606 2020-05-18 14:43:16 +10:00			`Generate SSL check list`

			`This role automatically generates a list of domains for the`
			`certificate validation checks. This ensures our certificates are`
			`valid and are being renewed as expected.`

			This role must run after ``letsencrypt-request-certs`` role, as that
			builds the ``letsencrypt_certcheck_domains`` variable for each
			`host and certificate. It must also run on a host that has already run`
			the ``install-certcheck`` role.

			`Role Variables`

			`.. zuul:rolevar:: letsencrypt_certcheck_domain_list`
			`:default: /var/lib/certcheck/ssldomains`

			`The ssl-cert-check domain configuration file to write. See also`
			the ``install-certcheck`` role.

			`.. zuul:rolevar:: letsencrypt_certcheck_additional_domains`
			`:default: []`

			`A list of additional domains to check for hosts not using the`
			``letsencrypt-*`` roles. Each entry should be in the format
			``hostname port``.