Documentation clarifications for software RAID

This change clarifies which options are supported for software RAID
and what the defaults are.

Change-Id: Ib93d0f564b7ee51ee9beb7f6143635c240f4baf3
This commit is contained in:
Dmitry Tantsur 2020-03-17 12:16:10 +01:00
parent 940cbbc998
commit 9fd0aa859c

View File

@ -94,7 +94,8 @@ Optional properties
^^^^^^^^^^^^^^^^^^^
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.
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
disks for RAID configuration. This is machine-independent information. This
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 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
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
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
^^^^^^^^^^^^^^^^^^^^^^
@ -141,7 +143,7 @@ are hardware dependent.
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``.
- ``physical_disks`` - A list of physical disks to use as read by the
RAID interface.
RAID interface. Not supported for software RAID.
.. note::
If properties from both "Backing physical disk hints" or