Browse Source

Merge "Document storage backends and migrating between them"

changes/41/587041/9
Zuul 3 years ago committed by Gerrit Code Review
parent
commit
86cd1a6aee
  1. 13
      doc/source/admin/upgrade.rst
  2. 16
      doc/source/install/index.rst

13
doc/source/admin/upgrade.rst

@ -26,3 +26,16 @@ When upgrading ironic-inspector, the following steps should always be taken:
.. note::
There is no implicit upgrade order between ironic and ironic-inspector,
unless the `release notes`_ say otherwise.
Migrating introspection data
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Starting with Stein release, ironic-inspector supports two introspection data
storage backends: ``swift`` and ``database``. If you decide to change the
backend, you can use the provided command to migrate the data::
ironic-inspector-migrate-data --from swift --to database --config-file /etc/ironic-inspector/inspector.conf
.. note::
Configuration for **both** backends is expected to be present in the
configuration file for this command to succeed.

16
doc/source/install/index.rst

@ -98,6 +98,22 @@ Fill in these minimum configuration values:
* if you wish to use the ``dnsmasq`` PXE/DHCP filter driver rather than the
default ``iptables`` driver, see the :ref:`dnsmasq_pxe_filter` description.
* ``store_data`` in the ``processing`` section defines where introspection data
is stored and takes one of three values:
``none``
introspection data is not stored (the default)
``database``
introspection data is stored in the database (recommended for standalone
deployments)
``swift``
introspection data is stored in the Object Store service (recommended for
full openstack deployments)
.. note::
It is possible to create third party storage backends using the
``ironic_inspector.introspection_data.store`` entry point.
See comments inside :doc:`the sample configuration
</configuration/sample-config>` for other possible configuration options.

Loading…
Cancel
Save