Skip to content

HCIDOCS-699: Missing documentation for BMO configuration #92567

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -465,10 +465,10 @@ Topics:
File: ipi-install-installing-a-cluster
- Name: Troubleshooting the installation
File: ipi-install-troubleshooting
- Name: Postinstallation configuration
File: ipi-install-post-installation-configuration
- Name: Expanding the cluster
File: ipi-install-expanding-the-cluster
- Name: Postinstallation configuration
File: bare-metal-postinstallation-configuration
- Name: Expanding the cluster
File: bare-metal-expanding-the-cluster
- Name: Installing IBM Cloud Bare Metal (Classic)
Dir: installing_ibm_cloud_classic
Distros: openshift-origin,openshift-enterprise
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
:_mod-docs-content-type: ASSEMBLY
[id="bare-metal-expanding-the-cluster"]
= Expanding the cluster
include::_attributes/common-attributes.adoc[]
:context: bare-metal-expanding

toc::[]

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.

[NOTE]
====
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.
====

include::modules/ipi-install-preparing-the-bare-metal-node.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* 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.
* 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.

include::modules/ipi-install-replacing-a-bare-metal-control-plane-node.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* xref:../../backup_and_restore/control_plane_backup_and_restore/replacing-unhealthy-etcd-member.adoc#replacing-the-unhealthy-etcd-member[Replacing an unhealthy etcd member]

* xref:../../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backing-up-etcd-data_backup-etcd[Backing up etcd]

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

* xref:../../installing/installing_bare_metal/ipi/ipi-install-installation-workflow.adoc#bmc-addressing_ipi-install-installation-workflow[BMC addressing]

include::modules/ipi-install-preparing-to-deploy-with-virtual-media-on-the-baremetal-network.adoc[leveloffset=+1]

include::modules/ipi-install-diagnosing-duplicate-mac-address.adoc[leveloffset=+1]

include::modules/ipi-install-provisioning-the-bare-metal-node.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
:_mod-docs-content-type: ASSEMBLY
[id="ipi-install-post-installation-configuration"]
= Installer-provisioned postinstallation configuration
[id="bare-metal-post-installation-configuration"]
= Postinstallation configuration
include::_attributes/common-attributes.adoc[]
:context: ipi-install-post-installation-configuration
:context: bare-metal-post-installation-configuration

toc::[]

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

// Configuring NTP for disconnected clusters
include::modules/ipi-install-configuring-ntp-for-disconnected-clusters.adoc[leveloffset=+1]
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
// This is included in the following assemblies:
//
// installing/installing_bare_metal/ipi/ipi-install-expanding-the-cluster.adoc
// installing/installing_bare_metal/bare-metal-expanding-the-cluster.adoc

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

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

[IMPORTANT]
====
If you reuse the `BareMetalHost` object definition from an existing control plane host, do not leave the `externallyProvisioned` field set to `true`.

Existing control plane `BareMetalHost` objects may have the `externallyProvisioned` flag set to `true` if they were provisioned by the {product-title} installation program.
Existing control plane `BareMetalHost` objects might have the `externallyProvisioned` flag set to `true` if they were provisioned by the {product-title} installation program.
====

.Prerequisites
Expand Down Expand Up @@ -85,11 +85,11 @@ spec:
online: true
EOF
----
<1> Replace `<num>` for the control plane number of the bare metal node in the `name` fields and the `credentialsName` field.
<1> Replace `<num>` for the control plane number of the bare-metal node in the `name` fields and the `credentialsName` field.
<2> Replace `<base64_of_uid>` with the `base64` string of the user name.
<3> Replace `<base64_of_pwd>` with the `base64` string of the password.
<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.
<5> Replace `<NIC1_mac_address>` with the MAC address of the bare metal node's first NIC.
<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.
<5> Replace `<NIC1_mac_address>` with the MAC address of the bare-metal node's first NIC.
+
After the inspection is complete, the `BareMetalHost` object is created and available to be provisioned.

Expand Down Expand Up @@ -147,7 +147,7 @@ spec:
name: master-user-data-managed
EOF
----
<1> Replace `<num>` for the control plane number of the bare metal node in the `name`, `labels` and `annotations` fields.
<1> Replace `<num>` for the control plane number of the bare-metal node in the `name`, `labels` and `annotations` fields.
+
. To view the `BareMetalHost` objects, run the following command:
+
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
// This is included in the following assemblies:
//
// ipi-install-post-installation-configuration.adoc
// bare-metal-postinstallation-configuration.adoc

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

= Enabling a provisioning network after installation

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.
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.

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

Expand Down