Update external links to developer documentation

Various sections were updated. New anchors were defined to be able to
use the "ref" sphinx syntax.

Finally, an external link in cleaning was found to point to an outdated
page. Updated with a new link to the api-ref docs.

Change-Id: Ie637224fdfd8fb2a570bda3e727926765a6efc48
This commit is contained in:
Mathieu Mitchell 2016-09-28 16:12:59 -04:00
parent 0a9abccd8c
commit 10a495ae87
5 changed files with 12 additions and 9 deletions

View File

@ -103,7 +103,7 @@ higher::
PUT /v1/nodes/<node_ident>/states/provision
(Additional information is available `here <http://docs.openstack.org/developer/ironic/webapi/v1.html#nodes>`_.)
(Additional information is available `here <http://developer.openstack.org/api-ref/baremetal/index.html?expanded=change-node-provision-state-detail#change-node-provision-state>`_.)
This API will allow operators to put a node directly into ``cleaning``
provision state from ``manageable`` state via 'target': 'clean'.

View File

@ -100,7 +100,7 @@ system or device firmware or firmware settings.
Operators are encouraged to write their own hardware manager plugins for the
``ironic-python-agent`` ramdisk. This should include custom ``clean steps``
that would be run during the `automated cleaning`_ process, as part of Node
that would be run during the :ref:`cleaning` process, as part of Node
de-provisioning. The ``clean steps``
would perform the specific actions necessary within that environment to ensure
the integrity of each server's firmware.
@ -111,16 +111,14 @@ include:
- installing signed firmware for BIOS and peripheral devices
- using a TPM (Trusted Platform Module) to validate signatures at boot time
- booting machines in `UEFI Secure Boot mode`_, rather than BIOS mode, to
- booting machines in :ref:`iLO UEFI Secure Boot Support`, rather than BIOS mode, to
validate kernel signatures
- disabling local (in-band) access from the host OS to the management controller (BMC)
- disabling modifications to boot settings from the host OS
Additional references:
- `automated cleaning`_
- :ref:`cleaning`
- `trusted boot with partition image`_
- `UEFI Secure Boot mode`_
- :ref:`iLO UEFI Secure Boot Support`
.. _automated cleaning: http://docs.openstack.org/developer/ironic/deploy/cleaning.html#automated-cleaning
.. _trusted boot with partition image: http://docs.openstack.org/project-install-guide/baremetal/draft/advanced.html#trusted-boot-with-partition-image
.. _UEFI Secure Boot mode: http://docs.openstack.org/developer/ironic/drivers/ilo.html?highlight=secure%20boot#uefi-secure-boot-support

View File

@ -23,6 +23,8 @@ An Ironic deployment will be composed of the following components:
- **NOTE:** The agent is never run inside a tenant instance.
.. _`architecture_drivers`:
Drivers
=======

View File

@ -697,6 +697,9 @@ element to the diskimage-builder command to build the image. For example::
disk-image-create ubuntu baremetal iso
.. _`iLO UEFI Secure Boot Support`:
UEFI Secure Boot Support
^^^^^^^^^^^^^^^^^^^^^^^^
The following drivers support UEFI secure boot deploy:

View File

@ -421,11 +421,11 @@ For more details on how Ironic-OneViewd works and how to set it up, see [7]_.
References
==========
.. [1] HP OneView - https://www.hpe.com/us/en/integrated-systems/software.html
.. [2] Driver interfaces - http://docs.openstack.org/developer/ironic/dev/architecture.html#drivers
.. [2] :ref:`architecture_drivers`
.. [3] python-oneviewclient - https://pypi.python.org/pypi/python-oneviewclient
.. [4] Enrollment process of a node - http://docs.openstack.org/project-install-guide/baremetal/draft/enrollment.html
.. [5] ironic install guide - http://docs.openstack.org/project-install-guide/baremetal/draft/
.. [6] Dynamic Allocation in OneView drivers - http://specs.openstack.org/openstack/ironic-specs/specs/not-implemented/oneview-drivers-dynamic-allocation.html
.. [7] ironic-oneviewd - https://pypi.python.org/pypi/ironic-oneviewd/
.. [8] ironic-oneview-cli - https://pypi.python.org/pypi/ironic-oneview-cli/
.. [9] Ironics State Machine - http://docs.openstack.org/developer/ironic/dev/states.html#states
.. [9] :ref:`states`