ironic-inspector/doc/source/upgrade.rst
Dmitry Tantsur 2bb48c6196 Document upgrade procedure
Change-Id: I4f013488ef1b7a605cca909e12f2b84c133ff3f4
2016-12-01 18:01:42 +01:00

30 lines
1.1 KiB
ReStructuredText

==============================================
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.