Skip to content

Commit a02ba4f

Browse files
authored
Merge pull request #49290 from tmulquee/BZ1979956
BZ1979956: review terminology of provisioning
2 parents 623b063 + cca2856 commit a02ba4f

8 files changed

+30
-24
lines changed
-6.22 KB
Loading
-3.84 KB
Loading

installing/installing_bare_metal_ipi/ipi-install-overview.adoc

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,25 @@
44
include::_attributes/common-attributes.adoc[]
55
:context: ipi-install
66

7-
Installer-provisioned installation provides support for installing {product-title} on bare metal nodes. This guide provides a methodology to achieving a successful installation.
8-
9-
During installer-provisioned installation on bare metal, the installation program on the bare metal node labeled as `provisioner` creates a bootstrap virtual machine (VM). The role of the bootstrap VM is to assist in the process of deploying an {product-title} cluster. The bootstrap VM connects to the `baremetal` network and to the `provisioning` network, if present, via the network bridges.
7+
Installer-provisioned installation on bare metal nodes deploys and configures the infrastructure that a {product-title} cluster runs on. This guide provides a methodology to achieving a successful installer-provisioned bare-metal installation. The following diagram illustrates the installation environment in phase 1 of deployment.
108

119
image::210_OpenShift_Baremetal_IPI_Deployment_updates_0122_1.png[Deployment phase one]
1210

13-
The provisioning node can be removed after the installation.
11+
For the installation, the key elements in the previous diagram are:
12+
13+
- **Provisioner**: A physical machine that runs the installation program and hosts the bootstrap VM that deploys the controller of a new {product-title} cluster.
14+
- **Bootstrap VM**: A virtual machine that assists in the process of deploying an {product-title} cluster.
15+
- **Network bridges**: The bootstrap VM connects to the bare-metal network and to the provisioning network, if present, via network bridges, `eno1` and `eno2`.
16+
17+
In phase 2 of the deployment, the provisioner destroys the bootstrap VM automatically and moves the virtual IP addresses (VIPs) to the appropriate nodes. The API VIP moves to the control plane nodes and the Ingress VIP moves to the worker nodes.
1418

15-
When the installation of {product-title} is complete and fully operational, the installation program destroys the bootstrap VM automatically and moves the virtual IP addresses (VIPs) to the appropriate nodes accordingly. The API VIP moves to the control plane nodes and the Ingress VIP moves to the worker nodes.
19+
The following diagram illustrates phase 2 of deployment.
1620

1721
image::210_OpenShift_Baremetal_IPI_Deployment_updates_0122_2.png[Deployment phase two]
1822

23+
After this point, the node used by the provisioner can be removed or repurposed. From here, all additional provisioning tasks are carried out by controllers.
24+
1925
[IMPORTANT]
2026
====
21-
The `provisioning` network is optional, but it is required for PXE booting. If you deploy without a `provisioning` network, you must use a virtual media BMC addressing option such as `redfish-virtualmedia` or `idrac-virtualmedia`.
22-
====
27+
The provisioning network is optional, but it is required for PXE booting. If you deploy without a provisioning network, you must use a virtual media baseboard management controller (BMC) addressing option such as `redfish-virtualmedia` or `idrac-virtualmedia`.
28+
====

installing/installing_bare_metal_ipi/ipi-install-prerequisites.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ toc::[]
88

99
Installer-provisioned installation of {product-title} requires:
1010

11-
ifdef::openshift-origin[. One provisioner node with {op-system-first} installed. The provisioning node can be removed after installation.]
12-
ifndef::openshift-origin[. One provisioner node with {op-system-base-full} 8.x installed. The provisioning node can be removed after installation.]
13-
. Three control plane nodes.
14-
. Baseboard management controller (BMC) access to each node.
11+
ifdef::openshift-origin[. One provisioner node with {op-system-first} installed. The provisioner can be removed after installation.]
12+
ifndef::openshift-origin[. One provisioner node with {op-system-base-full} 8.x installed. The provisioner can be removed after installation.]
13+
. Three control plane nodes
14+
. Baseboard management controller (BMC) access to each node
1515
. At least one network:
1616
.. One required routable network
17-
.. One optional network for provisioning nodes; and,
18-
.. One optional management network.
17+
.. One optional provisioning network
18+
.. One optional management network
1919

2020
Before starting an installer-provisioned installation of {product-title}, ensure the hardware environment meets the following requirements.
2121

installing/installing_ibm_cloud/install-ibm-cloud-prerequisites.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ You can use installer-provisioned installation to install {product-title} on IBM
1010

