Commit Graph

168 Commits (master)

Author SHA1 Message Date
Pierre Riteau 4a6bdaaf4b docs: fix typo
Change-Id: I9ad7b07834a0f83f82c2580fe277a337c6d03a12
2023-08-25 14:45:56 +02:00
Zuul 8b38e25ffb Merge "Add DnsmasqFilter error - my fsm encountered an exception" 2022-08-08 18:19:29 +00:00
niuke 2c34c29134 remove unicode from code
Change-Id: I56e457c0c52405d8f9c8ef12374e43353278f74d
2022-07-28 13:46:43 +08:00
Bernd Mueller 113d3e4d2d Add DnsmasqFilter error - my fsm encountered an exception
Signed-off-by: Bernd Mueller <>
Change-Id: I45ac3931b3d261a385385ade829767b56b175704
2022-05-18 09:38:36 +02:00
Cenne 072ebdc1f1 Fix broken links in CONTRIBUTING.rst
* turn on apidocs option for individual module docs
* crosslink to information using :doc: and :ref:

Change-Id: Ie8016623251fb0f55335c64252060d4ce966dc96
2021-07-01 19:50:56 +02:00
Radosław Piliszek 1ba0849b6b [doc] Improvements in processing_hooks docs
* 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
2021-06-04 11:48:36 +00:00
Julia Kreger 901c816b23 Add upgrade check, and json2yaml policy handling
Adds the ironic-inspector-status command as well with the
requried upgrade check.

Mostly based upon
which is based upon

Note: Also had to update the version of eventlet because
existing minimum requirement was seemingly incompatible with
prior versions and would prevent lower constraints testing
to proceed due to issues with ``os`` being patched by eventlet.

Change-Id: I1f479f834f1d79e9eeb591c58a52b6ab80c24534
2021-01-04 13:56:28 -08:00
Zuul 2e6f5ed25b Merge "Replaced openstack baremetal to baremetal in the documentation Changed osc_plugin_cli.html to index.html" 2020-10-22 21:23:11 +00:00
ANURADHAJHA99 a06687e39b Replaced openstack baremetal to baremetal in the documentation
Changed osc_plugin_cli.html to index.html

Story: #2008194
Task: #40963

Change-Id: I1ef1a72b5d2b461939a76448177f0d827df585b2
2020-10-19 14:11:36 +05:30
Harald Jensås 6b498bc23d [DOC] Add note regarding ``[pxe_filter]deny_unknown_macs``
Add a note in the user guide section related to validate_interfaces
plug-in. When [pxe_filter]deny_unknown_macs is enabled no node
without a pre-enrolled port will boot into introspection, so one
cannot rely on the validate network interfaces plug-in to create
the PXE-booting port in this case.

This is a follow up to:

Change-Id: I41c7693f3f73ddb29725741075b9fb0b4c0ebd02
2020-10-07 22:17:36 +02:00
Zuul 0b9b175666 Merge "Identify accelerator devices during introspection" 2020-09-07 15:07:22 +00:00
Kaifeng Wang de2a27ad8b Identify accelerator devices during introspection
Identify acclerator devices by processing pci devices and update to
ironic node when found. Currently only Tesla T4 from NVIDIA is

Change-Id: Id702cb04cb2445d544965821680cd0cc5cfd37e5
Story: 2007971
Task: 40473
2020-08-20 14:03:37 +08:00
Bob Fournier 6792848386 Minor doc fix to kernel options
Use the same string in text and example.

Change-Id: I071d5406b13f1ad9d6f5f6800db023cb3c934330
2020-08-17 09:16:52 -04:00
Dmitry Tantsur bd16d80005 Remove built-in API documentation in favour of API-REF
A few items have been migrated from the former to the latter.

Change-Id: Icc4f00b872a2550ff886287d8f0844ee2593f296
2020-07-28 12:39:28 +02:00
Dmitry Tantsur cc7fcf4332 Add support for retrieving unprocessed data
Change-Id: I3c0070d0c1f5d12e98f914be44f4ed52b01ea043
2020-07-28 12:19:19 +02:00
Harald Jensås a1f8926cd1 Remove non-inclusive language in pxe filter
Replaces the use of black/white-list with deny/allow-list
in the pxe filter.

Change-Id: I84e6343fc13e4c4c02521499632a07e782088057
2020-07-09 12:06:03 +02:00
Zuul c1fa28a9f8 Merge "Allow setting other fields on discovery" 2020-06-30 20:40:55 +00:00
Dmitry Tantsur f78229f659 Allow setting other fields on discovery
Adds a new option to set arbitrary fields on newly discovered nodes,
which is useful to e.g. set non-default driver interfaces.

