Skip to content

Commit 14dc0af

Browse files
committed
HCIDOCS-699: Raised postinstallation configuration and expanding the cluster to same level as UPI/IPI, since the procedures are not exclusive to IPI..
1 parent 0b0a193 commit 14dc0af

16 files changed

+77
-81
lines changed

_topic_maps/_topic_map.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -469,10 +469,10 @@ Topics:
469469
File: ipi-install-installing-a-cluster
470470
- Name: Troubleshooting the installation
471471
File: ipi-install-troubleshooting
472-
- Name: Postinstallation configuration
473-
File: ipi-install-post-installation-configuration
474-
- Name: Expanding the cluster
475-
File: ipi-install-expanding-the-cluster
472+
- Name: Postinstallation configuration
473+
File: bare-metal-postinstallation-configuration
474+
- Name: Expanding the cluster
475+
File: bare-metal-expanding-the-cluster
476476
- Name: Installing IBM Cloud Bare Metal (Classic)
477477
Dir: installing_ibm_cloud_classic
478478
Distros: openshift-origin,openshift-enterprise

backup_and_restore/control_plane_backup_and_restore/disaster_recovery/quorum-restoration.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ include::modules/dr-restoring-etcd-quorum-ha.adoc[leveloffset=+1]
1616
== Additional resources
1717

1818
* xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installing-bare-metal[Installing a user-provisioned cluster on bare metal]
19-
* xref:../../../installing/installing_bare_metal/ipi/ipi-install-expanding-the-cluster.adoc#replacing-a-bare-metal-control-plane-node_ipi-install-expanding[Replacing a bare-metal control plane node]
19+
* xref:../../../installing/installing_bare_metal/bare-metal-expanding-the-cluster.adoc#replacing-a-bare-metal-control-plane-node_bare-metal-expanding[Replacing a bare-metal control plane node]

backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-2-restoring-cluster-state.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,6 @@ include::modules/manually-restoring-cluster-etcd-backup.adoc[leveloffset=+1]
3030

3131
* xref:../../../networking/accessing-hosts.adoc#accessing-hosts[Creating a bastion host to access {product-title} instances and the control plane nodes with SSH]
3232

33-
* xref:../../../installing/installing_bare_metal/ipi/ipi-install-expanding-the-cluster.adoc#replacing-a-bare-metal-control-plane-node_ipi-install-expanding[Replacing a bare-metal control plane node]
33+
* xref:../../../installing/installing_bare_metal/bare-metal-expanding-the-cluster.adoc#replacing-a-bare-metal-control-plane-node_bare-metal-expanding[Replacing a bare-metal control plane node]
3434

3535
include::modules/dr-scenario-cluster-state-issues.adoc[leveloffset=+1]

edge_computing/image_base_install/ibi_deploying_sno_clusters/ibi-edge-image-based-install.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ include::modules/ibi-extra-manifests-configmap.adoc[leveloffset=+1]
5454
[role="_additional-resources"]
5555
.Additional resources
5656

57-
* xref:../../../installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc#bmo-about-the-baremetalhost-resource_ipi-install-post-installation-configuration[About the BareMetalHost resource]
57+
* xref:../../../installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc#bmo-about-the-baremetalhost-resource_bare-metal-postinstallation-configuration[About the BareMetalHost resource]
5858
5959
* xref:../../../openshift_images/managing_images/using-image-pull-secrets.adoc[Using image pull secrets]
6060
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
[id="bare-metal-expanding-the-cluster"]
3+
= Expanding the cluster
4+
include::_attributes/common-attributes.adoc[]
5+
:context: bare-metal-expanding
6+
7+
toc::[]
8+
9+
After deploying a bare-metal cluster, you can use the following procedures to expand the number of worker nodes. Ensure that each prospective worker node meets the prerequisites.
10+
11+
[NOTE]
12+
====
13+
Expanding the cluster using RedFish Virtual Media involves meeting minimum firmware requirements. See *Firmware requirements for installing with virtual media* in the *Prerequisites* section for additional details when expanding the cluster using RedFish Virtual Media.
14+
====
15+
16+
include::modules/ipi-install-preparing-the-bare-metal-node.adoc[leveloffset=+1]
17+
18+
[role="_additional-resources"]
19+
.Additional resources
20+
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.
23+
24+
include::modules/ipi-install-replacing-a-bare-metal-control-plane-node.adoc[leveloffset=+1]
25+
26+
[role="_additional-resources"]
27+
.Additional resources
28+
29+
* xref:../../backup_and_restore/control_plane_backup_and_restore/replacing-unhealthy-etcd-member.adoc#replacing-the-unhealthy-etcd-member[Replacing an unhealthy etcd member]
30+
31+
* xref:../../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backing-up-etcd-data_backup-etcd[Backing up etcd]
32+
33+
* xref:../../installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc#bmo-config-using-bare-metal-operator_bare-metal-postinstallation-configuration[Configuration using the Bare Metal Operator]
34+
35+
* xref:../../installing/installing_bare_metal/ipi/ipi-install-installation-workflow.adoc#bmc-addressing_ipi-install-installation-workflow[BMC addressing]
36+
37+
include::modules/ipi-install-preparing-to-deploy-with-virtual-media-on-the-baremetal-network.adoc[leveloffset=+1]
38+
39+
include::modules/ipi-install-diagnosing-duplicate-mac-address.adoc[leveloffset=+1]
40+
41+
include::modules/ipi-install-provisioning-the-bare-metal-node.adoc[leveloffset=+1]

installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc renamed to installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
:_mod-docs-content-type: ASSEMBLY
2-
[id="ipi-install-post-installation-configuration"]
3-
= Installer-provisioned postinstallation configuration
2+
[id="bare-metal-post-installation-configuration"]
3+
= Postinstallation configuration
44
include::_attributes/common-attributes.adoc[]
5-
:context: ipi-install-post-installation-configuration
5+
:context: bare-metal-postinstallation-configuration
66

77
toc::[]
88

9-
After successfully deploying an installer-provisioned cluster, consider the following postinstallation procedures.
9+
After successfully deploying a bare-metal cluster, consider the following postinstallation procedures.
1010

1111
// Configuring NTP for disconnected clusters
1212
include::modules/ipi-install-configuring-ntp-for-disconnected-clusters.adoc[leveloffset=+1]
@@ -39,11 +39,6 @@ include::modules/bmo-troubleshooting-latency-when-deleting-a-baremetalhost-resou
3939
include::modules/bmo-attaching-a-non-bootable-iso-to-a-bare-metal-node.adoc[leveloffset=+2]
4040
// Configuring NC-SI and DisablePowerOff for shared NICs
4141
include::modules/bmo-configuring-ncsi-disable-poweroff.adoc[leveloffset=+2]
42-
[role="_additional-resources"]
43-
.Additional resources
44-
45-
* xref:../../../installing/installing_bare_metal/ipi/ipi-install-installation-workflow.adoc#bmc-addressing_ipi-install-installation-workflow[BMC addressing]
46-
4742
// About the HostFirmwareSettings resource
4843
include::modules/bmo-about-the-hostfirmwaresettings-resource.adoc[leveloffset=+2]
4944
// Getting the HostFirmwareSettings resource

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

Lines changed: 0 additions & 41 deletions
This file was deleted.

installing/installing_bare_metal/ipi/ipi-install-installation-workflow.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ include::modules/ipi-install-bmc-addressing.adoc[leveloffset=+2]
7373
[role="_additional-resources"]
7474
.Additional resources
7575

76-
* xref:../../../installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc#bmo-editing-a-baremetalhost-resource_ipi-install-post-installation-configuration[Editing a BareMetalHost resource]
76+
* xref:../../../installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc#bmo-editing-a-baremetalhost-resource_bare-metal-postinstallation-configuration[Editing a BareMetalHost resource]
7777

7878
// Verifying support for the Redfish API
7979
include::modules/ipi-install-verifying-support-for-redfish-apis.adoc[leveloffset=+2]
@@ -147,7 +147,7 @@ include::modules/ipi-install-configuring-the-bios.adoc[leveloffset=+2]
147147
[id="additional-resources_bare_metal_config"]
148148
.Additional resources
149149

150-
* xref:../../../installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc#bmo-config-using-bare-metal-operator_ipi-install-post-installation-configuration[Configuration using the Bare Metal Operator]
150+
* xref:../../../installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc#bmo-config-using-bare-metal-operator_bare-metal-postinstallation-configuration[Configuration using the Bare Metal Operator]
151151

152152
// Optional: Configuring the RAID
153153
include::modules/ipi-install-configuring-the-raid.adoc[leveloffset=+2]
@@ -159,7 +159,7 @@ include::modules/ipi-install-configuring-storage-on-nodes.adoc[leveloffset=+2]
159159
[id="additional-resources_raid_config"]
160160
.Additional resources
161161

