Skip to content

Commit 6889ce8

Browse files
authored
Merge pull request #63490 from rohennes/OCPBUGS-12788-bare-metal-style
OCPBUGS-12788: Style fix to general references
2 parents 479f8c4 + 303316e commit 6889ce8

4 files changed

+24
-24
lines changed

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ and the `bmc` parameter for the `install-config.yaml` file.
2626

2727
| `bootstrapExternalStaticIP`
2828
|
29-
| The static IP address for the bootstrap VM. You must set this value when deploying a cluster with static IP addresses when there is no DHCP server on the `baremetal` network.
29+
| The static IP address for the bootstrap VM. You must set this value when deploying a cluster with static IP addresses when there is no DHCP server on the bare-metal network.
3030

3131
| `bootstrapExternalStaticGateway`
3232
|
33-
| The static IP address of the gateway for the bootstrap VM. You must set this value when deploying a cluster with static IP addresses when there is no DHCP server on the `baremetal` network.
33+
| The static IP address of the gateway for the bootstrap VM. You must set this value when deploying a cluster with static IP addresses when there is no DHCP server on the bare-metal network.
3434

3535
| `sshKey`
3636
|
@@ -94,7 +94,7 @@ controlPlane:
9494
|
9595
|Replicas sets the number of control plane (master) nodes included as part of the {product-title} cluster.
9696

97-
a| `provisioningNetworkInterface` | | The name of the network interface on nodes connected to the `provisioning` network. For {product-title} 4.9 and later releases, use the `bootMACAddress` configuration setting to enable Ironic to identify the IP address of the NIC instead of using the `provisioningNetworkInterface` configuration setting to identify the name of the NIC.
97+
a| `provisioningNetworkInterface` | | The name of the network interface on nodes connected to the provisioning network. For {product-title} 4.9 and later releases, use the `bootMACAddress` configuration setting to enable Ironic to identify the IP address of the NIC instead of using the `provisioningNetworkInterface` configuration setting to identify the name of the NIC.
9898

9999

100100
| `defaultMachinePlatform` | | The default configuration used for machine pools without a platform configuration.
@@ -132,27 +132,27 @@ Before {product-title} 4.12, the cluster installation program only accepted an I
132132

133133
|`provisioningDHCPRange`
134134
|`172.22.0.10,172.22.0.100`
135-
|Defines the IP range for nodes on the `provisioning` network.
135+
|Defines the IP range for nodes on the provisioning network.
136136

137137
a|`provisioningNetworkCIDR`
138138
|`172.22.0.0/24`
139-
|The CIDR for the network to use for provisioning. This option is required when not using the default address range on the `provisioning` network.
139+
|The CIDR for the network to use for provisioning. This option is required when not using the default address range on the provisioning network.
140140

141141
|`clusterProvisioningIP`
142142
|The third IP address of the `provisioningNetworkCIDR`.
143-
|The IP address within the cluster where the provisioning services run. Defaults to the third IP address of the `provisioning` subnet. For example, `172.22.0.3`.
143+
|The IP address within the cluster where the provisioning services run. Defaults to the third IP address of the provisioning subnet. For example, `172.22.0.3`.
144144

145145
|`bootstrapProvisioningIP`
146146
|The second IP address of the `provisioningNetworkCIDR`.
147-
|The IP address on the bootstrap VM where the provisioning services run while the installer is deploying the control plane (master) nodes. Defaults to the second IP address of the `provisioning` subnet. For example, `172.22.0.2` or `2620:52:0:1307::2`.
147+
|The IP address on the bootstrap VM where the provisioning services run while the installer is deploying the control plane (master) nodes. Defaults to the second IP address of the provisioning subnet. For example, `172.22.0.2` or `2620:52:0:1307::2`.
148148

149149
| `externalBridge`
150150
| `baremetal`
151-
| The name of the `baremetal` bridge of the hypervisor attached to the `baremetal` network.
151+
| The name of the bare-metal bridge of the hypervisor attached to the bare-metal network.
152152

153153
| `provisioningBridge`
154154
| `provisioning`
155-
| The name of the `provisioning` bridge on the `provisioner` host attached to the `provisioning` network.
155+
| The name of the provisioning bridge on the `provisioner` host attached to the provisioning network.
156156

157157
|`architecture`
158158
|
@@ -169,9 +169,9 @@ a|`provisioningNetworkCIDR`
169169

170170
| `provisioningNetwork`
171171
|
172-
| The `provisioningNetwork` configuration setting determines whether the cluster uses the `provisioning` network. If it does, the configuration setting also determines if the cluster manages the network.
172+
| The `provisioningNetwork` configuration setting determines whether the cluster uses the provisioning network. If it does, the configuration setting also determines if the cluster manages the network.
173173

174-
`Disabled`: Set this parameter to `Disabled` to disable the requirement for a `provisioning` network. When set to `Disabled`, you must only use virtual media based provisioning, or bring up the cluster using the assisted installer. If `Disabled` and using power management, BMCs must be accessible from the `baremetal` network. If `Disabled`, you must provide two IP addresses on the `baremetal` network that are used for the provisioning services.
174+
`Disabled`: Set this parameter to `Disabled` to disable the requirement for a provisioning network. When set to `Disabled`, you must only use virtual media based provisioning, or bring up the cluster using the assisted installer. If `Disabled` and using power management, BMCs must be accessible from the bare-metal network. If `Disabled`, you must provide two IP addresses on the bare-metal network that are used for the provisioning services.
175175

176176
`Managed`: Set this parameter to `Managed`, which is the default, to fully manage the provisioning network, including DHCP, TFTP, and so on.
177177

