openstack/ironic-inspector
Code Issues Proposed changes

[doc] Improvements in processing_hooks docs

Browse Source 
* Emphasise that order matters.
* Make order of LLDP-related hooks the recommended one.
* Fix some related wording.
* Mention IPA param requirements already in lldp_basic hook.

Change-Id: I043fdd5b5582971e43211c9a860d6b28ca73dc4e
This commit is contained in:
Radosław Piliszek 2021-06-04 11:44:21 +00:00
parent ec4ee8171c
commit 1ba0849b6b
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -186,7 +186,7 @@ Plugins
**ironic-inspector** heavily relies on plugins for data processing. Even the **ironic-inspector** heavily relies on plugins for data processing. Even the
standard functionality is largely based on plugins. Set ``processing_hooks`` standard functionality is largely based on plugins. Set ``processing_hooks``
option in the configuration file to change the set of plugins to be run on option in the configuration file to change the set of plugins to be run on
introspection data. Note that order does matter in this option, especially introspection data. Note that order **does** matter in this option, especially
for hooks that have dependencies on other hooks. for hooks that have dependencies on other hooks.
These are plugins that are enabled by default and should not be disabled, These are plugins that are enabled by default and should not be disabled,
@ -248,18 +248,20 @@ Here are some plugins that can be additionally enabled:
then the new format will be stored in the 'extra' key. The 'data' key is then the new format will be stored in the 'extra' key. The 'data' key is
then deleted from the introspection data, as unless converted it's assumed then deleted from the introspection data, as unless converted it's assumed
unusable by introspection rules. unusable by introspection rules.
``lldp_basic``
Processes LLDP data returned from inspection, parses TLVs from the
Basic Management (802.1AB), 802.1Q, and 802.3 sets and stores the
processed data back in the Ironic inspector database. To enable LLDP in the
inventory from IPA, ``ipa-collect-lldp=1`` should be passed as a kernel
parameter to the IPA ramdisk.
``local_link_connection`` ``local_link_connection``
Processes LLDP data returned from inspection specifically looking for the Processes LLDP data returned from inspection, specifically looking for the
port ID and chassis ID, if found it configures the local link connection port ID and chassis ID. If found, it configures the local link connection
information on the nodes Ironic ports with that data. To enable LLDP in the information on the Ironic ports with that data. To enable LLDP in the
inventory from IPA ``ipa-collect-lldp=1`` should be passed as a kernel inventory from IPA, ``ipa-collect-lldp=1`` should be passed as a kernel
parameter to the IPA ramdisk. In order to avoid processing the raw LLDP parameter to the IPA ramdisk. In order to avoid processing the raw LLDP
data twice, the ``lldp_basic`` plugin should also be installed and run data twice, the ``lldp_basic`` plugin should also be installed and run
prior to this plugin. prior to this plugin.
``lldp_basic``
Processes LLDP data returned from inspection and parses TLVs from the
Basic Management (802.1AB), 802.1Q, and 802.3 sets and stores the
processed data back to the Ironic inspector data in Swift.
``physnet_cidr_map`` ``physnet_cidr_map``
Configures the ``physical_network`` property of the nodes Ironic port when Configures the ``physical_network`` property of the nodes Ironic port when
the IP address is in a configured CIDR mapping. CIDR to physical network the IP address is in a configured CIDR mapping. CIDR to physical network