Skip to content

Commit 7eb5176

Browse files
jeana-redhatjeana-redhat
authored
Merge pull request #46455 from kelbrown20/OSDOCS-3327-arm-metal-ipi-docs-4.11
OSDOCS-3327: ARM doc updates to metal IPI
2 parents e727418 + 0442321 commit 7eb5176

10 files changed

+99
-18
lines changed

‎installing/installing-preparing.adoc

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ Not all installation options are supported for all platforms, as shown in the fo
125125
//This table is for all flavors of OpenShift, except OKD. A separate table is required because OKD does not support multiple AWS architecture types. Trying to maintain one table using conditions, while convenient, is very fragile and prone to publishing errors.
126126
ifndef::openshift-origin[]
127127
|===
128-
||Alibaba |AWS (x86_64) |AWS (arm64) |Azure |Azure Stack Hub |GCP |{rh-openstack} |{rh-openstack} on SR-IOV |RHV |Bare metal |vSphere |VMC |IBM Cloud VPC |IBM Z |IBM Power
128+
||Alibaba |AWS (x86_64) |AWS (arm64) |Azure |Azure Stack Hub |GCP |{rh-openstack} |{rh-openstack} on SR-IOV |RHV |Bare metal (x86_64) |Bare metal (arm64) |vSphere |VMC |IBM Cloud VPC |IBM Z |IBM Power
129129

130130
|Default
131131
|xref:../installing/installing_alibaba/installing-alibaba-default.adoc#installing-alibaba-default[X]
@@ -138,6 +138,7 @@ ifndef::openshift-origin[]
138138
|
139139
|xref:../installing/installing_rhv/installing-rhv-default.adoc#installing-rhv-default[X]
140140
|xref:../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install-overview[X]
141+
|xref:../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install-overview[X]
141142
|xref:../installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc#installing-vsphere-installer-provisioned[X]
142143
|xref:../installing/installing_vmc/installing-vmc.adoc#installing-vmc[X]
143144
|xref:../installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[X]
@@ -155,6 +156,7 @@ ifndef::openshift-origin[]
155156
|xref:../installing/installing_openstack/installing-openstack-installer-sr-iov.adoc#installing-openstack-installer-sr-iov[X]
156157
|xref:../installing/installing_rhv/installing-rhv-customizations.adoc#installing-rhv-customizations[X]
157158
|
159+
|
158160
|xref:../installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc#installing-vsphere-installer-provisioned-customizations[X]
159161
|xref:../installing/installing_vmc/installing-vmc-customizations.adoc#installing-vmc-customizations[X]
160162
|xref:../installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[X]
@@ -172,6 +174,7 @@ ifndef::openshift-origin[]
172174
|
173175
|
174176
|
177+
|
175178
|xref:../installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc#installing-vsphere-installer-provisioned-network-customizations[X]
176179
|xref:../installing/installing_vmc/installing-vmc-network-customizations.adoc#installing-vmc-network-customizations[X]
177180
|xref:../installing/installing_ibm_cloud_public/installing-ibm-cloud-network-customizations.adoc#installing-ibm-cloud-network-customizations[X]
@@ -189,6 +192,7 @@ ifndef::openshift-origin[]
189192
|
190193
|xref:../installing/installing_rhv/installing-rhv-restricted-network.adoc#installing-rhv-restricted-network[X]
191194
|
195+
|
192196
|xref:../installing/installing_vsphere/installing-restricted-networks-installer-provisioned-vsphere.adoc#installing-restricted-networks-installer-provisioned-vsphere[X]
193197
|xref:../installing/installing_vmc/installing-restricted-networks-vmc.adoc#installing-restricted-networks-vmc[X]
194198
|
@@ -211,6 +215,7 @@ ifndef::openshift-origin[]
211215
|
212216
|
213217
|
218+
|
214219

215220
|Existing virtual private networks
216221
|
@@ -228,6 +233,7 @@ ifndef::openshift-origin[]
228233
|
229234
|
230235
|
236+
|
231237

232238
|Government regions
233239
|
@@ -245,6 +251,7 @@ ifndef::openshift-origin[]
245251
|
246252
|
247253
|
254+
|
248255

249256
|Secret regions
250257
|
@@ -262,6 +269,7 @@ ifndef::openshift-origin[]
262269
|
263270
|
264271
|
272+
|
265273

266274
|China regions
267275
|
@@ -279,6 +287,7 @@ ifndef::openshift-origin[]
279287
|
280288
|
281289
|
290+
|
282291
|===
283292
endif::openshift-origin[]
284293

‎modules/ipi-install-additional-install-config-parameters.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,10 @@ a|`provisioningNetworkCIDR`
143143
| `provisioning`
144144
| The name of the `provisioning` bridge on the `provisioner` host attached to the `provisioning` network.
145145

146+
|`architecture`
147+
|
148+
|Defines the host architecture for your cluster. Valid values are `amd64` or `arm64`.
149+
146150
| `defaultMachinePlatform`
147151
|
148152
| The default configuration used for machine pools without a platform configuration.

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

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,62 @@ platform:
6464
password: <password>
6565
disableCertificateVerification: True
6666
----
67+
[discrete]
68+
== Redfish APIs
69+
70+
Several redfish API endpoints are called onto your BCM when using the bare-metal installer-provisioned infrastructure.
71+
72+
[IMPORTANT]
73+
====
74+
You need to ensure that your BMC supports all of the redfish APIs before installation.
75+
====
76+
77+
List of redfish APIs::
78+
* Power on
79+
+
80+
[source, terminal]
81+
----
82+
curl -u $USER:$PASS -X POST -H'Content-Type: application/json' -H'Accept: application/json' -d '{"Action": "Reset", "ResetType": "On"}' https://$SERVER/redfish/v1/Systems/$SystemID/Actions/ComputerSystem.Reset
83+
----
84+
* Power off
85+
+
86+
[source, terminal]
87+
----
88+
curl -u $USER:$PASS -X POST -H'Content-Type: application/json' -H'Accept: application/json' -d '{"Action": "Reset", "ResetType": "ForceOff"}' https://$SERVER/redfish/v1/Systems/$SystemID/Actions/ComputerSystem.Reset
89+
----
90+
* Temporary boot using `pxe`
91+
+
92+
[source, terminal]
93+
----
94+
curl -u $USER:$PASS -X PATCH -H "Content-Type: application/json" https://$Server/redfish/v1/Systems/$SystemID/ -d '{"Boot": {"BootSourceOverrideTarget": "pxe", "BootSourceOverrideEnabled": "Once"}}
95+
----
96+
* Set BIOS boot mode using `Legacy` or `UEFI`
97+
+
98+
[source, terminal]
99+
----
100+
curl -u $USER:$PASS -X PATCH -H "Content-Type: application/json" https://$Server/redfish/v1/Systems/$SystemID/ -d '{"Boot": {"BootSourceOverrideMode":"UEFI"}}
101+
----
102+
103+
List of redfish-virtualmedia APIs::
104+
* Set temporary boot device using `cd` or `dvd`
105+
+
106+
[source, terminal]
107+
----
108+
curl -u $USER:$PASS -X PATCH -H "Content-Type: application/json" https://$Server/redfish/v1/Systems/$SystemID/ -d '{"Boot": {"BootSourceOverrideTarget": "cd", "BootSourceOverrideEnabled": "Once"}}'
109+
----
110+
* Mount virtual media
111+
+
112+
[source, terminal]
113+
----
114+
curl -u $USER:$PASS -X PATCH -H "Content-Type: application/json" -H "If-Match: *" https://$Server/redfish/v1/Managers/$ManagerID/VirtualMedia/$VmediaId -d '{"Image": "https://example.com/test.iso", "TransferProtocolType": "HTTPS", "UserName": "", "Password":""}'
115+
----
116+
117+
[NOTE]
118+
====
119+
The `PowerOn` and `PowerOff` commands for redfish APIs are the same for the redfish-virtualmedia APIs.
120+
====
121+
122+
[IMPORTANT]
123+
====
124+
`HTTPS` and `HTTP` are the only supported parameter types for `TransferProtocolTypes`.
125+
====

