openstack
/
ironic
Code Issues Proposed changes

Merge "correct URLs in admin docs" into stable/pike

This commit is contained in:
Jenkins 2017-08-23 14:13:39 +00:00 committed by Gerrit Code Review
parent 50e556ab25 14b9b0d7d2
commit d25c975273
13 changed files with 18 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/admin/cleaning.rst
View File

@ -103,7 +103,7 @@ higher::
PUT /v1/nodes/<node_ident>/states/provision
(Additional information is available `here <http://developer.openstack.org/api-ref/baremetal/index.html?expanded=change-node-provision-state-detail#change-node-provision-state>`_.)
(Additional information is available `here <https://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'.
@ -192,7 +192,7 @@ If you are using the Neutron DHCP provider (the default) you will also need to
ensure you have configured a cleaning network. This network will be used to
boot the ramdisk for in-band cleaning. You can use the same network as your
tenant network. For steps to set up the cleaning network, please see
`Configure the Bare Metal service for cleaning`_.
:ref:`configure-cleaning`.
.. _InbandvsOutOfBandCleaning:
@ -331,5 +331,3 @@ to allow it to be scheduled by nova.
The node will begin automated cleaning from the start, and move to
``available`` state when complete.
.. _`Configure the Bare Metal service for cleaning`: https://docs.openstack.org/project-install-guide/baremetal/draft/configure-cleaning.html

5
doc/source/admin/console.rst
View File

@ -92,7 +92,7 @@ The web console can be configured in Bare Metal service in the following way:
* Append console parameters for bare metal PXE boot in the Bare Metal service
configuration file (/etc/ironic/ironic.conf). See the reference for
configuration in `console kernel parameters`_.
configuration in :ref:`kernel-boot-parameters`.
* Configure node web console.
@ -165,7 +165,7 @@ Serial consoles can be configured in the Bare Metal service as follows:
* Append console parameters for bare metal PXE boot in the Bare Metal
service configuration file. See the reference on how to configure them in
`console kernel parameters`_.
:ref:`kernel-boot-parameters`.
* Configure node console.
@ -199,4 +199,3 @@ the serial console is disabled. If you want to launch serial console, see the
``Configure node console``.
.. _`socat`: http://www.dest-unreach.org/socat
.. _`console kernel parameters`: https://docs.openstack.org/project-install-guide/baremetal/draft/advanced.html#appending-kernel-parameters-to-boot-instances

6
doc/source/admin/drivers/cimc.rst
View File

@ -22,7 +22,7 @@ the disk, instead of the conductor.
The CIMC drivers can use the Ironic Inspector service for in-band inspection of
equipment. For more information see the `Ironic Inspector documentation
<http://docs.openstack.org/developer/ironic-inspector/>`_.
<https://docs.openstack.org/ironic-inspector/latest>`_.
Prerequisites
=============
@ -89,6 +89,4 @@ The following sequence of commands can be used to enroll a UCS Standalone node.
ironic port-create -n $NODE -a <MAC_address_of_Ucs_server's_NIC>
For more information about enrolling nodes see `Enrolling a node`_ in the install guide.
.. _`Enrolling a node`: https://docs.openstack.org/project-install-guide/baremetal/draft/enrollment.html#enrolling-a-node
For more information about enrolling nodes see :ref:`enrollment` in the install guide.

2
doc/source/admin/drivers/ipa.rst
View File

@ -14,7 +14,7 @@ IPA is distributed over nodes and runs, inside of a ramdisk, the
process of booting this ramdisk on the node.
For more information see the `ironic-python-agent documentation
<http://docs.openstack.org/developer/ironic-python-agent/>`_.
<https://docs.openstack.org/ironic-python-agent/latest>`_.
Drivers
=======

3
doc/source/admin/drivers/redfish.rst
View File

@ -85,10 +85,9 @@ a node with the ``redfish`` driver. For example:
redfish_system_id=/redfish/v1/Systems/CX34R87 --driver-info \
redfish_username=admin --driver-info redfish_password=password
For more information about enrolling nodes see `Enrolling a node`_
For more information about enrolling nodes see :ref:`enrollment`
in the install guide.
.. _Redfish: http://redfish.dmtf.org/
.. _Sushy: https://git.openstack.org/cgit/openstack/sushy
.. _TLS: https://en.wikipedia.org/wiki/Transport_Layer_Security
.. _`Enrolling a node`: http://docs.openstack.org/project-install-guide/baremetal/draft/enrollment.html#enrolling-a-node

2
doc/source/admin/drivers/ucs.rst
View File

@ -20,7 +20,7 @@ management operations on the baremetal node (instead of using IPMI).
The UCS drivers can use the Ironic Inspector service for in-band inspection of
equipment. For more information see the `Ironic Inspector documentation
<http://docs.openstack.org/developer/ironic-inspector/>`_.
<http://docs.openstack.org/ironic-inspector/latest>`_.
Prerequisites
=============

2
doc/source/admin/index.rst
View File

@ -53,4 +53,4 @@ Documentation for that can be found within the ironic-ui project.
.. toctree::
:maxdepth: 1
Dashboard (horizon) plugin <http://docs.openstack.org/developer/ironic-ui/>
Dashboard (horizon) plugin <https://docs.openstack.org/ironic-ui/latest>

2
doc/source/admin/metrics.rst
View File

@ -77,7 +77,7 @@ drivers are used in the Bare Metal deployment. This estimate may be used to
determine if a deployer needs to scale their metrics backend to handle the
additional load before enabling metrics. To see which metrics have changed names
or have been removed between releases, refer to the `ironic release notes
<http://docs.openstack.org/releasenotes/ironic/>`_.
<https://docs.openstack.org/releasenotes/ironic/>`_.
.. note::
With the default statsd configuration, each timing metric may create

6
doc/source/admin/multitenancy.rst
View File

@ -87,10 +87,8 @@ criteria are used to select a suitable unattached port or port group:
Configuring the Bare Metal service
==================================
See the `Configure tenant networks`_ section in the installation guide for the
Bare Metal service.
.. _`Configure tenant networks`: http://docs.openstack.org/project-install-guide/baremetal/draft/configure-tenant-networks.html
See the :ref:`configure-tenant-networks` section in the installation guide for
the Bare Metal service.
Configuring nodes
=================

2
doc/source/admin/raid.rst
View File

@ -314,7 +314,7 @@ support for pluggable hardware managers which can be used to extend the
functionality offered by IPA ramdisk using stevedore plugins. For more
information, see Ironic Python Agent `Hardware Manager`_ documentation.
.. _`Hardware Manager`: http://docs.openstack.org/developer/ironic-python-agent/#hardware-managers
.. _`Hardware Manager`: https://docs.openstack.org/ironic-python-agent/latest/install/index.html#hardware-managers
The hardware manager that supports RAID configuration should do the following:

5
doc/source/admin/security.rst
View File

@ -118,7 +118,4 @@ include:
Additional references:
- :ref:`cleaning`
- `trusted boot with partition image`_
- :ref:`iLO UEFI Secure Boot Support`
.. _trusted boot with partition image: http://docs.openstack.org/project-install-guide/baremetal/draft/advanced.html#trusted-boot-with-partition-image
- :ref:`trusted-boot`

2
doc/source/admin/troubleshooting.rst
View File

@ -110,7 +110,7 @@ A few things should be checked in this case:
The name of the filter that removed the last hosts may give some hints on
what exactly was not matched. See `Nova filters documentation
<http://docs.openstack.org/developer/nova/filter_scheduler.html>`_ for more
<https://docs.openstack.org/nova/latest/filter_scheduler.html>`_ for more
details.
#. If none of the above helped, check Ironic conductor log carefully to see

5
doc/source/admin/upgrade-guide.rst
View File

@ -24,7 +24,7 @@ Plan your upgrade
This means that you cannot upgrade Ocata directly into Queens; you need to
upgrade into Pike first.
* The `release notes <http://docs.openstack.org/releasenotes/ironic/>`_
* The `release notes <https://docs.openstack.org/releasenotes/ironic/>`_
should always be read carefully when upgrading the Bare Metal service.
Specific upgrade steps and considerations are documented there.
@ -46,8 +46,7 @@ Plan your upgrade
require manual intervention to return them to the available hardware pool.
This is most likely in cases where a timeout has occurred or a service was
terminated abruptly. For a visual diagram detailing states and possible
state transitions, please see the
`state machine diagram <https://docs.openstack.org/ironic/latest/contributor/states.html>`_.
state transitions, please see :ref:`states`.
Offline upgrades
================