Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HCIDOCS-260: 4.15 cherry pick for 86823 #87021

Merged
merged 1 commit into from
Jan 14, 2025
Merged

HCIDOCS-260: 4.15 cherry pick for 86823 #87021

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions modules/bmo-about-the-baremetalhost-resource.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ a| A boolean indicating whether the host provisioning and deprovisioning are man
* Hardware inventory will be monitored, but no provisioning or deprovisioning operations are performed on the host.

| `firmware`
a| Contains information about the BIOS configuration of bare metal hosts. Currently, `firmware` is only supported by iRMC, iDRAC, iLO4 and iLO5 BMCs. The sub fields are:
a| Contains information about the BIOS configuration of bare-metal hosts. Currently, `firmware` is only supported by iRMC, iDRAC, iLO4 and iLO5 BMCs. The sub fields are:

** `simultaneousMultithreadingEnabled`: Allows a single physical processor core to appear as several logical processors. Valid settings are `true` or `false`.
** `sriovEnabled`: SR-IOV support enables a hypervisor to create virtual instances of a PCI-express device, potentially increasing performance. Valid settings are `true` or `false`.
Expand All @@ -76,7 +76,7 @@ a| The `image` configuration setting holds the details for the image to be deplo
* `url`: The URL of an image to deploy to the host.
* `checksum`: The actual checksum or a URL to a file containing the checksum for the image at `image.url`.
* `checksumType`: You can specify checksum algorithms. Currently `image.checksumType` only supports `md5`, `sha256`, and `sha512`. The default checksum type is `md5`.
* `format`: This is the disk format of the image. It can be one of `raw`, `qcow2`, `vdi`, `vmdk`, `live-iso` or be left unset. Setting it to `raw` enables raw image streaming in the Ironic agent for that image. Setting it to `live-iso` enables iso images to live boot without deploying to disk, and it ignores the `checksum` fields.
* `format`: This is the disk format of the image. It can be one of `raw`, `qcow2`, `vdi`, `vmdk`, `live-iso` or be left unset. Setting it to `raw` enables raw image streaming in the Ironic agent for that image. Setting it to `live-iso` enables ISO images to live boot without deploying to disk, and it ignores the `checksum` fields.

| `networkData`
| A reference to the secret containing the network configuration data and its namespace, so that it can be attached to the host before the host boots to set up the network.
Expand All @@ -90,16 +90,16 @@ raid:
hardwareRAIDVolumes:
softwareRAIDVolumes:
----
a| (Optional) Contains the information about the RAID configuration for bare metal hosts. If not specified, it retains the current configuration.
a| (Optional) Contains the information about the RAID configuration for bare-metal hosts. If not specified, it retains the current configuration.

[NOTE]
====
{product-title} {product-version} supports hardware RAID for BMCs, including:
{product-title} {product-version} supports hardware RAID on the installation drive for BMCs, including:

* Fujitsu iRMC with support for RAID levels 0, 1, 5, 6, and 10
* Fujitsu iRMC with support for RAID levels 0, 1, 5, 6, and 10
* Dell iDRAC using the Redfish API with firmware version 6.10.30.20 or later and RAID levels 0, 1, and 5

{product-title} {product-version} does not support software RAID.
{product-title} {product-version} does not support software RAID on the installation drive.
====

See the following configuration settings:
Expand All @@ -114,7 +114,7 @@ See the following configuration settings:
** `rotational`: If set to `true`, it will only select rotational disk drives. If set to `false`, it will only select solid-state and NVMe drives. If not set, it selects any drive types, which is the default behavior.
** `sizeGibibytes`: The size of the logical drive as an integer to create in GiB. If unspecified or set to `0`, it will use the maximum capacity of physical drive for the logical drive.