@@ -217,11 +217,11 @@ The `hosts` parameter is a list of separate bare metal assets used to build the
217217

218218
| `bootMACAddress`
219219
|
220-
a| The MAC address of the NIC that the host uses for the `provisioning` network. Ironic retrieves the IP address using the `bootMACAddress` configuration setting. Then, it binds to the host.
220+
a| The MAC address of the NIC that the host uses for the provisioning network. Ironic retrieves the IP address using the `bootMACAddress` configuration setting. Then, it binds to the host.
221221

222222
[NOTE]
223223
====
224-
You must provide a valid MAC address from the host if you disabled the `provisioning` network.
224+
You must provide a valid MAC address from the host if you disabled the provisioning network.
225225
====
226226

227227
| `networkConfig`

modules/ipi-install-configuring-host-network-interfaces-in-the-install-config.yaml-file.adoc

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

99
Before installation, you can set the `networkConfig` configuration setting in the `install-config.yaml` file to configure host network interfaces using NMState.
1010

11-
The most common use case for this functionality is to specify a static IP address on the `baremetal` network, but you can also configure other networks such as a storage network. This functionality supports other NMState features such as VLAN, VXLAN, bridges, bonds, routes, MTU, and DNS resolver settings.
11+
The most common use case for this functionality is to specify a static IP address on the bare-metal network, but you can also configure other networks such as a storage network. This functionality supports other NMState features such as VLAN, VXLAN, bridges, bonds, routes, MTU, and DNS resolver settings.
1212

13-
.Prequisites
13+
.Prerequisites
1414

1515
* Configure a `PTR` DNS record with a valid hostname for each node with a static IP address.
1616
* Install the NMState CLI (`nmstate`).

modules/ipi-install-configuring-networking.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="configuring-networking_{context}"]
77
= Configuring networking
88

9-
Before installation, you must configure the networking on the provisioner node. Installer-provisioned clusters deploy with a `baremetal` bridge and network, and an optional `provisioning` bridge and network.
9+
Before installation, you must configure the networking on the provisioner node. Installer-provisioned clusters deploy with a bare-metal bridge and network, and an optional provisioning bridge and network.
1010

1111
image::210_OpenShift_Baremetal_IPI_Deployment_updates_0122_1.png[Configure networking]
1212

@@ -17,14 +17,14 @@ You can also configure networking from the web console.
1717

1818
.Procedure
1919

20-
. Export the `baremetal` network NIC name:
20+
. Export the bare-metal network NIC name:
2121
+
2222
[source,terminal]
2323
----
2424
$ export PUB_CONN=<baremetal_nic_name>
2525
----
2626

27-
. Configure the `baremetal` network:
27+
. Configure the bare-metal network:
2828
+
2929
[NOTE]
3030
====
@@ -45,14 +45,14 @@ $ sudo nohup bash -c "
4545
"
4646
----
4747

48-
. Optional: If you are deploying with a `provisioning` network, export the `provisioning` network NIC name:
48+
. Optional: If you are deploying with a provisioning network, export the provisioning network NIC name:
4949
+
5050
[source,terminal]
5151
----
5252
$ export PROV_CONN=<prov_nic_name>
5353
----
5454

55-
. Optional: If you are deploying with a `provisioning` network, configure the `provisioning` network:
55+
. Optional: If you are deploying with a provisioning network, configure the provisioning network:
5656
+
5757
[source,terminal]
5858
----
@@ -71,12 +71,12 @@ $ sudo nohup bash -c "
7171
====
7272
The ssh connection might disconnect after executing these steps.
7373
74-
The IPv6 address can be any address as long as it is not routable via the `baremetal` network.
74+
The IPv6 address can be any address as long as it is not routable via the bare-metal network.
7575
7676
Ensure that UEFI is enabled and UEFI PXE settings are set to the IPv6 protocol when using IPv6 addressing.
7777
====
7878

79-
. Optional: If you are deploying with a `provisioning` network, configure the IPv4 address on the `provisioning` network connection:
79+
. Optional: If you are deploying with a provisioning network, configure the IPv4 address on the provisioning network connection:
8080
+
8181
[source,terminal]
8282
----

modules/ipi-install-configuring-the-install-config-file.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,8 @@ sshKey: '<ssh_pub_key>'
9393
+
9494
--
9595
<1> Scale the worker machines based on the number of worker nodes that are part of the {product-title} cluster. Valid options for the `replicas` value are `0` and integers greater than or equal to `2`. Set the number of replicas to `0` to deploy a three-node cluster, which contains only three control plane machines. A three-node cluster is a smaller, more resource-efficient cluster that can be used for testing, development, and production. You cannot install the cluster with only one worker.
96-
<2> When deploying a cluster with static IP addresses, you must set the `bootstrapExternalStaticIP` configuration setting to specify the static IP address of the bootstrap VM when there is no DHCP server on the `baremetal` network.
97-
<3> When deploying a cluster with static IP addresses, you must set the `bootstrapExternalStaticGateway` configuration setting to specify the gateway IP address for the bootstrap VM when there is no DHCP server on the `baremetal` network.
96+
<2> When deploying a cluster with static IP addresses, you must set the `bootstrapExternalStaticIP` configuration setting to specify the static IP address of the bootstrap VM when there is no DHCP server on the bare-metal network.
97+
<3> When deploying a cluster with static IP addresses, you must set the `bootstrapExternalStaticGateway` configuration setting to specify the gateway IP address for the bootstrap VM when there is no DHCP server on the bare-metal network.
9898
<4> See the BMC addressing sections for more options.
9999
<5> To set the path to the installation disk drive, enter the kernel name of the disk. For example, `/dev/sda`.
100100
+

0 commit comments

Comments
 (0)