Fix documentation related build warnings throughout Ironic's docs
Change-Id: Ie49559a111d6e63dcf7aa8028428de3355494939 Signed-off-by: Clif Houck <me@clifhouck.com>
This commit is contained in:
Clif Houck
@@ -54,6 +54,8 @@ Comparison with Other OpenStack Services
|
||||
Ironic's Three-Tier Approach
|
||||
=============================
|
||||
|
||||
.. _multiple_ironic_deployments:
|
||||
|
||||
Tier 1: Multiple Ironic Deployments
|
||||
------------------------------------
|
||||
|
||||
|
||||
@@ -79,7 +79,7 @@ Advanced Usage with Multiple Deployments
|
||||
|
||||
Conductor groups work within a single Ironic deployment. For complete
|
||||
service isolation across geographic regions or regulatory boundaries,
|
||||
consider using :ref:`multiple Ironic deployments <availability-zones:Tier 1: Multiple Ironic Deployments>`
|
||||
consider using :ref:`multiple Ironic deployments <multiple_ironic_deployments>`
|
||||
targeted by different Nova compute services.
|
||||
|
||||
See Also
|
||||
|
||||
@@ -48,9 +48,9 @@ node:
|
||||
Inspection
|
||||
----------
|
||||
|
||||
If using :ref:`in-band inspection`, you need to tell ironic not to power off
|
||||
nodes afterwards. Depending on the inspection mode (managed or unmanaged),
|
||||
you need to configure two places.
|
||||
If using :ref:`agent inspection<agent-inspection>`, aka in-band, you need to tell ironic not to
|
||||
power off nodes afterwards. Depending on the inspection mode (managed or
|
||||
unmanaged), you need to configure two places.
|
||||
In ``ironic.conf``:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
:orphan:
|
||||
|
||||
===================
|
||||
Hardware Inspection
|
||||
===================
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
.. _capabilities-discovery:
|
||||
|
||||
======================
|
||||
Capabilities discovery
|
||||
======================
|
||||
|
||||
.. _capabilities-discovery:
|
||||
|
||||
This is an incomplete list of capabilities we want to discover during
|
||||
inspection. The exact support is hardware and hardware type specific though,
|
||||
the most complete list is provided by the iLO :ref:`ilo-inspection`.
|
||||
|
||||
@@ -44,6 +44,8 @@ Functionality
|
||||
migration
|
||||
copy-inspection-data-swift
|
||||
|
||||
.. _agent-inspection:
|
||||
|
||||
Agent Inspection
|
||||
----------------
|
||||
|
||||
|
||||
@@ -31,7 +31,7 @@ This list currently includes:
|
||||
ones that `display the network interface information from the LLDP data
|
||||
<https://docs.openstack.org/python-ironic-inspector-client/latest/cli/index.html#list-interface-data>`_.
|
||||
|
||||
:ironic-inspector-doc:`Inspection rules <user/usage.html#introspection-rules>`
|
||||
ironic-inspector :doc:`Inspection rules <rules>`
|
||||
have now been implemented as of 2025.1 "Epoxy" release.
|
||||
|
||||
New defaults
|
||||
@@ -45,9 +45,9 @@ New defaults
|
||||
Built-in hooks
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
Most of the :ironic-inspector-doc:`introspection hooks
|
||||
<user/usage.html#plugins>` have been :doc:`migrated to ironic <hooks>`,
|
||||
although many have been migrated for clarity and consistency.
|
||||
Most of the ironic-inspector introspection hooks have been
|
||||
:doc:`migrated to ironic <hooks>`, although many have been migrated for
|
||||
clarity and consistency.
|
||||
|
||||
.. list-table:: Hooks mapping
|
||||
:header-rows: 1
|
||||
@@ -113,8 +113,7 @@ Custom hooks
|
||||
A custom hook (called *processing hook* in ironic-inspector) has to be
|
||||
derived from the base class :py:class:`InspectionHook
|
||||
<ironic.drivers.modules.inspector.hooks.base.InspectionHook>`. It differs
|
||||
from the older :ironic-inspector-doc:`ProcessingHook
|
||||
<contributor/api/ironic_inspector.plugins.base.html#ironic_inspector.plugins.base.ProcessingHook>`
|
||||
from the older ironic-inspector ``ProcessingHook``
|
||||
in a few important ways, requiring custom hooks to be adapted for ironic:
|
||||
|
||||
* Hooks operate on the regular :py:class:`task
|
||||
|
||||
@@ -249,6 +249,8 @@ responsible to provide all necessary deploy steps with priorities between
|
||||
61 and 99 (see :ref:`node-deployment-core-steps` for information on
|
||||
priorities).
|
||||
|
||||
.. _bootc-deploy:
|
||||
|
||||
Bootc Agent Deploy
|
||||
==================
|
||||
|
||||
|
||||
@@ -69,6 +69,7 @@ primarily for developers.
|
||||
OSProfiler Tracing <osprofiler-support>
|
||||
Rolling Upgrades <rolling-upgrades>
|
||||
Role Based Access Control Testing <rbac-testing>
|
||||
Metrics <metrics>
|
||||
|
||||
Governance and Processes
|
||||
------------------------
|
||||
@@ -129,3 +130,4 @@ the documentation below.
|
||||
Job Roles in the CI <jobs-description>
|
||||
How to Add a New Job? <adding-new-job>
|
||||
How to Debug Failures in CI Jobs <debug-ci-failures>
|
||||
Metal3 Continuous Integration <metal3-integration>
|
||||
|
||||
@@ -23,10 +23,9 @@ The description of each jobs that runs in the CI when you submit a patch for
|
||||
* - bifrost-integration-redfish-vmedia-uefi-centos-9
|
||||
- Tests the integration between Ironic and Bifrost using redfish vmedia and
|
||||
a dib image based on centos stream 9.
|
||||
* - `metal3-integration`_
|
||||
* - `metal3-integration <contributor/metal3-integration>`_
|
||||
- Tests the integration between Ironic and `Metal3`_ using the
|
||||
`metal3-dev-env`_ environment
|
||||
|
||||
.. _metal3-integration: metal3-integration.html
|
||||
.. _Metal3: https://metal3.io/
|
||||
.. _metal3-dev-env: https://github.com/metal3-io/metal3-dev-env
|
||||
|
||||
@@ -39,7 +39,7 @@ There are however some limitations for different hardware interfaces:
|
||||
* File images must not be located in ``/dev``, ``/sys``, ``/proc``,
|
||||
``/etc``, ``/boot``, ``/run`` or other system paths.
|
||||
* File images must be located in a path listed in
|
||||
:oslo_config:option:`conductor.file_url_allowed_paths`
|
||||
:oslo.config:option:`conductor.file_url_allowed_paths`
|
||||
|
||||
.. warning::
|
||||
The Ironic CLI tool will not transfer the file from a local machine to the
|
||||
|
||||
Reference in New Issue
Block a user