openstack-ansible/doc/source/install-guide/configure.rst
Ianeta Hutchinson 34cc7a8e54 [DOCS] Applying edits to the OSA install guide: configure
Change-Id: I563ecf597d76fc86e85d175c6a348f1b12d33b25
Partial-bug: #1628958
2016-10-05 20:31:39 +00:00

91 lines
3.3 KiB
ReStructuredText

.. _configure:
========================
Configure the deployment
========================
.. figure:: figures/installation-workflow-configure-deployment.png
:width: 100%
Ansible references some files that contain mandatory and optional
configuration directives. Before you can run the Ansible playbooks, modify
these files to define the target environment. Configuration tasks include:
* Target host networking to define bridge interfaces and
networks.
* A list of target hosts on which to install the software.
* Virtual and physical network relationships for OpenStack
Networking (neutron).
* Passwords for all services.
Initial environment configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
OpenStack-Ansible (OSA) depends on various files that are used to build an
inventory for Ansible. Perform the following configuration on the deployment
host.
#. Copy the contents of the
``/opt/openstack-ansible/etc/openstack_deploy`` directory to the
``/etc/openstack_deploy`` directory.
#. Change to the ``/etc/openstack_deploy`` directory.
#. Copy the ``openstack_user_config.yml.example`` file to
``/etc/openstack_deploy/openstack_user_config.yml``.
#. Review the ``openstack_user_config.yml`` file and make changes
to the deployment of your OpenStack environment.
.. note::
The file is heavily commented with details about the various options.
The configuration in the ``openstack_user_config.yml`` file defines which hosts
run the containers and services deployed by OpenStack-Ansible. For
example, hosts listed in the ``shared-infra_hosts`` section run containers for
many of the shared services that your OpenStack environment requires. Some of
these services include databases, Memcached, and RabbitMQ. Several other
host types contain other types of containers, and all of these are listed
in the ``openstack_user_config.yml`` file.
To configure your OpenStack installation for a test environment or production
environment, see the examples in :ref:`test-environment-config` and
:ref:`production-environment-config` file.
To install additional services, see the example configuration files in
``/etc/openstack_deploy/conf.d``.
For details about how the inventory is generated from the environment
configuration, see :ref:`developer-inventory`.
Configuring service credentials
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Configure credentials for each service in the
``/etc/openstack_deploy/*_secrets.yml`` files. Consider using the
`Ansible Vault <http://docs.ansible.com/playbooks_vault.html>`_ feature to
increase security by encrypting any files that contain credentials.
Adjust permissions on these files to restrict access by nonprivileged
users.
The ``keystone_auth_admin_password`` option configures the ``admin`` tenant
password for both the OpenStack API and Dashboard access.
We recommend that you use the ``pw-token-gen.py`` script to generate random
values for the variables in each file that contains service credentials:
.. code-block:: shell-session
# cd /opt/openstack-ansible/scripts
# python pw-token-gen.py --file /etc/openstack_deploy/user_secrets.yml
To regenerate existing passwords, add the ``--regen`` flag.
.. warning::
The playbooks do not currently manage changing passwords in an existing
environment. Changing passwords and rerunning the playbooks will fail
and might break your OpenStack environment.