openstack/ironic
Code Issues Proposed changes

Merge "Add openstack commands in node deployment guide"

Browse Source
This commit is contained in:
Zuul 2019-05-03 11:58:25 +00:00 committed by Gerrit Code Review
commit 21093ca886
1 changed files with 24 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
doc/source/admin/node-deployment.rst
View File

@ -2,6 +2,11 @@
Node Deployment Node Deployment
=============== ===============
.. contents::
:depth: 2
.. _node-deployment-deploy-steps:
Overview Overview
======== ========
@ -9,11 +14,6 @@ Node deployment is performed by the Bare Metal service to prepare a node for
use by a workload. The exact work flow used depends on a number of factors, use by a workload. The exact work flow used depends on a number of factors,
including the hardware type and interfaces assigned to a node. including the hardware type and interfaces assigned to a node.
.. contents::
:depth: 2
.. _node-deployment-deploy-steps:
Deploy Steps Deploy Steps
============ ============
@ -221,18 +221,19 @@ Example of use with the Compute service
.. note:: The deploy steps used in this example are for example purposes only. .. note:: The deploy steps used in this example are for example purposes only.
In the following example, we have a node with the following node traits: In the following example, we first add the trait ``CUSTOM_HYPERTHREADING_ON``
to the node represented by ``$node_ident``:
.. code-block:: json .. code-block:: console
[ openstack baremetal node add trait $node_ident CUSTOM_HYPERTHREADING_ON
"CUSTOM_HYPERTHREADING_ON"
]
We also have a flavor, ``bm-hyperthreading-on``, in the Compute service with We also update the flavor ``bm-hyperthreading-on`` in the Compute
the following property:: service with the following property:
trait:CUSTOM_HYPERTHREADING_ON:required .. code-block:: console
openstack flavor set --property trait:CUSTOM_HYPERTHREADING_ON=required bm-hyperthreading-on
Creating a Compute instance with this flavor will ensure that the instance is Creating a Compute instance with this flavor will ensure that the instance is
scheduled only to Bare Metal nodes with the ``CUSTOM_HYPERTHREADING_ON`` trait. scheduled only to Bare Metal nodes with the ``CUSTOM_HYPERTHREADING_ON`` trait.
@ -266,22 +267,22 @@ deploy steps of deploy template ``CUSTOM_HYPERTHREADING_ON`` will be executed
during the deployment of the scheduled node, causing Hyperthreading to be during the deployment of the scheduled node, causing Hyperthreading to be
enabled in the node's BIOS configuration. enabled in the node's BIOS configuration.
To make this example more dynamic, consider adding a second trait to the node: To make this example more dynamic, let's add a second trait
``CUSTOM_HYPERTHREADING_OFF`` to the node:
.. code-block:: json .. code-block:: console
[ openstack baremetal node add trait $node_ident CUSTOM_HYPERTHREADING_OFF
"CUSTOM_HYPERTHREADING_ON",
"CUSTOM_HYPERTHREADING_OFF"
]
We could also create a second flavor, ``bm-hyperthreading-off``, with the We could also update a second flavor, ``bm-hyperthreading-off``, with the
following property:: following property:
trait:CUSTOM_HYPERTHREADING_OFF:required .. code-block:: console
openstack flavor set --property trait:CUSTOM_HYPERTHREADING_OFF=required bm-hyperthreading-off
Finally, we create a deploy template with the name Finally, we create a deploy template with the name
``CUSTOM_HYPERTHREADING_OFF`` and a different set of deploy steps: ``CUSTOM_HYPERTHREADING_OFF`` and a deploy step that disables Hyperthreading:
.. code-block:: json .. code-block:: json