diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index bdeda711d..6642e3a08 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -86,7 +86,7 @@ You can develop and test **ironic-inspector** using DevStack - see Deploying Ironic Inspector with DevStack ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -`DevStack `_ provides a way to +`DevStack `_ provides a way to quickly build a full OpenStack development environment with requested components. There is a plugin for installing **ironic-inspector** in DevStack. Installing **ironic-inspector** requires a machine running Ubuntu 14.04 (or @@ -159,7 +159,7 @@ Inspect the node:: .. note:: The deploy driver used must support the inspect interface. See also the `Ironic Python Agent - `_. + `_. A node can also be inspected using the following command. However, this will 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 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 -.. _Introspection Rules: http://docs.openstack.org/developer/ironic-inspector/usage.html#introspection-rules +.. _ironic_inspector.plugins.base: https://docs.openstack.org/ironic-inspector/latest/api/ironic_inspector.plugins.base.html +.. _Introspection Rules: https://docs.openstack.org/ironic-inspector/latest/usage.html#introspection-rules Making changes to the database ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -314,7 +314,7 @@ the database:: ironic-inspector-dbsync revision -m "A short description" .. _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 Implementing PXE Filter Drivers diff --git a/README.rst b/README.rst index 694ecbd84..180cc6df4 100644 --- a/README.rst +++ b/README.rst @@ -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 * Bugs: http://bugs.launchpad.net/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 `_ (`documentation - `_). + `_). .. _Ironic: https://wiki.openstack.org/wiki/Ironic diff --git a/devstack/example.local.conf b/devstack/example.local.conf index 7ea69acb1..5ebf4879e 100644 --- a/devstack/example.local.conf +++ b/devstack/example.local.conf @@ -1,6 +1,6 @@ [[local|localrc]] # Credentials -# Reference: http://docs.openstack.org/developer/devstack/configuration.html +# Reference: https://docs.openstack.org/devstack/latest/configuration.html ADMIN_PASSWORD=password DATABASE_PASSWORD=$ADMIN_PASSWORD RABBIT_PASSWORD=$ADMIN_PASSWORD diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst index 37409cc31..6269623ad 100644 --- a/doc/source/install/index.rst +++ b/doc/source/install/index.rst @@ -6,7 +6,7 @@ environment):: pip install ironic-inspector -Also there is a `DevStack `_ +Also there is a `DevStack `_ plugin for **ironic-inspector** - see :ref:`contributing_link` for the current status. @@ -186,10 +186,10 @@ To build an **ironic-python-agent** ramdisk, do the following: Alternatively, you can download a `prebuilt TinyIPA image `_ or use the `other builders -`_. +`_. -.. _diskimage-builder: https://docs.openstack.org/developer/diskimage-builder/ -.. _ironic-python-agent: https://docs.openstack.org/developer/ironic-python-agent/ +.. _diskimage-builder: https://docs.openstack.org/diskimage-builder/latest/ +.. _ironic-python-agent: https://docs.openstack.org/ironic-python-agent/latest/ Configuring PXE ~~~~~~~~~~~~~~~ diff --git a/doc/source/user/http-api.rst b/doc/source/user/http-api.rst index 4a99f2c81..4010f9261 100644 --- a/doc/source/user/http-api.rst +++ b/doc/source/user/http-api.rst @@ -286,7 +286,7 @@ Response: 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: http://docs.openstack.org/project-install-guide/baremetal/draft/advanced.html#specifying-the-disk-for-deployment-root-device-hints diff --git a/doc/source/user/troubleshooting.rst b/doc/source/user/troubleshooting.rst index 671d5e3c3..5160a1580 100644 --- a/doc/source/user/troubleshooting.rst +++ b/doc/source/user/troubleshooting.rst @@ -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 one. -.. _devuser: http://docs.openstack.org/developer/diskimage-builder/elements/devuser/README.html -.. _dynamic-login: http://docs.openstack.org/developer/diskimage-builder/elements/dynamic-login/README.html +.. _devuser: https://docs.openstack.org/diskimage-builder/latest/elements/devuser/README.html +.. _dynamic-login: https://docs.openstack.org/diskimage-builder/latest/elements/dynamic-login/README.html Troubleshooting DNS issues on Ubuntu ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/source/user/usage.rst b/doc/source/user/usage.rst index 7cccc238e..0ebeac6fa 100644 --- a/doc/source/user/usage.rst +++ b/doc/source/user/usage.rst @@ -7,7 +7,7 @@ Refer to :ref:`api ` for information on the HTTP API. Refer to the `client documentation`_ for information on how to use CLI and 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 ~~~~~~~~~~~~~~~~~~~~~ @@ -16,7 +16,7 @@ Ironic Kilo introduced support for hardware introspection under name of "inspection". **ironic-inspector** introspection is supported for some generic 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 ~~~~~~~~~~~ diff --git a/doc/source/user/workflow.rst b/doc/source/user/workflow.rst index 0cf5b100c..bbcaade8f 100644 --- a/doc/source/user/workflow.rst +++ b/doc/source/user/workflow.rst @@ -55,7 +55,7 @@ Usual hardware introspection flow is as follows: the ``keep_ports`` option should be also set to ``all``. This will ensure 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 ` and :ref:`api `) can be used to query introspection results for a given node. diff --git a/ironic_inspector/test/inspector_tempest_plugin/README.rst b/ironic_inspector/test/inspector_tempest_plugin/README.rst index 5ccb57d48..0ea008c42 100644 --- a/ironic_inspector/test/inspector_tempest_plugin/README.rst +++ b/ironic_inspector/test/inspector_tempest_plugin/README.rst @@ -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 information about tempest plugin could be found here: -`Plugin `_ +`Plugin `_ The legacy method of running Tempest is to just treat the Tempest source code as a python unittest: -`Run tests `_ +`Run tests `_ There is also tox configuration for tempest, use following regex for running introspection tests::