openshift-docs/installing/installing_bare_metal/upi/installing-bare-metal.adoc

ifeval::["{context}" == "installing-with-agent-based-installer"]
:agent:
endif::[]

:_mod-docs-content-type: ASSEMBLY
[id="installing-bare-metal"]
= Installing a user-provisioned cluster on bare metal
include::_attributes/common-attributes.adoc[]
:context: installing-bare-metal

toc::[]

[role="_abstract"]
To optimize performance and maintain more control over your hardware in {product-title} {product-version}, you can install a cluster on bare-metal infrastructure that you provision.

[IMPORTANT]
====
While you might be able to follow this procedure to deploy a cluster on virtualized or cloud environments, you must be aware of additional considerations for non-bare-metal platforms. Review the information in the link:https://access.redhat.com/articles/4207611[guidelines for deploying {product-title} on non-tested platforms] before you attempt to install an {product-title} cluster in such an environment.
====

== Prerequisites

* You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users].
* If you use a firewall, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to.
+
[NOTE]
====
Be sure to also review this site list if you are configuring a proxy.
====

// Internet access for OpenShift Container Platform
include::modules/cluster-entitlements.adoc[leveloffset=+1]

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

* xref:../../../installing/installing_bare_metal/upi/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[Installing a user-provisioned bare metal cluster on a restricted network]

// Required machines for cluster installation
include::modules/installation-machine-requirements.adoc[leveloffset=+2]

// Minimum resource requirements for cluster installation
include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2]

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

* xref:../../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage]

include::modules/csr-management.adoc[leveloffset=+2]

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

* xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installation-three-node-cluster_installing-bare-metal[Configuring a three-node cluster]
* xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installation-approve-csrs_installing-bare-metal[Approving the certificate signing requests for your machines]

* xref:../../../installing/installing_vsphere/upi/installing-vsphere.adoc#installation-vsphere-machines_installing-vsphere[Installing RHCOS and starting the {product-title} bootstrap process]

// Networking requirements for user-provisioned infrastructure
include::modules/installation-network-user-infra.adoc[leveloffset=+2]

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

* xref:../../../installing/install_config/installing-customizing.adoc#installation-special-config-chrony_installing-customizing[Configuring chrony time service]

include::modules/installation-dns-user-infra.adoc[leveloffset=+2]

include::modules/installation-dns-user-infra-example.adoc[leveloffset=+3]

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

* xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installation-user-provisioned-validating-dns_installing-bare-metal[Validating DNS resolution for user-provisioned infrastructure]

include::modules/installation-bare-metal-dns-record-type.adoc[leveloffset=+2]

// Load balancing requirements for user-provisioned infrastructure
include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]

include::modules/installation-load-balancing-user-infra-example.adoc[leveloffset=+3]

// Creating a manifest object that includes a customized `br-ex` bridge
include::modules/creating-manifest-file-customized-br-ex-bridge.adoc[leveloffset=+1]

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

* xref:../../../networking/ovn_kubernetes_network_provider/converting-to-dual-stack.adoc#nw-dual-stack-convert_converting-to-dual-stack[Converting to a dual-stack cluster network]

* xref:../../../installing/installing_bare_metal/bare-metal-expanding-the-cluster.adoc#bare-metal-expanding-the-cluster[Expanding the cluster]

// Scale each machine set to compute nodes
include::modules/creating-scaling-machine-sets-compute-nodes-networking.adoc[leveloffset=+2]

// Enabling OVS balance-slb mode for your cluster
include::modules/enabling-OVS-balance-slb-mode.adoc[leveloffset=+1]

// Preparing the user-provisioned infrastructure
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]

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

* xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#creating-machines-bare-metal_installing-bare-metal[Installing {op-system} and starting the {product-title} bootstrap process]
* xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installation-host-names-dhcp-user-infra_installing-bare-metal[Setting the cluster node hostnames through DHCP]
* xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installation-user-infra-machines-advanced_installing-bare-metal[Advanced RHCOS installation configuration]
* xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installation-network-user-infra_installing-bare-metal[Networking requirements for user-provisioned infrastructure]
* xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installation-dns-user-infra_installing-bare-metal[User-provisioned DNS requirements]
* xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installation-user-provisioned-validating-dns_installing-bare-metal[Validating DNS resolution for user-provisioned infrastructure]
* xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installation-load-balancing-user-infra_installing-bare-metal[Load balancing requirements for user-provisioned infrastructure]

