openstack
/
ironic-inspector
Code Issues Proposed changes

Update the documentation link for doc migration 

Change-Id: Ie3d175b4d910f49f8a54812926131448ff1ab4d5
This commit is contained in:
chenxing 2017-07-26 17:03:16 +08:00 committed by Chason Chan
parent 112ab521ae
commit c28dd315bf
9 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.rst
View File

@ -86,7 +86,7 @@ You can develop and test **ironic-inspector** using DevStack - see
Deploying Ironic Inspector with DevStack Deploying Ironic Inspector with DevStack
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
`DevStack <http://docs.openstack.org/developer/devstack/>`_ provides a way to `DevStack <https://docs.openstack.org/devstack/latest/>`_ provides a way to
quickly build a full OpenStack development environment with requested quickly build a full OpenStack development environment with requested
components. There is a plugin for installing **ironic-inspector** in DevStack. components. There is a plugin for installing **ironic-inspector** in DevStack.
Installing **ironic-inspector** requires a machine running Ubuntu 14.04 (or Installing **ironic-inspector** requires a machine running Ubuntu 14.04 (or
@ -159,7 +159,7 @@ Inspect the node::
.. note:: .. note::
The deploy driver used must support the inspect interface. See also the The deploy driver used must support the inspect interface. See also the
`Ironic Python Agent `Ironic Python Agent
<http://docs.openstack.org/developer/ironic/drivers/ipa.html#ipa>`_. <https://docs.openstack.org/ironic/latest/admin/drivers/ipa.html>`_.
A node can also be inspected using the following command. However, this will A node can also be inspected using the following command. However, this will
not affect the provision state of the node:: not affect the provision state of the node::
@ -267,8 +267,8 @@ Writing a Plugin
``**`` argument is needed so that we can add optional arguments without ``**`` argument is needed so that we can add optional arguments without
breaking out-of-tree plugins. Please make sure to include and ignore it. breaking out-of-tree plugins. Please make sure to include and ignore it.
.. _ironic_inspector.plugins.base: http://docs.openstack.org/developer/ironic-inspector/api/ironic_inspector.plugins.base.html .. _ironic_inspector.plugins.base: https://docs.openstack.org/ironic-inspector/latest/api/ironic_inspector.plugins.base.html
.. _Introspection Rules: http://docs.openstack.org/developer/ironic-inspector/usage.html#introspection-rules .. _Introspection Rules: https://docs.openstack.org/ironic-inspector/latest/usage.html#introspection-rules
Making changes to the database Making changes to the database
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -314,7 +314,7 @@ the database::
ironic-inspector-dbsync revision -m "A short description" ironic-inspector-dbsync revision -m "A short description"
.. _Create a Migration Script: http://alembic.zzzcomputing.com/en/latest/tutorial.html#create-a-migration-script .. _Create a Migration Script: http://alembic.zzzcomputing.com/en/latest/tutorial.html#create-a-migration-script
.. _ironic_inspector.db: http://docs.openstack.org/developer/ironic-inspector/api/ironic_inspector.db.html .. _ironic_inspector.db: https://docs.openstack.org/ironic-inspector/latest/api/ironic_inspector.db.html
.. _What does Autogenerate Detect (and what does it not detect?): http://alembic.zzzcomputing.com/en/latest/autogenerate.html#what-does-autogenerate-detect-and-what-does-it-not-detect .. _What does Autogenerate Detect (and what does it not detect?): http://alembic.zzzcomputing.com/en/latest/autogenerate.html#what-does-autogenerate-detect-and-what-does-it-not-detect
Implementing PXE Filter Drivers Implementing PXE Filter Drivers

4
README.rst
View File

@ -18,11 +18,11 @@ scheduling from a bare metal node, given it's power management credentials
* Source: http://git.openstack.org/cgit/openstack/ironic-inspector * Source: http://git.openstack.org/cgit/openstack/ironic-inspector
* Bugs: http://bugs.launchpad.net/ironic-inspector * Bugs: http://bugs.launchpad.net/ironic-inspector
* Downloads: https://pypi.python.org/pypi/ironic-inspector * Downloads: https://pypi.python.org/pypi/ironic-inspector
* Documentation: http://docs.openstack.org/developer/ironic-inspector * Documentation: https://docs.openstack.org/ironic-inspector/latest/
* Python client library and CLI tool: `python-ironic-inspector-client * Python client library and CLI tool: `python-ironic-inspector-client
<https://pypi.python.org/pypi/python-ironic-inspector-client>`_ <https://pypi.python.org/pypi/python-ironic-inspector-client>`_
(`documentation (`documentation
<http://docs.openstack.org/developer/python-ironic-inspector-client>`_). <https://docs.openstack.org/python-ironic-inspector-client/latest/>`_).
.. _Ironic: https://wiki.openstack.org/wiki/Ironic .. _Ironic: https://wiki.openstack.org/wiki/Ironic

2
devstack/example.local.conf
View File

@ -1,6 +1,6 @@
[[local|localrc]] [[local|localrc]]
# Credentials # Credentials
# Reference: http://docs.openstack.org/developer/devstack/configuration.html # Reference: https://docs.openstack.org/devstack/latest/configuration.html
ADMIN_PASSWORD=password ADMIN_PASSWORD=password
DATABASE_PASSWORD=$ADMIN_PASSWORD DATABASE_PASSWORD=$ADMIN_PASSWORD
RABBIT_PASSWORD=$ADMIN_PASSWORD RABBIT_PASSWORD=$ADMIN_PASSWORD

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

@ -6,7 +6,7 @@ environment)::
pip install ironic-inspector pip install ironic-inspector
Also there is a `DevStack <http://docs.openstack.org/developer/devstack/>`_ Also there is a `DevStack <https://docs.openstack.org/devstack/latest/>`_
plugin for **ironic-inspector** - see :ref:`contributing_link` for the plugin for **ironic-inspector** - see :ref:`contributing_link` for the
current status. current status.
@ -186,10 +186,10 @@ To build an **ironic-python-agent** ramdisk, do the following:
Alternatively, you can download a `prebuilt TinyIPA image Alternatively, you can download a `prebuilt TinyIPA image
<http://tarballs.openstack.org/ironic-python-agent/tinyipa/files/>`_ or use <http://tarballs.openstack.org/ironic-python-agent/tinyipa/files/>`_ or use
the `other builders the `other builders
<http://docs.openstack.org/developer/ironic-python-agent/#image-builders>`_. <https://docs.openstack.org/ironic-python-agent/latest/install/index.html#image-builders>`_.
.. _diskimage-builder: https://docs.openstack.org/developer/diskimage-builder/ .. _diskimage-builder: https://docs.openstack.org/diskimage-builder/latest/
.. _ironic-python-agent: https://docs.openstack.org/developer/ironic-python-agent/ .. _ironic-python-agent: https://docs.openstack.org/ironic-python-agent/latest/
Configuring PXE Configuring PXE
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~

2
doc/source/user/http-api.rst
View File

@ -286,7 +286,7 @@ Response:
Response body: JSON dictionary with ``uuid`` key. Response body: JSON dictionary with ``uuid`` key.
.. _hardware inventory: http://docs.openstack.org/developer/ironic-python-agent/#hardware-inventory .. _hardware inventory: https://docs.openstack.org/ironic-python-agent/latest/admin/how_it_works.html#hardware-inventory
.. _Specifying the disk for deployment root device hints: .. _Specifying the disk for deployment root device hints:
http://docs.openstack.org/project-install-guide/baremetal/draft/advanced.html#specifying-the-disk-for-deployment-root-device-hints http://docs.openstack.org/project-install-guide/baremetal/draft/advanced.html#specifying-the-disk-for-deployment-root-device-hints

4
doc/source/user/troubleshooting.rst
View File

@ -125,8 +125,8 @@ to log into it. Use the `dynamic-login`_ or `devuser`_ element for a DIB-based
build or put an authorized_keys file in ``/usr/share/oem/`` for a CoreOS-based build or put an authorized_keys file in ``/usr/share/oem/`` for a CoreOS-based
one. one.
.. _devuser: http://docs.openstack.org/developer/diskimage-builder/elements/devuser/README.html .. _devuser: https://docs.openstack.org/diskimage-builder/latest/elements/devuser/README.html
.. _dynamic-login: http://docs.openstack.org/developer/diskimage-builder/elements/dynamic-login/README.html .. _dynamic-login: https://docs.openstack.org/diskimage-builder/latest/elements/dynamic-login/README.html
Troubleshooting DNS issues on Ubuntu Troubleshooting DNS issues on Ubuntu
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

4
doc/source/user/usage.rst
View File

@ -7,7 +7,7 @@ Refer to :ref:`api <http_api>` for information on the HTTP API.
Refer to the `client documentation`_ for information on how to use CLI and Refer to the `client documentation`_ for information on how to use CLI and
Python library. Python library.
.. _client documentation: http://docs.openstack.org/developer/python-ironic-inspector-client .. _client documentation: https://docs.openstack.org/python-ironic-inspector-client/latest/
Using from Ironic API Using from Ironic API
~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~
@ -16,7 +16,7 @@ Ironic Kilo introduced support for hardware introspection under name of
"inspection". **ironic-inspector** introspection is supported for some generic "inspection". **ironic-inspector** introspection is supported for some generic
drivers, please refer to `Ironic inspection documentation`_ for details. drivers, please refer to `Ironic inspection documentation`_ for details.
.. _Ironic inspection documentation: http://docs.openstack.org/developer/ironic/deploy/inspection.html .. _Ironic inspection documentation: https://docs.openstack.org/ironic/latest/admin/inspection.html
Node States Node States
~~~~~~~~~~~ ~~~~~~~~~~~

2
doc/source/user/workflow.rst
View File

@ -55,7 +55,7 @@ Usual hardware introspection flow is as follows:
the ``keep_ports`` option should be also set to ``all``. This will ensure the ``keep_ports`` option should be also set to ``all``. This will ensure
no manually added ports will be deleted. no manually added ports will be deleted.
.. _Ironic inspection documentation: http://docs.openstack.org/developer/ironic/deploy/inspection.html .. _Ironic inspection documentation: https://docs.openstack.org/ironic/latest/admin/inspection.html
* Separate API (see :ref:`usage <usage_guide>` and :ref:`api <http_api>`) can * Separate API (see :ref:`usage <usage_guide>` and :ref:`api <http_api>`) can
be used to query introspection results for a given node. be used to query introspection results for a given node.

4
ironic_inspector/test/inspector_tempest_plugin/README.rst
View File

@ -6,11 +6,11 @@ This directory contains Tempest tests to cover the ironic-inspector project.
It uses tempest plugin to automatically load these tests into tempest. More It uses tempest plugin to automatically load these tests into tempest. More
information about tempest plugin could be found here: information about tempest plugin could be found here:
`Plugin <http://docs.openstack.org/developer/tempest/plugin.html>`_ `Plugin <https://docs.openstack.org/tempest/latest/plugin.html>`_
The legacy method of running Tempest is to just treat the Tempest source code The legacy method of running Tempest is to just treat the Tempest source code
as a python unittest: as a python unittest:
`Run tests <http://docs.openstack.org/developer/tempest/overview.html#legacy-run-method>`_ `Run tests <https://docs.openstack.org/tempest/latest/overview.html#legacy-run-method>`_
There is also tox configuration for tempest, use following regex for running There is also tox configuration for tempest, use following regex for running
introspection tests:: introspection tests::