openstack
/
ironic
Code Issues Proposed changes

Update docs for train release 

Change-Id: Ica97ef06a42d381818d619481a7be304c3b4c2b6
This commit is contained in:
Mark Goddard 2019-09-26 14:37:44 +01:00
parent 0012bd57e8
commit d456d48369
35 changed files with 61 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/admin/api-audit-support.rst
View File

@ -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.
<https://docs.openstack.org/keystonemiddleware/latest/audit.html>`_
<https://docs.openstack.org/keystonemiddleware/train/audit.html>`_
Auditing can be enabled for the Bare Metal service by making the following changes
to ``/etc/ironic/ironic.conf``.

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

@ -281,4 +281,4 @@ configuration, you may consider some settings below.
memcache_servers = memcache01:11211,memcache02:11211,memcache03:11211
.. _`socat`: http://www.dest-unreach.org/socat
.. _`Serial Console`: https://docs.openstack.org/nova/latest/admin/remote-console-access.html#serial
.. _`Serial Console`: https://docs.openstack.org/nova/train/admin/remote-console-access.html#serial

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

@ -465,6 +465,6 @@ You can use these modules in your playbooks as well.
is not shadowed.
.. _Ansible: https://docs.ansible.com/ansible/latest/index.html
.. _Ironic Python Agent: https://docs.openstack.org/ironic-python-agent/latest/
.. _Ironic Python Agent: https://docs.openstack.org/ironic-python-agent/train/
.. _ironic-staging-drivers: https://opendev.org/x/ironic-staging-drivers/src/branch/stable/pike/imagebuild
.. _ironic-python-agent-builder: https://opendev.org/openstack/ironic-python-agent-builder

4
doc/source/admin/drivers/ilo.rst
View File

@ -123,7 +123,7 @@ The ``ilo`` hardware type supports following hardware interfaces:
enabled_inspect_interfaces = ilo,inspector
.. note::
`Ironic Inspector <https://docs.openstack.org/ironic-inspector/latest/>`_
`Ironic Inspector <https://docs.openstack.org/ironic-inspector/train/>`_
needs to be configured to use ``inspector`` as the inspect interface.
* management
@ -335,7 +335,7 @@ Glance Configuration
^^^^^^^^^^^^^^^^^^^^
1. `Configure Glance image service with its storage backend as Swift
<https://docs.openstack.org/glance/latest/configuration/configuring.html#configuring-the-swift-storage-backend>`_.
<https://docs.openstack.org/glance/train/configuration/configuring.html#configuring-the-swift-storage-backend>`_.
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``,

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

@ -12,7 +12,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
<https://docs.openstack.org/ironic-python-agent/latest>`_.
<https://docs.openstack.org/ironic-python-agent/train>`_.
Drivers
=======
@ -63,7 +63,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 <https://docs.openstack.org/swift/latest/deployment_guide.html>`_),
swift (see `swift deployment guide <https://docs.openstack.org/swift/train/deployment_guide.html>`_),
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

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

@ -58,7 +58,7 @@ hardware interfaces:
The default is ``irmc``.
.. note::
`Ironic Inspector <https://docs.openstack.org/ironic-inspector/latest/>`_
`Ironic Inspector <https://docs.openstack.org/ironic-inspector/train/>`_
needs to be present and configured to use ``inspector`` as the
inspect interface.

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

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

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

@ -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 <https://docs.openstack.org/ironic-python-agent/latest/>`_.
`ironic-python-agent documentation <https://docs.openstack.org/ironic-python-agent/train/>`_.
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
<https://docs.openstack.org/ironic-lib/latest/>`_ for details on how to use
<https://docs.openstack.org/ironic-lib/train/>`_ 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.

2
doc/source/admin/node-deployment.rst
View File

