openstack/ironic-inspector
Code Issues Proposed changes

Merge "docs: use openstackdocstheme extlink extension"

Browse Source
This commit is contained in:
Zuul 2019-12-17 00:04:18 +00:00 committed by Gerrit Code Review
commit b2c0c52a95
7 changed files with 48 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/admin/dnsmasq-pxe-filter.rst
View File

@ -82,9 +82,10 @@ commands to, for instance, directly control the **dnsmasq** service::
.. note:: .. note::
These commands are executed through the rootwrap_ facility, so overriding These commands are executed through the :oslo.rootwrap-doc:`rootwrap <>`
may require a filter file to be created in the ``rootwrap.d`` directory. A facility, so overriding may require a filter file to be created in the
sample configuration to use with the **systemctl** facility might be: ``rootwrap.d`` directory. A sample configuration to use with the
**systemctl** facility might be:
.. code-block:: console .. code-block:: console
@ -95,8 +96,6 @@ commands to, for instance, directly control the **dnsmasq** service::
systemctl: CommandFilter, systemctl, root, stop, dnsmasq systemctl: CommandFilter, systemctl, root, stop, dnsmasq
EOF EOF
.. _rootwrap: https://docs.openstack.org/oslo.rootwrap/latest/
Caveats Caveats
------- -------

10
doc/source/conf.py
View File

@ -21,6 +21,16 @@ except ImportError:
repository_name = 'openstack/ironic-inspector' repository_name = 'openstack/ironic-inspector'
use_storyboard = True use_storyboard = True
openstack_projects = [
'bifrost',
'devstack',
'ironic',
'ironic-python-agent',
'oslo.rootwrap',
'python-ironicclient',
'python-ironic-inspector-client',
'tooz',
]
wsme_protocols = ['restjson'] wsme_protocols = ['restjson']

31
doc/source/install/index.rst
View File

@ -6,19 +6,17 @@ environment)::
pip install ironic-inspector pip install ironic-inspector
Also there is a `DevStack <https://docs.openstack.org/devstack/latest/>`_ Also there is a :devstack-doc:`DevStack <>` plugin for **ironic-inspector** -
plugin for **ironic-inspector** - see :ref:`contributing_link` for the see :ref:`contributing_link` for the current status.
current status.
Finally, some distributions (e.g. Fedora) provide **ironic-inspector** Finally, some distributions (e.g. Fedora) provide **ironic-inspector**
packaged, some of them - under its old name *ironic-discoverd*. packaged, some of them - under its old name *ironic-discoverd*.
There are several projects you can use to set up **ironic-inspector** in There are several projects you can use to set up **ironic-inspector** in
production. `puppet-ironic production. `puppet-ironic <https://git.openstack.org/cgit/openstack/puppet-ironic/>`_
<https://git.openstack.org/cgit/openstack/puppet-ironic/>`_ provides Puppet provides Puppet manifests, while :bifrost-doc:`bifrost <>` provides an
manifests, while `bifrost <https://docs.openstack.org/bifrost/latest/>`_ Ansible-based standalone installer. Refer to Configuration_ if you plan on
provides an Ansible-based standalone installer. Refer to Configuration_ installing **ironic-inspector** manually.
if you plan on installing **ironic-inspector** manually.
.. _PyPI: https://pypi.org/project/ironic-inspector .. _PyPI: https://pypi.org/project/ironic-inspector
@ -90,7 +88,7 @@ non-standalone mode:
is configured to use ``etcd3+http://``, ``pymemcache`` is required to use is configured to use ``etcd3+http://``, ``pymemcache`` is required to use
``memcached://``. Some distributions may provide packages like ``memcached://``. Some distributions may provide packages like
``python3-etcd3gw`` or ``python3-memcache``. Supported drivers are listed at ``python3-etcd3gw`` or ``python3-memcache``. Supported drivers are listed at
`Tooz drivers <https://docs.openstack.org/tooz/latest/user/drivers.html>`_. :tooz-doc:`Tooz drivers <user/drivers.html>`.
* For ironic-inspector running in non-standalone mode, PXE configuration is * For ironic-inspector running in non-standalone mode, PXE configuration is
only required on the node where ironic-inspector conductor service is only required on the node where ironic-inspector conductor service is
@ -228,9 +226,9 @@ Replace ``stack`` with whatever user you'll be using to run
Configuring IPA Configuring IPA
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
ironic-python-agent_ is a ramdisk developed for **ironic** and support :ironic-python-agent-doc:`ironic-python-agent <>` is a ramdisk developed for
for **ironic-inspector** was added during the Liberty cycle. This is the **ironic** and support for **ironic-inspector** was added during the Liberty
default ramdisk starting with the Mitaka release. cycle. This is the default ramdisk starting with the Mitaka release.
.. note:: .. note::
You need at least 1.5 GiB of RAM on the machines to use IPA built with You need at least 1.5 GiB of RAM on the machines to use IPA built with
@ -254,11 +252,10 @@ To build an **ironic-python-agent** ramdisk, do the following:
Alternatively, you can download a `prebuilt TinyIPA image Alternatively, you can download a `prebuilt TinyIPA image
<https://tarballs.openstack.org/ironic-python-agent/tinyipa/files/>`_ or use <https://tarballs.openstack.org/ironic-python-agent/tinyipa/files/>`_ or use
the `other builders the :ironic-python-agent-doc:`other builders
<https://docs.openstack.org/ironic-python-agent/latest/install/index.html#image-builders>`_. <install/index.html#image-builders>`.
.. _diskimage-builder: https://docs.openstack.org/diskimage-builder/latest/ .. _diskimage-builder: https://docs.openstack.org/diskimage-builder/latest/
.. _ironic-python-agent: https://docs.openstack.org/ironic-python-agent/latest/
Configuring PXE Configuring PXE
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
@ -514,7 +511,9 @@ service. Below is a sample configuration for Apache with module mod_wsgi::
</Directory> </Directory>
</VirtualHost> </VirtualHost>
You can refer to `ironic installation document <https://docs.openstack.org/ironic/latest/install/install-rdo.html#configuring-ironic-api-behind-mod-wsgi>`_ You can refer to
:ironic-doc:`ironic installation document
<install/install-rdo.html#configuring-ironic-api-behind-mod-wsgi>`
for more guides. for more guides.
ironic-inspector conductor can be started with:: ironic-inspector conductor can be started with::

