aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJames Kirsch <generalfuzz@gmail.com>2020-04-16 16:10:46 -0500
committerMichal Arbet <michal.arbet@ultimum.io>2023-11-07 10:59:51 +0100
commit5581a282539b406977dcc6d1577ac2a51d46e4cf (patch)
tree1e75d190fa1f4a7541e6dabefe8e787bf45e2f63 /doc
parentc5f3f23e05a901bf2663184f13c137e46d71f507 (diff)
downloadkolla-ansible-5581a282539b406977dcc6d1577ac2a51d46e4cf.tar.gz
kolla-ansible-5581a282539b406977dcc6d1577ac2a51d46e4cf.zip
Add support for LetsEncrypt-managed certs
Add support for automatic provisioning and renewal of HTTPS certificates via LetsEncrypt. Spec is available at: https://etherpad.opendev.org/p/kolla-ansible-letsencrypt-https Depends-On: https://review.opendev.org/c/openstack/kolla/+/887347 Co-Authored-By: Michal Arbet <michal.arbet@ultimum.io> Implements: blueprint letsencrypt-https Change-Id: I35317ea0343f0db74ddc0e587862e95408e9e106
Diffstat (limited to 'doc')
-rw-r--r--doc/source/admin/tls.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/source/admin/tls.rst b/doc/source/admin/tls.rst
index f2acb9bb3..2810ecdc8 100644
--- a/doc/source/admin/tls.rst
+++ b/doc/source/admin/tls.rst
@@ -288,6 +288,35 @@ disable verification of the backend certificate:
.. _admin-tls-generating-a-private-ca:
+Generating TLS certificates with Let's Encrypt
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Let's Encrypt is a free, automated, and open certificate authority.
+
+To enable OpenStack to deploy the Let's Encrypt container to fetch
+certificates from the Let's Encrypt certificate authority, the following
+must be configured in ``globals.yml``:
+
+.. code-block:: yaml
+
+ enable_letsencrypt: "yes"
+ letsencrypt_email: "<The email used for registration and recovery contact>"
+
+The Let's Encrypt container will attempt to renew your certificates every 12
+hours. If the certificates are renewed, they will automatically be deployed
+to the HAProxy containers using SSH.
+
+.. note::
+
+ If ``letsencrypt_email`` is not valid email, letsencrypt role will
+ not work correctly.
+
+.. note::
+
+ If ``enable_letsencrypt`` is set to true, haproxy's socket will run with
+ admin access level. This is needed so Let's Encrypt can interact
+ with HAProxy.
+
Generating a Private Certificate Authority
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~