1111
[IMPORTANT]
1212
====
13-
Red Hat supports IPMI and PXE on the `provisioning` network only. Red Hat has not tested Red Fish, virtual media, or other complementary technologies such as Secure Boot on IBM Cloud deployments. The `provisioning` network is required.
13+
Red Hat supports IPMI and PXE on the provisioning network only. Red Hat has not tested Red Fish, virtual media, or other complementary technologies such as Secure Boot on IBM Cloud deployments. A provisioning network is required.
1414
====
1515

1616
Installer-provisioned installation of {product-title} requires:
1717

18-
* One provisioner node with {op-system-first} 8.x installed
18+
* One node with {op-system-first} 8.x installed, for running the provisioner
1919
* Three control plane nodes
2020
* One routable network
21-
* One network for provisioning nodes
21+
* One provisioning network
2222
2323
Before starting an installer-provisioned installation of {product-title} on IBM Cloud, address the following prerequisites and requirements.
2424

modules/ipi-install-network-requirements.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,4 +161,4 @@ You can reconfigure the control plane nodes to act as NTP servers on disconnecte
161161
[id='network-requirements-out-of-band_{context}']
162162
== Port access for the out-of-band management IP address
163163

164-
The out-of-band management IP address is on a separate network from the node. To ensure that the out-of-band management can communicate with the provisioning node during installation, the out-of-band management IP address must be granted access to port `80` on the bootstrap host and port `6180` on the {product-title} control plane hosts.
164+
The out-of-band management IP address is on a separate network from the node. To ensure that the out-of-band management can communicate with the provisioner during installation, the out-of-band management IP address must be granted access to port `80` on the bootstrap host and port `6180` on the {product-title} control plane hosts.

modules/ipi-install-troubleshooting-bootstrap-vm.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,13 +94,13 @@ $ ssh [email protected]
9494

9595
If you are not successful logging in to the bootstrap VM, you have likely encountered one of the following scenarios:
9696

97-
* You cannot reach the `172.22.0.0/24` network. Verify network connectivity on the provisioner host specifically around the `provisioning` network bridge. This will not be the issue if you are not using the `provisioning` network.
98-
97+
* You cannot reach the `172.22.0.0/24` network. Verify the network connectivity between the provisioner and the `provisioning` network bridge. This issue may occur if you are using a `provisioning` network.
98+
`
9999
* You cannot reach the bootstrap VM through the public network. When attempting
100100
to SSH via `baremetal` network, verify connectivity on the
101101
`provisioner` host specifically around the `baremetal` network bridge.
102102

103103
* You encountered `Permission denied (publickey,password,keyboard-interactive)`. When
104104
attempting to access the bootstrap VM, a `Permission denied` error
105105
might occur. Verify that the SSH key for the user attempting to log
106-
into the VM is set within the `install-config.yaml` file.
106+
in to the VM is set within the `install-config.yaml` file.

modules/ipi-verifying-nodes-after-installation.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
[role="_abstract"]
1010
The {product-title} installation completes when the following installation health checks are successful:
1111

12-
* The provisioning host can access the {product-title} web console.
12+
* The provisioner can access the {product-title} web console.
1313
1414
* All control plane nodes are ready.
1515
@@ -18,9 +18,9 @@ The {product-title} installation completes when the following installation healt
1818
[NOTE]
1919
====
2020
After the installation completes, the specific cluster Operators responsible for the worker nodes continuously attempt to provision all worker nodes. It can take some time before all worker nodes report as `READY`. For installations on bare metal, wait a minimum of 60 minutes before troubleshooting a worker node. For installations on all other platforms, wait a minimum of 40 minutes before troubleshooting a worker node. A `DEGRADED` state for the cluster Operators responsible for the worker nodes depends on the Operators' own resources and not on the state of the nodes.
21-
====
21+
====
2222

23-
After your installation completes, you can continue to monitor the condition of the nodes in your cluster using the following steps.
23+
After your installation completes, you can continue to monitor the condition of the nodes in your cluster by using the following steps.
2424

2525
.Prerequisites
2626
* The installation program resolves successfully in the terminal.
@@ -67,4 +67,4 @@ openshift-machine-api example-zbbt6-worker-0-25bhp Running
6767
openshift-machine-api example-zbbt6-worker-0-8b4c2 Running 49m
6868
openshift-machine-api example-zbbt6-worker-0-jkbqt Running 49m
6969
openshift-machine-api example-zbbt6-worker-0-qrl5b Running 49m
70-
----
70+
----

0 commit comments

Comments
 (0)