Files
openstack-ansible/doc/source/upgrade-guide/reference-scripts.rst
Jesse Pretorius 10a7d80b79 [docs] Resolve errors and simplify sphinx config
This patch does the following:

- Simplifies the sphinx configuration introduced in
  https://review.openstack.org/371722 to reduce the
  number of variables involved. The variables are
  also ordered in the same way everywhere to make it
  easier to read and troubleshoot.

- Simplifies some of the CLI guides to be more explicit
  about the tag to checkout when cloning the git repo.

- Cleaned up some references which went to non-existant
  documents.

- Added a link to the networking appendix.

- As per https://review.openstack.org/369650 the
  backup directory for the upgrade process is now
  the name of the source version the upgrade process is
  working with.

Change-Id: Iee30a32f99a66d9facb049311cadf1b9a8b2170e
2016-09-19 15:28:58 +00:00

1.6 KiB

Scripts

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

Within the main scripts directory there is a upgrade-utilities directory, which contains additional scripts that facilitate the initial upgrade process.

run-upgrade.sh

This script controls the overall upgrade process for deployers choosing not to do so manually.

It provides the following environment variables:

  • SCRIPTS_PATH - path to the top level scripts directory
  • MAIN_PATH - openstack_ansible root directory.
  • UPGRADE_PLAYBOOKS - path to the playbooks used in upgrading

The upgrade script also bootstraps OpenStack-Ansible (using bootstrap-ansible.sh) in order to provide the new role dependencies introduced in the series.

migrate_openstack_vars.py

Upstream decisions influenced the change of some variable names in . This script replaces any instances of these strings in the variable override files matching the pattern /etc/openstack_deploy/user_*.yml. Variable names within comments are updated.

This script creates files of the form VARS_MIGRATED_<filename> and places them in . For example, once the script has processed the file /etc/openstack_deploy/user_variables.yml, it creates VARS_MIGRATED_user_variables.yml in . This indicates to OpenStack-Ansible to skip this step on successive runs. The script itself does not check for this file.

Called by config-change-playbook