Change-Id: I2e23fde9c5aae00ed39bd60c204e7c3eb029586a
Story: #2007771
Task: #40091
2020-06-29 09:57:37 +02:00
Steve Baker 2532be9e05 Document [ironic] auth options for inspector
This change documents configuring inspector for client-side
authentication with a standalone Ironic API service.

Since this documention refers to a keystone auth feature which is
about to be released, requirements and lower-constraints are updated
to reflect the required release (see ).

Change-Id: I567fc8c7f2147339856563ad880334791f93d99b
2020-06-23 13:35:12 +12:00
Kaifeng Wang 52138f2c54 Update doc for multi-arch x86
Recent test shows the $grub_cpu is x86_64 for grubx64.efi,
replace the outdated i386 with x64.

Change-Id: I554b74aee85727e1d8c56d2bf9b5e0b682b6dbd2
2020-06-11 23:22:05 +08:00
Arne Wiebalck 6175bc4f5f [doc] Add misconfigured BMC channel to trouble shooting guide
Change-Id: I7285528511fd9cecd428a3a502281b4bd84dcd82
2020-06-05 10:31:05 +02:00
Andreas Jaeger 68ab6a01b6 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Set openstackdocs_auto_version to not auto-version the documents.

Set openstackdocs_auto_name to use 'project' as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

Change-Id: I9591e0f0215e9eb790ec2e3ea1a7ccbd55bb76d0
2020-05-20 10:59:56 +02:00
Dmitry Tantsur 6ba9e003f9 [docs] remove the horribly outdated version support matrix
Change-Id: Ibd2ec86ac488f22d387872dd982b271b7e01016d
2020-05-07 11:38:03 +02:00
Iury Gregory Melo Ferreira 02c6c92c50 Native zuulv3 grenade job for inspector
Based on the native 'grenade' job

Change-Id: I606f8ffed0defe4ebc7fc2ceda1f6853c36a1b05
2020-04-26 11:56:14 +02:00
Zuul 436fd8ad99 Merge "Cleanup py27 support" 2020-04-22 01:46:42 +00:00
Andreas Jaeger 1a8c1bb370 Cleanup py27 support
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
  know about the requirement
- Remove obsolete sections from setup.cfg
- Update classifiers
- Update requirements, no need for python_version anymore
- Switch to using sphinx-build with apidoc extension
- Use newer openstackdocstheme version
- Remove Babel requirement, this is not needed.

Change-Id: I4176d8002d45449171aa5f7a7caef196ab7900d0
2020-04-20 08:18:51 +02:00
Harald Jensås 92e2d26f15 Port physical network CIDR map hook
The physnet_cidr_map hook adds functionality to
populate the physical_network of a baremetal port based
on a cidr-to-physnet mapping in configuration.

Related-Bug: #1870529
Change-Id: I43cdac5ccd8c46836b26f6e4bc0d4509958e2e79
2020-04-17 16:31:40 +02:00
Zygimantas Matonis e2c8f9fd7b Added scope to introspection rules.
Added 'scope' property to IntrospectionRule and logic to check if a node
falls in the same scope.This allows introspection rules to be applied on
selected nodes instead of every one of them.

Story: 2006995
Task: 37763

Change-Id: I77034f032ea0ec16886afdd928546eb801f7a90a
2020-03-26 21:40:43 +01:00
Kaifeng Wang e6ece052ec Add words for mutiarch configuration
Adds some words on the PXE configuration for multi-arch environments.

Change-Id: I10cf510630f50d68e463476b922f40932418f4b3
2020-03-17 18:27:28 +08:00
Dmitry Tantsur 3d473dc2ea Replace references to the deprecated ironic-agent element
Change-Id: I0f473a0d59de50261880c4e1331c1861e8c745df
2020-02-11 17:30:13 +01:00
Doug Hellmann f4fe4307be link introspection API docs to client docs
The introspection API documentation does not include any detail at all
about the payload returned. That information is in the
ironic-python-agent documentation instead. Add a link to that location
to make it easier for someone trying to find out what introspection
data is returned to do so.

Change-Id: I972803ac700f25823ac6715d21dda09ebe40e307
Signed-off-by: Doug Hellmann <>
2020-01-23 16:14:50 -05:00
Wang Jerry 31faf7f08c Update ironic-inspector usage document
1. Add inspect command at "Node States" section
2. Add rule import command at "Introspection Rules" section

Change-Id: Ie8eb650f1258933bee0d74eddd77a74a73078f96
2020-01-09 08:53:21 +00:00
Zuul b2c0c52a95 Merge "docs: use openstackdocstheme extlink extension" 2019-12-17 00:04:18 +00:00
Kaifeng Wang b22c3347d3 Update docs on aarch64 PXE
Adds a subsection to note PXE configuration for aarch64 machines.

