Commit d394fb63 by Jenkins Committed by Gerrit Code Review

Merge "Correct URLs in install docs"

parents 4cb21751 8aadc1a2
......@@ -37,8 +37,6 @@ create a configuration drive by setting the following option in the
In some cases, you may wish to pass a user customized script when deploying an instance.
To do this, pass ``--user-data /path/to/file`` to the ``nova boot`` command.
More information can be found at `Provide user data to instances <>`_
When used standalone
......@@ -133,9 +131,6 @@ the configuration drive and mount it, for example::
on it instead of ISO 9660. But it's unlikely that it would be needed
since ISO 9660 is widely supported across operating systems.
For more information see `Store metadata on a configuration drive
Cloud-init integration
......@@ -3,12 +3,11 @@
Configure the Bare Metal service for cleaning
.. note:: If you configured the Bare Metal service to use `Node cleaning`_
.. note:: If you configured the Bare Metal service to do
(which is enabled by default), you will need to set the
``cleaning_network`` configuration option.
.. _`Node cleaning`:
#. Note the network UUID (the `id` field) of the network you created in
:ref:`configure-networking` or another network you created for cleaning:
......@@ -83,11 +83,11 @@ Configure the Identity service for the Bare Metal service
--user USERNAME baremetal_observer
#. Further documentation is available elsewhere for the ``openstack``
`command-line client`_ and the Identity_ service. A policy.json.sample_
`command-line client`_ and the Identity_ service. A
:doc:`policy.json.sample </configuration/sample-policy>`
file, which enumerates the service's default policies, is provided for
your convenience with the Bare Metal Service.
.. _Identity:
.. _`command-line client`:
.. _here:
.. _policy.json.sample:
.. _Identity:
.. _`command-line client`:
.. _here:
......@@ -17,8 +17,8 @@
``openipmi`` as it relies on error handling options not provided by
this tool.
Please refer to the `ipmitool driver page`_ for information on how to use
IPMItool-based drivers.
Please refer to the :doc:`/admin/drivers/ipmitool` for information on how to
use IPMItool-based drivers.
Validation and troubleshooting
......@@ -82,4 +82,3 @@ these are ``Temperature``, ``Fan``, ``Voltage``, ``Current``.
Special value ``All`` (the default) designates all supported sensor types.
.. _IPMI:
.. _ipmitool driver page:
......@@ -333,7 +333,7 @@ on the Bare Metal service node(s) where ``ironic-conductor`` is running.
for accessing objects stored in it.
Both the OpenStack Swift and RADOS Gateway provide support for this.
* See `Ceph Object Gateway support`_ on how to configure
* See :doc:`/admin/radosgw` on how to configure
the Bare Metal Service with RADOS Gateway as the Object Storage.
Configure this by setting the ``[pxe]/ipxe_use_swift`` configuration
......@@ -359,8 +359,6 @@ on the Bare Metal service node(s) where ``ironic-conductor`` is running.
you have to ensure that iPXE firmware on the nodes can indeed
boot from generated temporary URLs that use HTTPS protocol.
.. _Ceph Object Gateway support:
#. Restart the ``ironic-conductor`` process:
......@@ -123,7 +123,7 @@ provisioning will happen in a multi-tenant environment (which means using the
#. Install and configure a compatible ML2 mechanism driver which supports bare
metal provisioning for your switch. See `ML2 plugin configuration manual
for details.
#. Restart the ironic-conductor and ironic-api services after the
......@@ -147,6 +147,4 @@ provisioning will happen in a multi-tenant environment (which means using the
where FILENAME is the file located at the TFTP server.
See `Multitenancy in Bare Metal service`_ for required node configuration.
.. _`Multitenancy in Bare Metal service`:
See :ref:`multitenancy` for required node configuration.
......@@ -9,8 +9,8 @@ service running on it for controlling and deploying bare metal nodes.
You can download a pre-built version of the deploy ramdisk built with
the `CoreOS tools`_ at:
* `CoreOS deploy kernel <>`_
* `CoreOS deploy ramdisk <>`_
* `CoreOS deploy kernel <>`_
* `CoreOS deploy ramdisk <>`_
.. _ironic-python-agent:
......@@ -306,7 +306,7 @@ be installed locally. For example,
See :doc:`/admin/drivers` for the required configuration of each driver.
.. _driver composition reform specification:
.. _driver composition reform specification:
.. _setup.cfg:
.. _iSCSI:
.. _ironic-inspector:
......@@ -16,7 +16,7 @@ conductor and swift and bare metal (via virtual media). It can be enabled in on
of the following ways:
* `Using an SSL termination proxy
* `Using native SSL support in swift
......@@ -2,7 +2,7 @@ The Bare Metal service is configured via its configuration file. This file
is typically located at ``/etc/ironic/ironic.conf``.
Although some configuration options are mentioned here, it is recommended that
you review all the `available options <>`_
you review all the :doc:`/configuration/sample-config`
so that the Bare Metal service is configured for your needs.
It is possible to set up an ironic-api and an ironic-conductor services on the
......@@ -68,8 +68,7 @@ Configuring ironic-conductor service
.. note::
Swift backend for the Image service must be installed and configured
for ``agent_*`` drivers. Ceph Object Gateway (RADOS Gateway) is also
supported as the Image service's backend (`radosgw support
supported as the Image service's backend (:ref:`radosgw support`).
#. Set the URL (replace ``NEUTRON_IP``) for connecting to the Networking
service, to be the Networking service endpoint:
......@@ -82,8 +81,7 @@ Configuring ironic-conductor service
To configure the network for ironic-conductor service to perform node
cleaning, see `CleaningNetworkSetup <>`_
from the Ironic deploy guide.
cleaning, see :ref:`cleaning` from the admin guide.
#. Configure credentials for accessing other OpenStack services.
Configuring node web console
See `Configuring Web or Serial Console`_.
See :ref:`console`.
.. TODO(dtantsur): move the installation documentation here
.. _`Configuring Web or Serial Console`:
......@@ -6,7 +6,7 @@ The Bare Metal service is a collection of components that provides support to
manage and provision physical machines.
This chapter assumes a working setup of OpenStack following the
`OpenStack Installation Guides <>`_.
`OpenStack Installation Guides <>`_.
It contains the following sections:
.. toctree::
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment