[Docs] Migrate security into user guide
Migrate all the security related user configurations into a user story. Change-Id: I4dfc5941abfd834d1d53a9c737db7afcce2841a0
This commit is contained in:
parent
b6eb92beca
commit
f1a7525570
@ -1,6 +1,6 @@
|
|||||||
================================
|
====================
|
||||||
Appendix K: Additional resources
|
Additional resources
|
||||||
================================
|
====================
|
||||||
|
|
||||||
Ansible resources:
|
Ansible resources:
|
||||||
|
|
||||||
|
@ -5,5 +5,4 @@ Appendices
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
app-advanced-config-sslcertificates.rst
|
|
||||||
app-resources.rst
|
app-resources.rst
|
||||||
|
@ -1,3 +1,5 @@
|
|||||||
|
.. _security-design:
|
||||||
|
|
||||||
Security
|
Security
|
||||||
========
|
========
|
||||||
|
|
||||||
@ -52,27 +54,6 @@ to all deployments. The role has been carefully designed to perform as follows:
|
|||||||
* Balance security with OpenStack performance and functionality
|
* Balance security with OpenStack performance and functionality
|
||||||
* Run as quickly as possible
|
* Run as quickly as possible
|
||||||
|
|
||||||
The role is applicable to physical hosts within an OpenStack-Ansible deployment
|
|
||||||
that are operating as any type of node, infrastructure or compute. By
|
|
||||||
default, the role is enabled. You can disable it by changing the value of
|
|
||||||
the ``apply_security_hardening`` variable in the ``user_variables.yml`` file
|
|
||||||
to ``false``:
|
|
||||||
|
|
||||||
.. code-block:: yaml
|
|
||||||
|
|
||||||
apply_security_hardening: false
|
|
||||||
|
|
||||||
You can apply security hardening configurations to an existing environment or
|
|
||||||
audit an environment by using a playbook supplied with OpenStack-Ansible:
|
|
||||||
|
|
||||||
.. code-block:: bash
|
|
||||||
|
|
||||||
# Apply security hardening configurations
|
|
||||||
openstack-ansible security-hardening.yml
|
|
||||||
|
|
||||||
# Perform a quick audit by using Ansible's check mode
|
|
||||||
openstack-ansible --check security-hardening.yml
|
|
||||||
|
|
||||||
For more information about the security configurations, see the
|
For more information about the security configurations, see the
|
||||||
`security hardening role`_ documentation.
|
`security hardening role`_ documentation.
|
||||||
|
|
||||||
|
@ -28,3 +28,4 @@ For in-depth technical information, see the
|
|||||||
limited-connectivity/index.rst
|
limited-connectivity/index.rst
|
||||||
l3pods/example.rst
|
l3pods/example.rst
|
||||||
ceph/full-deploy.rst
|
ceph/full-deploy.rst
|
||||||
|
security/index.rst
|
||||||
|
29
doc/source/user/security/hardening.rst
Normal file
29
doc/source/user/security/hardening.rst
Normal file
@ -0,0 +1,29 @@
|
|||||||
|
Apply ansible-hardening
|
||||||
|
=======================
|
||||||
|
|
||||||
|
The ``ansible-hardening`` role is applicable to physical hosts within
|
||||||
|
an OpenStack-Ansible deployment
|
||||||
|
that are operating as any type of node, infrastructure or compute. By
|
||||||
|
default, the role is enabled. You can disable it by changing the value of
|
||||||
|
the ``apply_security_hardening`` variable in the ``user_variables.yml`` file
|
||||||
|
to ``false``:
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
apply_security_hardening: false
|
||||||
|
|
||||||
|
You can apply security hardening configurations to an existing environment or
|
||||||
|
audit an environment by using a playbook supplied with OpenStack-Ansible:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
# Apply security hardening configurations
|
||||||
|
openstack-ansible security-hardening.yml
|
||||||
|
|
||||||
|
# Perform a quick audit by using Ansible's check mode
|
||||||
|
openstack-ansible --check security-hardening.yml
|
||||||
|
|
||||||
|
For more information about the security configurations, see the
|
||||||
|
`security hardening role`_ documentation.
|
||||||
|
|
||||||
|
.. _security hardening role: http://docs.openstack.org/developer/ansible-hardening/
|
12
doc/source/user/security/index.rst
Normal file
12
doc/source/user/security/index.rst
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
=================
|
||||||
|
Security settings
|
||||||
|
=================
|
||||||
|
|
||||||
|
This chapter contains information to configure specific security
|
||||||
|
settings for your OpenStack-Ansible cloud.
|
||||||
|
|
||||||
|
For understanding security design, please see
|
||||||
|
:ref:`security-design`.
|
||||||
|
|
||||||
|
.. include:: ssl-certificates.rst
|
||||||
|
.. include:: hardening.rst
|
@ -1,4 +1,3 @@
|
|||||||
=======================================
|
|
||||||
Securing services with SSL certificates
|
Securing services with SSL certificates
|
||||||
=======================================
|
=======================================
|
||||||
|
|
||||||
@ -12,24 +11,17 @@ communication between services:
|
|||||||
All public endpoints reside behind haproxy, resulting in the only certificate
|
All public endpoints reside behind haproxy, resulting in the only certificate
|
||||||
management most environments need are those for haproxy.
|
management most environments need are those for haproxy.
|
||||||
|
|
||||||
When deploying with OpenStack-Ansible, you can either use self-signed certificates
|
When deploying with OpenStack-Ansible, you can either use self-signed
|
||||||
that are generated during the deployment process or provide SSL certificates,
|
certificates that are generated during the deployment process or provide
|
||||||
keys, and CA certificates from your own trusted certificate authority. Highly
|
SSL certificates, keys, and CA certificates from your own trusted
|
||||||
secured environments use trusted, user-provided certificates for as
|
certificate authority. Highly secured environments use trusted,
|
||||||
many services as possible.
|
user-provided certificates for as many services as possible.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
Perform all SSL certificate configuration in
|
Perform all SSL certificate configuration in
|
||||||
``/etc/openstack_deploy/user_variables.yml`` file and not in the playbooks
|
``/etc/openstack_deploy/user_variables.yml`` file. Do not edit the playbooks
|
||||||
or roles themselves. The variables to set which provide the path on the deployment
|
or roles themselves.
|
||||||
node to the certificates for HAProxy configuration are:
|
|
||||||
|
|
||||||
.. code-block:: yaml
|
|
||||||
|
|
||||||
haproxy_user_ssl_cert: /etc/openstack_deploy/ssl/example.com.crt
|
|
||||||
haproxy_user_ssl_key: /etc/openstack_deploy/ssl/example.com.key
|
|
||||||
haproxy_user_ssl_ca_cert: /etc/openstack_deploy/ssl/ExampleCA.crt
|
|
||||||
|
|
||||||
Self-signed certificates
|
Self-signed certificates
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
@ -113,7 +105,22 @@ OpenStack-Ansible:
|
|||||||
the ``/etc/openstack_deploy/user_variables.yml`` file.
|
the ``/etc/openstack_deploy/user_variables.yml`` file.
|
||||||
#. Run the playbook for that service.
|
#. Run the playbook for that service.
|
||||||
|
|
||||||
For example, to deploy user-provided certificates for RabbitMQ,
|
HAProxy example
|
||||||
|
---------------
|
||||||
|
|
||||||
|
The variables to set which provide the path on the deployment
|
||||||
|
node to the certificates for HAProxy configuration are:
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
haproxy_user_ssl_cert: /etc/openstack_deploy/ssl/example.com.crt
|
||||||
|
haproxy_user_ssl_key: /etc/openstack_deploy/ssl/example.com.key
|
||||||
|
haproxy_user_ssl_ca_cert: /etc/openstack_deploy/ssl/ExampleCA.crt
|
||||||
|
|
||||||
|
RabbitMQ example
|
||||||
|
----------------
|
||||||
|
|
||||||
|
To deploy user-provided certificates for RabbitMQ,
|
||||||
copy the certificates to the deployment host, edit
|
copy the certificates to the deployment host, edit
|
||||||
the ``/etc/openstack_deploy/user_variables.yml`` file and set the following
|
the ``/etc/openstack_deploy/user_variables.yml`` file and set the following
|
||||||
three variables:
|
three variables:
|
Loading…
Reference in New Issue
Block a user