Skip to content

Commit 18fcb0e

Browse files
ahardin-rhahardin-rh
authored
Merge pull request #32022 from johnwilkins/BZ1923965
Restructured docs for BMC.
2 parents 027364d + dcc74e8 commit 18fcb0e

File tree

5 files changed

+262
-140
lines changed

5 files changed

+262
-140
lines changed

‎installing/installing_bare_metal_ipi/ipi-install-configuration-files.adoc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
:context: ipi-install-configuration-files
44
:release: 4.7
55

6+
67
include::modules/ipi-install-configuring-the-install-config-file.adoc[leveloffset=+1]
78

89
ifeval::[{release} <= 4.3]
@@ -18,6 +19,13 @@ include::modules/ipi-install-modifying-install-config-for-no-provisioning-networ
1819
endif::[]
1920

2021
include::modules/ipi-install-additional-install-config-parameters.adoc[leveloffset=+1]
22+
2123
include::modules/ipi-install-bmc-addressing.adoc[leveloffset=+1]
24+
25+
include::modules/ipi-install-bmc-addressing-for-dell.adoc[leveloffset=+1]
26+
27+
include::modules/ipi-install-bmc-addressing-for-hpe.adoc[leveloffset=+1]
28+
2229
include::modules/ipi-install-root-device-hints.adoc[leveloffset=+1]
30+
2331
include::modules/ipi-install-creating-the-openshift-manifests.adoc[leveloffset=+1]

‎modules/ipi-install-bmc-addressing-for-dell.adoc‎

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
// This is included in the following assemblies:
2+
//
3+
// installing/installing_bare_metal_ipi/ipi-install-configuration-files.adoc
4+
[id='bmc-addressing-for-dell_{context}']
5+
6+
= BMC addressing for Dell
7+
8+
The `address` field for each `bmc` entry is a URL for connecting to the {product-title} cluster nodes, including the type of controller in the URL scheme and its location on the network.
9+
10+
[source,yaml]
11+
----
12+
platform:
13+
baremetal:
14+
hosts:
15+
- name: <host name>
16+
role: <master | worker>
17+
bmc:
18+
address: <address>
19+
username: <user>
20+
password: <password>
21+
----
22+
23+
For Dell hardware, Red Hat supports Redfish virtual media, Redfish network boot, and IPMI.
24+
25+
.BMC address formats for Dell hardware
26+
[frame="topbot",options="header"]
27+
|====
28+
|Protocol|Address Format
29+
|Redfish virtual media| `idrac-virtualmedia://<out-of-band-ip>/redfish/v1/Systems/System.Embedded.1`
30+
|Redfish network boot|`redfish://<out-of-band-ip>/redfish/v1/Systems/System.Embedded.1`
31+
|IPMI|`ipmi://<out-of-band-ip>`
32+
|====
33+
34+
[IMPORTANT]
35+
====
36+
Use `idrac-virtualmedia` as the protocol for Redfish virtual media. `redfish-virtualmedia` will not work on Dell hardware. Dell's `idrac-virtualmedia` uses the Redfish standard with Dell's OEM extensions.
37+
====
38+
39+
See the following sections for additional details.
40+
41+
.Redfish virtual media for Dell
42+
43+
For Redfish virtual media on Dell servers, use `idrac-virtualmedia://` in the `address` setting. Using `redfish-virtualmedia://` will not work.
44+
45+
ifeval::[{release} >= 4.6]
46+
ifeval::[{release} < 4.7]
47+
[NOTE]
48+
====
49+
Redfish virtual media on Dell servers has a known issue in {product-title} 4.6, which will be resolved in a future release.
50+
====
51+
endif::[]
52+
endif::[]
53+
54+
The following example demonstrates using iDRAC virtual media within the `install-config.yaml` file.
55+
56+
[source,yaml]
57+
----
58+
platform:
59+
baremetal:
60+
hosts:
61+
- name: openshift-master-0
62+
role: master
63+
bmc:
64+
address: idrac-virtualmedia://<out-of-band-ip>/redfish/v1/Systems/System.Embedded.1
65+
username: <user>
66+
password: <password>
67+
----
68+
69+
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.
70+
71+
[source,yaml]
72+
----
73+
platform:
74+
baremetal:
75+
hosts:
76+
- name: openshift-master-0
77+
role: master
78+
bmc:
79+
address: idrac-virtualmedia://<out-of-band-ip>/redfish/v1/Systems/System.Embedded.1
80+
username: <user>
81+
password: <password>
82+
disableCertificateVerification: True
83+
----
84+
85+
86+
[NOTE]
87+
====
88+
Currently, Redfish is only supported on Dell with iDRAC firmware versions `4.20.20.20` through `04.40.00.00` for installer-provisioned installations 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* .
89+
90+
Ensure the {product-title} cluster nodes have AutoAttach Enabled through the iDRAC console. The menu path is: *Configuration* -> *Virtual Media* -> *Attach Mode* -> `AutoAttach` .
91+
92+
Use `idrac-virtualmedia://` as the protocol for Redfish virtual media. Using `redfish-virtualmedia://` will not work on Dell hardware, because the `idrac-virtualmedia://` protocol corresponds to the `idrac` hardware type and the Redfish protocol in Ironic. Dell's `idrac-virtualmedia://` protocol uses the Redfish standard with Dell's OEM extensions. Ironic also supports the `idrac` type with the WSMAN protocol. Therefore, you must specify `idrac-virtualmedia://` to avoid unexpected behavior when electing to use Redfish with virtual media on Dell hardware.
93+
====
94+
95+
96+
.Redfish network boot for Dell
97+
98+
To enable Redfish, use `redfish://` or `redfish+http://` to disable transport layer security (TLS). The installer requires both the host name or the IP address and the path to the system ID. The following example demonstrates a Redfish configuration within the `install-config.yaml` file.
99+
100+
[source,yaml]
101+
----
102+
platform:
103+
baremetal:
104+
hosts:
105+
- name: openshift-master-0
106+
role: master
107+
bmc:
108+
address: redfish://<out-of-band-ip>/redfish/v1/Systems/System.Embedded.1
109+
username: <user>
110+
password: <password>
111+
----
112+
113+
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.
114+
115+
[source,yaml]
116+
----
117+
platform:
118+
baremetal:
119+
hosts:
120+
- name: openshift-master-0
121+
role: master
122+
bmc:
123+
address: redfish://<out-of-band-ip>/redfish/v1/Systems/System.Embedded.1
124+
username: <user>
125+
password: <password>
126+
disableCertificateVerification: True
127+
----
128+
129+
[NOTE]
130+
====
131+
Currently, Redfish is only supported on Dell with iDRAC firmware versions `4.20.20.20` through `04.40.00.00` for installer-provisioned installations 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* .
132+
133+
Ensure the {product-title} cluster nodes have AutoAttach Enabled through the iDRAC console. The menu path is: *Configuration* -> *Virtual Media* -> *Attach Mode* -> *AutoAttach* .
134+
135+
The `redfish://` URL protocol corresponds to the `redfish` hardware type in Ironic.
136+
====

