openstack/ironic
Code Issues Proposed changes

copy editing of ironic deploy docs

Browse Source 
per doc conventions ironic should be lowercase
https://wiki.openstack.org/wiki/Documentation/Conventions
titles should not be capitalized

Change-Id: Ia6a5ccea179ab809407db65ed634bc5ef35bf7bb
This commit is contained in:
Shilla Saebi 2015-06-15 10:48:48 -04:00
parent a0760043e5
commit f4e12a1bdb
2 changed files with 34 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
doc/source/deploy/cleaning.rst
View File

@ -1,14 +1,14 @@
.. _cleaning: .. _cleaning:
============= =============
Node Cleaning Node cleaning
============= =============
Overview Overview
======== ========
When hardware is recycled from one workload to another, Ironic performs When hardware is recycled from one workload to another, ironic performs
cleaning on the node to ensure it's ready for another workload. This ensures cleaning on the node to ensure it's ready for another workload. This ensures
the tenant will get a consistent baremetal node deployed every time. the tenant will get a consistent bare metal node deployed every time.
Ironic implements cleaning by collecting a list of steps to perform on a node Ironic implements cleaning by collecting a list of steps to perform on a node
from each Power, Deploy, and Management driver assigned to the node. These from each Power, Deploy, and Management driver assigned to the node. These
@ -23,14 +23,14 @@ full understanding of all state transitions into cleaning, please see
Ironic added support for cleaning nodes in the Kilo release. Ironic added support for cleaning nodes in the Kilo release.
Enabling Cleaning Enabling cleaning
================= =================
To enable cleaning, ensure your ironic.conf is set as follows: :: To enable cleaning, ensure your ironic.conf is set as follows: ::
[conductor] [conductor]
clean_nodes=true clean_nodes=true
This will enable the default set of steps, based on your hardware and Ironic This will enable the default set of steps, based on your hardware and ironic
drivers. If you're using an agent_* driver, this includes, by default, erasing drivers. If you're using an agent_* driver, this includes, by default, erasing
all of the previous tenant's data. all of the previous tenant's data.
@ -42,27 +42,27 @@ tenant network. For steps to set up the cleaning network, please see
.. _InbandvsOutOfBandCleaning: .. _InbandvsOutOfBandCleaning:
In-Band vs Out-of-Band In-band vs out-of-band
====================== ======================
Ironic uses two main methods to perform actions on a node: in-band and Ironic uses two main methods to perform actions on a node: in-band and
out-of-band. Ironic supports using both methods to clean a node. out-of-band. Ironic supports using both methods to clean a node.
In-Band In-band
------- -------
In-band steps are performed by Ironic making API calls to a ramdisk running In-band steps are performed by ironic making API calls to a ramdisk running
on the node using a Deploy driver. Currently, only the ironic-python-agent on the node using a Deploy driver. Currently, only the ironic-python-agent
ramdisk used with an agent_* driver supports in-band cleaning. By default, ramdisk used with an agent_* driver supports in-band cleaning. By default,
ironic-python-agent ships with a minimal cleaning configuration, only erasing ironic-python-agent ships with a minimal cleaning configuration, only erasing
disks. However, with this ramdisk, you can add your own cleaning steps and/or disks. However, with this ramdisk, you can add your own cleaning steps and/or
override default cleaning steps with a custom Hardware Manager. override default cleaning steps with a custom Hardware Manager.
There is currently no support for in-band cleaning using the Ironic pxe There is currently no support for in-band cleaning using the ironic pxe
ramdisk. ramdisk.
Out-of-Band Out-of-band
----------- -----------
Out-of-band are actions performed by your management controller, such as IPMI, Out-of-band are actions performed by your management controller, such as IPMI,
iLO, or DRAC. Out-of-band steps will be performed by Ironic using a Power or iLO, or DRAC. Out-of-band steps will be performed by ironic using a Power or
Management driver. Which steps are performed depends on the driver and hardware. Management driver. Which steps are performed depends on the driver and hardware.
For Out-of-Band cleaning operations supported by iLO drivers, refer to For Out-of-Band cleaning operations supported by iLO drivers, refer to
@ -112,8 +112,8 @@ before going into cleanfail state.
Should I disable cleaning? Should I disable cleaning?
-------------------------- --------------------------
Cleaning is recommended for Ironic deployments, however, there are some Cleaning is recommended for ironic deployments, however, there are some
tradeoffs to having it enabled. For instance, Ironic cannot deploy a new tradeoffs to having it enabled. For instance, ironic cannot deploy a new
instance to a node that is currently cleaning, and cleaning can be a time instance to a node that is currently cleaning, and cleaning can be a time
consuming process. To mitigate this, we suggest using disks with support for consuming process. To mitigate this, we suggest using disks with support for
cryptographic ATA Security Erase, as typically the erase_devices step in the cryptographic ATA Security Erase, as typically the erase_devices step in the
@ -123,14 +123,14 @@ Why can't I power on/off a node while it's cleaning?
---------------------------------------------------- ----------------------------------------------------
During cleaning, nodes may be performing actions that shouldn't be During cleaning, nodes may be performing actions that shouldn't be
interrupted, such as BIOS or Firmware updates. As a result, operators are interrupted, such as BIOS or Firmware updates. As a result, operators are
forbidden from changing power state via the Ironic API while a node is forbidden from changing power state via the ironic API while a node is
cleaning. cleaning.
Troubleshooting Troubleshooting
=============== ===============
If cleaning fails on a node, the node will be put into cleanfail state and If cleaning fails on a node, the node will be put into cleanfail state and
placed in maintenance mode, to prevent Ironic from taking actions on the placed in maintenance mode, to prevent ironic from taking actions on the
node. node.
Nodes in cleanfail will not be powered off, as the node might be in a state Nodes in cleanfail will not be powered off, as the node might be in a state
@ -138,24 +138,24 @@ such that powering it off could damage the node or remove useful information
about the nature of the cleaning failure. about the nature of the cleaning failure.
A cleanfail node can be moved to manageable state, where they cannot be A cleanfail node can be moved to manageable state, where they cannot be
scheduled by Nova and you can safely attempt to fix the node. To move a node scheduled by nova and you can safely attempt to fix the node. To move a node
from cleanfail to manageable: ``ironic node-set-provision-state manage``. from cleanfail to manageable: ``ironic node-set-provision-state manage``.
You can now take actions on the node, such as replacing a bad disk drive. You can now take actions on the node, such as replacing a bad disk drive.
Strategies for determining why a cleaning step failed include checking the Strategies for determining why a cleaning step failed include checking the
Ironic conductor logs, viewing logs on the still-running ironic-python-agent ironic conductor logs, viewing logs on the still-running ironic-python-agent
(if an in-band step failed), or performing general hardware troubleshooting on (if an in-band step failed), or performing general hardware troubleshooting on
the node. the node.
When the node is repaired, you can move the node back to available state, to When the node is repaired, you can move the node back to available state, to
allow it to be scheduled by Nova. allow it to be scheduled by nova.
:: ::
# First, move it out of maintenance mode # First, move it out of maintenance mode
ironic node-set-maintenance $node_ident false ironic node-set-maintenance $node_ident false
# Now, make the node available for scheduling by Nova # Now, make the node available for scheduling by nova
ironic node-set-provision-state $node_ident provide ironic node-set-provision-state $node_ident provide
The node will begin cleaning from the start, and move to available state The node will begin cleaning from the start, and move to available state

