Correct URLs in install docs

This corrects the URLs in the install documentation. The changes include:
- changing http to https
- changing absolute links to relative links (where applicable)
- updating links (due to doc migrations)
- removing old links

Change-Id: Iecca07e0da5e6b326baa0142f366449a4c5cfd89
This commit is contained in:
Ruby Loo 2017-08-22 16:44:44 -04:00
parent 60aec73848
commit 8aadc1a229
13 changed files with 21 additions and 36 deletions

View File

@ -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. 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. 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 <http://docs.openstack.org/user-guide/cli_provide_user_data_to_instances.html>`_
When used standalone 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 on it instead of ISO 9660. But it's unlikely that it would be needed
since ISO 9660 is widely supported across operating systems. since ISO 9660 is widely supported across operating systems.
For more information see `Store metadata on a configuration drive
<http://docs.openstack.org/user-guide/cli-config-drive.html>`_.
Cloud-init integration Cloud-init integration
---------------------- ----------------------

View File

@ -3,12 +3,11 @@
Configure the Bare Metal service for cleaning 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
:ref:`automated_cleaning`
(which is enabled by default), you will need to set the (which is enabled by default), you will need to set the
``cleaning_network`` configuration option. ``cleaning_network`` configuration option.
.. _`Node cleaning`: http://docs.openstack.org/ironic/latest/admin/cleaning.html#node-cleaning
#. Note the network UUID (the `id` field) of the network you created in #. Note the network UUID (the `id` field) of the network you created in
:ref:`configure-networking` or another network you created for cleaning: :ref:`configure-networking` or another network you created for cleaning:

View File

@ -83,11 +83,11 @@ Configure the Identity service for the Bare Metal service
--user USERNAME baremetal_observer --user USERNAME baremetal_observer
#. Further documentation is available elsewhere for the ``openstack`` #. 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 file, which enumerates the service's default policies, is provided for
your convenience with the Bare Metal Service. your convenience with the Bare Metal Service.
.. _Identity: http://docs.openstack.org/admin-guide/identity-management.html .. _Identity: https://docs.openstack.org/keystone/latest/admin/cli-manage-projects-users-and-roles.html
.. _`command-line client`: http://docs.openstack.org/admin-guide/cli-manage-projects-users-and-roles.html .. _`command-line client`: https://docs.openstack.org/python-openstackclient/latest/cli/authentication.html
.. _here: http://docs.openstack.org/admin-guide/identity-concepts.html#user-management .. _here: https://docs.openstack.org/keystone/latest/admin/identity-concepts.html#user-management
.. _policy.json.sample: https://github.com/openstack/ironic/blob/master/etc/ironic/policy.json.sample

View File

@ -17,8 +17,8 @@ http://ipmitool.sourceforge.net/.
``openipmi`` as it relies on error handling options not provided by ``openipmi`` as it relies on error handling options not provided by
this tool. this tool.
Please refer to the `ipmitool driver page`_ for information on how to use Please refer to the :doc:`/admin/drivers/ipmitool` for information on how to
IPMItool-based drivers. use IPMItool-based drivers.
Validation and troubleshooting Validation and troubleshooting
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -82,4 +82,3 @@ these are ``Temperature``, ``Fan``, ``Voltage``, ``Current``.
Special value ``All`` (the default) designates all supported sensor types. Special value ``All`` (the default) designates all supported sensor types.
.. _IPMI: https://en.wikipedia.org/wiki/Intelligent_Platform_Management_Interface .. _IPMI: https://en.wikipedia.org/wiki/Intelligent_Platform_Management_Interface
.. _ipmitool driver page: https://docs.openstack.org/ironic/latest/admin/drivers/ipmitool.html

View File

@ -333,7 +333,7 @@ on the Bare Metal service node(s) where ``ironic-conductor`` is running.
for accessing objects stored in it. for accessing objects stored in it.
Both the OpenStack Swift and RADOS Gateway provide support for this. 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. the Bare Metal Service with RADOS Gateway as the Object Storage.
Configure this by setting the ``[pxe]/ipxe_use_swift`` configuration 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 you have to ensure that iPXE firmware on the nodes can indeed
boot from generated temporary URLs that use HTTPS protocol. boot from generated temporary URLs that use HTTPS protocol.
.. _Ceph Object Gateway support: http://docs.openstack.org/ironic/latest/admin/radosgw.html
#. Restart the ``ironic-conductor`` process: #. Restart the ``ironic-conductor`` process:
Fedora/RHEL7/CentOS7/SUSE:: Fedora/RHEL7/CentOS7/SUSE::

View File

@ -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 #. Install and configure a compatible ML2 mechanism driver which supports bare
metal provisioning for your switch. See `ML2 plugin configuration manual metal provisioning for your switch. See `ML2 plugin configuration manual
<http://docs.openstack.org/networking-guide/config-ml2.html>`_ <https://docs.openstack.org/neutron/latest/admin/config-ml2.html>`_
for details. for details.
#. Restart the ironic-conductor and ironic-api services after the #. 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. where FILENAME is the file located at the TFTP server.
See `Multitenancy in Bare Metal service`_ for required node configuration. See :ref:`multitenancy` for required node configuration.
.. _`Multitenancy in Bare Metal service`: http://docs.openstack.org/ironic/latest/admin/multitenancy.html#multitenancy