// Validating DNS resolution for user-provisioned infrastructure
include::modules/installation-user-provisioned-validating-dns.adoc[leveloffset=+1]

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

* xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installation-dns-user-infra_installing-bare-metal[User-provisioned DNS requirements]
* xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installation-load-balancing-user-infra_installing-bare-metal[Load balancing requirements for user-provisioned infrastructure]

// Generating a key pair for cluster node SSH access
include::modules/ssh-agent-using.adoc[leveloffset=+1]

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

* xref:../../../support/troubleshooting/verifying-node-health.adoc#verifying-node-health[Verifying node health]

// Obtaining the installation program
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]

// Installing the OpenShift CLI on Linux
include::modules/cli-installing-cli-linux.adoc[leveloffset=+1]

// Installing the OpenShift CLI on Windows
include::modules/cli-installing-cli-windows.adoc[leveloffset=+1]

// Installing the OpenShift CLI on macOS
include::modules/cli-installing-cli-macos.adoc[leveloffset=+1]

// Manually creating the installation configuration file
include::modules/installation-initializing-manual.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
* xref:../../../installing/installing_bare_metal/upi/installation-config-parameters-bare-metal.adoc#installation-config-parameters-bare-metal[Installation configuration parameters for bare metal]

// Sample install-config.yaml file for bare metal
include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2]

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

* xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installation-load-balancing-user-infra_installing-bare-metal[Load balancing requirements for user-provisioned infrastructure]
* xref:../../../installing/overview/cluster-capabilities.adoc#cluster-capabilities[Cluster capabilities]
* xref:../../../installing/overview/cluster-capabilities.adoc#explanation_of_capabilities_cluster-capabilities[Optional cluster capabilities in {product-title} {product-version}]

include::modules/installation-configure-proxy.adoc[leveloffset=+2]

include::modules/installation-three-node-cluster.adoc[leveloffset=+2]

include::modules/installation-user-infra-generate-k8s-manifest-ignition.adoc[leveloffset=+1]

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

* xref:../../../backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-3-expired-certs.adoc#dr-recovering-expired-certs[Recovering from expired control plane certificates]

include::modules/creating-machines-bare-metal.adoc[leveloffset=+1]

include::modules/installation-user-infra-machines-iso.adoc[leveloffset=+2]

include::modules/installation-user-infra-machines-pxe.adoc[leveloffset=+2]

include::modules/installation-user-infra-machines-advanced.adoc[leveloffset=+2]

include::modules/installation-user-infra-machines-advanced-network.adoc[leveloffset=+3]

include::modules/installation-user-infra-machines-advanced-disk.adoc[leveloffset=+3]

include::modules/installation-user-infra-machines-advanced-retain-disk.adoc[leveloffset=+3]

include::modules/installation-user-infra-machines-advanced-ignition.adoc[leveloffset=+3]

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

* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/configuring_and_managing_networking/index#getting-started-with-nmcli_configuring-and-managing-networking[Getting started with nmcli] 
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/8/html-single/configuring_and_managing_networking/index#getting-started-with-nmtui_configuring-and-managing-networking[Getting started with nmtui]

include::modules/installation-user-infra-machines-advanced-console-configuration.adoc[leveloffset=+3]

include::modules/installation-user-infra-machines-advanced-enabling-serial-console.adoc[leveloffset=+3]

include::modules/installation-user-infra-machines-advanced-customizing-iso-or-pxe.adoc[leveloffset=+3]

:boot-media: ISO image
:boot: iso
include::modules/installation-user-infra-machines-advanced-customizing-live.adoc[leveloffset=+3]

include::modules/installation-user-infra-machines-advanced-customizing-live-serial-console.adoc[leveloffset=+3]

include::modules/installation-user-infra-machines-advanced-customizing-live-ca-certs.adoc[leveloffset=+3]

include::modules/installation-user-infra-machines-advanced-customizing-live-network-config.adoc[leveloffset=+3]

include::modules/installation-user-infra-machines-advanced-customizing-live-iscsi-manual.adoc[leveloffset=+3]

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

* link:https://www.man7.org/linux/man-pages/man7/dracut.cmdline.7.html[`dracut.cmdline` manual page]

include::modules/installation-user-infra-machines-advanced-customizing-live-iscsi-ibft.adoc[leveloffset=+3]

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

* link:https://www.man7.org/linux/man-pages/man7/dracut.cmdline.7.html[`dracut.cmdline` manual page]