15
doc/source/user/http-api.rst
View File

@ -227,8 +227,10 @@ Ramdisk Callback
discovered data. Should not be used for anything other than implementing discovered data. Should not be used for anything other than implementing
the ramdisk. Request body: JSON dictionary with at least these keys: the ramdisk. Request body: JSON dictionary with at least these keys:
* ``inventory`` full `hardware inventory`_ from the ironic-python-agent with at * ``inventory`` full
least the following keys: :ironic-python-agent-doc:`hardware inventory
<admin/how_it_works.html#hardware-inventory>`
from the ironic-python-agent with at least the following keys:
* ``memory`` memory information containing at least key ``physical_mb`` - * ``memory`` memory information containing at least key ``physical_mb`` -
physical memory size as reported by dmidecode, physical memory size as reported by dmidecode,
@ -258,8 +260,9 @@ the ramdisk. Request body: JSON dictionary with at least these keys:
.. note:: .. note::
**ironic-inspector** default plugin ``root_disk_selection`` may change **ironic-inspector** default plugin ``root_disk_selection`` may change
``root_disk`` based on root device hints if node specify hints via ``root_disk`` based on root device hints if node specify hints via
properties ``root_device`` key. See `Specifying the disk for deployment properties ``root_device`` key. See
root device hints`_ for more details. :ironic-doc:`Specifying the disk for deployment root device hints <install/advanced.html#specifying-the-disk-for-deployment-root-device-hints>`
for more details.
* ``boot_interface`` MAC address of the NIC that the machine PXE booted from * ``boot_interface`` MAC address of the NIC that the machine PXE booted from
either in standard format ``11:22:33:44:55:66`` or in *PXELinux* ``BOOTIF`` either in standard format ``11:22:33:44:55:66`` or in *PXELinux* ``BOOTIF``
@ -291,10 +294,6 @@ Response:
Response body: JSON dictionary with ``uuid`` key. Response body: JSON dictionary with ``uuid`` key.
.. _hardware inventory: https://docs.openstack.org/ironic-python-agent/latest/admin/how_it_works.html#hardware-inventory
.. _Specifying the disk for deployment root device hints:
https://docs.openstack.org/ironic/latest/install/advanced.html#specifying-the-disk-for-deployment-root-device-hints
Error Response Error Response
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~

