diff options
| author | Dmitry Tantsur <dtantsur@protonmail.com> | 2020-04-07 13:26:16 +0200 |
|---|---|---|
| committer | Dmitry Tantsur <dtantsur@protonmail.com> | 2020-04-07 13:26:16 +0200 |
| commit | 5e30e4dc4e9aee375f5f7ae3cfc1acb651e93089 (patch) | |
| tree | dff0f5fb3e51978c599bb605d2c6111f242ef7f6 /doc/source | |
| parent | 565a256f4e8bfc37e1203e22437cfdcfb73436b0 (diff) | |
| download | python-ironicclient-5e30e4dc4e9aee375f5f7ae3cfc1acb651e93089.tar.gz | |
Standalone CLI: optional support for ironic-inspector
To provide a `baremetal introspection` CLI interface similar to the
existing OSC plugin, this change adds optional support for pulling
commands from ironic-inspector-client.
Change-Id: I61b82af3afdd934ed130d3d700de8ec7423a1328
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/cli/standalone.rst | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/source/cli/standalone.rst b/doc/source/cli/standalone.rst index ff694a9..78146bb 100644 --- a/doc/source/cli/standalone.rst +++ b/doc/source/cli/standalone.rst @@ -29,6 +29,18 @@ exceptions: Check the :doc:`OSC CLI reference </cli/osc/v1/index>` for a list of available commands. +Inspector support +----------------- + +The standalone ``baremetal`` tool optionally supports the low-level bare metal +introspection API provided by ironic-inspector_. If ironic-inspector-client_ is +installed, its commands_ are automatically available (also without the +``openstack`` prefix). + +.. _ironic-inspector: https://docs.openstack.org/ironic-inspector/ +.. _ironic-inspector-client: https://docs.openstack.org/python-ironic-inspector-client/ +.. _commands: https://docs.openstack.org/python-ironic-inspector-client/latest/cli/index.html + Standalone usage ---------------- @@ -60,6 +72,22 @@ endpoint to connect to. It can be done in three ways: $ export OS_CLOUD=ironic $ baremetal node list +#. `Inspector support`_ works similarly, but the ``clouds.yaml`` option is + called ``baremetal_introspection_endpoint_override``. The two endpoints can + be configured simultaneously, e.g.: + + .. code-block:: bash + + $ cat ~/.config/openstack/clouds.yaml + clouds: + ironic: + auth_type: none + baremetal_endpoint_override: http://127.0.0.1:6385 + baremetal_introspection_endpoint_override: http://127.0.0.1:5050 + $ export OS_CLOUD=ironic + $ baremetal node list + $ baremetal introspection list + .. _clouds.yaml: https://docs.openstack.org/openstacksdk/latest/user/guides/connect_from_config.html Usage with OpenStack |