* `softwareRAIDVolumes`: {product-title} {product-version} does not support software RAID. The following information is for reference only. This configuration contains the list of logical disks for software RAID. If you don't specify `rootDeviceHints`, the first volume is the root volume. If you set `HardwareRAIDVolumes`, this item will be invalid. Software RAIDs will always be deleted. The number of created software RAID devices must be `1` or `2`. If there is only one software RAID device, it must be `RAID-1`. If there are two RAID devices, the first device must be `RAID-1`, while the RAID level for the second device can be `0`, `1`, or `1+0`. The first RAID device will be the deployment device. Therefore, enforcing `RAID-1` reduces the risk of a non-booting node in case of a device failure. The `softwareRAIDVolume` field defines the desired configuration of the volume in the software RAID. The sub-fields are:
* `softwareRAIDVolumes`: {product-title} {product-version} does not support software RAID on the installation drive. The following information is for reference only. This configuration contains the list of logical disks for software RAID. If you don't specify `rootDeviceHints`, the first volume is the root volume. If you set `HardwareRAIDVolumes`, this item will be invalid. Software RAIDs will always be deleted. The number of created software RAID devices must be `1` or `2`. If there is only one software RAID device, it must be `RAID-1`. If there are two RAID devices, the first device must be `RAID-1`, while the RAID level for the second device can be `0`, `1`, or `1+0`. The first RAID device will be the deployment device, which cannot be a software RAID volume. Therefore, enforcing `RAID-1` reduces the risk of a non-booting node in case of a device failure. The `softwareRAIDVolume` field defines the desired configuration of the volume in the software RAID. The sub-fields are:

** `level`: The RAID level for the logical drive. The following levels are supported: `0`,`1`,`1+0`.
** `physicalDisks`: A list of device hints. The number of items should be greater than or equal to `2`.
Expand Down Expand Up @@ -284,7 +284,7 @@ a| The status of the server. The status is one of the following:

* `OK`: Indicates all the details for the host are known, correctly configured, working, and manageable.
* `discovered`: Implies some of the host's details are either not working correctly or missing. For example, the BMC address is known but the login credentials are not.
* `error`: Indicates the system found some sort of irrecoverable error. Refer to the `errorMessage` field in the status section for more details.
* `error`: Indicates the system found some sort of unrecoverable error. Refer to the `errorMessage` field in the status section for more details.
* `delayed`: Indicates that provisioning is delayed to limit simultaneous provisioning of multiple hosts.
* `detached`: Indicates the host is marked `unmanaged`.

Expand Down Expand Up @@ -319,7 +319,7 @@ a| The `provisioning` field contains values related to deploying an image to the
* `id`: The unique identifier for the service in the underlying provisioning tool.
* `image`: The image most recently provisioned to the host.
* `raid`: The list of hardware or software RAID volumes recently set.
* `firmware`: The BIOS configuration for the bare metal server.
* `firmware`: The BIOS configuration for the bare-metal server.
* `rootDeviceHints`: The root device selection instructions used for the most recent provisioning operation.

| `triedCredentials`
Expand Down
8 changes: 7 additions & 1 deletion modules/installation-special-config-raid.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
// Module included in the following assemblies:
//
// * installing/install_config/installing-customizing.adoc
:_mod-docs-content-type: PROCEDURE

[id="installation-special-config-raid_{context}"]
== Configuring a RAID-enabled data volume

You can enable software RAID partitioning to provide an external data volume. {product-title} supports RAID 0, RAID 1, RAID 4, RAID 5, RAID 6, and RAID 10 for data protection and fault tolerance. See "About disk mirroring" for more details.

[NOTE]
====
{product-title} {product-version} does not support software RAIDs on the installation drive.
====

.Prerequisites

* You have downloaded the {product-title} installation program on your installation node.
Expand Down Expand Up @@ -62,7 +68,7 @@ storage:
wipe_filesystem: true
with_mount_unit: true
----
<1> When adding a data partition to the boot disk, a minimum value of 25000 mebibytes is recommended. If no value is specified, or if the specified value is smaller than the recommended minimum, the resulting root file system will be too small, and future reinstalls of {op-system} might overwrite the beginning of the data partition.
<1> When adding a data partition to the mirrored boot disk, a minimum value of 25000 mebibytes is recommended. If no value is specified, or if the specified value is smaller than the recommended minimum, the resulting root file system will be too small, and future reinstalls of {op-system} might overwrite the beginning of the data partition.

* To configure a data volume with RAID 1 on secondary disks, create a `$HOME/clusterconfig/raid1-alt-storage.bu` file, for example:
+
Expand Down