[Docs] Move upgrade guides into ops

Simplify the documentation, to be in-line with general openstack
recommendations, and follow the proposed blueprint
bp/docs-improvements.

Change-Id: Ib983d14cbbde13aa8fbb51ac91faa637ede3ed58
This commit is contained in:
Jean-Philippe Evrard 2018-02-18 08:33:02 +00:00
parent 8e8fa3be62
commit 56194bcb5a
6 changed files with 33 additions and 35 deletions

View File

@ -10,10 +10,8 @@ For information how to deploy your OpenStack-Ansible cloud, refer to the
for step-by-step instructions on how to deploy the OpenStack packages and
dependencies on your cloud using OpenStack-Ansible.
This guide is recommended for users of a successfully deployed
OpenStack-Ansible cloud. This explains from basic operations such as
adding images, booting instances, and attaching volumes, to the
more complex operations like upgrading.
This guide ranges from first operations to verify your deployment, to
the major upgrades procedures.
.. toctree::
:maxdepth: 1
@ -25,5 +23,7 @@ more complex operations like upgrading.
monitoring-systems.rst
backup-restore.rst
troubleshooting.rst
upgrades/minor-updates.rst
upgrades/major-upgrades.rst
advanced-config.rst
ref-info.rst

View File

@ -1,6 +1,5 @@
.. _upgrading-manually:
==================
Upgrading manually
==================

View File

@ -1,6 +1,5 @@
.. _upgrading-by-using-a-script:
===========================
Upgrading by using a script
===========================
@ -10,8 +9,8 @@ the code for migrating from |previous_release_formal_name| to
.. warning::
The upgrade script is still under active development. Do *not* run it
on a production environment at this time.
The upgrade script is always under active development.
Test it on a development environment first.
Running the upgrade script
~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@ -1,17 +1,18 @@
========
Overview
========
==============
Major upgrades
==============
An OpenStack-Ansible environment can upgrade to a minor or a major version.
This guide provides information about the upgrade process from
|previous_release_formal_name| to |current_release_formal_name|
for OpenStack-Ansible.
.. note::
You can only upgrade between sequential releases.
Upgrades between minor versions of OpenStack-Ansible require
updating the repository clone to the latest minor release tag, and then
running playbooks against the target hosts. For more information, see
:ref:`upgrading-to-a-minor-version`.
Introduction
============
For upgrades between major versions, the OpenStack-Ansible repository provides
playbooks and scripts to upgrade an environment. The ``run-upgrade.sh``
@ -24,7 +25,11 @@ major upgrade process performs the following actions:
- Places flag files that are created by the migration scripts in order to
achieve idempotency. These files are placed in the |upgrade_backup_dir|
directory.
- Upgrades the RabbitMQ server. See :ref:`setup-infra-playbook` for details.
- Upgrades the infrastructure servers.
See :ref:`setup-infra-playbook` for details.
For more information about the major upgrade process, see
:ref:`upgrading-by-using-a-script` and :ref:`upgrading-manually`.
.. include:: major-upgrades-with-script.rst
.. include:: major-upgrades-manual-upgrade.rst

View File

@ -1,19 +1,19 @@
.. _upgrading-to-a-minor-version:
=====================
Minor version upgrade
=====================
=================================
Executing a minor version upgrade
=================================
Upgrades between minor versions of OpenStack-Ansible require updating the
repository to the latest minor release tag, and then running playbooks
against the target hosts. This section provides instructions for those tasks.
Upgrades between minor versions of OpenStack-Ansible require
updating the repository clone to the latest minor release tag, updating
the ansible roles, and then running playbooks against the target hosts.
This section provides instructions for those tasks.
Prerequisites
~~~~~~~~~~~~~
To avoid issues and simplify troubleshooting during the upgrade, disable the
security hardening role by setting the ``apply_security_hardening`` variable
to ``False`` in the :file:`user_variables.yml` file.
to ``False`` in the :file:`user_variables.yml` file, and
backup your openstack-ansible installation.
Execute a minor version upgrade
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@ -1,16 +1,11 @@
=============
Upgrade Guide
=============
==========
User Guide
==========
This guide provides information about the upgrade process from
|previous_release_formal_name| to |current_release_formal_name|
for OpenStack-Ansible.
.. toctree::
:maxdepth: 2
overview
minor-upgrade
script-upgrade
manual-upgrade
reference