Skip to content

Commit 1e39f10

Browse files
authored
Merge pull request #49836 from johnwilkins/TELCODOCS-321-prep-node2
2 parents 2f54d96 + 19a6b0a commit 1e39f10

File tree

2 files changed

+61
-47
lines changed

2 files changed

+61
-47
lines changed

installing/installing_bare_metal_ipi/ipi-install-expanding-the-cluster.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,10 @@ Expanding the cluster using RedFish Virtual Media involves meeting minimum firmw
1616
include::modules/ipi-install-preparing-the-bare-metal-node.adoc[leveloffset=+1]
1717

1818
[role="_additional-resources"]
19-
[id="additional-resources_ipi-install-expanding"]
2019
.Additional resources
2120

22-
* xref:../../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#configuring-host-network-interfaces-in-the-install-config-yaml-file_ipi-install-installation-workflow[(Optional) Configuring host network interfaces in the install-config.yaml file]
23-
* xref:../../scalability_and_performance/managing-bare-metal-hosts.adoc#automatically-scaling-machines-to-available-bare-metal-hosts_managing-bare-metal-hosts[Automatically scaling machines to the number of available bare metal hosts]
21+
* See xref:../../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#configuring-host-network-interfaces-in-the-install-config-yaml-file_ipi-install-installation-workflow[Optional: Configuring host network interfaces in the install-config.yaml file] for details on configuring the NMState syntax.
22+
* See xref:../../scalability_and_performance/managing-bare-metal-hosts.adoc#automatically-scaling-machines-to-available-bare-metal-hosts_managing-bare-metal-hosts[Automatically scaling machines to the number of available bare metal hosts] for details on automatically scaling machines.
2423
2524
include::modules/ipi-install-replacing-a-bare-metal-control-plane-node.adoc[leveloffset=+1]
2625

modules/ipi-install-preparing-the-bare-metal-node.adoc

Lines changed: 59 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ Expanding the cluster requires a DHCP server. Each node must have a DHCP reserva
1111
[IMPORTANT]
1212
.Reserving IP addresses so they become static IP addresses
1313
====
14-
Some administrators prefer to use static IP addresses so that each node's IP address remains constant in the absence of a DHCP server. To configure static IP addresses with NMState, see "(Optional) Configuring host network interfaces in the `install-config.yaml` file" in the "Setting up the environment for an OpenShift installation" section for additional details.
14+
Some administrators prefer to use static IP addresses so that each node's IP address remains constant in the absence of a DHCP server. To configure static IP addresses with NMState, see "Optional: Configuring host network interfaces in the `install-config.yaml` file" in the "Setting up the environment for an OpenShift installation" section for additional details.
1515
====
1616

1717
Preparing the bare metal node requires executing the following procedure from the provisioner node.
1818

1919
.Procedure
2020

21-
. Get the `oc` binary, if needed. It should already exist on the provisioner node.
21+
. Get the `oc` binary:
2222
+
2323
[source,terminal]
2424
----
@@ -44,7 +44,7 @@ $ echo -ne "root" | base64
4444
$ echo -ne "password" | base64
4545
----
4646