162-
* xref:../../../installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc#bmo-config-using-bare-metal-operator_ipi-install-post-installation-configuration[Configuration using the Bare Metal Operator]
162+
* xref:../../../installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc#bmo-config-using-bare-metal-operator_bare-metal-postinstallation-configuration[Configuration using the Bare Metal Operator]
163163

164164
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html-single/managing_storage_devices/index#partition-naming-scheme_disk-partitions[Partition naming scheme]
165165

installing/installing_bare_metal/upi/scaling-a-user-provisioned-cluster-with-the-bare-metal-operator.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ include::modules/upi-provisioning-new-hosts-in-a-upi-cluster.adoc[leveloffset=+1
1717
[role="_additional-resources"]
1818
.Additional resources
1919

20-
* xref:../../../installing/installing_bare_metal/ipi/ipi-install-expanding-the-cluster.adoc#preparing-the-bare-metal-node_ipi-install-expanding[Preparing the bare-metal node]
20+
* xref:../../../installing/installing_bare_metal/bare-metal-expanding-the-cluster.adoc#preparing-the-bare-metal-node_bare-metal-expanding[Preparing the bare-metal node]
2121
2222
* xref:../../../installing/installing_bare_metal/ipi/ipi-install-installation-workflow.adoc#root-device-hints_ipi-install-installation-workflow[Root device hints]
2323
24-
* xref:../../../installing/installing_bare_metal/ipi/ipi-install-expanding-the-cluster.adoc#ipi-install-diagnosing-duplicate-mac-address_ipi-install-expanding[Diagnosing a duplicate MAC address when provisioning a new host in the cluster]
24+
* xref:../../../installing/installing_bare_metal/bare-metal-expanding-the-cluster.adoc#ipi-install-diagnosing-duplicate-mac-address_bare-metal-expanding[Diagnosing a duplicate MAC address when provisioning a new host in the cluster]
2525
2626
// Managing existing hosts in a user-provisioned cluster by using the BMO
2727
include::modules/upi-managing-existing-hosts-in-a-upi-cluster.adoc[leveloffset=+1]

installing/overview/cluster-capabilities.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ include::modules/cluster-bare-metal-operator.adoc[leveloffset=+2]
3434
.Additional resources
3535
* xref:../../installing/installing_bare_metal/ipi/ipi-install-overview.adoc#ipi-install-overview[Deploying installer-provisioned clusters on bare metal]
3636
* xref:../../installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc#preparing-to-install-on-bare-metal[Preparing for bare metal cluster installation]
37-
* xref:../../installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc#bmo-config-using-bare-metal-operator_ipi-install-post-installation-configuration[Configuration using the Bare Metal Operator]
37+
* xref:../../installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc#bmo-config-using-bare-metal-operator_bare-metal-postinstallation-configuration[Configuration using the Bare Metal Operator]
3838
3939
// Build capability
4040
include::modules/build-config-capability.adoc[leveloffset=+2]

installing/overview/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ include::modules/ipi-verifying-nodes-after-installation.adoc[leveloffset=+2]
2626
[role="_additional-resources"]
2727
.Additional resources
2828

29-
* xref:../../installing/installing_bare_metal/ipi/ipi-install-post-installation-configuration.adoc#bmo-getting-the-baremetalhost-resource_ipi-install-post-installation-configuration[Getting the BareMetalHost resource]
29+
* xref:../../installing/installing_bare_metal/bare-metal-postinstallation-configuration.adoc#bmo-getting-the-baremetalhost-resource_bare-metal-postinstallation-configuration[Getting the BareMetalHost resource]
3030
3131
* xref:../../installing/installing_bare_metal/ipi/ipi-install-installing-a-cluster.adoc#ipi-install-following-the-progress-of-the-installation_ipi-install-installing-a-cluster[Following the progress of the installation]
3232

modules/ipi-install-replacing-a-bare-metal-control-plane-node.adoc

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
// This is included in the following assemblies:
22
//
3-
// installing/installing_bare_metal/ipi/ipi-install-expanding-the-cluster.adoc
3+
// installing/installing_bare_metal/bare-metal-expanding-the-cluster.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="replacing-a-bare-metal-control-plane-node_{context}"]
77
= Replacing a bare-metal control plane node
88

9-
Use the following procedure to replace an installer-provisioned {product-title} control plane node.
9+
Use the following procedure to replace a {product-title} control plane node.
1010

1111
[IMPORTANT]
1212
====
1313
If you reuse the `BareMetalHost` object definition from an existing control plane host, do not leave the `externallyProvisioned` field set to `true`.
1414
15-
Existing control plane `BareMetalHost` objects may have the `externallyProvisioned` flag set to `true` if they were provisioned by the {product-title} installation program.
15+
Existing control plane `BareMetalHost` objects might have the `externallyProvisioned` flag set to `true` if they were provisioned by the {product-title} installation program.
1616
====
1717

1818
.Prerequisites
@@ -39,7 +39,7 @@ $ oc get clusteroperator baremetal
3939
[source,terminal,subs="attributes+"]
4040
----
4141
NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE MESSAGE
42-
baremetal {product-version} True False False 3d15h
42+
baremetal {product-version} True False False 3d15h
4343
----
4444

4545
. Remove the old `BareMetalHost` and `Machine` objects:
@@ -85,11 +85,11 @@ spec:
8585
online: true
8686
EOF
8787
----
88-
<1> Replace `<num>` for the control plane number of the bare metal node in the `name` fields and the `credentialsName` field.
88+
<1> Replace `<num>` for the control plane number of the bare-metal node in the `name` fields and the `credentialsName` field.
8989
<2> Replace `<base64_of_uid>` with the `base64` string of the user name.
9090
<3> Replace `<base64_of_pwd>` with the `base64` string of the password.
91-
<4> Replace `<protocol>` with the BMC protocol, such as `redfish`, `redfish-virtualmedia`, `idrac-virtualmedia`, or others. Replace `<bmc_ip>` with the IP address of the bare metal node's baseboard management controller. For additional BMC configuration options, see "BMC addressing" in the _Additional resources_ section.
92-
<5> Replace `<NIC1_mac_address>` with the MAC address of the bare metal node's first NIC.
91+
<4> Replace `<protocol>` with the BMC protocol, such as `redfish`, `redfish-virtualmedia`, `idrac-virtualmedia`, or others. Replace `<bmc_ip>` with the IP address of the bare-metal node's baseboard management controller. For additional BMC configuration options, see "BMC addressing" in the _Additional resources_ section.
92+
<5> Replace `<NIC1_mac_address>` with the MAC address of the bare-metal node's first NIC.
9393
+
9494
After the inspection is complete, the `BareMetalHost` object is created and available to be provisioned.
9595

@@ -122,12 +122,12 @@ apiVersion: machine.openshift.io/v1beta1
122122
kind: Machine
123123
metadata:
124124
annotations:
125-
metal3.io/BareMetalHost: openshift-machine-api/control-plane-<num> <1>
125+
metal3.io/BareMetalHost: openshift-machine-api/control-plane-<num>
126126
labels:
127-
machine.openshift.io/cluster-api-cluster: control-plane-<num> <1>
127+
machine.openshift.io/cluster-api-cluster: control-plane-<num>
128128
machine.openshift.io/cluster-api-machine-role: master
129129
machine.openshift.io/cluster-api-machine-type: master
130-
name: control-plane-<num> <1>
130+
name: control-plane-<num>
131131
namespace: openshift-machine-api
132132
spec:
133133
metadata: {}
@@ -147,7 +147,8 @@ spec:
147147
name: master-user-data-managed
148148
EOF
149149
----
150-
<1> Replace `<num>` for the control plane number of the bare metal node in the `name`, `labels` and `annotations` fields.
150+
+
151+
Replace `<num>` with the control plane number of the bare-metal node in the `annotations`, `labels` and `name` fields.
151152
+
152153
. To view the `BareMetalHost` objects, run the following command:
153154
+

modules/nw-enabling-a-provisioning-network-after-installation.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
// This is included in the following assemblies:
22
//
3-
// ipi-install-post-installation-configuration.adoc
3+
// bare-metal-postinstallation-configuration.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="enabling-a-provisioning-network-after-installation_{context}"]
77

88
= Enabling a provisioning network after installation
99

10-
The assisted installer and installer-provisioned installation for bare metal clusters provide the ability to deploy a cluster without a `provisioning` network. This capability is for scenarios such as proof-of-concept clusters or deploying exclusively with Redfish virtual media when each node's baseboard management controller is routable via the `baremetal` network.
10+
The {ai-full} and installer-provisioned installation for bare-metal clusters provide the ability to deploy a cluster without a `provisioning` network. This capability is for scenarios such as proof-of-concept clusters or deploying exclusively with Redfish virtual media when each node's baseboard management controller is routable via the `baremetal` network.
1111

1212
You can enable a `provisioning` network after installation using the Cluster Baremetal Operator (CBO).
1313

0 commit comments

Comments
 (0)