@ -90,7 +90,7 @@ executed with particular sets of arguments and priorities.
Each deploy template has a name, which must be a valid trait. Traits can be
either standard or custom. Standard traits are listed in the `os_traits
library <https://docs.openstack.org/os-traits/latest/>`_. Custom traits must
library <https://docs.openstack.org/os-traits/train/>`_. Custom traits must
meet the following requirements:
* prefixed with ``CUSTOM_``

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

@ -393,7 +393,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`: https://docs.openstack.org/ironic-python-agent/latest/install/index.html#hardware-managers
.. _`Hardware Manager`: https://docs.openstack.org/ironic-python-agent/train/install/index.html#hardware-managers
The hardware manager that supports RAID configuration should do the following:

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

@ -187,7 +187,7 @@ An easy way to do this is to:
* to disable unauthorized access to these endpoints in the (first) API services
group that serves external requests, the following lines should be
added to the `policy.yaml file
<https://docs.openstack.org/ironic/latest/configuration/sample-policy.html>`_::
<https://docs.openstack.org/ironic/train/configuration/sample-policy.html>`_::
# Send heartbeats from IPA ramdisk
"baremetal:node:ipa_heartbeat": "rule:is_admin"

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

@ -143,7 +143,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
<https://docs.openstack.org/nova/latest/filter_scheduler.html>`_ for more
<https://docs.openstack.org/nova/train/filter_scheduler.html>`_ for more
details.
#. If none of the above helped, check Ironic conductor log carefully to see

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