‎modules/ipi-install-bmc-addressing-for-hpe.adoc‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
// This is included in the following assemblies:
2+
//
3+
// installing/installing_bare_metal_ipi/ipi-install-configuration-files.adoc
4+
[id='bmc-addressing-for-hpe_{context}']
5+
6+
= BMC addressing for HPE
7+
8+
The `address` field for each `bmc` entry is a URL for connecting to the {product-title} cluster nodes, including the type of controller in the URL scheme and its location on the network.
9+
10+
[source,yaml]
11+
----
12+
platform:
13+
baremetal:
14+
hosts:
15+
- name: <host name>
16+
role: <master | worker>
17+
bmc:
18+
address: <address>
19+
username: <user>
20+
password: <password>
21+
----
22+
23+
For HPE hardware, Red Hat supports Redfish virtual media, Redfish network boot, and IPMI.
24+
25+
.BMC address formats for HPE hardware
26+
[frame="topbot",options="header"]
27+
|====
28+
|Protocol|Address Format
29+
|Redfish virtual media| `redfish-virtualmedia://<out-of-band-ip>/redfish/v1/Systems/1`
30+
|Redfish network boot| `redfish://<out-of-band-ip>/redfish/v1/Systems/1`
31+
|IPMI| `ipmi://<out-of-band-ip>`
32+
|====
33+
34+
See the following sections for additional details.
35+
36+
.Redfish virtual media for HPE
37+
38+
To enable Redfish virtual media for HPE servers, use `redfish-virtualmedia://` in the `address` setting. The following example demonstrates using Redfish virtual media within the `install-config.yaml` file.
39+
40+
[source,yaml]
41+
----
42+
platform:
43+
baremetal:
44+
hosts:
45+
- name: openshift-master-0
46+
role: master
47+
bmc:
48+
address: redfish-virtualmedia://<out-of-band-ip>/redfish/v1/Systems/1
49+
username: <user>
50+
password: <password>
51+
----
52+
53+
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.
54+
55+
[source,yaml]
56+
----
57+
platform:
58+
baremetal:
59+
hosts:
60+
- name: openshift-master-0
61+
role: master
62+
bmc:
63+
address: redfish-virtualmedia://<out-of-band-ip>/redfish/v1/Systems/1
64+
username: <user>
65+
password: <password>
66+
disableCertificateVerification: True
67+
----
68+
69+
[NOTE]
70+
====
71+
Redfish virtual media is not supported on 9th generation systems running iLO4, because Ironic does not support iLO4 with virtual media.
72+
====
73+
74+
75+
.Redfish network boot for HPE
76+
77+
To enable Redfish, use `redfish://` or `redfish+http://` to disable TLS. The installer requires both the host name or the IP address and the path to the system ID. The following example demonstrates a Redfish configuration within the `install-config.yaml` file.
78+
79+
[source,yaml]
80+
----
81+
platform:
82+
baremetal:
83+
hosts:
84+
- name: openshift-master-0
85+
role: master
86+
bmc:
87+
address: redfish://<out-of-band-ip>/redfish/v1/Systems/1
88+
username: <user>
89+
password: <password>
90+
----
91+
92+
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.
93+
94+
[source,yaml]
95+
----
96+
platform:
97+
baremetal:
98+
hosts:
99+
- name: openshift-master-0
100+
role: master
101+
bmc:
102+
address: redfish://<out-of-band-ip>/redfish/v1/Systems/1
103+
username: <user>
104+
password: <password>
105+
disableCertificateVerification: True
106+
----

0 commit comments

Comments
 (0)