‎modules/ipi-install-mirroring-for-disconnected-registry.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -208,20 +208,20 @@ mirrored, extract it and pin it to the release:
208208
+
209209
[source,terminal]
210210
----
211-
$ oc adm release extract -a ${LOCAL_SECRET_JSON} --command=openshift-install "${LOCAL_REGISTRY}/${LOCAL_REPOSITORY}:${OCP_RELEASE}"
211+
$ oc adm release extract -a ${LOCAL_SECRET_JSON} --command=openshift-baremetal-install "${LOCAL_REGISTRY}/${LOCAL_REPOSITORY}:${OCP_RELEASE}"
212212
----
213213
** If the local container registry is connected to the mirror host, run the following command:
214214
+
215215
ifdef::openshift-origin[]
216216
[source,terminal]
217217
----
218-
$ oc adm release extract -a ${LOCAL_SECRET_JSON} --command=openshift-install "${LOCAL_REGISTRY}/${LOCAL_REPOSITORY}:${OCP_RELEASE}"
218+
$ oc adm release extract -a ${LOCAL_SECRET_JSON} --command=openshift-baremetal-install "${LOCAL_REGISTRY}/${LOCAL_REPOSITORY}:${OCP_RELEASE}"
219219
----
220220
endif::[]
221221
ifndef::openshift-origin[]
222222
[source,terminal]
223223
----
224-
$ oc adm release extract -a ${LOCAL_SECRET_JSON} --command=openshift-install "${LOCAL_REGISTRY}/${LOCAL_REPOSITORY}:${OCP_RELEASE}-${ARCHITECTURE}"
224+
$ oc adm release extract -a ${LOCAL_SECRET_JSON} --command=openshift-baremetal-install "${LOCAL_REGISTRY}/${LOCAL_REPOSITORY}:${OCP_RELEASE}-${ARCHITECTURE}"
225225
----
226226
endif::[]
227227
+
@@ -240,5 +240,5 @@ If you are in a disconnected environment, use the `--image` flag as part of must
240240
+
241241
[source,terminal]
242242
----
243-
$ openshift-install
243+
$ openshift-baremetal-install
244244
----

‎modules/ipi-install-node-requirements.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,11 @@
88

99
Installer-provisioned installation involves a number of hardware node requirements:
1010

11-
* *CPU architecture:* All nodes must use `x86_64` CPU architecture.
12-
11+
* *CPU architecture:* All nodes must use `x86_64`
12+
ifndef::openshift-origin[]
13+
or `arm64`
14+
endif::openshift-origin[]
15+
CPU architecture.
1316
* *Similar nodes:* Red Hat recommends nodes have an identical configuration per role. That is, Red Hat recommends nodes be the same brand and model with the same CPU, memory, and storage configuration.
1417
1518
* *Baseboard Management Controller:* The `provisioner` node must be able to access the baseboard management controller (BMC) of each {product-title} cluster node. You may use IPMI, Redfish, or a proprietary protocol.

‎modules/ipi-install-preparing-the-provisioner-node-for-openshift-install.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ ifndef::openshift-origin[]
5555
[source,terminal]
5656
----
5757
$ sudo subscription-manager register --username=<user> --password=<pass> --auto-attach
58-
$ sudo subscription-manager repos --enable=rhel-8-for-x86_64-appstream-rpms --enable=rhel-8-for-x86_64-baseos-rpms
58+
$ sudo subscription-manager repos --enable=rhel-8-for-<architecture>-appstream-rpms --enable=rhel-8-for-<architecture>-baseos-rpms
5959
----
6060
+
6161
[NOTE]

‎modules/ipi-install-preparing-to-deploy-with-virtual-media-on-the-baremetal-network.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ oc edit provisioning
4040
provisioningInterface: enp1s0
4141
provisioningNetwork: Managed
4242
provisioningNetworkCIDR: 172.22.0.0/24
43-
provisioningOSDownloadURL: http://192.168.111.1/images/rhcos-<version>.x86_64.qcow2.gz?sha256=<sha256>
43+
provisioningOSDownloadURL: http://192.168.111.1/images/rhcos-<version>.<architecture>.qcow2.gz?sha256=<sha256>
4444
virtualMediaViaExternalNetwork: true <1>
4545
status:
4646
generations:
@@ -105,8 +105,8 @@ oc edit machineset
105105
apiVersion: baremetal.cluster.k8s.io/v1alpha1
106106
hostSelector: {}
107107
image:
108-
checksum: http:/172.22.0.3:6181/images/rhcos-<version>.x86_64.qcow2.<md5sum> <1>
109-
url: http://172.22.0.3:6181/images/rhcos-<version>.x86_64.qcow2 <2>
108+
checksum: http:/172.22.0.3:6181/images/rhcos-<version>.<architecture>.qcow2.<md5sum> <1>
109+
url: http://172.22.0.3:6181/images/rhcos-<version>.<architecture>.qcow2 <2>
110110
kind: BareMetalMachineProviderSpec
111111
metadata:
112112
creationTimestamp: null