:boot-media!:
:boot!:

:boot-media: PXE environment
:boot: pxe
include::modules/installation-user-infra-machines-advanced-customizing-live.adoc[leveloffset=+3]

include::modules/installation-user-infra-machines-advanced-customizing-live-serial-console.adoc[leveloffset=+3]

include::modules/installation-user-infra-machines-advanced-customizing-live-ca-certs.adoc[leveloffset=+3]

include::modules/installation-user-infra-machines-advanced-customizing-live-network-config.adoc[leveloffset=+3]

include::modules/installation-user-infra-machines-advanced-customizing-live-iscsi-manual.adoc[leveloffset=+3]

include::modules/installation-user-infra-machines-advanced-customizing-live-iscsi-ibft.adoc[leveloffset=+3]

:boot-media!:
:boot!:

include::modules/installation-user-infra-machines-static-network.adoc[leveloffset=+2]

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

* link:https://www.man7.org/linux/man-pages/man7/dracut.cmdline.7.html[`dracut.cmdline` manual page]

include::modules/configuring-dhcp-or-static-ip-addresses.adoc[leveloffset=+3]

include::modules/configuring-ip-address-without-static-hostname.adoc[leveloffset=+3]

include::modules/specifying-multiple-network-interfaces.adoc[leveloffset=+3]

include::modules/configuring-default-gateway-route.adoc[leveloffset=+3]

include::modules/configuring-vlans-individual-interfaces.adoc[leveloffset=+3]

include::modules/bonding-multiple-network-interfaces-to-single-interface.adoc[leveloffset=+3]

include::modules/bonding-multiple-sriov-network-interfaces-to-dual-port.adoc[leveloffset=+3]

include::modules/installation-user-infra-machines-coreos-installer-options.adoc[leveloffset=+3]

include::modules/rhcos-enabling-multipath.adoc[leveloffset=+2]

include::modules/rhcos-multipath-secondary-disk.adoc[leveloffset=+3]

//iscsi using `coreos-installer install`
include::modules/rhcos-install-iscsi-manual.adoc[leveloffset=+2]

include::modules/rhcos-install-iscsi-ibft.adoc[leveloffset=+2]

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

* link:https://www.man7.org/linux/man-pages/man7/dracut.cmdline.7.html[`dracut.cmdline` manual page]

* xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#creating-machines-bare-metal_installing-bare-metal[Installing {op-system} and starting the {product-title} bootstrap process]

include::modules/installation-installing-bare-metal.adoc[leveloffset=+1]

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

* xref:../../../support/troubleshooting/troubleshooting-installations.adoc#monitoring-installation-progress_troubleshooting-installations[Monitoring installation progress]

include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]

include::modules/installation-approve-csrs.adoc[leveloffset=+1]

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

* link:https://kubernetes.io/docs/reference/access-authn-authz/certificate-signing-requests/[Certificate Signing Requests]

include::modules/installation-operators-config.adoc[leveloffset=+1]

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

* xref:../../../support/troubleshooting/troubleshooting-installations.adoc#installation-bootstrap-gather_troubleshooting-installations[Gathering logs from a failed installation]
* xref:../../../support/troubleshooting/troubleshooting-operator-issues.adoc#troubleshooting-operator-issues[Troubleshooting Operator issues]

include::modules/registry-removed.adoc[leveloffset=+2]

include::modules/installation-registry-storage-config.adoc[leveloffset=+2]

include::modules/registry-configuring-storage-baremetal.adoc[leveloffset=+3]

include::modules/installation-registry-storage-non-production.adoc[leveloffset=+3]

include::modules/installation-registry-storage-block-recreate-rollout-bare-metal.adoc[leveloffset=+3]

include::modules/installation-complete-user-infra.adoc[leveloffset=+1]

include::modules/cluster-telemetry.adoc[leveloffset=+1]

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

* xref:../../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring]
* xref:../../../installing/validation_and_troubleshooting/validating-an-installation.adoc#validating-an-installation[Validating an installation]
* xref:../../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster].
* xref:../../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting]
* xref:../../../registry/configuring_registry_storage/configuring-registry-storage-baremetal.adoc#configuring-registry-storage-baremetal[Set up your registry and configure registry storage]
* link:https://access.redhat.com/solutions/4656511[Data Gathered and Used by Red Hat's subscription services ]

ifeval::["{context}" == "installing-with-agent-based-installer"]
:!agent:
endif::[]