5e4420763a
This change adds set_provision_state and wait_for_provision_state to openstack.baremetal.v1.Node, as well as set_node_provision_state to the bare metal Proxy. Also adds wait_for_nodes_provision_state, which is similar to Node.wait_for_provision_state but handles several nodes at the same time, which is important for bulk operations. The cloud's node_set_provision_state was updated to use the new calls. As a nice side effect, it now supports all provision states and actions up to the Queens release, as well as does proper microversioning. Some documentation was written for the bare metal proxy. Change-Id: I22a76c3623f4dd2cca0b2103cbd8b853d5cebb71
65 lines
1.9 KiB
ReStructuredText
65 lines
1.9 KiB
ReStructuredText
Using OpenStack Baremetal
|
|
=========================
|
|
|
|
Before working with the Bare Metal service, you'll need to create a
|
|
connection to your OpenStack cloud by following the :doc:`connect` user
|
|
guide. This will provide you with the ``conn`` variable used in the examples
|
|
below.
|
|
|
|
.. contents:: Table of Contents
|
|
:local:
|
|
|
|
The primary resource of the Bare Metal service is the **node**.
|
|
|
|
CRUD operations
|
|
~~~~~~~~~~~~~~~
|
|
|
|
List Nodes
|
|
----------
|
|
|
|
A **node** is a bare metal machine.
|
|
|
|
.. literalinclude:: ../examples/baremetal/list.py
|
|
:pyobject: list_nodes
|
|
|
|
Full example: `baremetal resource list`_
|
|
|
|
Provisioning operations
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Provisioning actions are the main way to manipulate the nodes. See `Bare Metal
|
|
service states documentation`_ for details.
|
|
|
|
Manage and inspect Node
|
|
-----------------------
|
|
|
|
*Managing* a node in the ``enroll`` provision state validates the management
|
|
(IPMI, Redfish, etc) credentials and moves the node to the ``manageable``
|
|
state. *Managing* a node in the ``available`` state moves it to the
|
|
``manageable`` state. In this state additional actions, such as configuring
|
|
RAID or inspecting, are available.
|
|
|
|
*Inspecting* a node detects its properties by either talking to its BMC or by
|
|
booting a special ramdisk.
|
|
|
|
.. literalinclude:: ../examples/baremetal/provisioning.py
|
|
:pyobject: manage_and_inspect_node
|
|
|
|
Full example: `baremetal provisioning`_
|
|
|
|
Provide Node
|
|
------------
|
|
|
|
*Providing* a node in the ``manageable`` provision state makes it available
|
|
for deployment.
|
|
|
|
.. literalinclude:: ../examples/baremetal/provisioning.py
|
|
:pyobject: provide_node
|
|
|
|
Full example: `baremetal provisioning`_
|
|
|
|
|
|
.. _baremetal resource list: http://git.openstack.org/cgit/openstack/openstacksdk/tree/examples/baremetal/list.py
|
|
.. _baremetal provisioning: http://git.openstack.org/cgit/openstack/openstacksdk/tree/examples/baremetal/provisioning.py
|
|
.. _Bare Metal service states documentation: https://docs.openstack.org/ironic/latest/contributor/states.html
|