openstack/ironic
Code Issues Proposed changes

Docs: play down the role of is_root_volume in RAID

Browse Source 
We've just discovered that this field does not do much. It basically
only affects the create_root_volume/create_nonroot_volumes arguments.
No RAID interfaces use it to populate root device hints.

Change-Id: I2ed780e13c59713127bd7f4ca30269e0c0865440
Signed-off-by: Dmitry Tantsur <dtantsur@protonmail.com>
This commit is contained in:
Dmitry Tantsur
2025-10-01 14:32:42 +02:00
parent 76fcfd7a09
commit 656446ae98
1 changed files with 11 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -109,9 +109,12 @@ software RAID.
- ``is_root_volume`` - Set to ``true`` if this is the root volume. At - ``is_root_volume`` - Set to ``true`` if this is the root volume. At
most one logical disk can have this set to ``true``; the other most one logical disk can have this set to ``true``; the other
logical disks must have this set to ``false``. The logical disks must have this set to ``false``. The default is ``false``.
``root device hint`` will be saved, if the RAID interface is capable of
retrieving it. This is ``false`` by default. This value currently only affects the ``create_root_volume`` and
``create_nonroot_volumes`` parameters to the ``create_configuration`` step,
but out-of-tree RAID interfaces may also use it to populate *root device
hints*. Otherwise, you need to populate the hints yourself.
Backing physical disk hints Backing physical disk hints
^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -170,7 +173,7 @@ Examples for ``target_raid_config``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
*Example 1*. Single RAID disk of RAID level 5 with all of the space *Example 1*. Single RAID disk of RAID level 5 with all of the space
available. Make this the root volume to which Ironic deploys the image: available.
.. code-block:: json .. code-block:: json
@@ -178,15 +181,13 @@ available. Make this the root volume to which Ironic deploys the image:
"logical_disks": [ "logical_disks": [
{ {
"size_gb": "MAX", "size_gb": "MAX",
"raid_level": "5", "raid_level": "5"
"is_root_volume": true
} }
] ]
} }
*Example 2*. Two RAID disks. One with RAID level 5 of 100 GiB and make it *Example 2*. Two RAID disks. One with RAID level 5 of 100 GiB and use SSD.
root volume and use SSD. Another with RAID level 1 of 500 GiB and use Another with RAID level 1 of 500 GiB and use HDD:
HDD:
.. code-block:: json .. code-block:: json
@@ -195,7 +196,6 @@ HDD:
{ {
"size_gb": 100, "size_gb": 100,
"raid_level": "5", "raid_level": "5",
"is_root_volume": true,
"disk_type": "ssd" "disk_type": "ssd"
}, },
{ {
@@ -216,8 +216,7 @@ HDD:
"size_gb": 100, "size_gb": 100,
"raid_level": "5", "raid_level": "5",
"controller": "Smart Array P822 in Slot 3", "controller": "Smart Array P822 in Slot 3",
"physical_disks": ["6I:1:5", "6I:1:6", "6I:1:7"], "physical_disks": ["6I:1:5", "6I:1:6", "6I:1:7"]
"is_root_volume": true
} }
] ]
} }
@@ -233,7 +232,6 @@ HDD:
"raid_level": "1+0", "raid_level": "1+0",
"controller": "RAID.Integrated.1-1", "controller": "RAID.Integrated.1-1",
"volume_name": "root_volume", "volume_name": "root_volume",
"is_root_volume": true,
"physical_disks": [ "physical_disks": [
"Disk.Bay.0:Encl.Int.0-1:RAID.Integrated.1-1", "Disk.Bay.0:Encl.Int.0-1:RAID.Integrated.1-1",
"Disk.Bay.1:Encl.Int.0-1:RAID.Integrated.1-1" "Disk.Bay.1:Encl.Int.0-1:RAID.Integrated.1-1"