From 16148bf6c8b8e5373d4f4cf70f644e611830c630 Mon Sep 17 00:00:00 2001 From: Ruby Loo Date: Mon, 23 Oct 2017 17:26:48 -0400 Subject: [PATCH] refer to 'openstack baremetal' CLI in docs 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 --- doc/source/user/usage.rst | 4 ++-- doc/source/user/workflow.rst | 6 ++++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/source/user/usage.rst b/doc/source/user/usage.rst index c06d3fbbf..d0e6c8f4f 100644 --- a/doc/source/user/usage.rst +++ b/doc/source/user/usage.rst @@ -26,12 +26,12 @@ Node States * The nodes should be moved to ``MANAGEABLE`` provision state before introspection (requires *python-ironicclient* of version 0.5.0 or newer):: - ironic node-set-provision-state manage + openstack baremetal node manage * After successful introspection and before deploying nodes should be made available to Nova, by moving them to ``AVAILABLE`` state:: - ironic node-set-provision-state provide + openstack baremetal node provide .. note:: Due to how Nova interacts with Ironic driver, you should wait 1 minute diff --git a/doc/source/user/workflow.rst b/doc/source/user/workflow.rst index c92ea7b87..8030a8d08 100644 --- a/doc/source/user/workflow.rst +++ b/doc/source/user/workflow.rst @@ -6,8 +6,9 @@ Workflow Usual hardware introspection flow is as follows: -* Operator enrolls nodes into Ironic_ e.g. via ironic CLI command. - Power management credentials should be provided to Ironic at this step. +* Operator enrolls nodes into Ironic_ e.g. via `openstack baremetal CLI`_ + command. Power management credentials should be provided to Ironic at this + step. * Nodes are put in the correct state for introspection as described in :ref:`node states `. @@ -81,3 +82,4 @@ The diagram also shows events that trigger state transitions. :alt: ironic-inspector state machine diagram .. _Ironic: https://wiki.openstack.org/wiki/Ironic +.. _openstack baremetal CLI: https://docs.openstack.org/python-ironicclient/latest/cli/osc_plugin_cli.html