openstack
/
ironic-inspector
Code Issues Proposed changes

Update links to existing documentation 

* Link to module autodoc instead of github
* Link to the new IPA inventory documentation

Change-Id: I4ed7db13f0f890fcbec553935861f4dbeb712a03
changes/06/293406/1
Dmitry Tantsur 2016-03-16 13:41:28 +01:00
parent 5fa5b4a8ec
commit 01a726a245
2 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.rst
View File

@ -284,8 +284,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: https://github.com/openstack/ironic-inspector/blob/master/ironic_inspector/plugins/base.py
.. _Introspection Rules: https://github.com/openstack/ironic-inspector#introspection-rules
.. _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
Making changes to the database
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -335,5 +335,5 @@ database::
ironic-inspector-dbsync revision -m "A short description"
.. _Create a Migration Script: https://alembic.readthedocs.org/en/latest/tutorial.html#create-a-migration-script
.. _ironic_inspector.db: https://github.com/openstack/ironic-inspector/blob/master/ironic_inspector/db.py
.. _ironic_inspector.db: http://docs.openstack.org/developer/ironic-inspector/api/ironic_inspector.db.html
.. _What does Autogenerate Detect (and what does it not detect?): http://alembic.readthedocs.org/en/latest/autogenerate.html#what-does-autogenerate-detect-and-what-does-it-not-detect

4
doc/source/http-api.rst
View File

@ -164,7 +164,7 @@ Ramdisk Callback
discovered data. Should not be used for anything other than implementing
the ramdisk. Request body: JSON dictionary with at least these keys:
* ``inventory`` full hardware inventory from the ironic-python-agent with at
* ``inventory`` full `hardware inventory`_ from the ironic-python-agent with at
least the following keys:
* ``memory`` memory information containing at least key ``physical_mb`` -
@ -237,6 +237,8 @@ body will contain the following keys:
* ``ipmi_username`` new IPMI user name
* ``ipmi_password`` new IPMI password
.. _hardware inventory: http://docs.openstack.org/developer/ironic-python-agent/#hardware-inventory
Error Response
~~~~~~~~~~~~~~