|
1 | 1 | :_mod-docs-content-type: ASSEMBLY |
2 | 2 | [id="preparing-to-install-on-bare-metal"] |
3 | | -= Preparing for bare metal cluster installation |
| 3 | += Preparing for bare-metal cluster installation |
4 | 4 | include::_attributes/common-attributes.adoc[] |
5 | 5 | :context: preparing-to-install-on-bare-metal |
6 | 6 |
|
7 | 7 | toc::[] |
8 | 8 |
|
| 9 | +[role="_abstract"] |
| 10 | +Review the different methods for installing {product-title} on bare metal and prepare your environment for installation. |
| 11 | + |
9 | 12 | [id="preparing_preparing-to-install-on-bare-metal"] |
10 | 13 | == Prerequisites |
11 | 14 |
|
12 | | -* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. |
13 | | -* You have read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. |
14 | | -* You have read the documentation for supported and unsupported OVN-Kubernetes network plugin use cases on xref:../../networking/ovn_kubernetes_network_provider/about-ovn-kubernetes.adoc#nw-ovn-kubernetes-purpose_about-ovn-kubernetes[OVN-Kubernetes purpose]. |
15 | | - |
16 | | -include::modules/virt-planning-bare-metal-cluster-for-ocp-virt.adoc[leveloffset=+1] |
17 | | - |
18 | | -[role="_additional-resources"] |
19 | | -.Additional resources |
20 | | - |
21 | | -* xref:../../virt/getting_started/virt-getting-started.adoc#virt-getting-started[Getting started with {VirtProductName}] |
22 | | -* xref:../../virt/install/preparing-cluster-for-virt.adoc#preparing-cluster-for-virt[Preparing your cluster for {VirtProductName}] |
23 | | -* xref:../../networking/hardware_networks/about-sriov.adoc#about-sriov[About Single Root I/O Virtualization (SR-IOV) hardware networks] |
24 | | -* xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#virt-connecting-vm-to-sriov[Connecting a virtual machine to an SR-IOV network] |
25 | | - |
26 | | -include::modules/nw-sriov-dual-nic-con.adoc[leveloffset=+1] |
27 | | - |
28 | | -[role="_additional-resources"] |
29 | | -.Additional resources |
30 | | - |
31 | | -* xref:../../installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc#agent-install-sample-config-bond-sriov_preparing-to-install-with-agent-based-installer[Example: Bonds and SR-IOV dual-nic node network configuration] |
32 | | - |
33 | | -* xref:../../installing/installing_bare_metal/ipi/ipi-install-installation-workflow.adoc#configuring-host-dual-network-interfaces-in-the-install-config-yaml-file_ipi-install-installation-workflow[Optional: Configuring host network interfaces for dual port NIC] |
34 | | - |
35 | | -* xref:../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#bonding-multiple-sriov-network-interfaces-to-dual-port_installing-bare-metal[Bonding multiple SR-IOV network interfaces to a dual port NIC interface] |
| 15 | +* You have read details about the {product-title} installation and update processes. |
| 16 | +* You have read the documentation on selecting a cluster installation method and preparing it for users. |
| 17 | +* You have read the documentation for supported and unsupported OVN-Kubernetes network plugin use cases. |
36 | 18 |
|
37 | 19 | [id="choosing-a-method-to-install-ocp-on-bare-metal"] |
38 | 20 | == Choosing a method to install {product-title} on bare metal |
39 | 21 |
|
40 | 22 | The {product-title} installation program offers four methods for deploying a cluster: |
41 | 23 |
|
42 | | -* *Interactive*: You can deploy a cluster with the web-based link:https://access.redhat.com/documentation/en-us/assisted_installer_for_openshift_container_platform[{ai-full}]. This is the recommended approach for clusters with networks connected to the internet. The {ai-full} is the easiest way to install {product-title}, it provides smart defaults, and it performs pre-flight validations before installing the cluster. It also provides a RESTful API for automation and advanced configuration scenarios. |
| 24 | +* *Interactive*: You can deploy a cluster with the web-based {ai-full}. This is the recommended approach for clusters with networks connected to the internet. The {ai-full} is the easiest way to install {product-title}, it provides smart defaults, and it performs pre-flight validations before installing the cluster. It also provides a RESTful API for automation and advanced configuration scenarios. |
43 | 25 |
|
44 | | -* *Local Agent-based*: You can deploy a cluster locally with the xref:../../installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc#preparing-to-install-with-agent-based-installer[agent-based installer] for air-gapped or restricted networks. It provides many of the benefits of the {ai-full}, but you must download and configure the link:https://console.redhat.com/openshift/install/metal/agent-based[agent-based installer] first. Configuration is done with a commandline interface. This approach is ideal for air-gapped or restricted networks. |
| 26 | +* *Local Agent-based*: You can deploy a cluster locally with the agent-based installer for air-gapped or restricted networks. It provides many of the benefits of the {ai-full}, but you must download and configure the agent-based installer first. Configuration is done with a commandline interface. This approach is ideal for air-gapped or restricted networks. |
45 | 27 |
|
46 | | -* *Automated*: You can xref:../../installing/installing_bare_metal/ipi/ipi-install-overview.adoc#ipi-install-overview[deploy a cluster on installer-provisioned infrastructure] and the cluster it maintains. The installer uses each cluster host's baseboard management controller (BMC) for provisioning. You can deploy clusters with both connected or air-gapped or restricted networks. |
| 28 | +* *Automated*: You can deploy a cluster on installer-provisioned infrastructure and the cluster it maintains. The installation program uses each cluster host's baseboard management controller (BMC) for provisioning. You can deploy clusters with both connected or air-gapped or restricted networks. |
47 | 29 |
|
48 | | -* *Full control*: You can deploy a cluster on xref:../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installing-bare-metal[infrastructure that you prepare and maintain], which provides maximum customizability. You can deploy clusters with both connected or air-gapped or restricted networks. |
| 30 | +* *Full control*: You can deploy a cluster on infrastructure that you prepare and maintain, which provides maximum customizability. You can deploy clusters with both connected or air-gapped or restricted networks. |
49 | 31 |
|
50 | 32 | The clusters have the following characteristics: |
51 | 33 |
|
52 | 34 | * Highly available infrastructure with no single points of failure is available by default. |
53 | 35 | * Administrators maintain control over what updates are applied and when. |
54 | 36 |
|
55 | | -See xref:../../architecture/architecture-installation.adoc#installation-process_architecture-installation[Installation process] for more information about installer-provisioned and user-provisioned installation processes. |
56 | | - |
57 | 37 | [id="choosing-a-method-to-install-ocp-on-bare-metal-installer-provisioned"] |
58 | | -=== Installing a cluster on installer-provisioned infrastructure |
| 38 | +== Installing a cluster on installer-provisioned infrastructure |
59 | 39 |
|
60 | | -You can install a cluster on bare metal infrastructure that is provisioned by the {product-title} installation program, by using the following method: |
| 40 | +You can install a cluster on bare-metal infrastructure that is provisioned by the {product-title} installation program, by using the following method: |
61 | 41 |
|
62 | | -**xref:../../installing/installing_bare_metal/ipi/ipi-install-overview.adoc#ipi-install-overview[Installing an installer-provisioned cluster on bare metal]**:: |
| 42 | +**Installing an installer-provisioned cluster on bare metal**:: |
63 | 43 | You can install {product-title} on bare metal by using installer provisioning. |
64 | 44 |
|
65 | 45 | [id="choosing-a-method-to-install-ocp-on-bare-metal-user-provisioned"] |
66 | | -=== Installing a cluster on user-provisioned infrastructure |
| 46 | +== Installing a cluster on user-provisioned infrastructure |
67 | 47 |
|
68 | | -You can install a cluster on bare metal infrastructure that you provision, by using one of the following methods: |
| 48 | +You can install a cluster on bare-metal infrastructure that you provision, by using one of the following methods: |
69 | 49 |
|
70 | | -**xref:../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installing-bare-metal[Installing a user-provisioned cluster on bare metal]**:: |
71 | | -You can install {product-title} on bare metal infrastructure that you provision. For a cluster that contains user-provisioned infrastructure, you must deploy all of the required machines. |
| 50 | +**Installing a user-provisioned cluster on bare metal**:: |
| 51 | +You can install {product-title} on bare-metal infrastructure that you provision. For a cluster that contains user-provisioned infrastructure, you must deploy all of the required machines. |
| 52 | + |
| 53 | +**Installing a user-provisioned bare-metal cluster with network customizations**:: |
| 54 | +You can install a bare-metal cluster on user-provisioned infrastructure with network-customizations. By customizing your network configuration, your cluster can coexist with existing IP address allocations in your environment and integrate with existing MTU and VXLAN configurations. Most of the network customizations must be applied at the installation stage. |
| 55 | + |
| 56 | +**Installing a user-provisioned bare-metal cluster on a restricted network**:: |
| 57 | +You can install a user-provisioned bare-metal cluster on a restricted or disconnected network by using a mirror registry. You can also use this installation method to ensure that your clusters only use container images that satisfy your organizational controls on external content. |
| 58 | + |
| 59 | +include::modules/virt-planning-bare-metal-cluster-for-ocp-virt.adoc[leveloffset=+1] |
72 | 60 |
|
73 | | -**xref:../../installing/installing_bare_metal/upi/installing-bare-metal-network-customizations.adoc#installing-bare-metal-network-customizations[Installing a user-provisioned bare metal cluster with network customizations]**:: |
74 | | -You can install a bare metal cluster on user-provisioned infrastructure with network-customizations. By customizing your network configuration, your cluster can coexist with existing IP address allocations in your environment and integrate with existing MTU and VXLAN configurations. Most of the network customizations must be applied at the installation stage. |
| 61 | +include::modules/nw-sriov-dual-nic-con.adoc[leveloffset=+1] |
75 | 62 |
|
76 | | -**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]**:: |
77 | | -You can install a user-provisioned bare metal cluster on a restricted or disconnected network by using a mirror registry. You can also use this installation method to ensure that your clusters only use container images that satisfy your organizational controls on external content. |
| 63 | +[role="_additional-resources"] |
| 64 | +[id="additional-resources_preparing-to-install-on-bare-metal"] |
| 65 | +== Additional resources |
| 66 | + |
| 67 | +* xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update processes] |
| 68 | +* xref:../../installing/overview/installing-preparing.adoc#installing-preparing[Selecting a cluster installation method and preparing it for users] |
| 69 | +* xref:../../networking/ovn_kubernetes_network_provider/about-ovn-kubernetes.adoc#nw-ovn-kubernetes-purpose_about-ovn-kubernetes[OVN-Kubernetes purpose] |
| 70 | +* link:https://access.redhat.com/documentation/en-us/assisted_installer_for_openshift_container_platform[{ai-full}] |
| 71 | +* xref:../../installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc#preparing-to-install-with-agent-based-installer[Preparing to install with the Agent-based Installer] |
| 72 | +* link:https://console.redhat.com/openshift/install/metal/agent-based[Agent-based installer] |
| 73 | +* xref:../../installing/installing_bare_metal/ipi/ipi-install-overview.adoc#ipi-install-overview[Deploying installer-provisioned clusters on bare metal] |
| 74 | +* xref:../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installing-bare-metal[Installing a user-provisioned cluster on bare metal] |
| 75 | +* xref:../../installing/installing_bare_metal/upi/installing-bare-metal-network-customizations.adoc#installing-bare-metal-network-customizations[Installing a user-provisioned bare-metal cluster with network customizations] |
| 76 | +* 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] |
| 77 | +* xref:../../architecture/architecture-installation.adoc#installation-process_architecture-installation[Installation process] |
| 78 | +* xref:../../virt/getting_started/virt-getting-started.adoc#virt-getting-started[Getting started with {VirtProductName}] |
| 79 | +* xref:../../virt/install/preparing-cluster-for-virt.adoc#preparing-cluster-for-virt[Preparing your cluster for {VirtProductName}] |
| 80 | +* xref:../../networking/hardware_networks/about-sriov.adoc#about-sriov[About Single Root I/O Virtualization (SR-IOV) hardware networks] |
| 81 | +* xref:../../virt/vm_networking/virt-connecting-vm-to-sriov.adoc#virt-connecting-vm-to-sriov[Connecting a virtual machine to an SR-IOV network] |
| 82 | +* xref:../../installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc#agent-install-sample-config-bond-sriov_preparing-to-install-with-agent-based-installer[Example: Bonds and SR-IOV dual-NIC node network configuration] |
| 83 | +* xref:../../installing/installing_bare_metal/ipi/ipi-install-installation-workflow.adoc#configuring-host-dual-network-interfaces-in-the-install-config-yaml-file_ipi-install-installation-workflow[Optional: Configuring host network interfaces for dual port NIC] |
| 84 | +* xref:../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#bonding-multiple-sriov-network-interfaces-to-dual-port_installing-bare-metal[Bonding multiple SR-IOV network interfaces to a dual port NIC interface] |
0 commit comments