openstack
/
ironic-inspector
Code Issues Proposed changes

Document upgrade procedure 

Change-Id: I4f013488ef1b7a605cca909e12f2b84c133ff3f4
This commit is contained in:
Dmitry Tantsur 2016-11-03 13:18:13 +01:00
parent cb8db157e4
commit 2bb48c6196
2 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/index.rst
View File

@ -18,6 +18,7 @@ Admin Guide
:maxdepth: 2
Installation <install>
Upgrade <upgrade>
Developer Guide
===============

29
doc/source/upgrade.rst Normal file
View File

@ -0,0 +1,29 @@
==============================================
Bare Metal Introspection Service Upgrade Guide
==============================================
The `release notes <http://docs.openstack.org/releasenotes/ironic-inspector/>`_
should always be read carefully when upgrading the ironic-inspector service.
Starting with the Mitaka series, specific upgrade steps and considerations are
well-documented in the release notes.
Upgrades are only supported one series at a time, or within a series.
Only offline (with downtime) upgrades are currently supported.
When upgrading ironic-inspector, the following steps should always be taken:
* Update ironic-inspector code, without restarting the service yet.
* Stop the ironic-inspector service.
* Run database migrations::
ironic-inspector-dbsync --config-file <PATH-TO-INSPECTOR.CONF> upgrade
* Start the ironic-inspector service.
* Upgrade the ironic-python-agent image used for introspection.
.. note::
There is no implicit upgrade order between ironic and ironic-inspector,
unless the `release notes`_ say otherwise.