‎modules/ipi-install-retrieving-the-openshift-installer.adoc

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,17 @@
66
[id="retrieving-the-openshift-installer_{context}"]
77
= Retrieving the {product-title} installer
88

9-
Use the `stable-4.x` version of the installer to deploy the generally
10-
available stable version of {product-title}:
9+
Use the `stable-4.x` version of the installation program and your selected architecture to deploy the generally available stable version of {product-title}:
1110

12-
[source,terminal,subs="attributes"]
11+
[source,terminal,subs="attributes+"]
1312
----
1413
$ export VERSION=stable-{product-version}
15-
export RELEASE_IMAGE=$(curl -s https://mirror.openshift.com/pub/openshift-v4/clients/ocp/$VERSION/release.txt | grep 'Pull From: quay.io' | awk -F ' ' '{print $3}')
14+
----
15+
[source,terminal,subs="attributes+"]
16+
----
17+
$ export RELEASE_ARCH=<architecture>
18+
----
19+
[source,terminal,subs="attributes+"]
20+
----
21+
$ export RELEASE_IMAGE=$(curl -s https://mirror.openshift.com/pub/openshift-v4/$RELEASE_ARCH/clients/ocp/$VERSION/release.txt | grep 'Pull From: quay.io' | awk -F ' ' '{print $3}')
1622
----

‎modules/ipi-install-troubleshooting-bootstrap-vm-inspecting-logs.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ When experiencing issues downloading or accessing the {op-system} images, first
1010
.Example of internal webserver hosting {op-system} images
1111
[source,yaml]
1212
----
13-
bootstrapOSImage: http://<ip:port>/rhcos-43.81.202001142154.0-qemu.x86_64.qcow2.gz?sha256=9d999f55ff1d44f7ed7c106508e5deecd04dc3c06095d34d36bf1cd127837e0c
14-
clusterOSImage: http://<ip:port>/rhcos-43.81.202001142154.0-openstack.x86_64.qcow2.gz?sha256=a1bda656fa0892f7b936fdc6b6a6086bddaed5dafacedcd7a1e811abb78fe3b0
13+
bootstrapOSImage: http://<ip:port>/rhcos-43.81.202001142154.0-qemu.<architecture>.qcow2.gz?sha256=9d999f55ff1d44f7ed7c106508e5deecd04dc3c06095d34d36bf1cd127837e0c
14+
clusterOSImage: http://<ip:port>/rhcos-43.81.202001142154.0-openstack.<architecture>.qcow2.gz?sha256=a1bda656fa0892f7b936fdc6b6a6086bddaed5dafacedcd7a1e811abb78fe3b0
1515
----
1616

1717
The `ipa-downloader` and `coreos-downloader` containers download resources from a webserver or the external link:https://quay.io[quay.io] registry, whichever the `install-config.yaml` configuration file specifies. Verify the following two containers are up and running and inspect their logs as needed:

‎modules/ipi-install-troubleshooting-install-config.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The `install-config.yaml` configuration file represents all of the nodes that ar
1616
+
1717
[source,terminal]
1818
----
19-
$ curl -s -o /dev/null -I -w "%{http_code}\n" http://webserver.example.com:8080/rhcos-44.81.202004250133-0-qemu.x86_64.qcow2.gz?sha256=7d884b46ee54fe87bbc3893bf2aa99af3b2d31f2e19ab5529c60636fbd0f1ce7
19+
$ curl -s -o /dev/null -I -w "%{http_code}\n" http://webserver.example.com:8080/rhcos-44.81.202004250133-0-qemu.<architecture>.qcow2.gz?sha256=7d884b46ee54fe87bbc3893bf2aa99af3b2d31f2e19ab5529c60636fbd0f1ce7
2020
----
2121
+
2222
If the output is `200`, there is a valid response from the webserver storing the bootstrap VM image.

0 commit comments

Comments
 (0)