Change-Id: I5a450da256057ac1a997c08f7c3b580feb490377
2019-12-04 10:46:54 +08:00
Riccardo Pittau aa75bfa8f0 docs: use openstackdocstheme extlink extension
The extlink extension [1] ensures the urls have version-specific
references to other projects.


Change-Id: I59ae4e28a02ee2683d35cf46857386e3f458ec2c
Story: 2006621
Task: 36917
2019-11-22 12:31:21 +01:00
Kaifeng Wang 0e3cd671da Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

ironic-inspector is ready with python 3 and ok to drop the
python 2.7 support.

Complete discussion & schedule can be found in

Ussuri Communtiy-wide goal -

Change-Id: Ifae00adf782b6a7d71c4dc45a69a9638b8514d30
2019-11-22 11:17:34 +08:00
Bob Fournier 29dce28b13 Add IPv6 support to dnsmasq example
This adds IPv6 support to the documented dnsmasq example.
For DHCPv6 PXE boot, the Client Architecture option uses code 61,
(see For both
DHCP and DHCPv6, support for UEFI client arch type 11 (EFI aarch64)
is documented.

Change-Id: I4018d99b9723527ed0cbb2c6825b0062d82c85b1
2019-10-22 14:03:09 -04:00
Kaifeng Wang adc1c24121 Docs for ironic inspector with tooz
Update docs about running ironic-inspector in non-standalone mode.

Story: 2001842
Task: 30376

Change-Id: I0f8649ef005e4551ff9cc046ec5ab970f3bdc552
2019-09-16 14:17:51 +08:00
Kaifeng Wang 76cbd2dbbb Build pdf doc
The is one of community goals that each project could produce a
single PDF file. The pdf should be in the output of openstack-tox-docs

TeX packages are required to build PDF locally, following is recommended:

* inkscape
* texlive-latex-base
* texlive-latex-extra
* texlive-fonts-recommended

More about the goal:

Change-Id: I784be3f2462184ce951cb27e68e578f8befaa580
2019-09-06 15:58:06 +08:00
Iury Gregory Melo Ferreira 503cba28ba CI documentation
- Jobs description: Help people understand what each job does in our CI.

Change-Id: Ia6267e9b4618d4039f0606270f8dcf759cd92750
2019-08-05 14:45:47 +02:00
Dmitry Tantsur 48d5d56394 Document storage backends and migrating between them
Change-Id: I36e5a9b9faf59684adf807c2a065c35a5d4a00f6
2019-06-18 16:48:03 +02:00
Zuul abba15fe71 Merge "Support reapply with supplied introspection data" 2019-04-17 12:47:23 +00:00
Dongcan Ye 541dec6d11 Fix validate_interfaces processing hook format

Change-Id: If1a32dfb451709e322461f19c3824e0eca792c73
2019-04-17 01:44:56 +00:00
Kaifeng Wang 29d8515f50 Support reapply with supplied introspection data
This patch adds support to provide unprocessed introspection data
to reapply a node. The provided introspection data will be save to
current introspection storage backend.

Change-Id: I969ae9c32f53f89c006a64a006388ddea9542aa5
Story: 1564863
Task: 11344
2019-04-15 15:04:33 +00:00
zhouxinyong 74dcdc4d08 Remove the repetition words in usage.rst
Change-Id: I20656e4f189586b12cdea7ada10fbabe1f4c4dba
2018-11-13 18:40:34 +08:00
Zuul 106716abd1 Merge "Rearrange conf and policy configuration file" 2018-10-22 18:54:37 +00:00
Kaifeng Wang 8ab225e47a Rearrange conf and policy configuration file
Minor project file structure adjustment, to move config-generator.conf
and policy-generator.conf into tools/ subdirectory.

Also exclude tools/ from dsvm jobs.

Change-Id: I3242401511b88bd9b677d9875481808783f890b8
2018-10-16 16:16:29 +08:00
Dmitry Tantsur 0a26a6677d Add introspection rules actions to add/remove traits on nodes
Otherwise it's not possible to modify them, since they're not updated
via the regular node updating mechanism.

Change-Id: I338015ff9dafe07f4e70a23ddcf6cd488eda9907
Story: #2003788
Task: #26496
2018-09-18 10:13:48 +02:00
Zuul b3c8241ed1 Merge "Update HTTP API version history" 2018-08-06 13:39:16 +00:00
Will Miller 9f44231c1c Update HTTP API version history
Add blurb for 1.14 HTTP API version.

Task: #24275
Story: #1670768
Change-Id: Icedd6d20c23fe252ef81c02a560901ff7243abb2
2018-08-06 12:41:15 +01:00