openstack/tripleo-docs
Code Issues Proposed changes
e710bbb57b
tripleo-docs/deploy-guide/source/features/tls-everywhere.rst

125 lines
5.1 KiB
ReStructuredText
Raw Normal View History

Add a new introduction for TLS documentation The existing documentation is full of useful bits for setting up TLS everywhere and TLS for public-only endpoints. This commit adds an introduction that attempts to describe the usecases for using TLS. Additionally, it adds short, concise descriptions of the components needed in TLS deployments and why they're important. This is going to be the first of a series of documentation patches that attempt to refactor the existing TLS/SSL documentation to be more use-case driven. The goal is to make it easier for readers and TripleO developers to understand how TLS works in TripleO. Change-Id: I7eaf8f852eaccf4debd0b5095c2622c53b09de4d
2019-10-31 09:19:19 -05:00
TLS-Everywhere
==============
Introduction
------------
Depending on your deployment's security requirements, you might be required to
encrypt network traffic. TripleO helps you accomplish this by supporting
various TLS deployment options. Let's start by understanding the different ways
we can deploy TLS.
The first option is to only encrypt traffic between clients and public
endpoints. This approach results in fewer certificates to manage, and we refer
to it as *public TLS*. Public endpoints, in this sense, are endpoints only
exposed to end-users. Traffic between internal endpoints is not encrypted. We
do not describe how to deploy *public TLS* in this document.
The second option leverages TLS for all endpoints in the entire deployment,
including the overcloud, undercloud, and any systems that natively support TLS.
We typically refer to this approach as *TLS-everywhere* because we use TLS
everywhere we can, encrypting as much network traffic as possible. Certificate
management is critical with this approach because the number of certificates
scales linearly with the number of services in your deployment. TripleO uses
several components to help ease the burden of managing certificates. This
option is desirable for deployments susceptible to industry regulation or those
who have a higher security risk. Healthcare, telecommunications, and the
public sector are but a few industries that make extensive use of
*TLS-everywhere*. This document contains all the details to deploy
*TLS-everywhere*.
TripleO makes use of the following components to implement *TLS-everywhere*.
The sections below describe each component and the role it plays in
*TLS-everywhere*.
Certmonger
~~~~~~~~~~
`Certmonger`_ is a daemon that helps simplify certificate management between
endpoints and certificate authorities (CAs). You can use it to generate key
pairs and certificate signing requests (CSRs). It can self-sign CSRs or send
them to external CAs for signing. Certmonger also tracks the expiration of each
certificate it manages. When a certificate is about to expire, Certmonger
requests a new certificate, updates it accordingly, and may restart a service.
This automation keeps the node enrolled as a client of the certificate
authority so that you don’t have to update hundreds, or thousands, of
certificates manually. Certmonger runs on each node that provides an endpoint
in your deployment.
.. _Certmonger: https://pagure.io/certmonger
FreeIPA
~~~~~~~
`FreeIPA`_ is a multi-purpose system that includes a certificate authority
(DogTag Certificate System), LDAP (389 Directory Server), MIT Kerberos, NTP
server, and DNS. TripleO uses all of these subsystems to implement TLS across
OpenStack. For example, if you use FreeIPA in your deployment, you can sign
CSRs with DogTag, as opposed to self-signing CSRs with certmonger locally.
FreeIPA runs on a supplemental node in your deployment, and it is kept separate
from other infrastructure.
.. _FreeIPA: https://www.freeipa.org/page/Main_Page
Installing FreeIPA
^^^^^^^^^^^^^^^^^^
Similar to setting up the undercloud node, you need to set the hostname
properly for the FreeIPA server. For this example, let's assume we're using
``example.com`` as the domain name for the deployment.::
sudo hostnamectl set-hostname ipa.example.come
sudo hostnamectl set-hostname --transient ipa.example.com
Collect and install the FreeIPA packages::
sudo yum install -y ipa-server ipa-server-dns
Configure FreeIPA::
sudo ipa-server-install --realm EXAMPLE.COM /
--ds-password $DIRECTORY_MANAGER_PASSWORD /
--admin-password $ADMIN_PASSWORD /
--hostname ipa.example.com /
--setup-dns /
--auto-forwarders /
--auto-reverse /
--unattended
Please refer to ``ipa-server-install --help`` for specifics on each argument.
The directions above are only a guide. You may need to adjust certain values
and configuration options to use FreeIPA, depending on your requirements.
Novajoin
~~~~~~~~
`Novajoin`_ is a vendor data service that extends nova's config drive
functionality. When the undercloud creates new nodes for the overcloud,
novajoin creates a host entry in FreeIPA to enable the overcloud node to enroll
as a FreeIPA client.
If you want to use novajoin, you must have nova deployed in your undercloud.
Novajoin isn't supported for deployments :doc:`deployed_server`.
Novajoin was introduced in the Queens release and is supported through Train.
The tripleo-ipa project, described below, effectively replaced novajoin in the
Train release.
.. _Novajoin: https://opendev.org/x/novajoin
tripleo-ipa
~~~~~~~~~~~
`tripleo-ipa`_ is a collection of Ansible roles used to integrate FreeIPA into
TripleO deployments. These playbooks support deployments using nova and ironic
in the undercloud as well as :doc:`deployed_server`. This project was
introduced in Train and effectively replaces the novajoin metadata service.
We recommend using tripleo-ipa for all *TLS-everywhere* deployments as of the
Train release. In a future release, we will update TripleO to only support
tripleo-ipa as the default method for configuring and deploying
*TLS-everywhere*.
.. _tripleo-ipa: https://opendev.org/x/tripleo-ipa
Copy Permalink