View File

@ -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 You can download a pre-built version of the deploy ramdisk built with
the `CoreOS tools`_ at: the `CoreOS tools`_ at:
* `CoreOS deploy kernel <http://tarballs.openstack.org/ironic-python-agent/coreos/files/coreos_production_pxe.vmlinuz>`_ * `CoreOS deploy kernel <https://tarballs.openstack.org/ironic-python-agent/coreos/files/coreos_production_pxe.vmlinuz>`_
* `CoreOS deploy ramdisk <http://tarballs.openstack.org/ironic-python-agent/coreos/files/coreos_production_pxe_image-oem.cpio.gz>`_ * `CoreOS deploy ramdisk <https://tarballs.openstack.org/ironic-python-agent/coreos/files/coreos_production_pxe_image-oem.cpio.gz>`_
.. _ironic-python-agent: https://docs.openstack.org/ironic-python-agent/latest/ .. _ironic-python-agent: https://docs.openstack.org/ironic-python-agent/latest/

View File

@ -306,7 +306,7 @@ be installed locally. For example,
See :doc:`/admin/drivers` for the required configuration of each driver. See :doc:`/admin/drivers` for the required configuration of each driver.
.. _driver composition reform specification: http://specs.openstack.org/openstack/ironic-specs/specs/approved/driver-composition-reform.html .. _driver composition reform specification: https://specs.openstack.org/openstack/ironic-specs/specs/approved/driver-composition-reform.html
.. _setup.cfg: https://git.openstack.org/cgit/openstack/ironic/tree/setup.cfg .. _setup.cfg: https://git.openstack.org/cgit/openstack/ironic/tree/setup.cfg
.. _iSCSI: https://en.wikipedia.org/wiki/ISCSI .. _iSCSI: https://en.wikipedia.org/wiki/ISCSI
.. _ironic-inspector: https://docs.openstack.org/ironic-inspector/latest/ .. _ironic-inspector: https://docs.openstack.org/ironic-inspector/latest/

View File

@ -16,7 +16,7 @@ conductor and swift and bare metal (via virtual media). It can be enabled in on
of the following ways: of the following ways:
* `Using an SSL termination proxy * `Using an SSL termination proxy
<http://docs.openstack.org/security-guide/secure-communication/tls-proxies-and-http-services.html>`_ <https://docs.openstack.org/security-guide/secure-communication/tls-proxies-and-http-services.html>`_
* `Using native SSL support in swift * `Using native SSL support in swift
<https://docs.openstack.org/swift/latest/deployment_guide.html>`_ <https://docs.openstack.org/swift/latest/deployment_guide.html>`_

View File

@ -2,7 +2,7 @@ The Bare Metal service is configured via its configuration file. This file
is typically located at ``/etc/ironic/ironic.conf``. is typically located at ``/etc/ironic/ironic.conf``.
Although some configuration options are mentioned here, it is recommended that Although some configuration options are mentioned here, it is recommended that
you review all the `available options <https://git.openstack.org/cgit/openstack/ironic/tree/etc/ironic/ironic.conf.sample>`_ you review all the :doc:`/configuration/sample-config`
so that the Bare Metal service is configured for your needs. 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 It is possible to set up an ironic-api and an ironic-conductor services on the

View File

@ -68,8 +68,7 @@ Configuring ironic-conductor service
.. note:: .. note::
Swift backend for the Image service must be installed and configured Swift backend for the Image service must be installed and configured
for ``agent_*`` drivers. Ceph Object Gateway (RADOS Gateway) is also 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`).
<http://docs.openstack.org/ironic/latest/admin/radosgw.html#radosgw-support>`_).
#. Set the URL (replace ``NEUTRON_IP``) for connecting to the Networking #. Set the URL (replace ``NEUTRON_IP``) for connecting to the Networking
service, to be the Networking service endpoint: service, to be the Networking service endpoint:
@ -82,8 +81,7 @@ Configuring ironic-conductor service
url=http://NEUTRON_IP:9696 url=http://NEUTRON_IP:9696
To configure the network for ironic-conductor service to perform node To configure the network for ironic-conductor service to perform node
cleaning, see `CleaningNetworkSetup <http://docs.openstack.org/ironic/latest/admin/cleaning.html>`_ cleaning, see :ref:`cleaning` from the admin guide.
from the Ironic deploy guide.
#. Configure credentials for accessing other OpenStack services. #. Configure credentials for accessing other OpenStack services.

View File

@ -1,8 +1,6 @@
Configuring node web console Configuring node web console
---------------------------- ----------------------------
See `Configuring Web or Serial Console`_. See :ref:`console`.
.. TODO(dtantsur): move the installation documentation here .. TODO(dtantsur): move the installation documentation here
.. _`Configuring Web or Serial Console`: http://docs.openstack.org/ironic/latest/admin/console.html

View File

@ -6,7 +6,7 @@ The Bare Metal service is a collection of components that provides support to
manage and provision physical machines. manage and provision physical machines.
This chapter assumes a working setup of OpenStack following the This chapter assumes a working setup of OpenStack following the
`OpenStack Installation Guides <http://docs.openstack.org/#install-guides>`_. `OpenStack Installation Guides <https://docs.openstack.org/#install-guides>`_.
It contains the following sections: It contains the following sections:
.. toctree:: .. toctree::