openstack/ironic
Code Issues Proposed changes

Merge "Documentation clarifications for software RAID"

Browse Source
This commit is contained in:
Zuul 2020-03-18 12:40:37 +00:00 committed by Gerrit Code Review
commit 5221f7792e
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/admin/raid.rst
View File

@ -94,7 +94,8 @@ Optional properties
^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
These properties have default values and they may be overridden in the These properties have default values and they may be overridden in the
specification of any logical disk. specification of any logical disk. None of these options are supported for
software RAID.
- ``volume_name`` - Name of the volume. Should be unique within the Node. - ``volume_name`` - Name of the volume. Should be unique within the Node.
If not specified, volume name will be auto-generated. If not specified, volume name will be auto-generated.
@ -111,11 +112,12 @@ Backing physical disk hints
These hints are specified for each logical disk to let Ironic find the desired These hints are specified for each logical disk to let Ironic find the desired
disks for RAID configuration. This is machine-independent information. This disks for RAID configuration. This is machine-independent information. This
serves the use-case where the operator doesn't want to provide individual serves the use-case where the operator doesn't want to provide individual
details for each bare metal node. details for each bare metal node. None of these options are supported for
software RAID.
- ``share_physical_disks`` - Set to ``true`` if this logical disk can - ``share_physical_disks`` - Set to ``true`` if this logical disk can
share physical disks with other logical disks. The default value is share physical disks with other logical disks. The default value is
``false``. ``false``, except for software RAID which always shares disks.
- ``disk_type`` - ``hdd`` or ``ssd``. If this is not specified, disk type - ``disk_type`` - ``hdd`` or ``ssd``. If this is not specified, disk type
will not be a criterion to find backing physical disks. will not be a criterion to find backing physical disks.
@ -126,7 +128,7 @@ details for each bare metal node.
- ``number_of_physical_disks`` - Integer, number of disks to use for the - ``number_of_physical_disks`` - Integer, number of disks to use for the
logical disk. Defaults to minimum number of disks required for the logical disk. Defaults to minimum number of disks required for the
particular RAID level. particular RAID level, except for software RAID which always spans all disks.
Backing physical disks Backing physical disks
^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^
@ -141,7 +143,7 @@ are hardware dependent.
In order to trigger the setup of a Software RAID via the Ironic Python In order to trigger the setup of a Software RAID via the Ironic Python
Agent, the value of this property needs to be set to ``software``. Agent, the value of this property needs to be set to ``software``.
- ``physical_disks`` - A list of physical disks to use as read by the - ``physical_disks`` - A list of physical disks to use as read by the
RAID interface. RAID interface. Not supported for software RAID.
.. note:: .. note::
If properties from both "Backing physical disk hints" or If properties from both "Backing physical disk hints" or