Introducing cli and contributor content
Had to change the level of headings here and there Change-Id: Ib3161e4d3e1798b0cdbe26735272c2938819dcb4
This commit is contained in:
dparalen
2
.gitignore
vendored
2
.gitignore
vendored
@@ -6,7 +6,7 @@
|
||||
|
||||
# Sphinx
|
||||
_build
|
||||
doc/source/api/
|
||||
doc/source/reference/api/
|
||||
|
||||
# release notes build
|
||||
releasenotes/build
|
||||
|
||||
@@ -1,8 +1,12 @@
|
||||
Command Line Reference
|
||||
======================
|
||||
|
||||
|
||||
CLI tool is based on OpenStackClient_ with prefix
|
||||
``openstack baremetal introspection``.
|
||||
|
||||
Common arguments
|
||||
~~~~~~~~~~~~~~~~
|
||||
----------------
|
||||
|
||||
All commands accept the following arguments:
|
||||
|
||||
@@ -13,7 +17,7 @@ All commands accept the following arguments:
|
||||
for details.
|
||||
|
||||
Start introspection on a node
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
-----------------------------
|
||||
|
||||
::
|
||||
|
||||
@@ -36,7 +40,7 @@ With ``--wait`` flag it waits until introspection ends for all given nodes,
|
||||
then displays the results as a table.
|
||||
|
||||
Query introspection status
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
--------------------------
|
||||
|
||||
::
|
||||
|
||||
@@ -53,7 +57,7 @@ Returns following information about a node introspection status:
|
||||
* ``uuid``: node UUID
|
||||
|
||||
List introspection statuses
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
---------------------------
|
||||
|
||||
This command supports pagination.
|
||||
|
||||
@@ -76,7 +80,7 @@ Shows a table with the following columns:
|
||||
``Started at`` column, newer items first.
|
||||
|
||||
Retrieving introspection data
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
-----------------------------
|
||||
|
||||
::
|
||||
|
||||
@@ -91,7 +95,7 @@ Retrieving introspection data
|
||||
by setting ``[processing]store_data`` configuration option to ``swift``.
|
||||
|
||||
Aborting introspection
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
----------------------
|
||||
|
||||
::
|
||||
|
||||
@@ -100,7 +104,7 @@ Aborting introspection
|
||||
* ``NODE_ID`` - Ironic node UUID or name.
|
||||
|
||||
Reprocess stored introspection data
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
-----------------------------------
|
||||
|
||||
::
|
||||
|
||||
@@ -113,10 +117,10 @@ Reprocess stored introspection data
|
||||
by setting ``[processing]store_data`` configuration option to ``swift``.
|
||||
|
||||
Introspection Rules API
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
-----------------------
|
||||
|
||||
Creating a rule
|
||||
^^^^^^^^^^^^^^^
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
@@ -126,7 +130,7 @@ Creating a rule
|
||||
:py:meth:`ironic_inspector_client.RulesAPI.from_json` for details.
|
||||
|
||||
Listing all rules
|
||||
^^^^^^^^^^^^^^^^^
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
@@ -136,14 +140,14 @@ Returns list of short rule representations, containing only description, UUID
|
||||
and links.
|
||||
|
||||
Deleting all rules
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
$ openstack baremetal introspection rule purge
|
||||
|
||||
Deleting a rule
|
||||
^^^^^^^^^^^^^^^
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
@@ -152,7 +156,7 @@ Deleting a rule
|
||||
* ``UUID`` rule UUID.
|
||||
|
||||
Using names instead of UUID
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
---------------------------
|
||||
|
||||
Starting with baremetal introspection API 1.5 (provided by **Ironic Inspector**
|
||||
3.3.0) it's possible to use node names instead of UUIDs in all Python and CLI
|
||||
@@ -163,7 +167,7 @@ calls.
|
||||
|
||||
|
||||
List interface data
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
-------------------
|
||||
|
||||
::
|
||||
|
||||
@@ -178,7 +182,7 @@ Returns a list of interface data, including attached switch information,
|
||||
for each interface on the node.
|
||||
|
||||
Show interface data
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
-------------------
|
||||
|
||||
::
|
||||
|
||||
@@ -191,3 +195,5 @@ Show interface data
|
||||
|
||||
Show interface data, including attached switch information,
|
||||
for a particular node and interface.
|
||||
|
||||
.. _OpenStackClient: https://docs.openstack.org/python-openstackclient/latest/
|
||||
@@ -4,52 +4,14 @@ Welcome to Ironic Inspector Client
|
||||
|
||||
.. include:: ../../README.rst
|
||||
|
||||
Command Line Tool
|
||||
=================
|
||||
|
||||
CLI tool is based on OpenStackClient_ with prefix
|
||||
``openstack baremetal introspection``.
|
||||
Contents
|
||||
========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
cli
|
||||
|
||||
Python API
|
||||
==========
|
||||
|
||||
To use Python API first create a ``ClientV1`` object::
|
||||
|
||||
import ironic_inspector_client
|
||||
client = ironic_inspector_client.ClientV1(session=keystone_session)
|
||||
|
||||
This code creates a client with API version *1.0* and a given `Keystone
|
||||
session`_. The service URL is fetched from the service catalog in this case.
|
||||
See :py:class:`ironic_inspector_client.v1.ClientV1` documentation for details.
|
||||
|
||||
.. _api-versioning:
|
||||
|
||||
API Versioning
|
||||
--------------
|
||||
|
||||
Starting with version 2.1.0 **Ironic Inspector** supports optional API
|
||||
versioning. Version is a tuple (X, Y), where X is always 1 for now.
|
||||
|
||||
The server has maximum and minimum supported versions. If no version is
|
||||
requested, the server assumes the maximum it's supported.
|
||||
|
||||
Two constants are exposed for convenience:
|
||||
|
||||
* :py:const:`ironic_inspector_client.v1.DEFAULT_API_VERSION`
|
||||
* :py:const:`ironic_inspector_client.v1.MAX_API_VERSION`
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
api/autoindex
|
||||
cli/index
|
||||
reference/index
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
@@ -57,7 +19,3 @@ Indices and tables
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
|
||||
.. _OpenStackClient: http://docs.openstack.org/developer/python-openstackclient/
|
||||
.. _Keystone session: http://docs.openstack.org/developer/keystoneauth/using-sessions.html
|
||||
|
||||
38
doc/source/reference/index.rst
Normal file
38
doc/source/reference/index.rst
Normal file
@@ -0,0 +1,38 @@
|
||||
Library User Reference
|
||||
======================
|
||||
|
||||
To use Python API first create a ``ClientV1`` object::
|
||||
|
||||
import ironic_inspector_client
|
||||
client = ironic_inspector_client.ClientV1(session=keystone_session)
|
||||
|
||||
This code creates a client with API version *1.0* and a given `Keystone
|
||||
session`_. The service URL is fetched from the service catalog in this case.
|
||||
See :py:class:`ironic_inspector_client.v1.ClientV1` documentation for details.
|
||||
|
||||
.. _api-versioning:
|
||||
|
||||
API Versioning
|
||||
--------------
|
||||
|
||||
Starting with version 2.1.0 **Ironic Inspector** supports optional API
|
||||
versioning. Version is a tuple (X, Y), where X is always 1 for now.
|
||||
|
||||
The server has maximum and minimum supported versions. If no version is
|
||||
requested, the server assumes the maximum it's supported.
|
||||
|
||||
Two constants are exposed for convenience:
|
||||
|
||||
* :py:const:`ironic_inspector_client.v1.DEFAULT_API_VERSION`
|
||||
* :py:const:`ironic_inspector_client.v1.MAX_API_VERSION`
|
||||
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
api/autoindex
|
||||
|
||||
.. _Keystone session: http://docs.openstack.org/developer/keystoneauth/using-sessions.html
|
||||
Reference in New Issue
Block a user