4
doc/source/user/troubleshooting.rst
View File

@ -22,8 +22,8 @@ There may be 3 reasons why introspection can time out after some time
#. Fatal failure in processing chain before node was found in the local cache. #. Fatal failure in processing chain before node was found in the local cache.
See `Troubleshooting data processing`_ for the hints. See `Troubleshooting data processing`_ for the hints.
#. Failure to load the ramdisk on the target node. See `Troubleshooting #. Failure to load the ramdisk on the target node. See
PXE boot`_ for the hints. `Troubleshooting PXE boot`_ for the hints.
#. Failure during ramdisk run. See `Troubleshooting ramdisk run`_ for the #. Failure during ramdisk run. See `Troubleshooting ramdisk run`_ for the
hints. hints.

12
doc/source/user/usage.rst
View File

@ -4,19 +4,17 @@ Usage
.. _usage_guide: .. _usage_guide:
Refer to :ref:`api <http_api>` for information on the HTTP API. Refer to :ref:`api <http_api>` for information on the HTTP API.
Refer to the `client documentation`_ for information on how to use CLI and Refer to the :python-ironic-inspector-client-doc:`client documentation <>`
Python library. for information on how to use CLI and Python library.
.. _client documentation: https://docs.openstack.org/python-ironic-inspector-client/latest/
Using from Ironic API Using from Ironic API
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
Ironic Kilo introduced support for hardware introspection under name of Ironic Kilo introduced support for hardware introspection under name of
"inspection". **ironic-inspector** introspection is supported for some generic "inspection". **ironic-inspector** introspection is supported for some generic
drivers, please refer to `Ironic inspection documentation`_ for details. drivers, please refer to
:ironic-doc:`Ironic inspection documentation <admin/inspection.html>`
.. _Ironic inspection documentation: https://docs.openstack.org/ironic/latest/admin/inspection.html for details.
Node States Node States
~~~~~~~~~~~ ~~~~~~~~~~~

10
doc/source/user/workflow.rst
View File

@ -6,7 +6,8 @@ Workflow
Usual hardware introspection flow is as follows: Usual hardware introspection flow is as follows:
* Operator enrolls nodes into Ironic_ e.g. via `openstack baremetal CLI`_ * Operator enrolls nodes into Ironic_ e.g. via
:python-ironicclient-doc:`openstack baremetal CLI <cli/osc_plugin_cli.html>`
command. Power management credentials should be provided to Ironic at this command. Power management credentials should be provided to Ironic at this
step. step.
@ -50,15 +51,15 @@ Usual hardware introspection flow is as follows:
Ironic inspection feature by default requires different settings: Ironic inspection feature by default requires different settings:
``add_ports=all``, ``keep_ports=present``, which means that ports will be ``add_ports=all``, ``keep_ports=present``, which means that ports will be
created for all detected NIC's, and all other ports will be deleted. created for all detected NIC's, and all other ports will be deleted.
Refer to the `Ironic inspection documentation`_ for details. Refer to the
:ironic-doc:`Ironic inspection documentation <admin/inspection.html>`
for details.
Ironic inspector can also be configured to not create any ports. This is Ironic inspector can also be configured to not create any ports. This is
done by setting ``add_ports=disabled``. If setting ``add_ports`` to disabled done by setting ``add_ports=disabled``. If setting ``add_ports`` to disabled
the ``keep_ports`` option should be also set to ``all``. This will ensure the ``keep_ports`` option should be also set to ``all``. This will ensure
no manually added ports will be deleted. no manually added ports will be deleted.
.. _Ironic inspection documentation: https://docs.openstack.org/ironic/latest/admin/inspection.html
* Separate API (see :ref:`usage <usage_guide>` and :ref:`api <http_api>`) can * Separate API (see :ref:`usage <usage_guide>` and :ref:`api <http_api>`) can
be used to query introspection results for a given node. be used to query introspection results for a given node.
@ -83,4 +84,3 @@ The diagram also shows events that trigger state transitions.
:alt: ironic-inspector state machine diagram :alt: ironic-inspector state machine diagram
.. _Ironic: https://wiki.openstack.org/wiki/Ironic .. _Ironic: https://wiki.openstack.org/wiki/Ironic
.. _openstack baremetal CLI: https://docs.openstack.org/python-ironicclient/latest/cli/osc_plugin_cli.html