openstack/ironic-inspector
Code Issues Proposed changes

refer to 'openstack baremetal' CLI in docs

Browse Source 
The 'ironic' CLI is going to be deprecated [1]; the 'openstack baremetal'
(OSC) CLI should be used instead. This changes the documentation to refer
to the OSC CLI.

[1] https://bugs.launchpad.net/python-ironicclient/+bug/1700815

Change-Id: I737ba38c6130e7ba123368b6081c4923d1423d98
This commit is contained in:
Ruby Loo 2017-10-23 17:26:48 -04:00
parent fa6163c8f8
commit 16148bf6c8
2 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -26,12 +26,12 @@ Node States
* The nodes should be moved to ``MANAGEABLE`` provision state before * The nodes should be moved to ``MANAGEABLE`` provision state before
introspection (requires *python-ironicclient* of version 0.5.0 or newer):: introspection (requires *python-ironicclient* of version 0.5.0 or newer)::
ironic node-set-provision-state <UUID> manage openstack baremetal node manage <node>
* After successful introspection and before deploying nodes should be made * After successful introspection and before deploying nodes should be made
available to Nova, by moving them to ``AVAILABLE`` state:: available to Nova, by moving them to ``AVAILABLE`` state::
ironic node-set-provision-state <UUID> provide openstack baremetal node provide <node>
.. note:: .. note::
Due to how Nova interacts with Ironic driver, you should wait 1 minute Due to how Nova interacts with Ironic driver, you should wait 1 minute

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

@ -6,8 +6,9 @@ Workflow
Usual hardware introspection flow is as follows: Usual hardware introspection flow is as follows:
* Operator enrolls nodes into Ironic_ e.g. via ironic CLI command. * Operator enrolls nodes into Ironic_ e.g. via `openstack baremetal CLI`_
Power management credentials should be provided to Ironic at this step. command. Power management credentials should be provided to Ironic at this
step.
* Nodes are put in the correct state for introspection as described in * Nodes are put in the correct state for introspection as described in
:ref:`node states <node_states>`. :ref:`node states <node_states>`.
@ -81,3 +82,4 @@ The diagram also shows events that trigger state transitions.
:alt: ironic-inspector state machine diagram :alt: ironic-inspector state machine diagram
.. _Ironic: https://wiki.openstack.org/wiki/Ironic .. _Ironic: https://wiki.openstack.org/wiki/Ironic
.. _openstack baremetal CLI: https://docs.openstack.org/python-ironicclient/latest/cli/osc_plugin_cli.html