diff --git a/doc/source/index.rst b/doc/source/index.rst index 5eb46ae6a..d2392152a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -18,6 +18,7 @@ Admin Guide :maxdepth: 2 Installation + Upgrade Developer Guide =============== diff --git a/doc/source/upgrade.rst b/doc/source/upgrade.rst new file mode 100644 index 000000000..549aed214 --- /dev/null +++ b/doc/source/upgrade.rst @@ -0,0 +1,29 @@ +============================================== +Bare Metal Introspection Service Upgrade Guide +============================================== + +The `release notes `_ +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 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.