30
doc/source/deploy/drivers.rst
View File

@ -1,13 +1,13 @@
.. _drivers: .. _drivers:
================= =================
Enabling Drivers Enabling drivers
================= =================
Ironic-Python-Agent (agent) Ironic-Python-Agent (agent)
--------------------------- ---------------------------
To enable IPA add the appropriate Ironic agent driver to the ``enabled_drivers`` To enable IPA, add the appropriate ironic agent driver to the ``enabled_drivers``
line of the ironic.conf file. line of the ironic.conf file.
Several variants are currently supported, they are: Several variants are currently supported, they are:
@ -17,7 +17,7 @@ Several variants are currently supported, they are:
* agent_ssh * agent_ssh
* agent_vbox * agent_vbox
.. note:: Starting with the Kilo release IPA ramdisk may also be used with Ironic PXE drivers. .. note:: Starting with the Kilo release IPA ramdisk may also be used with ironic PXE drivers.
For more information see the `ironic-python-agent GitHub repo <https://github.com/openstack/ironic-python-agent/>`_ For more information see the `ironic-python-agent GitHub repo <https://github.com/openstack/ironic-python-agent/>`_
@ -57,23 +57,23 @@ Supported PDUs
- EatonPower (implemented according to MIB spec but not tested on hardware) - EatonPower (implemented according to MIB spec but not tested on hardware)
- Teltronix - Teltronix
Software Requirements Software requirements
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
- The PySNMP package must be installed, variously referred to as ``pysnmp`` - The PySNMP package must be installed, variously referred to as ``pysnmp``
or ``python-pysnmp`` or ``python-pysnmp``
Enabling the SNMP Power Driver Enabling the SNMP power driver
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Add ``pxe_snmp`` to the list of ``enabled_drivers`` in - Add ``pxe_snmp`` to the list of ``enabled_drivers`` in
``/etc/ironic/ironic.conf`` ``/etc/ironic/ironic.conf``
- Ironic Conductor must be restarted for the new driver to be loaded. - Ironic Conductor must be restarted for the new driver to be loaded.
Ironic Node Configuration Ironic node configuration
^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^
Nodes are configured for SNMP control by setting the Ironic node object's Nodes are configured for SNMP control by setting the ironic node object's
``driver`` property to be ``pxe_snmp``. Further configuration values are ``driver`` property to be ``pxe_snmp``. Further configuration values are
added to ``driver_info``: added to ``driver_info``:
@ -88,7 +88,7 @@ added to ``driver_info``:
parameter for reads and writes to the PDU. parameter for reads and writes to the PDU.
- ``snmp_security``: (Required for SNMPv3) SNMP security string. - ``snmp_security``: (Required for SNMPv3) SNMP security string.
PDU Configuration PDU configuration
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^
This version of the SNMP power driver does not support handling This version of the SNMP power driver does not support handling
@ -116,25 +116,25 @@ SeaMicro driver
iRMC iRMC
---- ----
The iRMC driver enables PXE Deploy to control power via ServerView Common The iRMC driver enables PXE deploy to control power via ServerView Common
Command Interface (SCCI). Command Interface (SCCI).
Software Requirements Software requirements
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^
- Install `python-scciclient package <https://pypi.python.org/pypi/python-scciclient>`_ - Install `python-scciclient package <https://pypi.python.org/pypi/python-scciclient>`_
Enabling the iRMC Driver Enabling the iRMC driver
^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^
- Add ``pxe_irmc`` to the list of ``enabled_drivers in`` - Add ``pxe_irmc`` to the list of ``enabled_drivers in``
``/etc/ironic/ironic.conf`` ``/etc/ironic/ironic.conf``
- Ironic Conductor must be restarted for the new driver to be loaded. - Ironic Conductor must be restarted for the new driver to be loaded.
Ironic Node Configuration Ironic node configuration
^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^
Nodes are configured for iRMC with PXE Deploy by setting the Ironic node Nodes are configured for iRMC with PXE deploy by setting the ironic node
object's ``driver`` property to be ``pxe_irmc``. Further configuration values object's ``driver`` property to be ``pxe_irmc``. Further configuration values
are added to ``driver_info``: are added to ``driver_info``:
@ -145,7 +145,7 @@ are added to ``driver_info``:
- ``irmc_auth_method``: authentication method for iRMC (optional, either - ``irmc_auth_method``: authentication method for iRMC (optional, either
'basic' or 'digest'. default is 'basic') 'basic' or 'digest'. default is 'basic')
Supported Platforms Supported platforms
^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
This driver supports FUJITSU PRIMERGY BX S4 or RX S8 servers and above. This driver supports FUJITSU PRIMERGY BX S4 or RX S8 servers and above.
@ -163,7 +163,7 @@ VirtualBox drivers
../drivers/vbox ../drivers/vbox
Cisco UCS Driver Cisco UCS driver
---------------- ----------------
.. toctree:: .. toctree::