From 10a495ae87377ba2064cb9b05aa8c7efcd4e1912 Mon Sep 17 00:00:00 2001 From: Mathieu Mitchell Date: Wed, 28 Sep 2016 16:12:59 -0400 Subject: [PATCH] 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 --- doc/source/deploy/cleaning.rst | 2 +- doc/source/deploy/security.rst | 10 ++++------ doc/source/dev/architecture.rst | 2 ++ doc/source/drivers/ilo.rst | 3 +++ doc/source/drivers/oneview.rst | 4 ++-- 5 files changed, 12 insertions(+), 9 deletions(-) diff --git a/doc/source/deploy/cleaning.rst b/doc/source/deploy/cleaning.rst index f5cf1af6fe..44e1dfad9e 100644 --- a/doc/source/deploy/cleaning.rst +++ b/doc/source/deploy/cleaning.rst @@ -103,7 +103,7 @@ higher:: PUT /v1/nodes//states/provision -(Additional information is available `here `_.) +(Additional information is available `here `_.) This API will allow operators to put a node directly into ``cleaning`` provision state from ``manageable`` state via 'target': 'clean'. diff --git a/doc/source/deploy/security.rst b/doc/source/deploy/security.rst index ec8beef9fc..15051907a6 100644 --- a/doc/source/deploy/security.rst +++ b/doc/source/deploy/security.rst @@ -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 diff --git a/doc/source/dev/architecture.rst b/doc/source/dev/architecture.rst index 527084c521..7aa6bd574f 100644 --- a/doc/source/dev/architecture.rst +++ b/doc/source/dev/architecture.rst @@ -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 ======= diff --git a/doc/source/drivers/ilo.rst b/doc/source/drivers/ilo.rst index 20e5ab0a31..0b72ee1aea 100644 --- a/doc/source/drivers/ilo.rst +++ b/doc/source/drivers/ilo.rst @@ -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: diff --git a/doc/source/drivers/oneview.rst b/doc/source/drivers/oneview.rst index b881a53eca..f9d1e0b7c9 100644 --- a/doc/source/drivers/oneview.rst +++ b/doc/source/drivers/oneview.rst @@ -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] Ironic’s State Machine - http://docs.openstack.org/developer/ironic/dev/states.html#states +.. [9] :ref:`states`