[docs] Add documentation for 'install_method' variable

The 'install_method' variable can be used to deploy OpenStack services
either from source or from distribution packages. Since this variable
is meant to be set during the initial deployment and can't be changed
afterwards, it is important to document it in order to let deployers
know about it.

Implements: blueprint openstack-distribution-packages
Change-Id: I59fe66a5cef45487afbfc090aca93cb567427f7a
This commit is contained in:
Markos Chandras 2018-08-07 10:58:17 +03:00 committed by Amy Marrich (spotz)
parent 2d88a3cb0c
commit 2da59eeabc
3 changed files with 35 additions and 0 deletions

View File

@ -43,6 +43,27 @@ host.
See our :dev_docs:`User Guide <user/index.html>` and
:dev_docs:`Reference Guide <reference/index.html>` for more details.
#. Review the ``user_variables.yml`` file to configure global and role specific
deployment options. The file contains some example variables and comments but
you can get the full list of variables in each role's specific documentation.
.. note::
One imporant variable is the ``install_method`` which configures the installation
method for the OpenStack services. The services can either be deployed from
source (default) or from distribution packages. Source based deployments are closer
to a vanilla OpenStack installation and allow for more tweaking and customizations. On
the other hand, distro based deployments generally provide a package combination which
has been verified by the distributions themselves. However, this means that updates are
being released less often and with a potential delay. Moreover, this method might offer
fewer opportunities for deployment customizations. The ``install_method`` variable is set
during the initial deployment and you **must not** change it as OpenStack-Ansible is not
able to convert itself from one installation method to the other. As such, it's
important to judge your needs against the pros and cons of each method before making
a decision. Please note that the ``distro`` installation method was introduced during
the Rocky cycle, and as a result of which, Ubuntu 16.04 is not supported due to the
fact that there are no Rocky packages for it.
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

View File

@ -21,6 +21,12 @@
## Debug and Verbose options.
debug: false
## Installation method for OpenStack services
# Default option (source) is to install the OpenStack services using PIP
# packages. An alternative method (distro) is to use the distribution cloud
# repositories to install OpenStack using distribution packages
install_method: source
## Common Glance Overrides
# Set glance_default_store to "swift" if using Cloud Files backend
# or "rbd" if using ceph backend; the latter will trigger ceph to get

View File

@ -0,0 +1,8 @@
---
features:
- |
Deployers can now set the ``install_method`` to either ``source`` (default)
or ``distro`` to choose the method for installing OpenStack services on the
hosts. This only applies to *new* deployments. Existing deployments which
are source based, cannot be converted to the new ``distro`` method.
For more information, please refer to the `Deployment Guide <https://docs.openstack.org/project-deploy-guide/openstack-ansible>`_.