=================
Upgrade playbooks
=================

This section describes the playbooks that are used in the upgrade process in
further detail.

Within the main :file:`scripts` directory there is an :file:`upgrade-utilities`
directory, which contains an additional playbooks directory. These playbooks
facilitate the upgrade process.

.. _lbaas-version-check:

lbaas-version-check.yml
-----------------------

This playbook is part of the general pre-flight checks.

Because LBaaS v1 isn't supported in Newton and above, and there is no
migration path, the deployer will have to manually disable LBaaS v1 before
upgrading. For openstack-ansible, we are checking if ``neutron_lbaas`` is
set to ``False``, but additional operations are to be done by the deployer for
the cleanup.

.. _fact-cleanup-playbook:

``ansible_fact_cleanup.yml``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This calls a script to removes files in
``/etc/openstack_deploy/ansible_facts/``

.. _config-change-playbook:

``deploy-config-changes.yml``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This playbook backs up the ``/etc/openstack_deploy`` directory before
changing the configuration.

``/etc/openstack_deploy`` copies once to ``/etc/openstack_deploy.NEWTON``.

.. _user-secrets-playbook:

``user-secrets-adjustment.yml``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This playbook ensures that the user secrets file is updated based on the
example file in the main repository, making it possible to guarantee all
secrets move into the upgraded environment and generate appropriately.
This adds only new secrets, such as those necessary for new services or new
settings added to existing services. Values set previously are not changed.

.. _repo-server-pip-conf-removal:

``repo-server-pip-conf-removal.yml``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The presence of ``pip.conf`` locks down all Python installations to packages
on the repo server. If ``pip.conf`` exists on the repo server, it creates a
circular dependency, causing build failures.

.. _old-hostname-compatibility:

``old-hostname-compatibility.yml``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This playbook ensures an alias is created for old hostnames that may not be
RFC 1034 or 1035 compatible. Using a hostname alias allows agents to continue
working in cases where the hostname is also the registered agent name. This
playbook is only needed for upgrades of in-place upgrades of existing nodes or
if a node is replaced or rebuilt it will be brought into the cluster using a
compliant hostname.

.. _setup-infra-playbook:

``setup-infrastructure.yml``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The ``playbooks`` directory contains the ``setup-infrastructure.yml`` playbook.
The ``run-upgrade.sh`` script calls ``setup-insfrastructure.yml`` with specific
arguments to upgrade MariaDB and RabbitMQ.

For example, to run an upgrade for both components at once, run the following
commands:

.. code-block:: console

    # openstack-ansible setup-infrastructure.yml -e 'rabbitmq_upgrade=true' \
    # -e 'galera_upgrade=true'

The ``rabbitmq_upgrade`` variable tells the ``rabbitmq_server`` role to
upgrade RabbitMQ.

.. note::
    The RabbitMQ server role installs patch releases automatically,
    regardless of the value of ``rabbitmq_upgrade``. This variable only
    controls upgrading the major or minor versions.

    Upgrading RabbitMQ in the Newton release is optional. The
    ``run-upgrade.sh`` script does not automatically upgrade it. To upgrade
    RabbitMQ, insert the ``rabbitmq_upgrade: true``
    line into a file, such as: ``/etc/openstack_deploy/user_variables.yml``.

The ``galera_upgrade`` variable tells the ``galera_server`` role to remove the
current version of MariaDB and Galera and upgrade to the 10.x series.

.. _memcached-flush:

``memcached-flush.yml``
~~~~~~~~~~~~~~~~~~~~~~~

Sends "flush_all" to memcached with the help of nc.

.. _aodh-api-init-delete:

``aodh-api-init-delete.yml``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Stops the ``aodh-api`` service and removes the init file since ``aodh-api``
now runs under Apache ``mod_wsgi``.
Run the ``os-aodh-install.yml`` playbook during the OpenStack services upgrade
to ensure ``aodh-api`` is available after running ``aodh-api-init-delete.yml``.


--------------

.. include:: navigation.txt