From 21504464806378960314016198d8f28d316e7c0d Mon Sep 17 00:00:00 2001 From: wangkf Date: Wed, 9 Aug 2017 10:15:24 +0800 Subject: [PATCH] Fix broken links to ocata installation guide Many links in ocata installation guide is broken due to doc migration, it's originally reported as broken link to Image Builders. This patch will try to cover all broken links and anchors found in the installation guide for ocata branch. As an example, the wrong link to Image Builders is: http://docs.openstack.org/developer/ironic-python-agent/ocata/index.html#image-builders We have to remove 'developer' from the path for link to be available. Change-Id: Id5cf2b22ae2a81cba0102e2566a258b27a3890f2 Closes-Bug: #1705498 --- install-guide/source/configure-cleaning.rst | 2 +- install-guide/source/configure-port-groups.rst | 2 +- install-guide/source/configure-tenant-networks.rst | 2 +- install-guide/source/deploy-ramdisk.rst | 2 +- install-guide/source/enabling-https.rst | 6 +++--- install-guide/source/enrollment.rst | 4 ++-- install-guide/source/get_started.rst | 6 +++--- install-guide/source/include/configure-glance-images.rst | 4 ++-- install-guide/source/include/configure-ironic-conductor.rst | 6 +++--- .../source/include/local-boot-partition-images.rst | 4 ++-- install-guide/source/include/notifications.rst | 2 +- install-guide/source/setup-drivers.rst | 4 ++-- install-guide/source/troubleshooting.rst | 2 +- 13 files changed, 23 insertions(+), 23 deletions(-) diff --git a/install-guide/source/configure-cleaning.rst b/install-guide/source/configure-cleaning.rst index 94784ea693..f3c3d07d0f 100644 --- a/install-guide/source/configure-cleaning.rst +++ b/install-guide/source/configure-cleaning.rst @@ -7,7 +7,7 @@ Configure the Bare Metal service for cleaning (which is enabled by default), you will need to set the ``cleaning_network`` configuration option. -.. _`Node cleaning`: http://docs.openstack.org/developer/ironic/ocata/deploy/cleaning.html#node-cleaning +.. _`Node cleaning`: http://docs.openstack.org/ironic/ocata/deploy/cleaning.html#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: diff --git a/install-guide/source/configure-port-groups.rst b/install-guide/source/configure-port-groups.rst index f544a51665..5a30503190 100644 --- a/install-guide/source/configure-port-groups.rst +++ b/install-guide/source/configure-port-groups.rst @@ -5,4 +5,4 @@ Configure port groups See `Port groups configuration in Bare Metal service`_. -.. _`Port groups configuration in Bare Metal service`: http://docs.openstack.org/developer/ironic/ocata/deploy/portgroups.html +.. _`Port groups configuration in Bare Metal service`: http://docs.openstack.org/ironic/ocata/deploy/portgroups.html diff --git a/install-guide/source/configure-tenant-networks.rst b/install-guide/source/configure-tenant-networks.rst index 4fbebd555f..e8f20cc59b 100644 --- a/install-guide/source/configure-tenant-networks.rst +++ b/install-guide/source/configure-tenant-networks.rst @@ -5,4 +5,4 @@ Configure tenant networks See `Multitenancy in Bare Metal service`_. -.. _`Multitenancy in Bare Metal service`: http://docs.openstack.org/developer/ironic/ocata/deploy/multitenancy.html#multitenancy +.. _`Multitenancy in Bare Metal service`: http://docs.openstack.org/ironic/ocata/deploy/multitenancy.html#multitenancy diff --git a/install-guide/source/deploy-ramdisk.rst b/install-guide/source/deploy-ramdisk.rst index cc32abe2cd..5f81743c1a 100644 --- a/install-guide/source/deploy-ramdisk.rst +++ b/install-guide/source/deploy-ramdisk.rst @@ -12,7 +12,7 @@ the `CoreOS tools`_ at: * `CoreOS deploy kernel `_ * `CoreOS deploy ramdisk `_ -.. _ironic-python-agent: http://docs.openstack.org/developer/ironic-python-agent/ocata/ +.. _ironic-python-agent: http://docs.openstack.org/ironic-python-agent/ocata/ Building from source -------------------- diff --git a/install-guide/source/enabling-https.rst b/install-guide/source/enabling-https.rst index df13b18f11..53bdd53c49 100644 --- a/install-guide/source/enabling-https.rst +++ b/install-guide/source/enabling-https.rst @@ -32,7 +32,7 @@ image service does not use HTTPS, but it is required for secure communication. It can be enabled by making the following changes to ``/etc/glance/glance-api.conf``: #. `Configuring SSL support - `_ + `_ #. Restart the glance-api service:: @@ -42,7 +42,7 @@ It can be enabled by making the following changes to ``/etc/glance/glance-api.co Debian/Ubuntu: sudo service glance-api restart -See the `Glance `_ documentation, +See the `Glance `_ documentation, for more details on the Image service. Enabling HTTPS communication between Image service and Object storage @@ -56,7 +56,7 @@ To enable secure HTTPS communication between Image service and Object storage fo #. :ref:`EnableHTTPSinSwift` #. `Configure Swift Storage Backend - `_ + `_ #. :ref:`EnableHTTPSinGlance` diff --git a/install-guide/source/enrollment.rst b/install-guide/source/enrollment.rst index ff2fc617f5..c1729a293f 100644 --- a/install-guide/source/enrollment.rst +++ b/install-guide/source/enrollment.rst @@ -325,7 +325,7 @@ To move a node from ``manageable`` to ``available`` provision state:: For more details on the Bare Metal service's state machine, see the -`state machine `_ +`state machine `_ documentation. @@ -395,4 +395,4 @@ Hardware Inspection Starting with the Kilo release, Bare Metal service supports hardware inspection that simplifies enrolling nodes - please see `inspection`_ for details. -.. _`inspection`: http://docs.openstack.org/developer/ironic/ocata/deploy/inspection.html +.. _`inspection`: http://docs.openstack.org/ironic/ocata/deploy/inspection.html diff --git a/install-guide/source/get_started.rst b/install-guide/source/get_started.rst index df64c47918..ff82d4ab6a 100644 --- a/install-guide/source/get_started.rst +++ b/install-guide/source/get_started.rst @@ -73,8 +73,8 @@ bifrost_ A set of Ansible playbooks that automates the task of deploying a base image onto a set of known hardware using ironic in a standalone mode. -.. _python-ironicclient: http://docs.openstack.org/developer/python-ironicclient/ -.. _ironic-inspector: http://docs.openstack.org/developer/ironic-inspector/ocata/ +.. _python-ironicclient: http://docs.openstack.org/python-ironicclient +.. _ironic-inspector: http://docs.openstack.org/ironic-inspector/ocata/ .. _diskimage-builder: http://docs.openstack.org/developer/diskimage-builder/ -.. _bifrost: http://docs.openstack.org/developer/bifrost/ocata/ +.. _bifrost: http://docs.openstack.org/bifrost/ocata/ diff --git a/install-guide/source/include/configure-glance-images.rst b/install-guide/source/include/configure-glance-images.rst index c411f5e33f..495c89eb5e 100644 --- a/install-guide/source/include/configure-glance-images.rst +++ b/install-guide/source/include/configure-glance-images.rst @@ -15,7 +15,7 @@ them to the Image service: The `disk-image-builder`_ can be used to create user images required for deployment and the actual OS which the user is going to run. - .. _disk-image-builder: http://docs.openstack.org/developer/diskimage-builder/ + .. _disk-image-builder: http://docs.openstack.org/diskimage-builder/latest - Install diskimage-builder package (use virtualenv, if you don't want to install anything globally): @@ -105,7 +105,7 @@ them to the Image service: one kernel disk ``coreos_production_pxe.vmlinuz`` and one ram disk ``coreos_production_pxe_image-oem.cpio.gz``. - .. note:: If you want to customize your deploy images, please read `Image Builders `_. + .. note:: If you want to customize your deploy images, please read `Image Builders `_. #. Add the deploy images to the Image service diff --git a/install-guide/source/include/configure-ironic-conductor.rst b/install-guide/source/include/configure-ironic-conductor.rst index 702ee6e9f4..7f19e4b179 100644 --- a/install-guide/source/include/configure-ironic-conductor.rst +++ b/install-guide/source/include/configure-ironic-conductor.rst @@ -81,7 +81,7 @@ Configuring ironic-conductor service Swift backend for the Image service should be installed and configured for ``agent_*`` drivers. Starting with Mitaka the Bare Metal service also supports Ceph Object Gateway (RADOS Gateway) as the Image service's backend - (`radosgw support `_). + (`radosgw support `_). #. Set the URL (replace ``NEUTRON_IP``) for connecting to the Networking service, to be the Networking service endpoint: @@ -94,7 +94,7 @@ Configuring ironic-conductor service url=http://NEUTRON_IP:9696 To configure the network for ironic-conductor service to perform node - cleaning, see `CleaningNetworkSetup `_ + cleaning, see `CleaningNetworkSetup `_ from the Ironic deploy guide. #. Configure credentials for accessing other OpenStack services. @@ -173,7 +173,7 @@ Configuring ironic-conductor service #. Make sure that ``qemu-img`` and ``iscsiadm`` (in the case of using iscsi-deploy driver) binaries are installed and prepare the host system as described at - `Setup the drivers for the Bare Metal service `_ + `Setup the drivers for the Bare Metal service `_ #. Restart the ironic-conductor service: diff --git a/install-guide/source/include/local-boot-partition-images.rst b/install-guide/source/include/local-boot-partition-images.rst index a1953b300a..42be757c97 100644 --- a/install-guide/source/include/local-boot-partition-images.rst +++ b/install-guide/source/include/local-boot-partition-images.rst @@ -20,8 +20,8 @@ The following sections will describe both methods. with diskimage-builder_ **version >= 0.1.42** or ironic-python-agent_ in the kilo-era. -.. _diskimage-builder: http://docs.openstack.org/developer/diskimage-builder/ -.. _ironic-python-agent: http://docs.openstack.org/developer/ironic-python-agent/ocata/ +.. _diskimage-builder: http://docs.openstack.org/developer/diskimage-builder +.. _ironic-python-agent: http://docs.openstack.org/ironic-python-agent/ocata/ Enabling local boot with Compute service diff --git a/install-guide/source/include/notifications.rst b/install-guide/source/include/notifications.rst index f1c84b44a9..1c171bbb11 100644 --- a/install-guide/source/include/notifications.rst +++ b/install-guide/source/include/notifications.rst @@ -13,4 +13,4 @@ resources from the Bare Metal service. Notifications are disabled by default. For a complete list of available notifications and instructions for how to enable them, see the `deploy -guide `_. +guide `_. diff --git a/install-guide/source/setup-drivers.rst b/install-guide/source/setup-drivers.rst index d4a47b91eb..8db948ae32 100644 --- a/install-guide/source/setup-drivers.rst +++ b/install-guide/source/setup-drivers.rst @@ -343,7 +343,7 @@ 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: http://docs.openstack.org/developer/ironic/ocata/deploy/radosgw.html + .. _Ceph Object Gateway support: http://docs.openstack.org/ironic/ocata/deploy/radosgw.html #. Restart the ``ironic-conductor`` process:: @@ -502,7 +502,7 @@ Configure node web console See `Configuring Web or Serial Console`_. -.. _`Configuring Web or Serial Console`: http://docs.openstack.org/developer/ironic/ocata/deploy/console.html +.. _`Configuring Web or Serial Console`: http://docs.openstack.org/ironic/ocata/deploy/console.html .. _boot_mode_support: diff --git a/install-guide/source/troubleshooting.rst b/install-guide/source/troubleshooting.rst index 377a2749da..05420b1bc4 100644 --- a/install-guide/source/troubleshooting.rst +++ b/install-guide/source/troubleshooting.rst @@ -123,4 +123,4 @@ following command. $ ironic node-set-maintenance $NODE_UUID off -.. _ironic-python-agent: http://docs.openstack.org/developer/ironic-python-agent/ocata/ +.. _ironic-python-agent: http://docs.openstack.org/ironic-python-agent/ocata/