47-
. Create a configuration file for the bare metal node.
47+
. Create a configuration file for the bare metal node using the following example `bmh.yaml` file, replacing values in the YAML to match your environment:
4848
+
4949
[source,terminal]
5050
----
@@ -53,75 +53,90 @@ $ vim bmh.yaml
5353
+
5454
[source,yaml]
5555
----
56-
apiVersion: v1
56+
---
57+
apiVersion: v1 <1>
5758
kind: Secret
5859
metadata:
59-
name: openshift-worker-<num>-network-config-secret <1> <2>
60+
name: openshift-worker-<num>-network-config-secret <2>
6061
type: Opaque
6162
stringData:
6263
nmstate: |
63-
routes:
64-
config:
65-
- destination: 0.0.0.0/0
66-
next-hop-address: 192.168.123.1
67-
next-hop-interface: enp0s4
68-
dns-resolver:
69-
config:
70-
server:
71-
- 192.168.123.1
72-
interfaces:
73-
- name: enp0s4
74-
state: up
75-
ipv4:
76-
address:
77-
- ip: 192.168.123.16
78-
prefix-length: 24
79-
enabled: true
80-
dhcp: false
64+
routes:
65+
config:
66+
- destination: 0.0.0.0/0
67+
next-hop-address: <next_hop_address>
68+
next-hop-interface: <next_hop_interface>
69+
dns-resolver:
70+
config:
71+
server:
72+
- <dns_server_ip_address>
73+
interfaces:
74+
- name: <nic_interface>
75+
state: up
76+
ipv4:
77+
address:
78+
- ip: <ip_address>
79+
prefix-length: <cidr>
80+
enabled: true
81+
dhcp: false
8182
---
8283
apiVersion: v1
8384
kind: Secret
8485
metadata:
85-
name: openshift-worker-<num>-bmc-secret <2>
86+
name: openshift-worker-<num>-bmc-secret <2>
8687
namespace: openshift-machine-api
8788
type: Opaque
8889
data:
89-
username: <base64-of-uid> <3>
90-
password: <base64-of-pwd> <4>
90+
username: <base64_of_uid> <3>
91+
password: <base64_of_pwd> <4>
9192
---
9293
apiVersion: metal3.io/v1alpha1
9394
kind: BareMetalHost
9495
metadata:
9596
name: openshift-worker-<num> <2>
9697
namespace: openshift-machine-api
9798
spec:
98-
online: true
99-
bootMACAddress: <NIC1-mac-address> <5>
99+
online: True
100+
bootMACAddress: <nic1_mac_address> <5>
100101
bmc:
101-
address: <protocol>://<bmc-ip> <6>
102+
address: <protocol>://<bmc_url> <6>
102103
credentialsName: openshift-worker-<num>-bmc-secret <2>
103-
disableCertificateVerification: true <7>
104-
username: <bmc-username> <8>
105-
password: <bmc-password> <9>
106-
preprovisioningNetworkDataName: openshift-worker-<num>-network-config-secret <10> <2>
104+
disableCertificateVerification: True <7>
105+
username: <bmc_username> <8>
106+
password: <bmc_password> <9>
107+
rootDeviceHints:
108+
deviceName: <root_device_hint> <10>
109+
preprovisioningNetworkDataName: openshift-worker-<num>-network-config-secret <11>
107110
----
108-
<1> Optional: To configure network for a newly created node, specify the name of the secret that contains the network configuration. Follow the `nmstate` syntax to define the network configuration for your node.
111+
+
112+
<1> Optional: To configure the network interface for a newly created node, specify the name of the secret that contains the network configuration. Follow the `nmstate` syntax to define the network configuration for your node. See "Optional: Configuring host network interfaces in the install-config.yaml file" for details on configuring NMState syntax.
113+
+
109114
<2> Replace `<num>` for the worker number of the bare metal node in the `name` fields, the `credentialsName` field, and the `preprovisioningNetworkDataName` field.
110-
<3> Replace `<base64-of-uid>` with the `base64` string of the user name.
111-
<4> Replace `<base64-of-pwd>` with the `base64` string of the password.
112-
<5> Replace `<NIC1-mac-address>` with the MAC address of the bare metal node's first NIC. See the "BMC addressing" section for additional BMC configuration options.
113-
<6> Replace `<protocol>` with the BMC protocol, such as IPMI, RedFish, or others. Replace `<bmc-ip>` with the IP address of the bare metal node's baseboard management controller.
114-
<7> To skip certificate validation, set `disableCertificateVerification` to `true`.
115-
<8> Replace `<bmc-username>` with the `bmc` string of the user name.
116-
<9> Replace `<bmc-password>` with the `bmc` string of the password.
117-
<10> Optional: Provide the network configuration secret name in the `preprovisioningNetworkDataName` of the `BareMetalHost` CR if you have configured network for the newly created node.
115+
+
116+
<3> Replace `<base64_of_uid>` with the base64 string of the user name.
117+
+
118+
<4> Replace `<base64_of_pwd>` with the base64 string of the password.
119+
+
120+
<5> Replace `<nic1_mac_address>` with the MAC address of the bare metal node's first NIC. See the "BMC addressing" section for additional BMC configuration options.
121+
+
122+
<6> Replace `<protocol>` with the BMC protocol, such as IPMI, RedFish, or others. Replace `<bmc_url>` with the URL of the bare metal node's baseboard management controller.
123+
+
124+
<7> To skip certificate validation, set `disableCertificateVerification` to true.
125+
+
126+
<8> Replace `<bmc_username>` with the string of the BMC user name.
127+
+
128+
<9> Replace `<bmc_password>` with the string of the BMC password.
129+
+
130+
<10> Optional: Replace `<root_device_hint>` with a device path if you specify a root device hint.
131+
+
132+
<11> Optional: If you have configured the network interface for the newly created node, provide the network configuration secret name in the `preprovisioningNetworkDataName` of the BareMetalHost CR.
118133
+
119134
[NOTE]
120135
====
121136
If the MAC address of an existing bare metal node matches the MAC address of a bare metal host that you are attempting to provision, then the Ironic installation will fail. If the host enrollment, inspection, cleaning, or other Ironic steps fail, the Bare Metal Operator retries the installation continuously. See "Diagnosing a host duplicate MAC address" for more information.
122137
====
123138

124-
. Create the bare metal node.
139+
. Create the bare metal node:
125140
+
126141
[source,terminal]
127142
----
@@ -138,7 +153,7 @@ baremetalhost.metal3.io/openshift-worker-<num> created
138153
+
139154
Where `<num>` will be the worker number.
140155

141-
. Power up and inspect the bare metal node.
156+
. Power up and inspect the bare metal node:
142157
+
143158
[source,terminal]
144159
----

0 commit comments

Comments
 (0)