From 1df3dff00b2752d1a34334a064b6d89a9c6e4177 Mon Sep 17 00:00:00 2001 From: gaozx Date: Fri, 18 Aug 2017 09:40:08 +0800 Subject: [PATCH] Fix incorrect documentation urls Change-Id: Ifc39a856251c18077bc1c3820bffd3c2e9eed9a1 --- doc/source/admin/api-audit-support.rst | 2 +- doc/source/admin/drivers/ilo.rst | 29 ++++++++++------------- doc/source/admin/drivers/ipa.rst | 6 ++--- doc/source/admin/drivers/oneview.rst | 13 +++++----- doc/source/admin/metrics.rst | 4 ++-- doc/source/admin/upgrade-guide.rst | 13 ++++------ doc/source/contributor/architecture.rst | 6 ++--- doc/source/contributor/dev-quickstart.rst | 6 ++--- doc/source/contributor/faq.rst | 4 ++-- doc/source/contributor/notifications.rst | 4 ++-- doc/source/contributor/releasing.rst | 2 +- 11 files changed, 39 insertions(+), 50 deletions(-) diff --git a/doc/source/admin/api-audit-support.rst b/doc/source/admin/api-audit-support.rst index b1680c963e..51aec46ea0 100644 --- a/doc/source/admin/api-audit-support.rst +++ b/doc/source/admin/api-audit-support.rst @@ -18,7 +18,7 @@ Enabling API Audit Logging Audit middleware is available as part of `keystonemiddleware` (>= 1.6) library. For information regarding how audit middleware functions refer `here. -`_ +`_ Auditing can be enabled for the Bare Metal service by making the following changes to ``/etc/ironic/ironic.conf``. diff --git a/doc/source/admin/drivers/ilo.rst b/doc/source/admin/drivers/ilo.rst index 82d3564df6..4437e55a7f 100644 --- a/doc/source/admin/drivers/ilo.rst +++ b/doc/source/admin/drivers/ilo.rst @@ -209,7 +209,7 @@ Glance Configuration ^^^^^^^^^^^^^^^^^^^^ 1. `Configure Glance image service with its storage backend as Swift - `_. + `_. 2. Set a temp-url key for Glance user in Swift. For example, if you have configured Glance with user ``glance-swift`` and tenant as ``service``, @@ -358,12 +358,11 @@ Target Users The PXE driver passes management information in clear-text to the bare metal node. However, if swift proxy server and glance have HTTPS - endpoints (See `Enabling HTTPS in Swift`_, `Enabling HTTPS in Image - service`_ for more information), the ``iscsi_ilo`` driver provides enhanced - security by exchanging management information with swift and glance - endpoints over HTTPS. The management information, deploy ramdisk and boot - images for the instance will be retrieved over encrypted management network - via iLO virtual media. + endpoints (See :ref:`EnableHTTPSinSwift`, :ref:`EnableHTTPSinGlance` + for more information), the ``iscsi_ilo`` driver provides enhanced security by + exchanging management information with swift and glance endpoints over HTTPS. + The management information, deploy ramdisk and boot images for the instance + will be retrieved over encrypted management network via iLO virtual media. Tested Platforms ~~~~~~~~~~~~~~~~ @@ -396,7 +395,7 @@ Features * UEFI Secure Boot Support * Passing management information via secure, encrypted management network (virtual media) if swift proxy server and glance have HTTPS endpoints. See - `Enabling HTTPS in Swift`_, `Enabling HTTPS in Image service`_ for more + :ref:`EnableHTTPSinSwift`, :ref:`EnableHTTPSinGlance` for more information. User image provisioning is done using iSCSI over data network, so this driver has the benefit of security enhancement with the same performance. It segregates management info from data channel. @@ -525,11 +524,11 @@ Target Users The PXE based agent drivers pass management information in clear-text to the bare metal node. However, if swift proxy server and glance have HTTPS - endpoints (See `Enabling HTTPS in Swift`_, `Enabling HTTPS in Image - service`_ for more information), the ``agent_ilo`` driver provides enhanced - security by exchanging authtoken and management information with swift and - glance endpoints over HTTPS. The management information and deploy ramdisk - will be retrieved over encrypted management network via iLO. + endpoints (See :ref:`EnableHTTPSinSwift`, :ref:`EnableHTTPSinGlance` for more + information), the ``agent_ilo`` driver provides enhanced security by + exchanging authtoken and management information with swift and glance + endpoints over HTTPS. The management information and deploy ramdisk will be + retrieved over encrypted management network via iLO. Tested Platforms ~~~~~~~~~~~~~~~~ @@ -1807,9 +1806,7 @@ See the `proliant-tools`_ for more information on creating agent ramdisk with ``proliant-tools`` element in DIB. .. _`ssacli documentation`: http://h20566.www2.hpe.com/hpsc/doc/public/display?docId=c03909334 -.. _`proliant-tools`: http://docs.openstack.org/developer/diskimage-builder/elements/proliant-tools/README.html -.. _`Enabling HTTPS in Swift`: http://docs.openstack.org/project-install-guide/baremetal/draft/enabling-https.html#enabling-https-in-swift -.. _`Enabling HTTPS in Image service`: http://docs.openstack.org/project-install-guide/baremetal/draft/enabling-https.html#enabling-https-in-image-service +.. _`proliant-tools`: https://docs.openstack.org/diskimage-builder/latest/elements/proliant-tools/README.html .. _`HPE iLO4 User Guide`: http://h20566.www2.hpe.com/hpsc/doc/public/display?docId=c03334051 .. _`iLO 4 management engine`: https://www.hpe.com/us/en/servers/integrated-lights-out-ilo.html .. _`iLO 5 management engine`: https://www.hpe.com/us/en/servers/integrated-lights-out-ilo.html#innovations diff --git a/doc/source/admin/drivers/ipa.rst b/doc/source/admin/drivers/ipa.rst index 9d4a6e0269..da3458fc35 100644 --- a/doc/source/admin/drivers/ipa.rst +++ b/doc/source/admin/drivers/ipa.rst @@ -46,7 +46,7 @@ Requirements ------------ Using IPA requires it to be present and configured on the deploy ramdisk, see -`Building or downloading a deploy ramdisk image`_. +:ref:`deploy-ramdisk` Using proxies for image download in agent drivers ================================================= @@ -66,7 +66,7 @@ Steps to enable proxies This will probably require you to configure the proxy server to cache the content even if the requested URL contains a query, and to raise the maximum cached file size as images can be pretty big. If you have HTTPS enabled in - swift (see `swift deployment guide `_), + swift (see `swift deployment guide `_), it is possible to configure the proxy server to talk to swift via HTTPS to download the image, store it in the cache unencrypted and return it to the node via HTTPS again. Because the image will be stored unencrypted in @@ -124,5 +124,3 @@ that, you have to update the node's ``driver_info`` field and set the example, the below command sets this configuration in a specific node:: ironic node-update add driver_info/deploy_forces_oob_reboot=True - -.. _`Building or downloading a deploy ramdisk image`: http://docs.openstack.org/project-install-guide/baremetal/draft/deploy-ramdisk.html diff --git a/doc/source/admin/drivers/oneview.rst b/doc/source/admin/drivers/oneview.rst index 3a9e0da443..6f5112cfc1 100644 --- a/doc/source/admin/drivers/oneview.rst +++ b/doc/source/admin/drivers/oneview.rst @@ -129,7 +129,7 @@ Configuring and enabling the driver $ sudo service ironic-conductor restart -See [5]_ for more information. +See :doc:`/install/index` for more information. Deploy process ~~~~~~~~~~~~~~ @@ -179,7 +179,7 @@ Configuring and enabling the driver $ service ironic-conductor restart -See [5]_ for more information. +See :doc:`/install/index` for more information. Deploy process ~~~~~~~~~~~~~~ @@ -277,7 +277,8 @@ To tell ironic which NIC should be connected to the provisioning network, do:: $ ironic port-create -n $NODE_UUID -a $MAC_ADDRESS -For more information on the enrollment process of an ironic node, see [4]_. +For more information on the enrollment process of an ironic node, see +:ref:`enrollment`. For more information on the definitions of ``Server Hardware``, ``Server Profile``, ``Server Profile Template`` and other OneView entities, refer to @@ -321,10 +322,8 @@ References .. [1] HP OneView - https://www.hpe.com/us/en/integrated-systems/software.html .. [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-inspector - http://docs.openstack.org/developer/ironic-inspector/ -.. [10] ironic-inspector install - http://docs.openstack.org/developer/ironic-inspector/install.html +.. [9] ironic-inspector - https://docs.openstack.org/ironic-inspector/latest/ +.. [10] ironic-inspector install - https://docs.openstack.org/ironic-inspector/latest/install/index.html diff --git a/doc/source/admin/metrics.rst b/doc/source/admin/metrics.rst index 5b90779f25..900f435215 100644 --- a/doc/source/admin/metrics.rst +++ b/doc/source/admin/metrics.rst @@ -90,7 +90,7 @@ The ironic-python-agent ramdisk emits timing metrics for every API method. Deployers who use custom HardwareManagers can emit custom metrics for their hardware. For more information on custom HardwareManagers, and emitting metrics from them, please see the -`ironic-python-agent documentation `_. +`ironic-python-agent documentation `_. Adding New Metrics @@ -98,6 +98,6 @@ Adding New Metrics If you're a developer, and would like to add additional metrics to ironic, please see the `ironic-lib developer documentation -`_ for details on how to use +`_ for details on how to use the metrics library. A release note should also be created each time a metric is changed or removed to alert deployers of the change. diff --git a/doc/source/admin/upgrade-guide.rst b/doc/source/admin/upgrade-guide.rst index 0459c177dd..7441e7ae90 100644 --- a/doc/source/admin/upgrade-guide.rst +++ b/doc/source/admin/upgrade-guide.rst @@ -311,9 +311,7 @@ Upgrading from Ocata to Pike #. It is required to set the ``resource_class`` field for nodes registered with the Bare Metal service *before* using the Pike version of the Compute - service. See `enrollment documentation - `_ - for details. + service. See :ref:`enrollment` for details. #. It is recommended to move from old-style classic drivers to the new hardware types after the upgrade to Pike. We expect the classic drivers to @@ -359,7 +357,7 @@ client module for the in-band inspection service, which was previously part of the **ironic-discoverd** package. Ironic Liberty supports the **ironic-discoverd** service, but does not support its in-tree client module. Please refer to `ironic-inspector version support matrix -`_ +`_ for details on which ironic versions are compatible with which **ironic-inspector**/**ironic-discoverd** versions. @@ -421,8 +419,5 @@ For more information, see :ref:`automated_cleaning`. If ironic is configured with automated cleaning enabled (defaults to True) and neutron is set as the DHCP provider (also the default), you will need to set the `cleaning_network_uuid` option in the ironic configuration file before -starting the ironic service. See -`Configure the Bare Metal service for cleaning`_ for information on how to set -up the cleaning network for ironic. - -.. _`Configure the Bare Metal service for cleaning`: http://docs.openstack.org/project-install-guide/baremetal/draft/configure-cleaning.html +starting the ironic service. See :ref:`configure-cleaning` +for information on how to set up the cleaning network for ironic. diff --git a/doc/source/contributor/architecture.rst b/doc/source/contributor/architecture.rst index 1089046034..fe00b51d1f 100644 --- a/doc/source/contributor/architecture.rst +++ b/doc/source/contributor/architecture.rst @@ -116,6 +116,6 @@ driver actions such as take-over or clean-up. .. _BaseDriver: api/ironic.drivers.base.html#ironic.drivers.base.BaseDriver .. _Conductor service: api/ironic.conductor.manager.html .. _DB API: api/ironic.db.api.html -.. _diskimage-builder: http://docs.openstack.org/developer/diskimage-builder/ -.. _consistent hashing algorithm: http://docs.openstack.org/developer/tooz/tutorial/hashring.html -.. _periodic: http://docs.openstack.org/developer/futurist/api.html#futurist.periodics.periodic +.. _diskimage-builder: https://docs.openstack.org/diskimage-builder/latest/ +.. _consistent hashing algorithm: https://docs.openstack.org/tooz/latest/user/tutorial/hashring.html +.. _periodic: https://docs.openstack.org/futurist/latest/reference/index.html#futurist.periodics.periodic diff --git a/doc/source/contributor/dev-quickstart.rst b/doc/source/contributor/dev-quickstart.rst index b31a9a6e9a..607de22c46 100644 --- a/doc/source/contributor/dev-quickstart.rst +++ b/doc/source/contributor/dev-quickstart.rst @@ -137,7 +137,7 @@ Then run ``tox`` with the debug environment as one of the following:: tox -e debug test_file_name.TestClass.test_name For more information see the `oslotest documentation -`_. +`_. Database Setup -------------- @@ -412,7 +412,7 @@ up to date and has the latest packages installed before beginning this process. .. seealso:: - http://docs.openstack.org/developer/devstack/ + https://docs.openstack.org/devstack/latest/ .. note:: The devstack "demo" tenant is now granted the "baremetal_observer" role @@ -559,7 +559,7 @@ and uses the ``agent_ipmitool`` driver by default:: For more details, see the `devstack plugin interface documentation - `_. + `_. Run stack.sh:: diff --git a/doc/source/contributor/faq.rst b/doc/source/contributor/faq.rst index 01abfe1684..26abb7673b 100644 --- a/doc/source/contributor/faq.rst +++ b/doc/source/contributor/faq.rst @@ -71,7 +71,7 @@ Then edit the result file. Note that: For more information see the `reno documentation`_. -.. _`reno documentation`: http://docs.openstack.org/developer/reno/usage.html +.. _`reno documentation`: https://docs.openstack.org/reno/latest/user/usage.html ...get a decision on something? ------------------------------- @@ -121,5 +121,5 @@ the preferred process is: ----------------------------------------------------------------- For more information, see the -`oslo.reports documentation `_ +`oslo.reports documentation `_ page. diff --git a/doc/source/contributor/notifications.rst b/doc/source/contributor/notifications.rst index 7a4c6ad89e..3d6346d10b 100644 --- a/doc/source/contributor/notifications.rst +++ b/doc/source/contributor/notifications.rst @@ -149,5 +149,5 @@ This example will send the following notification over the message bus:: "publisher_id":"ironic-conductor.hostname01" } -.. [1] http://docs.openstack.org/developer/oslo.messaging/notifier.html -.. [2] http://docs.openstack.org/developer/oslo.versionedobjects +.. [1] https://docs.openstack.org/oslo.messaging/latest/reference/notifier.html +.. [2] https://docs.openstack.org/oslo.versionedobjects/latest/ diff --git a/doc/source/contributor/releasing.rst b/doc/source/contributor/releasing.rst index 23d0ade06e..69a952b285 100644 --- a/doc/source/contributor/releasing.rst +++ b/doc/source/contributor/releasing.rst @@ -92,7 +92,7 @@ Additionally, changes need to be made on master to: version. See `example `_ and `pbr documentation - `_ for details. + `_ for details. * to support rolling upgrades, since the release was a named release: