diff --git a/installing/installing_bare_metal_ipi/ipi-install-expanding-the-cluster.adoc b/installing/installing_bare_metal_ipi/ipi-install-expanding-the-cluster.adoc index a7ddddd83a2e..7a1da80700e2 100644 --- a/installing/installing_bare_metal_ipi/ipi-install-expanding-the-cluster.adoc +++ b/installing/installing_bare_metal_ipi/ipi-install-expanding-the-cluster.adoc @@ -7,6 +7,11 @@ include::modules/common-attributes.adoc[] After deploying an installer-provisioned {product-title} cluster, you can use the following procedures to expand the number of worker nodes. Ensure that each prospective worker node meets the prerequisites. +[NOTE] +==== +Expanding the cluster using RedFish Virtual Media involves meeting minimum firmware requirements. See *Firmware requirements for installing with virtual media* in the *Prerequisites* section for additional details when expanding the cluster using RedFish Virtual Media. +==== + include::modules/ipi-install-preparing-the-bare-metal-node.adoc[leveloffset=+1] include::modules/ipi-install-provisioning-the-bare-metal-node.adoc[leveloffset=+1] diff --git a/installing/installing_bare_metal_ipi/ipi-install-prerequisites.adoc b/installing/installing_bare_metal_ipi/ipi-install-prerequisites.adoc index 8ecb2b918b08..abc7ce9d59de 100644 --- a/installing/installing_bare_metal_ipi/ipi-install-prerequisites.adoc +++ b/installing/installing_bare_metal_ipi/ipi-install-prerequisites.adoc @@ -2,13 +2,13 @@ = Prerequisites include::modules/common-attributes.adoc[] :context: ipi-install-prerequisites -:release: 4.6 +:release: 4.7 toc::[] Installer-provisioned installation of {product-title} requires: -. One provisioner node with {op-system-base-full} 8.1 installed. +. One provisioner node with {op-system-base-full} 8.x installed. . Three control plane nodes. . Baseboard Management Controller (BMC) access to each node. ifeval::[{release} > 4.5] @@ -24,10 +24,12 @@ ifeval::[{release} < 4.6] .. One *optional* management network. endif::[] - Before starting an installer-provisioned installation of {product-title}, ensure the hardware environment meets the following requirements. include::modules/ipi-install-node-requirements.adoc[leveloffset=+1] +ifeval::[{release} >= 4.6] +include::modules/ipi-install-firmware-requirements-for-installing-with-virtual-media.adoc[leveloffset=+1] +endif::[] include::modules/ipi-install-network-requirements.adoc[leveloffset=+1] ifdef::upstream[] ifeval::[{release} >= 4.5] diff --git a/installing/installing_bare_metal_ipi/ipi-install-troubleshooting.adoc b/installing/installing_bare_metal_ipi/ipi-install-troubleshooting.adoc index 95daba8c8e74..c2141aa5c48a 100644 --- a/installing/installing_bare_metal_ipi/ipi-install-troubleshooting.adoc +++ b/installing/installing_bare_metal_ipi/ipi-install-troubleshooting.adoc @@ -5,6 +5,7 @@ include::modules/common-attributes.adoc[] toc::[] + == Troubleshooting the installer workflow Prior to troubleshooting the installation environment, it is critical to understand the overall flow of the installer-provisioned installation on bare metal. The diagrams below provide a troubleshooting flow with a step-by-step breakdown for the environment. @@ -19,7 +20,7 @@ _Workflow 2 of 4_ illustrates a troubleshooting workflow for xref:ipi-install-tr image:flow3.png[Flow-Diagram-3] -_Workflow 3 of 4_ illustrates a troubleshooting workflow for xref:ipi-install-troubleshooting-cluster-nodes-will-not-pxe_{context}[ cluster nodes that will not PXE boot]. +_Workflow 3 of 4_ illustrates a troubleshooting workflow for xref:ipi-install-troubleshooting-cluster-nodes-will-not-pxe_{context}[ cluster nodes that will not PXE boot]. If installing using RedFish Virtual Media, each node must meet minimum firmware requirements for the installer to deploy the node. See *Firmware requirements for installing with virtual media* in the *Prerequisites* section for additional details. image:flow4.png[Flow-Diagram-4] diff --git a/modules/ipi-install-bmc-addressing.adoc b/modules/ipi-install-bmc-addressing.adoc index b732f6c895fe..83bc481a146f 100644 --- a/modules/ipi-install-bmc-addressing.adoc +++ b/modules/ipi-install-bmc-addressing.adoc @@ -42,8 +42,7 @@ platform: password: ---- -While it is recommended to have a certificate of authority for the -out-of-band management addresses, you must include `disableCertificateVerification: True` in the `bmc` configuration if using self-signed certificates. The following example demonstrates a RedFish configuration using the `disableCertificateVerification: True` configuration parameter within the `install-config.yaml` file. +While it is recommended to have a certificate of authority for the out-of-band management addresses, you must include `disableCertificateVerification: True` in the `bmc` configuration if using self-signed certificates. The following example demonstrates a RedFish configuration using the `disableCertificateVerification: True` configuration parameter within the `install-config.yaml` file. [source,yaml] ---- @@ -77,8 +76,7 @@ platform: password: ---- -While it is recommended to have a certificate of authority for the -out-of-band management addresses, you must include `disableCertificateVerification: True` in the `bmc` configuration if using self-signed certificates. The following example demonstrates a RedFish configuration using the `disableCertificateVerification: True` configuration parameter within the `install-config.yaml` file. +While it is recommended to have a certificate of authority for the out-of-band management addresses, you must include `disableCertificateVerification: True` in the `bmc` configuration if using self-signed certificates. The following example demonstrates a RedFish configuration using the `disableCertificateVerification: True` configuration parameter within the `install-config.yaml` file. [source,yaml] ---- @@ -96,7 +94,9 @@ platform: [NOTE] ==== -Currently RedFish is only supported on Dell with iDRAC firmware version `4.20.20.20` or higher for installer-provisioned installations of {product-title} on bare metal deployments. +Currently RedFish is only supported on Dell with iDRAC firmware versions `4.20.20.20` through `04.40.00.00` for IPI on bare metal deployments. There is a known issue with version `04.40.00.00`. With iDRAC 9 firmware version `04.40.00.00`, the Virtual Console plug-in defaults to `eHTML5`, which causes problems with the *InsertVirtualMedia* workflow. Set the plug-in to `HTML5` to avoid this issue. The menu path is: *Configuration* -> *Virtual console* -> *Plug-in Type* -> *HTML5* . + +Ensure the {product-title} cluster nodes have AutoAttach Enabled through the iDRAC console. The menu path is: *Configuration* -> *Virtual Media* -> *Attach Mode* -> *AutoAttach* . ==== @@ -117,11 +117,52 @@ platform: password: ---- +While it is recommended to have a certificate of authority for the out-of-band management addresses, you must include `disableCertificateVerification: True` in the `bmc` configuration if using self-signed certificates. The following example demonstrates a RedFish configuration using the `disableCertificateVerification: True` configuration parameter within the `install-config.yaml` file. + +[source,yaml] +---- +platform: + baremetal: + hosts: + - name: openshift-master-0 + role: master + bmc: + address: redfish-virtualmedia:///redfish/v1/Systems/1 + username: + password: + disableCertificateVerification: True +---- + + .RedFish Virtual Media for Dell For RedFish Virtual Media on Dell servers, use `idrac-virtualmedia://` in the `address` setting. -The following example demonstrates using iDRAC Virtual Media within the `install-config.yaml` file. +ifeval::[{release} >= 4.6] +ifeval::[{release} < 4.7] +[NOTE] +==== +RedFish Virtual Media on Dell servers has a known issue in {product-title} 4.6, which will be resolved in the 4.6.1 point release. +==== +endif::[] +endif::[] + +The following example demonstrates using iDRAC Virtual Media within the `install-config.yaml` file. + +[source,yaml] +---- +platform: + baremetal: + hosts: + - name: openshift-master-0 + role: master + bmc: + address: idrac-virtualmedia:///redfish/v1/Systems/System.Embedded.1 + username: + password: +---- + +While it is recommended to have a certificate of authority for the out-of-band management addresses, you must include `disableCertificateVerification: True` in the `bmc` configuration if using self-signed certificates. The following example demonstrates a RedFish configuration using the `disableCertificateVerification: True` configuration parameter within the `install-config.yaml` file. [source,yaml] ---- @@ -134,11 +175,13 @@ platform: address: idrac-virtualmedia:///redfish/v1/Systems/System.Embedded.1 username: password: + disableCertificateVerification: True ---- + [NOTE] ==== -`idrac-virtualmedia` requires iDRAC firmware version 4.20.20.20 or higher. +Currently RedFish is only supported on Dell with iDRAC firmware versions `4.20.20.20` through `04.40.00.00` for IPI on bare metal deployments. There is a known issue with version `04.40.00.00`. With iDRAC 9 firmware version `04.40.00.00`, the Virtual Console plug-in defaults to `eHTML5`, which causes problems with the *InsertVirtualMedia* workflow. Set the plug-in to `HTML5` to avoid this issue. The menu path is: *Configuration* -> *Virtual console* -> *Plug-in Type* -> *HTML5* . -Ensure the {product-title} cluster nodes have AutoAttach Enabled through the iDRAC console. The menu path is: **Configuration->Virtual Media->Attach Mode->AutoAttach**. +Ensure the {product-title} cluster nodes have AutoAttach Enabled through the iDRAC console. The menu path is: *Configuration* -> *Virtual Media* -> *Attach Mode* -> *AutoAttach* . ==== diff --git a/modules/ipi-install-creating-a-disconnected-registry.adoc b/modules/ipi-install-creating-a-disconnected-registry.adoc index 4e4ef16484fb..ccb86b18a2ee 100644 --- a/modules/ipi-install-creating-a-disconnected-registry.adoc +++ b/modules/ipi-install-creating-a-disconnected-registry.adoc @@ -7,12 +7,12 @@ = Creating a disconnected registry (optional) -In some cases, you might want to install an OpenShift KNI cluster using a local copy of the installation registry. This could be for enhancing network efficiency because the cluster nodes are on a network that does not have access to the internet. +In some cases, you might want to install an {product-title} cluster using a local copy of the installation registry. This could be for enhancing network efficiency because the cluster nodes are on a network that does not have access to the internet. A local, or mirrored, copy of the registry requires the following: * A certificate for the registry node. This can be a self-signed certificate. -* A webserver - this will be served by a container on a system. +* A web server that a container on a system will serve. * An updated pull secret that contains the certificate and local repository information. [NOTE] diff --git a/modules/ipi-install-firmware-requirements-for-installing-with-virtual-media.adoc b/modules/ipi-install-firmware-requirements-for-installing-with-virtual-media.adoc new file mode 100644 index 000000000000..e22c850fb757 --- /dev/null +++ b/modules/ipi-install-firmware-requirements-for-installing-with-virtual-media.adoc @@ -0,0 +1,35 @@ +// Module included in the following assemblies: +// +// * installing/installing_bare_metal_ipi/ipi-install-prerequisites.adoc + +[id='ipi-install-firmware-requirements-for-installing-with-virtual-media_{context}'] += Firmware requirements for installing with virtual media + +The installer for installer-provisioned {product-title} clusters validates the hardware and firmware compatibility with RedFish virtual media. The following table lists supported firmware for installer-provisioned {product-title} clusters deployed with RedFish virtual media. + +.Firmware Compatibility for RedFish Virtual Media +[frame="topbot", options="header"] +|==== +|Hardware| Model | Management | Minimum Firmware Version +.2+| HP | 10th Generation | iLO5 | N/A +| 9th Generation | iLO4 | N/A + +.2+| Dell | 14th Generation | iDRAC 9 | v4.20.20.20 - 04.40.00.00 + +| 13th Generation .2+| iDRAC 8 | v2.75.75.75+ + +|==== + +[NOTE] +==== +Refer to the hardware documentation for the nodes or contact the hardware vendor for information on updating the firmware. + +There are no known firmware limitations for HP servers. + +For Dell servers, ensure the {product-title} cluster nodes have AutoAttach Enabled through the iDRAC console. The menu path is: *Configuration* -> *Virtual Media* -> *Attach Mode* -> *AutoAttach* . With iDRAC 9 firmware version `04.40.00.00`, the Virtual Console plug-in defaults to `eHTML5`, which causes problems with the *InsertVirtualMedia* workflow. Set the plug-in to `HTML5` to avoid this issue. The menu path is: *Configuration* -> *Virtual console* -> *Plug-in Type* -> *HTML5* . +==== + +[IMPORTANT] +==== +The installer will not initiate installation on a node if the node firmware is below the foregoing versions when installing with virtual media. +====