From f6e664db0e937df7a87eda0cc395a1f3784342a1 Mon Sep 17 00:00:00 2001
From: Jesse Pretorius <jesse.pretorius@rackspace.co.uk>
Date: Mon, 5 Oct 2015 17:23:23 +0100
Subject: [PATCH] Add minor upgrade documentation to the install guide

Change-Id: I15490d10edce508430ea3747544dadf661a6b111
---
 doc/source/install-guide/app-minorupgrade.rst | 104 ++++++++++++++++++
 doc/source/install-guide/app-tips.rst         |   2 +-
 doc/source/install-guide/index.rst            |   1 +
 3 files changed, 106 insertions(+), 1 deletion(-)
 create mode 100644 doc/source/install-guide/app-minorupgrade.rst

diff --git a/doc/source/install-guide/app-minorupgrade.rst b/doc/source/install-guide/app-minorupgrade.rst
new file mode 100644
index 0000000000..b47cc5a6c8
--- /dev/null
+++ b/doc/source/install-guide/app-minorupgrade.rst
@@ -0,0 +1,104 @@
+`Home <index.html>`__ OpenStack Ansible Installation Guide
+
+Appendix C. Minor Upgrades
+--------------------------
+
+Upgrades between minor versions of OpenStack-Ansible are handled by simply
+updating the repository clone to the latest tag, then executing playbooks
+against the target hosts.
+
+Due to changes in python package dependencies by OpenStack (even in stable
+branches) it is likely that some python packages may have to be downgraded in
+a production environment.
+
+In order to facilitate this extra options may be passed to the python package
+installer to reinstall based on whatever version of the package is available
+in the repository. This is done by executing, for example:
+
+.. code-block:: bash
+
+    openstack-ansible -e pip_install_options="--force-reinstall" \
+        setup-openstack.yml
+
+A minor upgrade will typically require the execution of the following:
+
+.. code-block:: bash
+
+    # Change directory into the repository clone root directory
+    cd /opt/openstack-ansible
+
+    # Update the git remotes
+    git fetch --all
+
+    # Checkout the latest tag (the below tag is an example)
+    git checkout 12.0.1
+
+    # Change into the playbooks directory
+    cd playbooks
+
+    # Build the updated repository
+    openstack-ansible repo-install.yml
+
+    # Update RabbitMQ
+    openstack-ansible -e rabbitmq_upgrade=true \
+        rabbitmq-install.yml
+
+    # Update the Utility Container
+    openstack-ansible -e pip_install_options="--force-reinstall" \
+        utility-install.yml
+
+    # Update all OpenStack Services
+    openstack-ansible -e pip_install_options="--force-reinstall" \
+        setup-openstack.yml
+
+Note that if you wish to scope the upgrades to specific OpenStack components
+then each of the component playbooks may be executed and scoped using groups.
+For example:
+
+.. code-block:: bash
+
+    # Update only the Compute Hosts
+    openstack-ansible -e pip_install_options="--force-reinstall" \
+        os-nova-install.yml --limit nova_compute
+
+    # Update only a single Compute Host
+    #  Skipping the 'nova-key' tag is necessary as the keys on all compute
+    #  hosts will not be gathered.
+    openstack-ansible -e pip_install_options="--force-reinstall" \
+        os-nova-install.yml --limit <node-name> --skip-tags 'nova-key'
+
+If you wish to see which hosts belong to which groups, the
+``inventory-manage.py`` script will show all groups and their hosts.
+For example:
+
+.. code-block:: bash
+
+    # Change directory into the repository clone root directory
+    cd /opt/openstack-ansible
+
+    # Show all groups and which hosts belong to them
+    ./scripts/inventory-manage.py -G
+
+    # Show all hosts and which groups they belong to
+    ./scripts/inventory-manage.py -g
+
+You may also see which hosts a playbook will execute against, and which tasks
+will be executed:
+
+.. code-block:: bash
+
+    # Change directory into the repository clone playbooks directory
+    cd /opt/openstack-ansible/playbooks
+
+    # See the hosts in the nova_compute group which a playbook will execute
+    #  against
+    openstack-ansible os-nova-install.yml --limit nova_compute --list-hosts
+
+    # See the tasks which will be executed on hosts in the nova_compute group
+    openstack-ansible os-nova-install.yml --limit nova_compute \
+                                          --skip-tags 'nova-key' \
+                                          --list-tasks
+
+--------------
+
+.. include:: navigation.txt
diff --git a/doc/source/install-guide/app-tips.rst b/doc/source/install-guide/app-tips.rst
index 2a31b3b460..0db32d7961 100644
--- a/doc/source/install-guide/app-tips.rst
+++ b/doc/source/install-guide/app-tips.rst
@@ -1,6 +1,6 @@
 `Home <index.html>`__ OpenStack Ansible Installation Guide
 
-Appendix C. Tips and Tricks
+Appendix D. Tips and Tricks
 ---------------------------
 
 Ansible Forks
diff --git a/doc/source/install-guide/index.rst b/doc/source/install-guide/index.rst
index 30f8e4f72f..dd5257bd90 100644
--- a/doc/source/install-guide/index.rst
+++ b/doc/source/install-guide/index.rst
@@ -60,4 +60,5 @@ Appendices
 
    app-configfiles.rst
    app-resources.rst
+   app-minorupgrade.rst
    app-tips.rst