@ -381,7 +381,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
<https://docs.openstack.org/ironic-inspector/latest/install/index.html#version-support-matrix>`_
<https://docs.openstack.org/ironic-inspector/train/install/index.html#version-support-matrix>`_
for details on which ironic versions are compatible with which
**ironic-inspector**/**ironic-discoverd** versions.
@ -392,7 +392,7 @@ The discoverd to inspector upgrade procedure is as follows:
* Update the **ironic-inspector** configuration file to stop using deprecated
configuration options, as marked by the comments in the `example.conf
<https://docs.openstack.org/ironic-inspector/latest/install/index.html#configuration>`_.
<https://docs.openstack.org/ironic-inspector/train/install/index.html#configuration>`_.
It is recommended you move the configuration file to
``/etc/ironic-inspector/inspector.conf``.

2
doc/source/admin/upgrade-to-hardware-types.rst
View File

@ -218,7 +218,7 @@ RAID interface. For example, to update all nodes use:
the ramdisk (more specifically, a `hardware manager`_ used in it),
not on the driver.
.. _hardware manager: https://docs.openstack.org/ironic-python-agent/latest/contributor/hardware_managers.html
.. _hardware manager: https://docs.openstack.org/ironic-python-agent/train/contributor/hardware_managers.html
Network and storage
~~~~~~~~~~~~~~~~~~~

12
doc/source/contributor/code-contribution-guide.rst
View File

@ -48,12 +48,12 @@ developed by the same community.
.. seealso::
* https://docs.openstack.org/bifrost/latest/
* https://docs.openstack.org/ironic-inspector/latest/
* https://docs.openstack.org/ironic-lib/latest/
* https://docs.openstack.org/ironic-python-agent/latest/
* https://docs.openstack.org/python-ironicclient/latest/
* https://docs.openstack.org/python-ironic-inspector-client/latest/
* https://docs.openstack.org/bifrost/train/
* https://docs.openstack.org/ironic-inspector/train/
* https://docs.openstack.org/ironic-lib/train/
* https://docs.openstack.org/ironic-python-agent/train/
* https://docs.openstack.org/python-ironicclient/train/
* https://docs.openstack.org/python-ironic-inspector-client/train/
Project Hosting Details
-----------------------

2
doc/source/contributor/dev-quickstart.rst
View File

@ -132,7 +132,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
<https://docs.openstack.org/oslotest/latest/user/features.html#debugging-with-oslo-debug-helper>`_.
<https://docs.openstack.org/oslotest/train/user/features.html#debugging-with-oslo-debug-helper>`_.
Database Setup
--------------

2
doc/source/contributor/faq.rst
View File

@ -138,5 +138,5 @@ the preferred process is:
-----------------------------------------------------------------
For more information, see the
`oslo.reports documentation <https://docs.openstack.org/oslo.reports/latest/user/usage.html>`_
`oslo.reports documentation <https://docs.openstack.org/oslo.reports/train/user/usage.html>`_
page.

4
doc/source/contributor/notifications.rst
View File

@ -149,5 +149,5 @@ This example will send the following notification over the message bus::
"publisher_id":"ironic-conductor.hostname01"
}
.. [1] https://docs.openstack.org/oslo.messaging/latest/reference/notifier.html
.. [2] https://docs.openstack.org/oslo.versionedobjects/latest/
.. [1] https://docs.openstack.org/oslo.messaging/train/reference/notifier.html
.. [2] https://docs.openstack.org/oslo.versionedobjects/train/

2
doc/source/contributor/osprofiler-support.rst
View File

@ -120,4 +120,4 @@ References
- `OSProfiler – Cross-project profiling library`_
- :ref:`deploy_devstack`
.. _OSProfiler – Cross-project profiling library: https://docs.openstack.org/osprofiler/latest/index.html
.. _OSProfiler – Cross-project profiling library: https://docs.openstack.org/osprofiler/train/index.html

2
doc/source/contributor/webapi.rst
View File

@ -47,7 +47,7 @@ version of API that they have been tested against.
microversion, which always requests the newest supported API version from
the server.
.. _Nova versioning documentation: https://docs.openstack.org/nova/latest/contributor/microversions.html#when-do-i-need-a-new-microversion
.. _Nova versioning documentation: https://docs.openstack.org/nova/train/contributor/microversions.html#when-do-i-need-a-new-microversion
REST API Versions History
-------------------------

2
doc/source/install/configdrive.rst
View File

@ -47,7 +47,7 @@ and provide the file or HTTP URL to the Bare Metal service.
For the format of the configuration drive, Bare Metal service expects a
``gzipped`` and ``base64`` encoded ISO 9660 [#]_ file with a ``config-2``
label. The `openstack baremetal client
<https://docs.openstack.org/python-ironicclient/latest/cli/osc_plugin_cli.html>`_
<https://docs.openstack.org/python-ironicclient/train/cli/osc_plugin_cli.html>`_
can generate a configuration drive in the `expected format`_. Just pass a
directory path containing the files that will be injected into it via the
``--config-drive`` parameter of the ``openstack baremetal node deploy``

2
doc/source/install/configure-glance-swift.rst
View File

@ -74,4 +74,4 @@ and Object Storage service as described below.
#. (Re)start the ironic-conductor service.
.. _swift: https://docs.openstack.org/swift/latest/
.. _swift: https://docs.openstack.org/swift/train/

6
doc/source/install/configure-identity.rst
View File

@ -78,6 +78,6 @@ Configure the Identity service for the Bare Metal service
file, which enumerates the service's default policies, is provided for
your convenience with the Bare Metal Service.
.. _Identity: https://docs.openstack.org/keystone/latest/admin/cli-manage-projects-users-and-roles.html
.. _`command-line client`: https://docs.openstack.org/python-openstackclient/latest/cli/authentication.html
.. _here: https://docs.openstack.org/keystone/latest/admin/identity-concepts.html#user-management
.. _Identity: https://docs.openstack.org/keystone/train/admin/cli-manage-projects-users-and-roles.html
.. _`command-line client`: https://docs.openstack.org/python-openstackclient/train/cli/authentication.html
.. _here: https://docs.openstack.org/keystone/train/admin/identity-concepts.html#user-management

4
doc/source/install/configure-networking.rst
View File

@ -12,10 +12,10 @@ It is recommended to use the baremetal ML2 mechanism driver and L2 agent for
proper integration with the Networking service. Documentation regarding
installation and configuration of the baremetal mechanism driver and L2 agent
is available `here
<https://docs.openstack.org/networking-baremetal/latest/index.html>`_.
<https://docs.openstack.org/networking-baremetal/train/index.html>`_.
For use with `routed networks
<https://docs.openstack.org/neutron/latest/admin/config-routed-networks>`_
<https://docs.openstack.org/neutron/train/admin/config-routed-networks>`_
the baremetal ML2 components are required.
.. Note:: When the baremetal ML2 components are *not* used, ports in the

2
doc/source/install/configure-nova-flavors.rst
View File

@ -31,7 +31,7 @@ still used to determine the root partition size.
.. note:: You can add ``--id <id>`` to specify an ID for the flavor.
See the `docs on this command
<https://docs.openstack.org/python-openstackclient/latest/cli/command-objects/flavor.html#flavor-create>`_
<https://docs.openstack.org/python-openstackclient/train/cli/command-objects/flavor.html#flavor-create>`_
for other options that may be specified.
After creation, associate each flavor with one custom resource class. The name

2
doc/source/install/configure-tenant-networks.rst
View File

@ -135,7 +135,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
<https://docs.openstack.org/neutron/latest/admin/config-ml2.html>`_
<https://docs.openstack.org/neutron/train/admin/config-ml2.html>`_
for details.
#. Restart the ironic-conductor and ironic-api services after the

2
doc/source/install/deploy-ramdisk.rst
View File

@ -8,7 +8,7 @@ service running on it for controlling and deploying bare metal nodes.
.. TODO(dtantsur): a link to DIB ramdisks once we finally build them
.. _ironic-python-agent: https://docs.openstack.org/ironic-python-agent/latest/
.. _ironic-python-agent: https://docs.openstack.org/ironic-python-agent/train/
Building from source
--------------------

2
doc/source/install/enabling-drivers.rst
View File

@ -292,4 +292,4 @@ existing nodes.
provide an explicit value for this interface when creating a node.
.. _setup.cfg: https://opendev.org/openstack/ironic/src/branch/master/setup.cfg
.. _ironic-inspector: https://docs.openstack.org/ironic-inspector/latest/
.. _ironic-inspector: https://docs.openstack.org/ironic-inspector/train/

8
doc/source/install/enabling-https.rst
View File

@ -19,7 +19,7 @@ of the following ways:
<https://docs.openstack.org/security-guide/secure-communication/tls-proxies-and-http-services.html>`_
* `Using native SSL support in swift
<https://docs.openstack.org/swift/latest/deployment_guide.html>`_
<https://docs.openstack.org/swift/train/deployment_guide.html>`_
(recommended only for testing purpose by swift).
.. _EnableHTTPSinGlance:
@ -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
<https://docs.openstack.org/glance/latest/configuration/configuring.html#configuring-ssl-support>`_
<https://docs.openstack.org/glance/train/configuration/configuring.html#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 <https://docs.openstack.org/glance/latest/>`_ documentation,
See the `Glance <https://docs.openstack.org/glance/train/>`_ 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
<https://docs.openstack.org/glance/latest/configuration/configuring.html#configuring-the-swift-storage-backend>`_
<https://docs.openstack.org/glance/train/configuration/configuring.html#configuring-the-swift-storage-backend>`_
#. :ref:`EnableHTTPSinGlance`

2
doc/source/install/enrollment.rst
View File

@ -476,7 +476,7 @@ To move a node from ``manageable`` to ``available`` provision state:
For more details on the Bare Metal service's state machine, see the
:doc:`/contributor/states` documentation.
.. _ComputeCapabilitiesFilter: https://docs.openstack.org/nova/latest/user/filter-scheduler.html
.. _ComputeCapabilitiesFilter: https://docs.openstack.org/nova/train/user/filter-scheduler.html
Mapping nodes to Compute cells
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

10
doc/source/install/get_started.rst
View File

@ -140,10 +140,10 @@ bifrost_
.. _remote procedure call (RPC): https://en.wikipedia.org/wiki/Remote_procedure_call
.. _WSGI: https://en.wikipedia.org/wiki/Web_Server_Gateway_Interface
.. _oslo.messaging: https://docs.openstack.org/oslo.messaging/latest/
.. _python-ironicclient: https://docs.openstack.org/python-ironicclient/latest/
.. _ironic-ui: https://docs.openstack.org/ironic-ui/latest/
.. _ironic-inspector: https://docs.openstack.org/ironic-inspector/latest/
.. _oslo.messaging: https://docs.openstack.org/oslo.messaging/train/
.. _python-ironicclient: https://docs.openstack.org/python-ironicclient/train/
.. _ironic-ui: https://docs.openstack.org/ironic-ui/train/
.. _ironic-inspector: https://docs.openstack.org/ironic-inspector/train/
.. _diskimage-builder: https://docs.openstack.org/diskimage-builder/latest/
.. _bifrost: https://docs.openstack.org/bifrost/latest/
.. _bifrost: https://docs.openstack.org/bifrost/train/

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

@ -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 <https://docs.openstack.org/latest/install>`_.
`OpenStack Installation Guides <https://docs.openstack.org/train/install>`_.
It contains the following sections:
.. toctree::

14
doc/source/install/refarch/small-cloud-trusted-tenants.rst
View File

@ -237,12 +237,12 @@ protocol, and the *bare metal network* has to have a route to the *storage
network*. See :doc:`/admin/boot-from-volume` for more details.
.. _an OpenStack installation: https://docs.openstack.org/arch-design/use-cases/use-case-general-compute.html
.. _Compute service: https://docs.openstack.org/nova/latest/
.. _Networking service: https://docs.openstack.org/neutron/latest/
.. _Image service: https://docs.openstack.org/glance/latest/
.. _Volume service: https://docs.openstack.org/cinder/latest/
.. _Bare Metal Introspection service: https://docs.openstack.org/ironic-inspector/latest/
.. _Compute service: https://docs.openstack.org/nova/train/
.. _Networking service: https://docs.openstack.org/neutron/train/
.. _Image service: https://docs.openstack.org/glance/train/
.. _Volume service: https://docs.openstack.org/cinder/train/
.. _Bare Metal Introspection service: https://docs.openstack.org/ironic-inspector/train/
.. _control plane design guide: https://docs.openstack.org/arch-design/design-control-plane.html
.. _networking-baremetal: https://docs.openstack.org/networking-baremetal/latest/
.. _ironic-neutron-agent: https://docs.openstack.org/networking-baremetal/latest/install/index.html#configure-ironic-neutron-agent
.. _networking-baremetal: https://docs.openstack.org/networking-baremetal/train/
.. _ironic-neutron-agent: https://docs.openstack.org/networking-baremetal/train/install/index.html#configure-ironic-neutron-agent
.. _iSCSI: https://en.wikipedia.org/wiki/ISCSI

2
doc/source/install/standalone.rst
View File

@ -61,7 +61,7 @@ There are however some limitations for different hardware interfaces:
Steps to start a deployment are pretty similar to those when using Compute:
#. To use the `openstack baremetal CLI
<https://docs.openstack.org/python-ironicclient/latest/cli/osc_plugin_cli.html>`_,
<https://docs.openstack.org/python-ironicclient/train/cli/osc_plugin_cli.html>`_,
set up these environment variables. Since no authentication strategy is
being used, the value none must be set for OS_AUTH_TYPE. OS_ENDPOINT is
the URL of the ironic-api process.

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

@ -131,4 +131,4 @@ following command.
$ openstack baremetal node maintenance unset $NODE_UUID
.. _ironic-python-agent: https://docs.openstack.org/ironic-python-agent/latest/
.. _ironic-python-agent: https://docs.openstack.org/ironic-python-agent/train/