mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS-1978 - Enhancing the bare metal UPI installation docs
This commit is contained in:
Paul Needle
@@ -212,11 +212,11 @@ Topics:
|
||||
Topics:
|
||||
- Name: Preparing to install on bare metal
|
||||
File: preparing-to-install-on-bare-metal
|
||||
- Name: Installing a cluster on bare metal
|
||||
- Name: Installing a user-provisioned cluster on bare metal
|
||||
File: installing-bare-metal
|
||||
- Name: Installing a cluster on bare metal with network customizations
|
||||
- Name: Installing a user-provisioned bare metal cluster with network customizations
|
||||
File: installing-bare-metal-network-customizations
|
||||
- Name: Restricted network bare metal installation
|
||||
- Name: Installing a user-provisioned bare metal cluster on a restricted network
|
||||
File: installing-restricted-networks-bare-metal
|
||||
- Name: Deploying installer-provisioned clusters on bare metal
|
||||
Dir: installing_bare_metal_ipi
|
||||
|
||||
@@ -1,18 +1,17 @@
|
||||
[id="installing-bare-metal-network-customizations"]
|
||||
= Installing a cluster on bare metal with network customizations
|
||||
= Installing a user-provisioned bare metal cluster with network customizations
|
||||
include::modules/common-attributes.adoc[]
|
||||
:context: installing-bare-metal-network-customizations
|
||||
|
||||
toc::[]
|
||||
|
||||
In {product-title} version {product-version}, you can install a cluster on bare
|
||||
In {product-title} {product-version}, you can install a cluster on bare
|
||||
metal infrastructure that you provision with customized network configuration
|
||||
options. 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.
|
||||
|
||||
You must set most of the network configuration parameters during installation,
|
||||
and you can modify only `kubeProxy` configuration parameters in a running
|
||||
When you customize {product-title} networking, you must set most of the network configuration parameters during installation. You can modify only `kubeProxy` network configuration parameters in a running
|
||||
cluster.
|
||||
|
||||
== Prerequisites
|
||||
@@ -25,20 +24,55 @@ xref:../../installing/install_config/configuring-firewall.adoc#configuring-firew
|
||||
|
||||
include::modules/cluster-entitlements.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* See xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[Installing a user-provisioned bare metal cluster on a restricted network] for more information about performing a restricted network installation on bare metal infrastructure that you provision.
|
||||
|
||||
include::modules/installation-requirements-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
.Additional resources
|
||||
|
||||
* See xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installation-three-node-cluster_installing-bare-metal[Configuring a three-node cluster] for details about deploying three-node clusters in bare metal environments.
|
||||
* See xref:../../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installation-approve-csrs_installing-bare-metal-network-customizations[Approving the certificate signing requests for your machines] for more information about approving cluster certificate signing requests after installation.
|
||||
|
||||
include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* xref:../install_config/installing-customizing.adoc#installation-special-config-chrony_installing-customizing[Configuring chrony time service]
|
||||
* 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]
|
||||
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installation-user-provisioned-validating-dns_installing-bare-metal-network-customizations[Validating DNS resolution for user-provisioned infrastructure]
|
||||
|
||||
include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installation-requirements-user-infra_installing-bare-metal[Requirements for a cluster with user-provisioned infrastructure]
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#creating-machines-bare-metal[Installing {op-system} and starting the {product-title} bootstrap process]
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installation-host-names-dhcp-user-infra_installing-bare-metal[Setting the cluster node hostnames through DHCP]
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installation-user-infra-machines-advanced_installing-bare-metal[Advanced RHCOS installation configuration]
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installation-network-user-infra_installing-bare-metal[Networking requirements for user-provisioned infrastructure]
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installation-dns-user-infra_installing-bare-metal[User-provisioned DNS requirements]
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installation-user-provisioned-validating-dns_installing-bare-metal[Validating DNS resolution for user-provisioned infrastructure]
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installation-load-balancing-user-infra_installing-bare-metal[Load balancing requirements for user-provisioned infrastructure]
|
||||
|
||||
include::modules/installation-user-provisioned-validating-dns.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installation-dns-user-infra_installing-bare-metal[User-provisioned DNS requirements]
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installation-load-balancing-user-infra_installing-bare-metal[Load balancing requirements for user-provisioned infrastructure]
|
||||
|
||||
include::modules/ssh-agent-using.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* xref:../../support/troubleshooting/verifying-node-health.adoc#verifying-node-health[Verifying node health]
|
||||
|
||||
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/cli-installing-cli.adoc[leveloffset=+1]
|
||||
@@ -49,6 +83,10 @@ include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* See xref:../../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installation-load-balancing-user-infra_installing-bare-metal[Load balancing requirements for user-provisioned infrastructure] for more information on the API and application ingress load balancing requirements.
|
||||
|
||||
// Network Operator specific configuration
|
||||
include::modules/nw-network-config.adoc[leveloffset=+1]
|
||||
include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1]
|
||||
@@ -57,29 +95,22 @@ include::modules/nw-operator-cr.adoc[leveloffset=+1]
|
||||
include::modules/installation-generate-ignition-configs.adoc[leveloffset=+1]
|
||||
|
||||
[id="creating-machines-bare-metal-network-customization"]
|
||||
== Creating {op-system-first} machines
|
||||
== Installing {op-system} and starting the {product-title} bootstrap process
|
||||
|
||||
Before you install a cluster on bare metal infrastructure that you provision,
|
||||
you must create {op-system} machines for it to use. To create the machines, follow either the steps
|
||||
to use an ISO image or network PXE booting.
|
||||
To install {product-title} on bare metal infrastructure that you provision, you must install {op-system-first} on the machines. When you install {op-system}, you must provide the Ignition config file that was generated by the {product-title} installation program for the type of machine you are installing. If you have configured suitable networking, DNS, and load balancing infrastructure, the {product-title} bootstrap process begins automatically after the {op-system} machines have rebooted.
|
||||
|
||||
There are several methods of configuring {op-system} during ISO and
|
||||
PXE installations. These include:
|
||||
To install {op-system} on the machines, follow either the steps to use an ISO image or network PXE booting.
|
||||
|
||||
* Kernel arguments: For a PXE install, you can `APPEND` arguments to the
|
||||
kernel of the live installer. For an ISO install, you can interrupt the
|
||||
live installation boot process to add kernel arguments. In both cases, you can use
|
||||
special `coreos.inst.*` arguments to direct the installer, as well as
|
||||
standard boot arguments for turning standard kernel services
|
||||
on or off.
|
||||
[NOTE]
|
||||
====
|
||||
The compute node deployment steps included in this installation document are {op-system}-specific. If you choose instead to deploy {op-system-base}-based compute nodes, you take responsibility for all operating system life cycle management and maintenance, including performing system updates, applying patches, and completing all other required tasks. Use of {op-system-base} 7 compute machines is deprecated and planned for removal in a future release of {product-title} 4.
|
||||
====
|
||||
|
||||
* Ignition configs: You must generate an {product-title} Ignition config file
|
||||
(`*.ign`) for the type of node you are installing (worker, control plane,
|
||||
or bootstrap). You pass the location of the Ignition config to the installed
|
||||
system so that it takes effect on first boot. In special cases, you can create a
|
||||
separate, limited Ignition config to pass to the live system. That Ignition config could do a certain set of tasks, such as reporting success to a provisioning system
|
||||
after completing installation. This special Ignition config is consumed by the installer and should not
|
||||
be used to include the standard `worker` and `master` Ignition configs.
|
||||
You can configure {op-system} during ISO and PXE installations by using the following methods:
|
||||
|
||||
* Kernel arguments: You can use kernel arguments to provide installation-specific information. For example, you can specify the locations of the {op-system} installation files that you uploaded to your HTTP server and the location of the Ignition config file for the type of node you are installing. For a PXE installation, you can use the `APPEND` parameter to pass the arguments to the kernel of the live installer. For an ISO installation, you can interrupt the live installation boot process to add the kernel arguments. In both installation cases, you can use special `coreos.inst.*` arguments to direct the installer, as well as standard boot arguments for turning standard kernel services on or off.
|
||||
|
||||
* Ignition configs: {product-title} Ignition config files (`*.ign`) are specific to the type of node you are installing. You pass the location of a bootstrap, control plane, or compute node Ignition config file during the {op-system} installation so that it takes effect on first boot. In special cases, you can create a separate, limited Ignition config to pass to the live system. That Ignition config could do a certain set of tasks, such as reporting success to a provisioning system after completing installation. This special Ignition config is consumed by the `coreos-installer` to be applied on first boot of the installed system. Do not provide the standard control plane and compute node Ignition configs to the live ISO directly.
|
||||
|
||||
* `coreos-installer`: You can boot the live ISO installer to a shell prompt,
|
||||
which allows you to prepare the permanent system in a variety of ways
|
||||
@@ -106,12 +137,21 @@ include::modules/architecture-rhcos-updating-bootloader.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-installing-bare-metal.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* See xref:../../support/troubleshooting/troubleshooting-installations.adoc#monitoring-installation-progress_troubleshooting-installations[Monitoring installation progress] for more information about monitoring the installation logs and retrieving diagnostic data if installation issues arise.
|
||||
|
||||
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-approve-csrs.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-operators-config.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* See xref:../../support/troubleshooting/troubleshooting-installations.adoc#installation-bootstrap-gather_troubleshooting-installations[Gathering logs from a failed installation] for details about gathering data in the event of a failed {product-title} installation.
|
||||
* See xref:../../support/troubleshooting/troubleshooting-operator-issues.adoc#troubleshooting-operator-issues[Troubleshooting Operator issues] for steps to check Operator pod health across the cluster and gather Operator logs for diagnosis.
|
||||
|
||||
include::modules/registry-removed.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-registry-storage-config.adoc[leveloffset=+2]
|
||||
@@ -122,6 +162,7 @@ include::modules/installation-complete-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
== Next steps
|
||||
|
||||
* xref:../../installing/validating-an-installation.adoc#validating-an-installation[Validating an installation].
|
||||
* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster].
|
||||
* If necessary, you can
|
||||
xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
[id="installing-bare-metal"]
|
||||
= Installing a cluster on bare metal
|
||||
= Installing a user-provisioned cluster on bare metal
|
||||
include::modules/common-attributes.adoc[]
|
||||
:context: installing-bare-metal
|
||||
|
||||
toc::[]
|
||||
|
||||
In {product-title} version {product-version}, you can install a cluster on
|
||||
In {product-title} {product-version}, you can install a cluster on
|
||||
bare metal infrastructure that you provision.
|
||||
|
||||
[IMPORTANT]
|
||||
@@ -32,20 +32,57 @@ Be sure to also review this site list if you are configuring a proxy.
|
||||
|
||||
include::modules/cluster-entitlements.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* See xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[Installing a user-provisioned bare metal cluster on a restricted network] for more information about performing a restricted network installation on bare metal infrastructure that you provision.
|
||||
|
||||
include::modules/installation-requirements-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
.Additional resources
|
||||
|
||||
* See xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installation-three-node-cluster_installing-bare-metal[Configuring a three-node cluster] for details about deploying three-node clusters in bare metal environments.
|
||||
* See xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installation-approve-csrs_installing-bare-metal[Approving the certificate signing requests for your machines] for more information about approving cluster certificate signing requests after installation.
|
||||
|
||||
include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* xref:../install_config/installing-customizing.adoc#installation-special-config-chrony_installing-customizing[Configuring chrony time service]
|
||||
* 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]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installation-user-provisioned-validating-dns_installing-bare-metal[Validating DNS resolution for user-provisioned infrastructure]
|
||||
|
||||
include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installation-requirements-user-infra_installing-bare-metal[Requirements for a cluster with user-provisioned infrastructure]
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#creating-machines-bare-metal[Installing {op-system} and starting the {product-title} bootstrap process]
|
||||
* xref:../../installing/installing_bare_metal/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/installing-bare-metal.adoc#installation-user-infra-machines-advanced_installing-bare-metal[Advanced RHCOS installation configuration]
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installation-network-user-infra_installing-bare-metal[Networking requirements for user-provisioned infrastructure]
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installation-dns-user-infra_installing-bare-metal[User-provisioned DNS requirements]
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installation-user-provisioned-validating-dns_installing-bare-metal[Validating DNS resolution for user-provisioned infrastructure]
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installation-load-balancing-user-infra_installing-bare-metal[Load balancing requirements for user-provisioned infrastructure]
|
||||
|
||||
include::modules/installation-user-provisioned-validating-dns.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installation-dns-user-infra_installing-bare-metal[User-provisioned DNS requirements]
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installation-load-balancing-user-infra_installing-bare-metal[Load balancing requirements for user-provisioned infrastructure]
|
||||
|
||||
include::modules/ssh-agent-using.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* xref:../../support/troubleshooting/verifying-node-health.adoc#verifying-node-health[Verifying node health]
|
||||
|
||||
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/cli-installing-cli.adoc[leveloffset=+1]
|
||||
@@ -56,36 +93,37 @@ include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* See xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installation-load-balancing-user-infra_installing-bare-metal[Load balancing requirements for user-provisioned infrastructure] for more information on the API and application ingress load balancing requirements.
|
||||
|
||||
include::modules/installation-configure-proxy.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-three-node-cluster.adoc[leveloffset=+1]
|
||||
include::modules/installation-three-node-cluster.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-user-infra-generate-k8s-manifest-ignition.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* See xref:../../backup_and_restore/disaster_recovery/scenario-3-expired-certs.adoc#dr-recovering-expired-certs[Recovering from expired control plane certificates] for more information about recovering kubelet certificates.
|
||||
|
||||
[id="creating-machines-bare-metal"]
|
||||
== Creating {op-system-first} machines
|
||||
== Installing {op-system} and starting the {product-title} bootstrap process
|
||||
|
||||
Before you install a cluster on bare metal infrastructure that you provision,
|
||||
you must create {op-system} machines for it to use. To create the machines, follow either the steps
|
||||
to use an ISO image or network PXE booting.
|
||||
To install {product-title} on bare metal infrastructure that you provision, you must install {op-system-first} on the machines. When you install {op-system}, you must provide the Ignition config file that was generated by the {product-title} installation program for the type of machine you are installing. If you have configured suitable networking, DNS, and load balancing infrastructure, the {product-title} bootstrap process begins automatically after the {op-system} machines have rebooted.
|
||||
|
||||
There are several methods of configuring {op-system} during ISO and
|
||||
PXE installations. These include:
|
||||
To install {op-system} on the machines, follow either the steps to use an ISO image or network PXE booting.
|
||||
|
||||
* Kernel arguments: For a PXE install, you can `APPEND` arguments to the
|
||||
kernel of the live installer. For an ISO install, you can interrupt the
|
||||
live installation boot process to add kernel arguments. In both cases, you can use
|
||||
special `coreos.inst.*` arguments to direct the live installer, as well as
|
||||
standard installation boot arguments for turning standard kernel services
|
||||
on or off.
|
||||
[NOTE]
|
||||
====
|
||||
The compute node deployment steps included in this installation document are {op-system}-specific. If you choose instead to deploy {op-system-base}-based compute nodes, you take responsibility for all operating system life cycle management and maintenance, including performing system updates, applying patches, and completing all other required tasks. Use of {op-system-base} 7 compute machines is deprecated and planned for removal in a future release of {product-title} 4.
|
||||
====
|
||||
|
||||
* Ignition configs: You must generate an {product-title} Ignition config file
|
||||
(`*.ign`) for the type of node you are installing (worker, control plane,
|
||||
or bootstrap). You pass the location of the Ignition config to the installed
|
||||
system so that it takes effect on first boot. In special cases, you can create a
|
||||
separate, limited Ignition config to pass to the live system. That Ignition config could do a certain set of tasks, such as reporting success to a provisioning system
|
||||
after completing installation. This special Ignition config is consumed by the installer and should not
|
||||
be used to include the standard `worker` and `master` Ignition configs.
|
||||
You can configure {op-system} during ISO and PXE installations by using the following methods:
|
||||
|
||||
* Kernel arguments: You can use kernel arguments to provide installation-specific information. For example, you can specify the locations of the {op-system} installation files that you uploaded to your HTTP server and the location of the Ignition config file for the type of node you are installing. For a PXE installation, you can use the `APPEND` parameter to pass the arguments to the kernel of the live installer. For an ISO installation, you can interrupt the live installation boot process to add the kernel arguments. In both installation cases, you can use special `coreos.inst.*` arguments to direct the live installer, as well as standard installation boot arguments for turning standard kernel services on or off.
|
||||
|
||||
* Ignition configs: {product-title} Ignition config files (`*.ign`) are specific to the type of node you are installing. You pass the location of a bootstrap, control plane, or compute node Ignition config file during the {op-system} installation so that it takes effect on first boot. In special cases, you can create a separate, limited Ignition config to pass to the live system. That Ignition config could do a certain set of tasks, such as reporting success to a provisioning system after completing installation. This special Ignition config is consumed by the `coreos-installer` to be applied on first boot of the installed system. Do not provide the standard control plane and compute node Ignition configs to the live ISO directly.
|
||||
|
||||
* `coreos-installer`: You can boot the live ISO installer to a shell prompt,
|
||||
which allows you to prepare the permanent system in a variety of ways
|
||||
@@ -106,7 +144,6 @@ As of {product-title} 4.6, the {op-system} ISO and other installation artifacts
|
||||
provide support for installation on disks with 4K sectors.
|
||||
====
|
||||
|
||||
|
||||
include::modules/installation-user-infra-machines-iso.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-user-infra-machines-pxe.adoc[leveloffset=+2]
|
||||
@@ -119,12 +156,21 @@ include::modules/architecture-rhcos-updating-bootloader.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-installing-bare-metal.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* See xref:../../support/troubleshooting/troubleshooting-installations.adoc#monitoring-installation-progress_troubleshooting-installations[Monitoring installation progress] for more information about monitoring the installation logs and retrieving diagnostic data if installation issues arise.
|
||||
|
||||
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-approve-csrs.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-operators-config.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* See xref:../../support/troubleshooting/troubleshooting-installations.adoc#installation-bootstrap-gather_troubleshooting-installations[Gathering logs from a failed installation] for details about gathering data in the event of a failed {product-title} installation.
|
||||
* See xref:../../support/troubleshooting/troubleshooting-operator-issues.adoc#troubleshooting-operator-issues[Troubleshooting Operator issues] for steps to check Operator pod health across the cluster and gather Operator logs for diagnosis.
|
||||
|
||||
include::modules/registry-removed.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-registry-storage-config.adoc[leveloffset=+2]
|
||||
@@ -139,6 +185,7 @@ include::modules/installation-complete-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
== Next steps
|
||||
|
||||
* xref:../../installing/validating-an-installation.adoc#validating-an-installation[Validating an installation].
|
||||
* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster].
|
||||
* If necessary, you can
|
||||
xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting].
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
[id="installing-restricted-networks-bare-metal"]
|
||||
= Installing a cluster on bare metal in a restricted network
|
||||
= Installing a user-provisioned bare metal cluster on a restricted network
|
||||
include::modules/common-attributes.adoc[]
|
||||
:context: installing-restricted-networks-bare-metal
|
||||
|
||||
toc::[]
|
||||
|
||||
In {product-title} version {product-version}, you can install a cluster on
|
||||
In {product-title} {product-version}, you can install a cluster on
|
||||
bare metal infrastructure that you provision in a restricted network.
|
||||
|
||||
[IMPORTANT]
|
||||
@@ -47,18 +47,51 @@ include::modules/cluster-entitlements.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-requirements-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
.Additional resources
|
||||
|
||||
* See xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installation-three-node-cluster_installing-restricted-networks-bare-metal[Configuring a three-node cluster] for details about deploying three-node clusters in bare metal environments.
|
||||
* See xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installation-approve-csrs_installing-bare-metal[Approving the certificate signing requests for your machines] for more information about approving cluster certificate signing requests after installation.
|
||||
|
||||
include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* xref:../install_config/installing-customizing.adoc#installation-special-config-chrony_installing-customizing[Configuring chrony time service]
|
||||
* 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]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installation-user-provisioned-validating-dns_installing-bare-metal[Validating DNS resolution for user-provisioned infrastructure]
|
||||
|
||||
include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installation-requirements-user-infra_installing-bare-metal[Requirements for a cluster with user-provisioned infrastructure]
|
||||
* xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#creating-machines-bare-metal[Installing {op-system} and starting the {product-title} bootstrap process]
|
||||
* xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installation-host-names-dhcp-user-infra_installing-bare-metal[Setting the cluster node hostnames through DHCP]
|
||||
* xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installation-user-infra-machines-advanced_installing-bare-metal[Advanced RHCOS installation configuration]
|
||||
* xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installation-network-user-infra_installing-bare-metal[Networking requirements for user-provisioned infrastructure]
|
||||
* xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installation-dns-user-infra_installing-bare-metal[User-provisioned DNS requirements]
|
||||
* xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installation-user-provisioned-validating-dns_installing-bare-metal[Validating DNS resolution for user-provisioned infrastructure]
|
||||
* xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installation-load-balancing-user-infra_installing-bare-metal[Load balancing requirements for user-provisioned infrastructure]
|
||||
|
||||
include::modules/installation-user-provisioned-validating-dns.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installation-dns-user-infra_installing-bare-metal[User-provisioned DNS requirements]
|
||||
* xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installation-load-balancing-user-infra_installing-bare-metal[Load balancing requirements for user-provisioned infrastructure]
|
||||
|
||||
include::modules/ssh-agent-using.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* xref:../../support/troubleshooting/verifying-node-health.adoc#verifying-node-health[Verifying node health]
|
||||
|
||||
//You extract the installation program from the mirrored content.
|
||||
|
||||
//You can install the CLI on the mirror host.
|
||||
@@ -69,39 +102,40 @@ include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* See xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installation-load-balancing-user-infra_installing-bare-metal[Load balancing requirements for user-provisioned infrastructure] for more information on the API and application ingress load balancing requirements.
|
||||
|
||||
include::modules/installation-configure-proxy.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-three-node-cluster.adoc[leveloffset=+1]
|
||||
include::modules/installation-three-node-cluster.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-user-infra-generate-k8s-manifest-ignition.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* See xref:../../backup_and_restore/disaster_recovery/scenario-3-expired-certs.adoc#dr-recovering-expired-certs[Recovering from expired control plane certificates] for more information about recovering kubelet certificates.
|
||||
|
||||
include::modules/installation-special-config-chrony.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
[id="creating-machines-bare-metal-restricted-network"]
|
||||
== Creating {op-system-first} machines
|
||||
== Installing {op-system} and starting the {product-title} bootstrap process
|
||||
|
||||
Before you install a cluster on bare metal infrastructure that you provision,
|
||||
you must create {op-system} machines for it to use. To create the machines, follow either the steps
|
||||
to use an ISO image or network PXE booting.
|
||||
To install {product-title} on bare metal infrastructure that you provision, you must install {op-system-first} on the machines. When you install {op-system}, you must provide the Ignition config file that was generated by the {product-title} installation program for the type of machine you are installing. If you have configured suitable networking, DNS, and load balancing infrastructure, the {product-title} bootstrap process begins automatically after the {op-system} machines have rebooted.
|
||||
|
||||
There are several methods of configuring {op-system} during ISO and
|
||||
PXE installations. These include:
|
||||
To install {op-system} on the machines, follow either the steps to use an ISO image or network PXE booting.
|
||||
|
||||
* Kernel arguments: For a PXE install, you can `APPEND` arguments to the
|
||||
kernel of the live installer. For an ISO install, you can interrupt the
|
||||
live installation boot process to add kernel arguments. In both cases, you can use
|
||||
special `coreos.inst.*` arguments to direct the live installer, as well as
|
||||
standard installation boot arguments for turning standard kernel services
|
||||
on or off.
|
||||
[NOTE]
|
||||
====
|
||||
The compute node deployment steps included in this installation document are {op-system}-specific. If you choose instead to deploy {op-system-base}-based compute nodes, you take responsibility for all operating system life cycle management and maintenance, including performing system updates, applying patches, and completing all other required tasks. Use of {op-system-base} 7 compute machines is deprecated and planned for removal in a future release of {product-title} 4.
|
||||
====
|
||||
|
||||
* Ignition configs: You must generate an {product-title} Ignition config file
|
||||
(`*.ign`) for the type of node you are installing (worker, control plane,
|
||||
or bootstrap). You pass the location of the Ignition config to the installed
|
||||
system so that it takes effect on first boot. In special cases, you can create a
|
||||
separate, limited Ignition config to pass to the live system. That Ignition config could do a certain set of tasks, such as reporting success to a provisioning system
|
||||
after completing installation. This special Ignition config is consumed by the installer and should not
|
||||
be used to include the standard `worker` and `master` Ignition configs.
|
||||
You can configure {op-system} during ISO and PXE installations by using the following methods:
|
||||
|
||||
* Kernel arguments: You can use kernel arguments to provide installation-specific information. For example, you can specify the locations of the {op-system} installation files that you uploaded to your HTTP server and the location of the Ignition config file for the type of node you are installing. For a PXE installation, you can use the `APPEND` parameter to pass the arguments to the kernel of the live installer. For an ISO installation, you can interrupt the live installation boot process to add the kernel arguments. In both installation cases, you can use special `coreos.inst.*` arguments to direct the live installer, as well as standard installation boot arguments for turning standard kernel services on or off.
|
||||
|
||||
* Ignition configs: {product-title} Ignition config files (`*.ign`) are specific to the type of node you are installing. You pass the location of a bootstrap, control plane, or compute node Ignition config file during the {op-system} installation so that it takes effect on first boot. In special cases, you can create a separate, limited Ignition config to pass to the live system. That Ignition config could do a certain set of tasks, such as reporting success to a provisioning system after completing installation. This special Ignition config is consumed by the `coreos-installer` to be applied on first boot of the installed system. Do not provide the standard control plane and compute node Ignition configs to the live ISO directly.
|
||||
|
||||
* `coreos-installer`: You can boot the live ISO installer to a shell prompt,
|
||||
which allows you to prepare the permanent system in a variety of ways
|
||||
@@ -128,12 +162,21 @@ include::modules/architecture-rhcos-updating-bootloader.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-installing-bare-metal.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* See xref:../../support/troubleshooting/troubleshooting-installations.adoc#monitoring-installation-progress_troubleshooting-installations[Monitoring installation progress] for more information about monitoring the installation logs and retrieving diagnostic data if installation issues arise.
|
||||
|
||||
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-approve-csrs.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-operators-config.adoc[leveloffset=+1]
|
||||
|
||||
.Additional resources
|
||||
|
||||
* See xref:../../support/troubleshooting/troubleshooting-installations.adoc#installation-bootstrap-gather_troubleshooting-installations[Gathering logs from a failed installation] for details about gathering data in the event of a failed {product-title} installation.
|
||||
* See xref:../../support/troubleshooting/troubleshooting-operator-issues.adoc#troubleshooting-operator-issues[Troubleshooting Operator issues] for steps to check Operator pod health across the cluster and gather Operator logs for diagnosis.
|
||||
|
||||
include::modules/installation-registry-storage-config.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/registry-change-management-state.adoc[leveloffset=+3]
|
||||
@@ -148,6 +191,7 @@ include::modules/installation-complete-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
== Next steps
|
||||
|
||||
* xref:../../installing/validating-an-installation.adoc#validating-an-installation[Validating an installation].
|
||||
* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster].
|
||||
* If the mirror registry that you used to install your cluster has a trusted CA, add it to the cluster by xref:../../openshift_images/image-configuration.adoc#images-configuration-cas_image-configuration[configuring additional trust stores].
|
||||
* If necessary, you can
|
||||
|
||||
@@ -15,12 +15,12 @@ toc::[]
|
||||
[id="choosing-a-method-to-install-ocp-on-bare-metal"]
|
||||
== Choosing a method to install {product-title} on bare metal
|
||||
|
||||
You can install OpenShift Container Platform on bare metal by using one of the following deployment methods.
|
||||
You can install {product-title} on bare metal by using one of the following deployment methods.
|
||||
|
||||
* **xref:../../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install-overview[Installer-provisioned cluster on bare metal]**: You can install {product-title} on bare metal by using installer provisioning.
|
||||
* **xref:../../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install-overview[Installing an installer-provisioned cluster on bare metal]**: You can install {product-title} on bare metal by using installer provisioning.
|
||||
|
||||
* **xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[Installing a user-provisioned cluster on bare metal]**: You can install {product-title} on bare metal by using the default network configuration options.
|
||||
* **xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[Installing a user-provisioned cluster on bare metal]**: 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.
|
||||
|
||||
* **xref:../../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installing-bare-metal-network-customizations[Installing a user-provisioned bare metal cluster with network customizations]**: You can install a network-customized cluster. The installation program allows for some customization to be applied at the installation stage.
|
||||
* **xref:../../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installing-bare-metal-network-customizations[Installing a user-provisioned bare metal cluster with network customizations]**: 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.
|
||||
|
||||
* **xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[Installing a user-provisioned bare metal cluster with restricted network customizations]**: You can customize your {product-title} network configuration during installation so the cluster can coexist with existing IP address allocations and adhere to your network requirements.
|
||||
* **xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[Installing a user-provisioned bare metal cluster on a restricted network]**: 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.
|
||||
|
||||
@@ -36,8 +36,6 @@ include::modules/cluster-entitlements.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-requirements-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
.Additional resources
|
||||
@@ -46,6 +44,12 @@ include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-dns-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-user-provisioned-validating-dns.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/ssh-agent-using.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
|
||||
@@ -58,14 +62,16 @@ include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2]
|
||||
|
||||
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]
|
||||
|
||||
[id="creating-machines-bare-metal-power"]
|
||||
== Creating {op-system-first} machines
|
||||
== Installing {op-system} and starting the {product-title} bootstrap process
|
||||
|
||||
Before you install a cluster on IBM Power Systems infrastructure that you provision,
|
||||
you must create {op-system} machines for it to use. Follow either the steps
|
||||
to use an ISO image or network PXE booting to create the machines.
|
||||
To install {product-title} on IBM Power Systems infrastructure that you provision, you must install {op-system-first} on the machines. When you install {op-system}, you must provide the Ignition config file that was generated by the {product-title} installation program for the type of machine you are installing. If you have configured suitable networking, DNS, and load balancing infrastructure, the {product-title} bootstrap process begins automatically after the {op-system} machines have rebooted.
|
||||
|
||||
Follow either the steps to use an ISO image or network PXE booting to install {op-system} on the machines.
|
||||
|
||||
include::modules/installation-user-infra-machines-iso.adoc[leveloffset=+2]
|
||||
|
||||
|
||||
@@ -44,8 +44,6 @@ include::modules/cluster-entitlements.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-requirements-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
.Additional resources
|
||||
@@ -54,6 +52,12 @@ include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-dns-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-user-provisioned-validating-dns.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/ssh-agent-using.adoc[leveloffset=+1]
|
||||
|
||||
//You extract the installation program from the mirrored content.
|
||||
@@ -66,14 +70,16 @@ include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2]
|
||||
|
||||
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]
|
||||
|
||||
[id="creating-machines-ibm-power-restricted-network"]
|
||||
== Creating {op-system-first} machines
|
||||
== Installing {op-system} and starting the {product-title} bootstrap process
|
||||
|
||||
Before you install a cluster on IBM Power Systems infrastructure that you provision,
|
||||
you must create {op-system} machines for it to use. Follow either the steps
|
||||
to use an ISO image or network PXE booting to create the machines.
|
||||
To install {product-title} on IBM Power Systems infrastructure that you provision, you must install {op-system-first} on the machines. When you install {op-system}, you must provide the Ignition config file that was generated by the {product-title} installation program for the type of machine you are installing. If you have configured suitable networking, DNS, and load balancing infrastructure, the {product-title} bootstrap process begins automatically after the {op-system} machines have rebooted.
|
||||
|
||||
Follow either the steps to use an ISO image or network PXE booting to install {op-system} on the machines.
|
||||
|
||||
include::modules/installation-user-infra-machines-iso.adoc[leveloffset=+2]
|
||||
|
||||
|
||||
@@ -43,8 +43,6 @@ include::modules/cluster-entitlements.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-requirements-user-infra-ibm-z-kvm.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
.Additional resources
|
||||
@@ -53,6 +51,12 @@ include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-dns-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-user-provisioned-validating-dns.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/ssh-agent-using.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
|
||||
@@ -63,13 +67,17 @@ include::modules/installation-initializing-manual.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-configure-proxy.adoc[leveloffset=+1]
|
||||
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]
|
||||
|
||||
include::modules/installation-ibm-z-kvm-user-infra-machines-iso.adoc[leveloffset=+1]
|
||||
include::modules/installation-ibm-z-kvm-user-infra-installing-rhcos.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-full-ibm-z-kvm-user-infra-machines-iso.adoc[leveloffset=+1]
|
||||
include::modules/installation-ibm-z-kvm-user-infra-machines-iso.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-full-ibm-z-kvm-user-infra-machines-iso.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-installing-bare-metal.adoc[leveloffset=+1]
|
||||
|
||||
@@ -91,7 +99,7 @@ include::modules/installation-ibm-z-troubleshooting-and-debugging.adoc[leveloffs
|
||||
|
||||
.Additional resources
|
||||
|
||||
* See also link:https://access.redhat.com/solutions/4387261[How to generate SOSREPORT within OpenShift4 nodes without SSH].
|
||||
* link:https://access.redhat.com/solutions/4387261[How to generate SOSREPORT within OpenShift4 nodes without SSH].
|
||||
|
||||
== Next steps
|
||||
|
||||
|
||||
@@ -48,8 +48,6 @@ include::modules/installation-requirements-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
* See link:http://public.dhe.ibm.com/software/dw/linux390/perf/zvm_hpav00.pdf[Scaling HyperPAV alias devices on Linux guests on z/VM] for performance optimization.
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
.Additional resources
|
||||
@@ -58,6 +56,12 @@ include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-dns-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-user-provisioned-validating-dns.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/ssh-agent-using.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
|
||||
@@ -68,7 +72,9 @@ include::modules/installation-initializing-manual.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-configure-proxy.adoc[leveloffset=+1]
|
||||
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]
|
||||
|
||||
@@ -94,7 +100,7 @@ include::modules/installation-ibm-z-troubleshooting-and-debugging.adoc[leveloffs
|
||||
|
||||
.Additional resources
|
||||
|
||||
* See also link:https://access.redhat.com/solutions/4387261[How to generate SOSREPORT within OpenShift4 nodes without SSH].
|
||||
* link:https://access.redhat.com/solutions/4387261[How to generate SOSREPORT within OpenShift4 nodes without SSH].
|
||||
|
||||
== Next steps
|
||||
|
||||
|
||||
@@ -71,11 +71,15 @@ include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2]
|
||||
|
||||
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]
|
||||
|
||||
include::modules/installation-ibm-z-kvm-user-infra-machines-iso.adoc[leveloffset=+1]
|
||||
include::modules/installation-ibm-z-kvm-user-infra-installing-rhcos.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-full-ibm-z-kvm-user-infra-machines-iso.adoc[leveloffset=+1]
|
||||
include::modules/installation-ibm-z-kvm-user-infra-machines-iso.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-full-ibm-z-kvm-user-infra-machines-iso.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-installing-bare-metal.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@ Additional considerations exist for non-bare metal platforms. Review the informa
|
||||
link:https://access.redhat.com/articles/4207611[guidelines for deploying {product-title} on non-tested platforms] before you install an {product-title} cluster.
|
||||
====
|
||||
|
||||
.Prerequisites
|
||||
== Prerequisites
|
||||
|
||||
* xref:../../installing/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[Create a mirror registry for installation in a restricted network] and obtain the `imageContentSources` data for your version of {product-title}.
|
||||
* Before you begin the installation process, you must move or remove any existing installation files. This ensures that the required installation files are created and updated during the installation process.
|
||||
@@ -52,8 +52,6 @@ include::modules/installation-requirements-user-infra.adoc[leveloffset=+1]
|
||||
* See link:https://www.ibm.com/support/knowledgecenter/en/SSB27U_7.1.0/com.ibm.zvm.v710.hcpa6/bhslzvs.htm[Bridging a HiperSockets LAN with a z/VM Virtual Switch] in the IBM Knowledge Center.
|
||||
* See link:http://public.dhe.ibm.com/software/dw/linux390/perf/zvm_hpav00.pdf[Scaling HyperPAV alias devices on Linux guests on z/VM] for performance optimization.
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
.Additional resources
|
||||
@@ -62,6 +60,12 @@ include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-dns-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-user-provisioned-validating-dns.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/ssh-agent-using.adoc[leveloffset=+1]
|
||||
|
||||
//You extract the installation program from the mirrored content.
|
||||
@@ -74,6 +78,8 @@ include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2]
|
||||
|
||||
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]
|
||||
|
||||
include::modules/installation-ibm-z-user-infra-machines-iso.adoc[leveloffset=+1]
|
||||
@@ -98,7 +104,7 @@ include::modules/installation-ibm-z-troubleshooting-and-debugging.adoc[leveloffs
|
||||
|
||||
.Additional resources
|
||||
|
||||
* See also link:https://access.redhat.com/solutions/4387261[How to generate SOSREPORT within {product-title} version 4 nodes without SSH].
|
||||
* link:https://access.redhat.com/solutions/4387261[How to generate SOSREPORT within {product-title} version 4 nodes without SSH].
|
||||
|
||||
.Next steps
|
||||
|
||||
|
||||
@@ -30,8 +30,6 @@ include::modules/cluster-entitlements.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-requirements-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
.Additional resources
|
||||
@@ -40,6 +38,12 @@ include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-dns-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-user-provisioned-validating-dns.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/ssh-agent-using.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
|
||||
@@ -52,32 +56,27 @@ include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-configure-proxy.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-three-node-cluster.adoc[leveloffset=+1]
|
||||
include::modules/installation-three-node-cluster.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-user-infra-generate-k8s-manifest-ignition.adoc[leveloffset=+1]
|
||||
|
||||
[id="creating-machines-platform-agnostic"]
|
||||
== Creating {op-system-first} machines
|
||||
== Installing {op-system} and starting the {product-title} bootstrap process
|
||||
|
||||
Before you install a cluster on infrastructure that you provision, you must create {op-system} machines for it to use. If your infrastructure supports it, create the machines by following either the steps to use an ISO image or network PXE booting. In some cases, you might be able to upload an appropriate {op-system} image from the link:https://access.redhat.com/downloads/content/290[Product Downloads] page on the Red Hat Customer Portal or the link:https://mirror.openshift.com/pub/openshift-v4/dependencies/rhcos/4.7/[{op-system} image mirror] to your cloud provider and use that image to create the machines.
|
||||
To install {product-title} on infrastructure that you provision, you must install {op-system-first} on the machines. When you install {op-system}, you must provide the Ignition config file that was generated by the {product-title} installation program for the type of machine you are installing. If you have configured suitable networking, DNS, and load balancing infrastructure, the {product-title} bootstrap process begins automatically after the {op-system} machines have rebooted.
|
||||
|
||||
There are several methods of configuring {op-system} during ISO and
|
||||
PXE installations. These include:
|
||||
If your infrastructure supports it, install {op-system} on the machines by following either the steps to use an ISO image or network PXE booting. In some cases, you might be able to upload an appropriate {op-system} image from the link:https://access.redhat.com/downloads/content/290[Product Downloads] page on the Red Hat Customer Portal or the link:https://mirror.openshift.com/pub/openshift-v4/dependencies/rhcos/4.7/[{op-system} image mirror] to your cloud provider and use that image to create the machines.
|
||||
|
||||
* Kernel arguments: For a PXE install, you can `APPEND` arguments to the
|
||||
kernel of the live installer. For an ISO install, you can interrupt the
|
||||
live installation boot process to add kernel arguments. In both cases, you can use
|
||||
special `coreos.inst.*` arguments to direct the live installer, as well as
|
||||
standard installation boot arguments for turning standard kernel services
|
||||
on or off.
|
||||
[NOTE]
|
||||
====
|
||||
The compute node deployment steps included in this installation document are {op-system}-specific. If your infrastructure supports it and you choose instead to deploy {op-system-base}-based compute nodes, you take responsibility for all operating system life cycle management and maintenance, including performing system updates, applying patches, and completing all other required tasks. Use of {op-system-base} 7 compute machines is deprecated and planned for removal in a future release of {product-title} 4.
|
||||
====
|
||||
|
||||
* Ignition configs: You must generate an {product-title} Ignition config file
|
||||
(`*.ign`) for the type of node you are installing (worker, control plane,
|
||||
or bootstrap). You pass the location of the Ignition config to the installed
|
||||
system so that it takes effect on first boot. In special cases, you can create a
|
||||
separate, limited Ignition config to pass to the live system. That Ignition config could do a certain set of tasks, such as reporting success to a provisioning system
|
||||
after completing installation. This special Ignition config is consumed by the installer and should not
|
||||
be used to include the standard `worker` and `master` Ignition configs.
|
||||
You can configure {op-system} during ISO and PXE installations by using the following methods:
|
||||
|
||||
* Kernel arguments: You can use kernel arguments to provide installation-specific information. For example, you can specify the locations of the {op-system} installation files that you uploaded to your HTTP server and the location of the Ignition config file for the type of node you are installing. For a PXE installation, you can use the `APPEND` parameter to pass the arguments to the kernel of the live installer. For an ISO installation, you can interrupt the live installation boot process to add the kernel arguments. In both installation cases, you can use special `coreos.inst.*` arguments to direct the live installer, as well as standard installation boot arguments for turning standard kernel services on or off.
|
||||
|
||||
* Ignition configs: {product-title} Ignition config files (`*.ign`) are specific to the type of node you are installing. You pass the location of a bootstrap, control plane, or compute node Ignition config file during the {op-system} installation so that it takes effect on first boot. In special cases, you can create a separate, limited Ignition config to pass to the live system. That Ignition config could do a certain set of tasks, such as reporting success to a provisioning system after completing installation. This special Ignition config is consumed by the `coreos-installer` to be applied on first boot of the installed system. Do not provide the standard control plane and compute node Ignition configs to the live ISO directly.
|
||||
|
||||
* `coreos-installer`: You can boot the live ISO installer to a shell prompt,
|
||||
which allows you to prepare the permanent system in a variety of ways
|
||||
@@ -98,7 +97,6 @@ As of {product-title} 4.6, the {op-system} ISO and other installation artifacts
|
||||
provide support for installation on disks with 4K sectors.
|
||||
====
|
||||
|
||||
|
||||
include::modules/installation-user-infra-machines-iso.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-user-infra-machines-pxe.adoc[leveloffset=+2]
|
||||
|
||||
@@ -43,6 +43,8 @@ include::modules/installation-network-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-dns-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installing-rhv-setting-up-installation-machine.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installing-rhv-setting-up-ca-certificate.adoc[leveloffset=+1]
|
||||
|
||||
@@ -38,12 +38,16 @@ include::modules/installation-vsphere-infrastructure.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-requirements-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-dns-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-user-provisioned-validating-dns.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/ssh-agent-using.adoc[leveloffset=+1]
|
||||
|
||||
//You extract the installation program from the mirrored content.
|
||||
|
||||
@@ -26,12 +26,16 @@ include::modules/installation-vsphere-infrastructure.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-requirements-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-dns-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-user-provisioned-validating-dns.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/ssh-agent-using.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
|
||||
|
||||
@@ -29,12 +29,16 @@ include::modules/installation-vsphere-infrastructure.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-requirements-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-dns-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-user-provisioned-validating-dns.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/ssh-agent-using.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
|
||||
|
||||
@@ -45,8 +45,6 @@ include::modules/installation-vsphere-infrastructure.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-requirements-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
.Additional resources
|
||||
@@ -55,6 +53,12 @@ include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-dns-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-user-provisioned-validating-dns.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/ssh-agent-using.adoc[leveloffset=+1]
|
||||
|
||||
//You extract the installation program from the mirrored content.
|
||||
|
||||
@@ -34,8 +34,6 @@ include::modules/installation-vsphere-infrastructure.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-requirements-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
.Additional resources
|
||||
@@ -44,6 +42,12 @@ include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-dns-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-user-provisioned-validating-dns.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/ssh-agent-using.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
|
||||
|
||||
@@ -36,8 +36,6 @@ include::modules/installation-vsphere-infrastructure.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-requirements-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
.Additional resources
|
||||
@@ -46,6 +44,12 @@ include::modules/installation-network-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-dns-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-load-balancing-user-infra.adoc[leveloffset=+2]
|
||||
|
||||
include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-user-provisioned-validating-dns.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/ssh-agent-using.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
|
||||
|
||||
@@ -11,6 +11,8 @@ You can add more compute machines to your {product-title} cluster on bare metal.
|
||||
|
||||
* You xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[installed a cluster on bare metal].
|
||||
* You have installation media and {op-system-first} images that you used to create your cluster. If you do not have these files, you must obtain them by following the instructions in the xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[installation procedure].
|
||||
* If a DHCP server is available for your user-provisioned infrastructure, you have added the details for the additional compute machines to your DHCP server configuration. This includes a persistent IP address, DNS server information, and a hostname for each machine.
|
||||
* You have updated your DNS configuration to include the record name and IP address of each compute machine that you are adding. You have validated that DNS lookup and reverse DNS lookup resolve correctly.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
|
||||
@@ -61,7 +61,7 @@ If you are upgrading a cluster in a restricted network, install the `oc` version
|
||||
endif::restricted[]
|
||||
====
|
||||
|
||||
[id="cli-installing-cli-on-linux_{context}"]
|
||||
[discrete]
|
||||
== Installing the OpenShift CLI on Linux
|
||||
|
||||
You can install the OpenShift CLI (`oc`) binary on Linux by using the following procedure.
|
||||
@@ -99,7 +99,7 @@ After you install the CLI, it is available using the `oc` command:
|
||||
$ oc <command>
|
||||
----
|
||||
|
||||
[id="cli-installing-cli-on-windows_{context}"]
|
||||
[discrete]
|
||||
== Installing the OpenShift CLI on Windows
|
||||
|
||||
You can install the OpenShift CLI (`oc`) binary on Windows by using the following procedure.
|
||||
@@ -132,7 +132,7 @@ After you install the CLI, it is available using the `oc` command:
|
||||
C:\> oc <command>
|
||||
----
|
||||
|
||||
[id="cli-installing-cli-on-macos_{context}"]
|
||||
[discrete]
|
||||
== Installing the OpenShift CLI on macOS
|
||||
|
||||
You can install the OpenShift CLI (`oc`) binary on macOS by using the following procedure.
|
||||
|
||||
@@ -216,7 +216,7 @@ first line of the `controlPlane` section must not. Although both sections
|
||||
currently define a single machine pool, it is possible that future versions
|
||||
of {product-title} will support defining multiple compute pools during
|
||||
installation. Only one control plane pool is used.
|
||||
<3> Whether to enable or disable simultaneous multithreading (SMT), or `hyperthreading`. By default, SMT is enabled to increase the performance of your machines' cores. You can disable it by setting the parameter value to `Disabled`. If you disable SMT, you must disable it in all cluster machines; this includes both control plane and compute machines.
|
||||
<3> Specifies whether to enable or disable simultaneous multithreading (SMT), or hyperthreading. By default, SMT is enabled to increase the performance of the cores in your machines. You can disable it by setting the parameter value to `Disabled`. If you disable SMT, you must disable it in all cluster machines; this includes both control plane and compute machines.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
@@ -227,11 +227,13 @@ Simultaneous multithreading (SMT) is enabled by default. If SMT is not enabled i
|
||||
====
|
||||
If you disable `hyperthreading`, whether in the BIOS or in the `install-config.yaml`, ensure that your capacity planning accounts for the dramatically decreased machine performance.
|
||||
====
|
||||
<4> You must set the value of the `replicas` parameter to `0`. This parameter
|
||||
controls the number of workers that the cluster creates and manages for you,
|
||||
which are functions that the cluster does not perform when you
|
||||
use user-provisioned infrastructure. You must manually deploy worker
|
||||
machines for the cluster to use before you finish installing {product-title}.
|
||||
<4> You must set this value to `0` when you install {product-title} on user-provisioned infrastructure. In installer-provisioned installations, the parameter controls the number of compute machines that the cluster creates and manages for you. In user-provisioned installations, you must manually deploy the compute machines before you finish installing the cluster.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
If you are installing a three-node cluster, do not deploy any compute machines when you install the {op-system-first} machines.
|
||||
====
|
||||
+
|
||||
<5> The number of control plane machines that you add to the cluster. Because
|
||||
the cluster uses these values as the number of etcd endpoints in the cluster, the
|
||||
value must match the number of control plane machines that you deploy.
|
||||
@@ -240,7 +242,7 @@ value must match the number of control plane machines that you deploy.
|
||||
not overlap with existing physical networks. These IP addresses are used for the pod network. If you need to access the pods from an external network, you must configure load balancers and routers to manage the traffic.
|
||||
<8> The subnet prefix length to assign to each individual node. For example, if
|
||||
`hostPrefix` is set to `23`, then each node is assigned a `/23` subnet out of
|
||||
the given `cidr`, which allows for 510 (2^(32 - 23) - 2) pod IPs addresses. If
|
||||
the given `cidr`, which allows for 510 (2^(32 - 23) - 2) pod IP addresses. If
|
||||
you are required to provide access to nodes from an external network, configure
|
||||
load balancers and routers to manage the traffic.
|
||||
<9> The IP address pool to use for service IP addresses. You can enter only
|
||||
@@ -261,8 +263,7 @@ The use of FIPS Validated / Modules in Process cryptographic libraries is only s
|
||||
====
|
||||
endif::openshift-origin[]
|
||||
ifndef::restricted[]
|
||||
<12> The pull secret that you obtained from the
|
||||
link:https://cloud.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site.
|
||||
<12> The pull secret that you obtained from the link:https://cloud.redhat.com/openshift[{cloud-redhat-com}] site.
|
||||
This pull secret allows you to authenticate with the services that are
|
||||
provided by the included authorities, including Quay.io, which serves the
|
||||
container images for {product-title} components.
|
||||
@@ -274,11 +275,11 @@ port, that your mirror registry uses to serve content. For example,
|
||||
specify the base64-encoded user name and password for your mirror registry.
|
||||
endif::restricted[]
|
||||
ifndef::openshift-origin[]
|
||||
<13> The public portion of the default SSH key for the `core` user in
|
||||
<13> The SSH public key for the `core` user in
|
||||
{op-system-first}.
|
||||
endif::openshift-origin[]
|
||||
ifdef::openshift-origin[]
|
||||
<12> The public portion of the default SSH key for the `core` user in
|
||||
<12> The SSH public key for the `core` user in
|
||||
{op-system-first}.
|
||||
endif::openshift-origin[]
|
||||
+
|
||||
|
||||
@@ -174,7 +174,7 @@ endif::osp[]
|
||||
|
||||
ifndef::openshift-origin[]
|
||||
|`pullSecret`
|
||||
|Get this pull secret from link:https://cloud.redhat.com/openshift/install/pull-secret[] to authenticate downloading container images for {product-title} components from services such as Quay.io.
|
||||
|Get a pull secret from link:https://cloud.redhat.com/openshift/install/pull-secret[] to authenticate downloading container images for {product-title} components from services such as Quay.io.
|
||||
|
|
||||
[source,json]
|
||||
----
|
||||
@@ -854,7 +854,7 @@ ifdef::vsphere,vmc[]
|
||||
|Parameter|Description|Values
|
||||
|
||||
|`platform.vsphere.vCenter`
|
||||
|The fully-qualified host name or IP address of the vCenter server.
|
||||
|The fully-qualified hostname or IP address of the vCenter server.
|
||||
|String
|
||||
|
||||
|`platform.vsphere.username`
|
||||
|
||||
@@ -95,8 +95,8 @@ URL scheme must be `http`. If you use an MITM transparent proxy network that doe
|
||||
this field is not specified, then `httpProxy` is used for both HTTP and HTTPS
|
||||
connections.
|
||||
If you use an MITM transparent proxy network that does not require additional proxy configuration but requires additional CAs, you must not specify an `httpsProxy` value.
|
||||
<3> A comma-separated list of destination domain names, domains, IP addresses, or
|
||||
other network CIDRs to exclude proxying. Preface a domain with `.` to match subdomains only. For example, `.y.com` matches `x.y.com`, but not `y.com`. Use `*` to bypass proxy for all destinations.
|
||||
<3> A comma-separated list of destination domain names, IP addresses, or
|
||||
other network CIDRs to exclude from proxying. Preface a domain with `.` to match subdomains only. For example, `.y.com` matches `x.y.com`, but not `y.com`. Use `*` to bypass the proxy for all destinations.
|
||||
ifdef::vsphere,vmc[]
|
||||
You must include vCenter's IP address and the IP range that you use for its machines.
|
||||
endif::vsphere,vmc[]
|
||||
@@ -104,8 +104,7 @@ endif::vsphere,vmc[]
|
||||
the `openshift-config` namespace that contains one or more additional CA
|
||||
certificates that are required for proxying HTTPS connections. The Cluster Network
|
||||
Operator then creates a `trusted-ca-bundle` config map that merges these contents
|
||||
with the {op-system-first} trust bundle, and this config map is referenced in the `Proxy`
|
||||
object's `trustedCA` field. The `additionalTrustBundle` field is required unless
|
||||
with the {op-system-first} trust bundle, and this config map is referenced in the `trustedCA` field of the `Proxy` object. The `additionalTrustBundle` field is required unless
|
||||
the proxy's identity certificate is signed by an authority from the {op-system} trust
|
||||
bundle.
|
||||
If you use an MITM transparent proxy network that does not require additional proxy configuration but requires additional CAs, you must provide the MITM CA certificate.
|
||||
|
||||
@@ -1,21 +1,22 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc
|
||||
// * installing/installing_bare_metal/installing-bare-metal.adoc
|
||||
// * installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc
|
||||
// * installing/installing_ibm_power/installing-ibm-power.adoc
|
||||
// * installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc
|
||||
// * installing/installing_ibm_z/installing-restricted-networks-ibm-z-kvm.adoc
|
||||
// * installing/installing_ibm_z/installing-ibm-z-kvm.adoc
|
||||
// * installing/installing_ibm_z/installing-ibm-z.adoc
|
||||
// * installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc
|
||||
// * installing/installing_platform_agnostic/installing-platform-agnostic.adoc
|
||||
// * installing/installing_rhv/installing-rhv-restricted-network.adoc
|
||||
// * installing/installing_vmc/installing-restricted-networks-vmc-user-infra.adoc
|
||||
// * installing/installing_vmc/installing-vmc-user-infra.adoc
|
||||
// * installing/installing_vmc/installing-vmc-network-customizations-user-infra.adoc
|
||||
// * installing/installing_vsphere/installing-restricted-networks-vsphere.adoc
|
||||
// * installing/installing_vsphere/installing-vsphere.adoc
|
||||
// * installing/installing_vsphere/installing-vsphere-network-customizations.adoc
|
||||
// * installing/installing_ibm_z/installing-ibm-z.adoc
|
||||
// * installing/installing_ibm_z/installing-ibm-z-kvm.adoc
|
||||
// * installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc
|
||||
// * installing/installing_ibm_z/installing-restricted-networks-ibm-z-kvm.adoc
|
||||
// * installing/installing_ibm_power/installing-ibm-power.adoc
|
||||
// * installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc
|
||||
// * installing/installing-rhv-restricted-network.adoc
|
||||
// * installing/installing_vsphere/installing-vsphere.adoc
|
||||
|
||||
ifeval::["{context}" == "installing-ibm-z"]
|
||||
:ibm-z:
|
||||
@@ -37,16 +38,24 @@ endif::[]
|
||||
[id="installation-dns-user-infra_{context}"]
|
||||
= User-provisioned DNS requirements
|
||||
|
||||
DNS is used for name resolution and reverse name resolution. DNS A/AAAA or CNAME records
|
||||
are used for name resolution and PTR records are used for reverse name resolution.
|
||||
The reverse records are important because {op-system-first} uses the reverse records to set the host name for
|
||||
all the nodes. Additionally, the reverse records are used to generate the certificate signing requests
|
||||
(CSR) that {product-title} needs to operate.
|
||||
In {product-title} deployments, DNS name resolution is required for the following components:
|
||||
|
||||
The following DNS records are required for an {product-title} cluster that uses
|
||||
user-provisioned infrastructure. In each record, `<cluster_name>` is the cluster
|
||||
name and `<base_domain>` is the cluster base domain that you specify in the
|
||||
`install-config.yaml` file. A complete DNS record takes the form: `<component>.<cluster_name>.<base_domain>.`.
|
||||
* The Kubernetes API
|
||||
* The {product-title} application wildcard
|
||||
* The bootstrap, control plane, and compute machines
|
||||
|
||||
Reverse DNS resolution is also required for the Kubernetes API, the bootstrap machine, the control plane machines, and the compute machines.
|
||||
|
||||
DNS A/AAAA or CNAME records are used for name resolution and PTR records are used for reverse name resolution. The reverse records are important because {op-system-first} uses the reverse records to set the hostnames for all the nodes, unless the hostnames are provided by DHCP. Additionally, the reverse records are used to generate the certificate signing requests (CSR) that {product-title} needs to operate.
|
||||
|
||||
ifndef::ibm-z,ibm-z-kvm[]
|
||||
[NOTE]
|
||||
====
|
||||
It is recommended to use a DHCP server to provide the hostnames to each cluster node. See the _DHCP recommendations for user-provisioned infrastructure_ section for more information.
|
||||
====
|
||||
endif::ibm-z,ibm-z-kvm[]
|
||||
|
||||
The following DNS records are required for a user-provisioned {product-title} cluster and they must be in place before installation. In each record, `<cluster_name>` is the cluster name and `<base_domain>` is the base domain that you specify in the `install-config.yaml` file. A complete DNS record takes the form: `<component>.<cluster_name>.<base_domain>.`.
|
||||
|
||||
.Required DNS records
|
||||
[cols="1a,3a,5a",options="header"]
|
||||
@@ -58,59 +67,66 @@ name and `<base_domain>` is the cluster base domain that you specify in the
|
||||
|
||||
.2+a|Kubernetes API
|
||||
|`api.<cluster_name>.<base_domain>.`
|
||||
|Add a DNS A/AAAA or CNAME record, and a DNS PTR record, to identify the load balancer
|
||||
for the control plane machines. These records must be resolvable by both clients
|
||||
external to the cluster and from all the nodes within the cluster.
|
||||
|A DNS A/AAAA or CNAME record, and a DNS PTR record, to identify the API load balancer. These records must be resolvable by both clients external to the cluster and from all the nodes within the cluster.
|
||||
|
||||
|`api-int.<cluster_name>.<base_domain>.`
|
||||
|Add a DNS A/AAAA or CNAME record, and a DNS PTR record, to identify the load balancer
|
||||
for the control plane machines. These records must be resolvable from all the
|
||||
nodes within the cluster.
|
||||
|A DNS A/AAAA or CNAME record, and a DNS PTR record, to internally identify the API load balancer. These records must be resolvable from all the nodes within the cluster.
|
||||
[IMPORTANT]
|
||||
====
|
||||
The API server must be able to resolve the worker nodes by the host names
|
||||
The API server must be able to resolve the worker nodes by the hostnames
|
||||
that are recorded in Kubernetes. If the API server cannot resolve the node
|
||||
names, then proxied API calls can fail, and you cannot retrieve logs from pods.
|
||||
====
|
||||
|
||||
|Routes
|
||||
|`*.apps.<cluster_name>.<base_domain>.`
|
||||
|Add a wildcard DNS A/AAAA or CNAME record that refers to the load balancer that targets the
|
||||
machines that run the Ingress router pods, which are the worker nodes by
|
||||
default. These records must be resolvable by both clients external to the cluster
|
||||
and from all the nodes within the cluster.
|
||||
|A wildcard DNS A/AAAA or CNAME record that refers to the application ingress load balancer. The application ingress load balancer targets the machines that run the Ingress Controller pods. The Ingress Controller pods run on the compute machines by default. These records must be resolvable by both clients external to the cluster and from all the nodes within the cluster.
|
||||
|
||||
|Bootstrap
|
||||
For example, `console-openshift-console.apps.<cluster_name>.<base_domain>` is used as a wildcard route to the {product-title} console.
|
||||
|
||||
|Bootstrap machine
|
||||
|`bootstrap.<cluster_name>.<base_domain>.`
|
||||
|Add a DNS A/AAAA or CNAME record, and a DNS PTR record, to identify the bootstrap
|
||||
|A DNS A/AAAA or CNAME record, and a DNS PTR record, to identify the bootstrap
|
||||
machine. These records must be resolvable by the nodes within the cluster.
|
||||
|
||||
|Master hosts
|
||||
|Control plane machines
|
||||
|`<master><n>.<cluster_name>.<base_domain>.`
|
||||
|Add DNS A/AAAA or CNAME records and DNS PTR records to identify each machine
|
||||
|DNS A/AAAA or CNAME records and DNS PTR records to identify each machine
|
||||
for the master nodes. These records must be resolvable by the nodes within the cluster.
|
||||
|
||||
|Worker hosts
|
||||
|Compute machines
|
||||
|`<worker><n>.<cluster_name>.<base_domain>.`
|
||||
|Add DNS A/AAAA or CNAME records and DNS PTR records to identify each machine
|
||||
|DNS A/AAAA or CNAME records and DNS PTR records to identify each machine
|
||||
for the worker nodes. These records must be resolvable by the nodes within the cluster.
|
||||
|
||||
|===
|
||||
|
||||
[TIP]
|
||||
[NOTE]
|
||||
====
|
||||
You can use the `nslookup <hostname>` command to verify name resolution. You can use the
|
||||
`dig -x <ip_address>` command to verify reverse name resolution for the PTR records.
|
||||
In {product-title} 4.4 and later, you do not need to specify etcd host and SRV records in your DNS configuration.
|
||||
====
|
||||
|
||||
The following example of a BIND zone file shows sample A records for name resolution. The
|
||||
purpose of the example is to show the records that are needed. The example is not meant
|
||||
to provide advice for choosing one name resolution service over another.
|
||||
[TIP]
|
||||
====
|
||||
You can use the `dig` command to verify name and reverse name resolution. See the section on _Validating DNS resolution for user-provisioned infrastructure_ for detailed validation steps.
|
||||
====
|
||||
|
||||
[id="installation-dns-user-infra-example_{context}"]
|
||||
== Example DNS configuration for user-provisioned clusters
|
||||
|
||||
This section provides A and PTR record configuration samples that meet the DNS requirements for deploying {product-title} on user-provisioned infrastructure. The samples are not meant to provide advice for choosing one DNS solution over another.
|
||||
|
||||
In the examples, the cluster name is `ocp4` and the base domain is `example.com`.
|
||||
|
||||
.Example DNS A record configuration for a user-provisioned cluster
|
||||
|
||||
The following example is a BIND zone file that shows sample A records for name resolution in a user-provisioned cluster.
|
||||
|
||||
.Sample DNS zone database
|
||||
[%collapsible]
|
||||
====
|
||||
[source,text]
|
||||
----
|
||||
$TTL 1W
|
||||
@ IN SOA ns1.example.com. root (
|
||||
2019070700 ; serial
|
||||
@@ -122,41 +138,52 @@ $TTL 1W
|
||||
IN MX 10 smtp.example.com.
|
||||
;
|
||||
;
|
||||
ns1 IN A 192.168.1.5
|
||||
smtp IN A 192.168.1.5
|
||||
ns1.example.com. IN A 192.168.1.5
|
||||
smtp.example.com. IN A 192.168.1.5
|
||||
;
|
||||
helper IN A 192.168.1.5
|
||||
helper.ocp4 IN A 192.168.1.5
|
||||
helper.example.com. IN A 192.168.1.5
|
||||
helper.ocp4.example.com. IN A 192.168.1.5
|
||||
;
|
||||
; The api identifies the IP of your load balancer.
|
||||
api.ocp4 IN A 192.168.1.5
|
||||
api-int.ocp4 IN A 192.168.1.5
|
||||
api.ocp4.example.com. IN A 192.168.1.5 <1>
|
||||
api-int.ocp4.example.com. IN A 192.168.1.5 <2>
|
||||
;
|
||||
; The wildcard also identifies the load balancer.
|
||||
*.apps.ocp4 IN A 192.168.1.5
|
||||
*.apps.ocp4.example.com. IN A 192.168.1.5 <3>
|
||||
;
|
||||
; Create an entry for the bootstrap host.
|
||||
bootstrap.ocp4 IN A 192.168.1.96
|
||||
bootstrap.ocp4.example.com. IN A 192.168.1.96 <4>
|
||||
;
|
||||
; Create entries for the master hosts.
|
||||
master0.ocp4 IN A 192.168.1.97
|
||||
master1.ocp4 IN A 192.168.1.98
|
||||
master2.ocp4 IN A 192.168.1.99
|
||||
master0.ocp4.example.com. IN A 192.168.1.97 <5>
|
||||
master1.ocp4.example.com. IN A 192.168.1.98 <5>
|
||||
master2.ocp4.example.com. IN A 192.168.1.99 <5>
|
||||
;
|
||||
; Create entries for the worker hosts.
|
||||
worker0.ocp4 IN A 192.168.1.11
|
||||
worker1.ocp4 IN A 192.168.1.7
|
||||
worker0.ocp4.example.com. IN A 192.168.1.11 <6>
|
||||
worker1.ocp4.example.com. IN A 192.168.1.7 <6>
|
||||
;
|
||||
;EOF
|
||||
----
|
||||
|
||||
<1> Provides name resolution for the Kubernetes API. The record refers to the IP address of the API load balancer.
|
||||
<2> Provides name resolution for the Kubernetes API. The record refers to the IP address of the API load balancer and is used for internal cluster communications.
|
||||
<3> Provides name resolution for the wildcard routes. The record refers to the IP address of the application ingress load balancer. The application ingress load balancer targets the machines that run the Ingress Controller pods. The Ingress Controller pods run on the compute machines by default.
|
||||
+
|
||||
[NOTE]
|
||||
=====
|
||||
In the example, the same load balancer is used for the Kubernetes API and application ingress traffic. In production scenarios, you can deploy the API and application ingress load balancers separately so that you can scale the load balancer infrastructure for each in isolation.
|
||||
=====
|
||||
+
|
||||
<4> Provides name resolution for the bootstrap machine.
|
||||
<5> Provides name resolution for the control plane machines.
|
||||
<6> Provides name resolution for the compute machines.
|
||||
====
|
||||
|
||||
The following example BIND zone file shows sample PTR records for reverse name
|
||||
resolution.
|
||||
.Example DNS PTR record configuration for a user-provisioned cluster
|
||||
|
||||
The following example BIND zone file shows sample PTR records for reverse name resolution in a user-provisioned cluster.
|
||||
|
||||
.Sample DNS zone database for reverse records
|
||||
[%collapsible]
|
||||
====
|
||||
[source,text]
|
||||
----
|
||||
$TTL 1W
|
||||
@ IN SOA ns1.example.com. root (
|
||||
2019070700 ; serial
|
||||
@@ -166,30 +193,32 @@ $TTL 1W
|
||||
1W ) ; minimum (1 week)
|
||||
IN NS ns1.example.com.
|
||||
;
|
||||
; The syntax is "last octet" and the host must have an FQDN
|
||||
; with a trailing dot.
|
||||
97 IN PTR master0.ocp4.example.com.
|
||||
98 IN PTR master1.ocp4.example.com.
|
||||
99 IN PTR master2.ocp4.example.com.
|
||||
5.1.168.192.in-addr.arpa. IN PTR api.ocp4.example.com. <1>
|
||||
5.1.168.192.in-addr.arpa. IN PTR api-int.ocp4.example.com. <2>
|
||||
;
|
||||
96 IN PTR bootstrap.ocp4.example.com.
|
||||
96.1.168.192.in-addr.arpa. IN PTR bootstrap.ocp4.example.com. <3>
|
||||
;
|
||||
5 IN PTR api.ocp4.example.com.
|
||||
5 IN PTR api-int.ocp4.example.com.
|
||||
97.1.168.192.in-addr.arpa. IN PTR master0.ocp4.example.com. <4>
|
||||
98.1.168.192.in-addr.arpa. IN PTR master1.ocp4.example.com. <4>
|
||||
99.1.168.192.in-addr.arpa. IN PTR master2.ocp4.example.com. <4>
|
||||
;
|
||||
11 IN PTR worker0.ocp4.example.com.
|
||||
7 IN PTR worker1.ocp4.example.com.
|
||||
11.1.168.192.in-addr.arpa. IN PTR worker0.ocp4.example.com. <5>
|
||||
7.1.168.192.in-addr.arpa. IN PTR worker1.ocp4.example.com. <5>
|
||||
;
|
||||
;EOF
|
||||
----
|
||||
|
||||
<1> Provides reverse DNS resolution for the Kubernetes API. The PTR record refers to the record name of the API load balancer.
|
||||
<2> Provides reverse DNS resolution for the Kubernetes API. The PTR record refers to the record name of the API load balancer and is used for internal cluster communications.
|
||||
<3> Provides reverse DNS resolution for the bootstrap machine.
|
||||
<4> Provides reverse DNS resolution for the control plane machines.
|
||||
<5> Provides reverse DNS resolution for the compute machines.
|
||||
====
|
||||
ifndef::ibm-z,ibm-z-kvm[]
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
For clusters using installer-provisioned infrastructure, only the DNS records must be added.
|
||||
A PTR record is not required for the {product-title} application wildcard.
|
||||
====
|
||||
endif::ibm-z,ibm-z-kvm[]
|
||||
ifdef::ibm-z,ibm-z-kvm[]
|
||||
endif::ibm-z,ibm-z-kvm[]
|
||||
|
||||
ifeval::["{context}" == "installing-ibm-z"]
|
||||
:!ibm-z:
|
||||
@@ -204,4 +233,4 @@ endif::[]
|
||||
ifeval::["{context}" == "installing-restricted-networks-ibm-z-kvm"]
|
||||
:!ibm-z-kvm:
|
||||
:!restricted:
|
||||
endif::[]
|
||||
endif::[]
|
||||
|
||||
@@ -4,9 +4,9 @@
|
||||
// * installing/installing_ibm_z/installing-restricted-networks-ibm-z-kvm.adoc
|
||||
|
||||
[id="installation-user-infra-machines-iso-ibm-z-kvm-full_{context}"]
|
||||
= Full installation: Creating {op-system-first} machines
|
||||
= Full installation on a new QCOW2 disk image
|
||||
|
||||
Before you install a cluster on IBM Z infrastructure that you provision, you must install {op-system} as {op-system-base-full} guest virtual machines for the cluster to use. Complete the following steps to create the machines in a full installation on a new QEMU copy-on-write (QCOW2) disk image.
|
||||
Complete the following steps to create the machines in a full installation on a new QEMU copy-on-write (QCOW2) disk image.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/installing_ibm_z/installing-restricted-networks-ibm-z-kvm.adoc
|
||||
// * installing/installing_ibm_z/installing-ibm-z-kvm.adoc
|
||||
|
||||
[id="installation-ibm-z-kvm-user-infra-installing-rhcos_{context}"]
|
||||
= Installing {op-system} and starting the {product-title} bootstrap process
|
||||
|
||||
To install {product-title} on IBM Z infrastructure that you provision, you must install {op-system-first} as {op-system-base-full} guest virtual machines. When you install {op-system}, you must provide the Ignition config file that was generated by the {product-title} installation program for the type of machine you are installing. If you have configured suitable networking, DNS, and load balancing infrastructure, the {product-title} bootstrap process begins automatically after the {op-system} machines have rebooted.
|
||||
|
||||
You can perform a fast-track installation of {op-system} that uses a prepackaged QEMU copy-on-write (QCOW2) disk image. Alternatively, you can perform a full installation on a new QCOW2 disk image.
|
||||
@@ -1,11 +1,12 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/installing_ibm_z/installing-restricted-networks-ibm-z-kvm.adoc
|
||||
// * installing/installing_ibm_z/installing-ibm-z-kvm.adoc
|
||||
|
||||
[id="installation-user-infra-machines-iso-ibm-z_kvm_{context}"]
|
||||
= Fast-track installation: Creating {op-system-first} machines
|
||||
= Fast-track installation by using a prepackaged QCOW2 disk image
|
||||
|
||||
Before you install a cluster on IBM Z infrastructure that you provision, you must install {op-system} as {op-system-base-full} guest virtual machines for the cluster to use. Complete the following steps to create the machines in a fast-track installation of {op-system-first}, importing a prepackaged {op-system-first} QEMU copy-on-write (QCOW2) disk image.
|
||||
Complete the following steps to create the machines in a fast-track installation of {op-system-first}, importing a prepackaged {op-system-first} QEMU copy-on-write (QCOW2) disk image.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
|
||||
@@ -3,9 +3,11 @@
|
||||
// * installing/installing_ibm_z/installing-ibm-z.adoc
|
||||
|
||||
[id="installation-user-infra-machines-iso-ibm-z_{context}"]
|
||||
= Creating {op-system-first} machines
|
||||
= Installing {op-system} and starting the {product-title} bootstrap process
|
||||
|
||||
Before you install a cluster on IBM Z infrastructure that you provision, you must install {op-system} on z/VM guest virtual machines for the cluster to use. Complete the following steps to create the machines.
|
||||
To install {product-title} on IBM Z infrastructure that you provision, you must install {op-system-first} on z/VM guest virtual machines. When you install {op-system}, you must provide the Ignition config file that was generated by the {product-title} installation program for the type of machine you are installing. If you have configured suitable networking, DNS, and load balancing infrastructure, the {product-title} bootstrap process begins automatically after the {op-system} z/VM guest virtual machines have rebooted.
|
||||
|
||||
Complete the following steps to create the machines.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
|
||||
@@ -27,15 +27,22 @@ ifeval::["{context}" == "installing-restricted-networks-ibm-z-kvm"]
|
||||
endif::[]
|
||||
|
||||
[id="installation-infrastructure-user-infra_{context}"]
|
||||
= Creating the user-provisioned infrastructure
|
||||
= Preparing the user-provisioned infrastructure
|
||||
|
||||
Before you deploy an {product-title} cluster that uses user-provisioned
|
||||
infrastructure, you must create the underlying infrastructure.
|
||||
Before you install {product-title} on user-provisioned infrastructure, you must prepare the underlying infrastructure.
|
||||
|
||||
This section provides details about the high-level steps required to set up your cluster infrastructure in preparation for an {product-title} installation. This includes configuring IP networking and network connectivity for your cluster nodes,
|
||||
ifdef::ibm-z[]
|
||||
preparing a web server for the Ignition files,
|
||||
endif::ibm-z[]
|
||||
enabling the required ports through your firewall, and setting up the required DNS and load balancing infrastructure.
|
||||
|
||||
After preparation, your cluster infrastructure must meet the requirements outlined in the _Requirements for a cluster with user-provisioned infrastructure_ section.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* Review the link:https://access.redhat.com/articles/4128421[{product-title} 4.x Tested Integrations]
|
||||
page before you create the supporting infrastructure for your cluster.
|
||||
* You have reviewed the link:https://access.redhat.com/articles/4128421[{product-title} 4.x Tested Integrations] page.
|
||||
* You have reviewed the infrastructure requirements detailed in the _Requirements for a cluster with user-provisioned infrastructure_ section.
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -44,19 +51,48 @@ ifdef::ibm-z[]
|
||||
. Set up an HTTP or HTTPS server to provide Ignition files to the cluster nodes.
|
||||
endif::ibm-z[]
|
||||
ifndef::ibm-z[]
|
||||
. Configure DHCP or set static IP addresses on each node.
|
||||
. If you are using DHCP to provide the IP networking configuration to your cluster nodes, configure your DHCP service.
|
||||
.. Add persistent IP addresses for the nodes to your DHCP server configuration. In your configuration, match the MAC address of the relevant network interface to the intended IP address for each node.
|
||||
.. When you use DHCP to configure IP addressing for the cluster machines, the machines also obtain the DNS server information through DHCP. Define the persistent DNS server address that is used by the cluster nodes through your DHCP server configuration.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
If you are not using a DHCP service, you must provide the IP networking configuration and the address of the DNS server to the nodes at {op-system} install time. These can be passed as boot arguments if you are installing from an ISO image. See the _Creating Red Hat Enterprise Linux CoreOS (RHCOS) machines_ section for more information about static IP provisioning and advanced networking options.
|
||||
====
|
||||
+
|
||||
.. Define the hostnames of your cluster nodes in your DHCP server configuration. See the _Setting the cluster node hostnames through DHCP_ section for details about hostname considerations.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
If you are not using a DHCP service, the cluster nodes obtain their hostname through a reverse DNS lookup.
|
||||
====
|
||||
endif::ibm-z[]
|
||||
ifdef::ibm-z-kvm[]
|
||||
. Choose to perform either a fast track installation of {op-system-first} or a full installation of {op-system-first}. For the full installation you must set up an HTTP or HTTPS server to provide Ignition files and install images to the cluster nodes. For the fast track installation an HTTP or HTTPS server is not not required, however, a DHCP server is required. See sections “Fast-track installation: Creating {op-system-first} machines" and “Full installation: Creating {op-system-first} machines".
|
||||
endif::ibm-z-kvm[]
|
||||
|
||||
. Provision the required load balancers.
|
||||
. Ensure that your network infrastructure provides the required network connectivity between the cluster components. See the _Networking requirements for user-provisioned infrastructure_ section for details about the requirements.
|
||||
|
||||
. Configure the ports for your machines.
|
||||
. Configure your firewall to enable the ports required for the {product-title} cluster components to communicate. See _Networking requirements for user-provisioned infrastructure_ section for details about the ports that are required.
|
||||
|
||||
. Configure DNS.
|
||||
. Setup the required DNS infrastructure for your cluster.
|
||||
.. Configure DNS name resolution for the Kubernetes API, the application wildcard, the bootstrap machine, the control plane machines, and the compute machines.
|
||||
.. Configure reverse DNS resolution for the Kubernetes API, the bootstrap machine, the control plane machines, and the compute machines.
|
||||
+
|
||||
See the _User-provisioned DNS requirements_ section for more information about the {product-title} DNS requirements.
|
||||
|
||||
. Ensure network connectivity.
|
||||
. Validate your DNS configuration.
|
||||
.. From your installation node, run DNS lookups against the record names of the Kubernetes API, the wildcard routes, and the cluster nodes. Validate that the IP addresses in the responses correspond to the correct components.
|
||||
.. From your installation node, run reverse DNS lookups against the IP addresses of the load balancer and the cluster nodes. Validate that the record names in the responses correspond to the correct components.
|
||||
+
|
||||
See the _Validating DNS resolution for user-provisioned infrastructure_ section for detailed DNS validation steps.
|
||||
|
||||
. Provision the required API and application ingress load balancing infrastructure. See the _Load balancing requirements for user-provisioned infrastructure_ section for more information about the requirements.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
Some load balancing solutions require the DNS name resolution for the cluster nodes to be in place before the load balancing is initialized.
|
||||
====
|
||||
|
||||
ifeval::["{context}" == "installing-ibm-z"]
|
||||
:!ibm-z:
|
||||
|
||||
@@ -45,8 +45,7 @@ endif::[]
|
||||
= Manually creating the installation configuration file
|
||||
|
||||
ifndef::aws-gov,azure-gov,aws-private,azure-private,gcp-private[]
|
||||
For installations of {product-title} that use user-provisioned
|
||||
infrastructure, you manually generate your installation configuration file.
|
||||
For user-provisioned installations of {product-title}, you manually generate your installation configuration file.
|
||||
endif::aws-gov,azure-gov,aws-private,azure-private,gcp-private[]
|
||||
ifdef::aws-gov[]
|
||||
When installing {product-title} on Amazon Web Services (AWS) into a region
|
||||
@@ -63,7 +62,8 @@ endif::aws-private,azure-private,gcp-private[]
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* Obtain the {product-title} installation program and the access token for your
|
||||
* You have an SSH public key on your local machine to provide to the installation program. The key will be used for SSH authentication onto your cluster nodes for debugging and disaster recovery.
|
||||
* You have obtained the {product-title} installation program and the pull secret for your
|
||||
cluster.
|
||||
ifdef::restricted[]
|
||||
* Obtain the `imageContentSources` section from the output of the command to
|
||||
@@ -91,7 +91,7 @@ names for the installation assets might change between releases. Use caution
|
||||
when copying installation files from an earlier {product-title} version.
|
||||
====
|
||||
|
||||
. Customize the following `install-config.yaml` file template and save
|
||||
. Customize the sample `install-config.yaml` file template that is provided and save
|
||||
it in the `<installation_directory>`.
|
||||
+
|
||||
[NOTE]
|
||||
@@ -106,6 +106,11 @@ provide the certificate for your mirror.
|
||||
** You must include the `imageContentSources` section from the output of the command to
|
||||
mirror the repository.
|
||||
endif::restricted[]
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
For some platform types, you can alternatively run `./openshift-install create install-config --dir=<installation_directory>` to generate an `install-config.yaml` file. You can provide details about your cluster configuration at the prompts.
|
||||
====
|
||||
|
||||
. Back up the `install-config.yaml` file so that you can use it to install
|
||||
multiple clusters.
|
||||
|
||||
@@ -28,19 +28,16 @@ ifeval::["{context}" == "installing-restricted-networks-vmc-user-infra"]
|
||||
endif::[]
|
||||
|
||||
[id="installation-installing-bare-metal_{context}"]
|
||||
= Creating the cluster
|
||||
= Waiting for the bootstrap process to complete
|
||||
|
||||
To create the {product-title} cluster, you wait for the bootstrap process to
|
||||
complete on the machines that you provisioned by using the
|
||||
Ignition config files that you generated with the installation program.
|
||||
The {product-title} bootstrap process begins after the cluster nodes first boot into the persistent {op-system} environment that has been installed to disk. The configuration information provided through the Ignition config files is used to initialize the bootstrap process and install {product-title} on the machines. You must wait for the bootstrap process to complete.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* Create the required infrastructure for the cluster.
|
||||
* You obtained the installation program and generated the Ignition config files
|
||||
for your cluster.
|
||||
* You used the Ignition config files to create {op-system} machines for your
|
||||
cluster.
|
||||
* You have created the Ignition config files for your cluster.
|
||||
* You have configured suitable network, DNS and load balancing infrastructure.
|
||||
* You have obtained the installation program and generated the Ignition config files for your cluster.
|
||||
* You installed {op-system} on your cluster machines and provided the Ignition config files that the {product-title} installation program generated.
|
||||
ifndef::restricted[]
|
||||
* Your machines have direct Internet access or have an HTTP or HTTPS proxy available.
|
||||
endif::restricted[]
|
||||
@@ -75,7 +72,7 @@ load balancer.
|
||||
[IMPORTANT]
|
||||
====
|
||||
You must remove the bootstrap machine from the load balancer at this point. You
|
||||
can also remove or reformat the machine itself.
|
||||
can also remove or reformat the bootstrap machine itself.
|
||||
====
|
||||
|
||||
ifeval::["{context}" == "installing-restricted-networks-ibm-z"]
|
||||
|
||||
268
modules/installation-load-balancing-user-infra.adoc
Normal file
268
modules/installation-load-balancing-user-infra.adoc
Normal file
@@ -0,0 +1,268 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/installing_bare_metal/installing-bare-metal.adoc
|
||||
// * installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc
|
||||
// * installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc
|
||||
// * installing/installing_platform_agnostic/installing-platform-agnostic.adoc
|
||||
// * installing/installing_vmc/installing-restricted-networks-vmc-user-infra.adoc
|
||||
// * installing/installing_vmc/installing-vmc-user-infra.adoc
|
||||
// * installing/installing_vmc/installing-vmc-network-customizations-user-infra.adoc
|
||||
// * installing/installing_vsphere/installing-restricted-networks-vsphere.adoc
|
||||
// * installing/installing_vsphere/installing-vsphere.adoc
|
||||
// * installing/installing_vsphere/installing-vsphere-network-customizations.adoc
|
||||
// * installing/installing_ibm_z/installing-ibm-z.adoc
|
||||
// * installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc
|
||||
// * installing/installing_ibm_z/installing-ibm-z-kvm.adoc
|
||||
// * installing/installing_ibm_z/installing-ibm-power.adoc
|
||||
// * installing/installing_ibm_z/installing-restricted-networks-ibm-power.adoc
|
||||
// * installing/installing-rhv-restricted-network.adoc
|
||||
|
||||
ifeval::["{context}" == "installing-vsphere"]
|
||||
:vsphere:
|
||||
endif::[]
|
||||
|
||||
ifeval::["{context}" == "installing-restricted-networks-vsphere"]
|
||||
:vsphere:
|
||||
endif::[]
|
||||
|
||||
ifeval::["{context}" == "installing-vsphere-network-customizations"]
|
||||
:vsphere:
|
||||
endif::[]
|
||||
|
||||
ifeval::["{context}" == "installing-ibm-z"]
|
||||
:ibm-z:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "installing-ibm-z-kvm"]
|
||||
:ibm-z-kvm:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "installing-restricted-networks-ibm-z"]
|
||||
:restricted:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "installing-restricted-networks-ibm-power"]
|
||||
:restricted:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "installing-restricted-networks-bare-metal"]
|
||||
:restricted:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "installing-restricted-networks-bare-metal"]
|
||||
:restricted:
|
||||
endif::[]
|
||||
|
||||
[id="installation-load-balancing-user-infra_{context}"]
|
||||
= Load balancing requirements for user-provisioned infrastructure
|
||||
|
||||
Before you install {product-title}, you must provision the API and application ingress load balancing infrastructure. In production scenarios, you can deploy the API and application ingress load balancers separately so that you can scale the load balancer infrastructure for each in isolation.
|
||||
|
||||
The load balancing infrastructure must meet the following requirements:
|
||||
|
||||
. *API load balancer*: Provides a common endpoint for users, both human and machine, to interact with and configure the platform. Configure the following conditions:
|
||||
+
|
||||
--
|
||||
** Layer 4 load balancing only. This can be referred to as Raw TCP, SSL Passthrough, or SSL Bridge mode. If you use SSL Bridge mode, you must enable Server Name Indication (SNI) for the API routes.
|
||||
** A stateless load balancing algorithm. The options vary based on the load balancer implementation.
|
||||
--
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
Session persistence is not required for the API load balancer to function properly.
|
||||
====
|
||||
+
|
||||
Configure the following ports on both the front and back of the load balancers:
|
||||
+
|
||||
.API load balancer
|
||||
[cols="2,5,^2,^2,2",options="header"]
|
||||
|===
|
||||
|
||||
|Port
|
||||
|Back-end machines (pool members)
|
||||
|Internal
|
||||
|External
|
||||
|Description
|
||||
|
||||
|`6443`
|
||||
|Bootstrap and control plane. You remove the bootstrap machine from the load
|
||||
balancer after the bootstrap machine initializes the cluster control plane. You
|
||||
must configure the `/readyz` endpoint for the API server health check probe.
|
||||
|X
|
||||
|X
|
||||
|Kubernetes API server
|
||||
|
||||
|`22623`
|
||||
|Bootstrap and control plane. You remove the bootstrap machine from the load
|
||||
balancer after the bootstrap machine initializes the cluster control plane.
|
||||
|X
|
||||
|
|
||||
|Machine config server
|
||||
|
||||
|===
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
The load balancer must be configured to take a maximum of 30 seconds from the
|
||||
time the API server turns off the `/readyz` endpoint to the removal of the API
|
||||
server instance from the pool. Within the time frame after `/readyz` returns an
|
||||
error or becomes healthy, the endpoint must have been removed or added. Probing
|
||||
every 5 or 10 seconds, with two successful requests to become healthy and three
|
||||
to become unhealthy, are well-tested values.
|
||||
====
|
||||
|
||||
. *Application ingress load balancer*: Provides an ingress point for application traffic flowing in from outside the cluster. Configure the following conditions:
|
||||
+
|
||||
--
|
||||
** Layer 4 load balancing only. This can be referred to as Raw TCP, SSL Passthrough, or SSL Bridge mode. If you use SSL Bridge mode, you must enable Server Name Indication (SNI) for the ingress routes.
|
||||
** A connection-based or session-based persistence is recommended, based on the options available and types of applications that will be hosted on the platform.
|
||||
--
|
||||
+
|
||||
[TIP]
|
||||
====
|
||||
If the true IP address of the client can be seen by the application ingress load balancer, enabling source IP-based session persistence can improve performance for applications that use end-to-end TLS encryption.
|
||||
====
|
||||
+
|
||||
Configure the following ports on both the front and back of the load balancers:
|
||||
+
|
||||
.Application ingress load balancer
|
||||
[cols="2,5,^2,^2,2",options="header"]
|
||||
|===
|
||||
|
||||
|Port
|
||||
|Back-end machines (pool members)
|
||||
|Internal
|
||||
|External
|
||||
|Description
|
||||
|
||||
|`443`
|
||||
|The machines that run the Ingress Controller pods, compute, or worker, by default.
|
||||
|X
|
||||
|X
|
||||
|HTTPS traffic
|
||||
|
||||
|`80`
|
||||
|The machines that run the Ingress Controller pods, compute, or worker, by default.
|
||||
|X
|
||||
|X
|
||||
|HTTP traffic
|
||||
|
||||
|===
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
If you are deploying a three-node cluster with zero compute nodes, the Ingress Controller pods run on the control plane nodes. In three-node cluster deployments, you must configure your application ingress load balancer to route HTTP and HTTPS traffic to the control plane nodes.
|
||||
====
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
A working configuration for the Ingress router is required for an
|
||||
{product-title} cluster. You must configure the Ingress router after the control
|
||||
plane initializes.
|
||||
====
|
||||
|
||||
[id="installation-load-balancing-user-infra-example_{context}"]
|
||||
== Example load balancer configuration for user-provisioned clusters
|
||||
|
||||
This section provides an example API and application ingress load balancer configuration that meets the load balancing requirements for user-provisioned clusters. The sample is an `/etc/haproxy/haproxy.cfg` configuration for an HAProxy load balancer. The example is not meant to provide advice for choosing one load balancing solution over another.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
In the example, the same load balancer is used for the Kubernetes API and application ingress traffic. In production scenarios you can deploy the API and application ingress load balancers separately so that you can scale the load balancer infrastructure for each in isolation.
|
||||
====
|
||||
|
||||
.Sample API and application ingress load balancer configuration
|
||||
[%collapsible]
|
||||
====
|
||||
[source,text]
|
||||
----
|
||||
global
|
||||
log 127.0.0.1 local2
|
||||
pidfile /var/run/haproxy.pid
|
||||
maxconn 4000
|
||||
daemon
|
||||
defaults
|
||||
mode http
|
||||
log global
|
||||
option dontlognull
|
||||
option http-server-close
|
||||
option redispatch
|
||||
retries 3
|
||||
timeout http-request 10s
|
||||
timeout queue 1m
|
||||
timeout connect 10s
|
||||
timeout client 1m
|
||||
timeout server 1m
|
||||
timeout http-keep-alive 10s
|
||||
timeout check 10s
|
||||
maxconn 3000
|
||||
frontend stats
|
||||
bind *:1936
|
||||
mode http
|
||||
log global
|
||||
maxconn 10
|
||||
stats enable
|
||||
stats hide-version
|
||||
stats refresh 30s
|
||||
stats show-node
|
||||
stats show-desc Stats for ocp4 cluster <1>
|
||||
stats auth admin:ocp4
|
||||
stats uri /stats
|
||||
listen api-server-6443 <2>
|
||||
bind *:6443
|
||||
mode tcp
|
||||
server bootstrap bootstrap.ocp4.example.com:6443 check inter 1s backup <3>
|
||||
server master0 master0.ocp4.example.com:6443 check inter 1s
|
||||
server master1 master1.ocp4.example.com:6443 check inter 1s
|
||||
server master2 master2.ocp4.example.com:6443 check inter 1s
|
||||
listen machine-config-server-22623 <4>
|
||||
bind *:22623
|
||||
mode tcp
|
||||
server bootstrap bootstrap.ocp4.example.com:22623 check inter 1s backup <3>
|
||||
server master0 master0.ocp4.example.com:22623 check inter 1s
|
||||
server master1 master1.ocp4.example.com:22623 check inter 1s
|
||||
server master2 master2.ocp4.example.com:22623 check inter 1s
|
||||
listen ingress-router-443 <5>
|
||||
bind *:443
|
||||
mode tcp
|
||||
balance source
|
||||
server worker0 worker0.ocp4.example.com:443 check inter 1s
|
||||
server worker1 worker1.ocp4.example.com:443 check inter 1s
|
||||
listen ingress-router-80 <6>
|
||||
bind *:80
|
||||
mode tcp
|
||||
balance source
|
||||
server worker0 worker0.ocp4.example.com:80 check inter 1s
|
||||
server worker1 worker1.ocp4.example.com:80 check inter 1s
|
||||
----
|
||||
|
||||
<1> In the example, the cluster name is `ocp4`.
|
||||
<2> Port `6443` handles the Kubernetes API traffic and points to the control plane machines.
|
||||
<3> The bootstrap entries must be in place before the {product-title} cluster installation and they must be removed after the bootstrap process is complete.
|
||||
<4> Port `22623` handles the machine config server traffic and points to the control plane machines.
|
||||
<5> Port `443` handles the HTTPS traffic and points to the machines that run the Ingress Controller pods. The Ingress Controller pods run on the compute machines by default.
|
||||
<6> Port `80` handles the HTTP traffic and points to the machines that run the Ingress Controller pods. The Ingress Controller pods run on the compute machines by default.
|
||||
+
|
||||
[NOTE]
|
||||
=====
|
||||
If you are deploying a three-node cluster with zero compute nodes, the Ingress Controller pods run on the control plane nodes. In three-node cluster deployments, you must configure your application ingress load balancer to route HTTP and HTTPS traffic to the control plane nodes.
|
||||
=====
|
||||
====
|
||||
|
||||
[TIP]
|
||||
====
|
||||
If you are using HAProxy as a load balancer, you can check that the `haproxy` process is listening on ports `6443`, `22623`, `443`, and `80` by running `netstat -nltupe` on the HAProxy node.
|
||||
====
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
If you are using HAProxy as a load balancer and SELinux is set to `enforcing`, you must ensure that the HAProxy service can bind to the configured TCP port by running `setsebool -P haproxy_connect_any=1`.
|
||||
====
|
||||
|
||||
ifeval::["{context}" == "installing-ibm-z"]
|
||||
:!ibm-z:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "installing-ibm-z-kvm"]
|
||||
:!ibm-z-kvm:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "installing-restricted-networks-ibm-z"]
|
||||
:!restricted:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "installing-restricted-networks-ibm-power"]
|
||||
:!restricted:
|
||||
endif::[]
|
||||
@@ -41,27 +41,34 @@ endif::[]
|
||||
ifeval::["{context}" == "installing-restricted-networks-ibm-power"]
|
||||
:restricted:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "installing-restricted-networks-bare-metal"]
|
||||
:restricted:
|
||||
endif::[]
|
||||
ifeval::["{context}" == "installing-restricted-networks-bare-metal"]
|
||||
:restricted:
|
||||
endif::[]
|
||||
|
||||
[id="installation-network-user-infra_{context}"]
|
||||
= Networking requirements for user-provisioned infrastructure
|
||||
|
||||
All the {op-system-first} machines require network in `initramfs` during boot
|
||||
to fetch Ignition config from the machine config server.
|
||||
All the {op-system-first} machines require networking to be configured in `initramfs` during boot
|
||||
to fetch their Ignition config files.
|
||||
|
||||
ifdef::ibm-z[]
|
||||
During the initial boot, the machines require an HTTP or HTTPS server to
|
||||
establish a network connection to download their Ignition config files.
|
||||
|
||||
Ensure that the machines have persistent IP addresses and host names.
|
||||
The machines are configured with static IP addresses. No DHCP server is required. Ensure that the machines have persistent IP addresses and hostnames.
|
||||
endif::ibm-z[]
|
||||
ifndef::ibm-z[]
|
||||
During the initial boot, the machines require either a DHCP server
|
||||
or that static IP addresses be set on each host in the cluster to
|
||||
establish a network connection, which allows them to download their Ignition config files.
|
||||
During the initial boot, the machines require an IP address configuration that is set either through a DHCP server or statically by providing the required boot options. After a network connection is established, the machines download their Ignition config files from an HTTP or HTTPS server. The Ignition config files are then used to set the exact state of each machine. The Machine Config Operator completes more changes to the machines, such as the application of new certificates or keys, after installation.
|
||||
|
||||
It is recommended to use the DHCP server to manage the machines for the cluster
|
||||
long-term. Ensure that the DHCP server is configured to provide persistent IP
|
||||
addresses and host names to the cluster machines.
|
||||
It is recommended to use a DHCP server for long-term management of the cluster machines. Ensure that the DHCP server is configured to provide persistent IP addresses, DNS server information, and hostnames to the cluster machines.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
If a DHCP service is not available for your user-provisioned infrastructure, you can instead provide the IP networking configuration and the address of the DNS server to the nodes at {op-system} install time. These can be passed as boot arguments if you are installing from an ISO image. See the _Creating Red Hat Enterprise Linux CoreOS (RHCOS) machines_ section for more information about static IP provisioning and advanced networking options.
|
||||
====
|
||||
endif::ibm-z[]
|
||||
|
||||
The Kubernetes API server must be able to resolve the node names of the cluster
|
||||
@@ -70,10 +77,32 @@ configure a default DNS search zone to allow the API server to resolve the
|
||||
node names. Another supported approach is to always refer to hosts by their
|
||||
fully-qualified domain names in both the node objects and all DNS requests.
|
||||
|
||||
You must configure the network connectivity between machines to allow cluster
|
||||
components to communicate. Each machine must be able to resolve the host names
|
||||
ifndef::ibm-z[]
|
||||
[id="installation-host-names-dhcp-user-infra_{context}"]
|
||||
== Setting the cluster node hostnames through DHCP
|
||||
|
||||
On {op-system-first} machines, the hostname is set through NetworkManager. By default, the machines obtain their hostname through DHCP. If the hostname is not provided by DHCP, it is obtained through a reverse DNS lookup. Reverse DNS lookup occurs after the network has been initialized on a node and can take time to resolve. Other system services can start prior to this and detect the hostname as `localhost` or similar. You can avoid this by using DHCP to provide the hostname for each cluster node.
|
||||
|
||||
Additionally, setting the hostnames through DHCP can bypass any manual DNS record name configuration errors in environments that have a DNS split-horizon implementation.
|
||||
endif::ibm-z[]
|
||||
|
||||
[id="installation-network-connectivity-user-infra_{context}"]
|
||||
== Network connectivity requirements
|
||||
|
||||
You must configure the network connectivity between machines to allow {product-title} cluster
|
||||
components to communicate. Each machine must be able to resolve the hostnames
|
||||
of all other machines in the cluster.
|
||||
|
||||
This section provides details about the ports that are required.
|
||||
|
||||
ifndef::restricted,origin[]
|
||||
[IMPORTANT]
|
||||
====
|
||||
In connected {product-title} environments, all nodes are required to have Internet access to pull images
|
||||
for platform containers and provide telemetry data to Red Hat.
|
||||
====
|
||||
endif::restricted,origin[]
|
||||
|
||||
ifdef::ibm-z-kvm[]
|
||||
[NOTE]
|
||||
====
|
||||
@@ -81,7 +110,7 @@ The {op-system-base} KVM host must be configured to use bridged networking in li
|
||||
====
|
||||
endif::ibm-z-kvm[]
|
||||
|
||||
.All machines to all machines
|
||||
.Ports used for all-machine to all-machine communications
|
||||
[cols="2a,2a,5a",options="header"]
|
||||
|===
|
||||
|
||||
@@ -123,7 +152,7 @@ the Cluster Version Operator on port `9099`.
|
||||
|
||||
|===
|
||||
|
||||
.All machines to control plane
|
||||
.Ports used for all-machine to control plane communications
|
||||
[cols="2a,2a,5a",options="header"]
|
||||
|===
|
||||
|
||||
@@ -137,7 +166,7 @@ the Cluster Version Operator on port `9099`.
|
||||
|
||||
|===
|
||||
|
||||
.Control plane machines to control plane machines
|
||||
.Ports used for control plane machine to control plane machine communications
|
||||
[cols="2a,2a,5a",options="header"]
|
||||
|===
|
||||
|
||||
@@ -151,121 +180,6 @@ the Cluster Version Operator on port `9099`.
|
||||
|
||||
|===
|
||||
|
||||
[discrete]
|
||||
== Network topology requirements
|
||||
|
||||
The infrastructure that you provision for your cluster must meet the following
|
||||
network topology requirements.
|
||||
|
||||
ifndef::restricted,origin[]
|
||||
[IMPORTANT]
|
||||
====
|
||||
{product-title} requires all nodes to have internet access to pull images
|
||||
for platform containers and provide telemetry data to Red Hat.
|
||||
====
|
||||
endif::restricted,origin[]
|
||||
|
||||
[discrete]
|
||||
=== Load balancers
|
||||
|
||||
Before you install {product-title}, you must provision two load balancers that meet the following requirements:
|
||||
|
||||
. *API load balancer*: Provides a common endpoint for users, both human and machine, to interact with and configure the platform. Configure the following conditions:
|
||||
+
|
||||
--
|
||||
** Layer 4 load balancing only. This can be referred to as Raw TCP, SSL Passthrough, or SSL Bridge mode. If you use SSL Bridge mode, you must enable Server Name Indication (SNI) for the API routes.
|
||||
** A stateless load balancing algorithm. The options vary based on the load balancer implementation.
|
||||
--
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
Session persistence is not required for the API load balancer to function properly.
|
||||
====
|
||||
+
|
||||
Configure the following ports on both the front and back of the load balancers:
|
||||
+
|
||||
.API load balancer
|
||||
[cols="2,5,^2,^2,2",options="header"]
|
||||
|===
|
||||
|
||||
|Port
|
||||
|Back-end machines (pool members)
|
||||
|Internal
|
||||
|External
|
||||
|Description
|
||||
|
||||
|`6443`
|
||||
|Bootstrap and control plane. You remove the bootstrap machine from the load
|
||||
balancer after the bootstrap machine initializes the cluster control plane. You
|
||||
must configure the `/readyz` endpoint for the API server health check probe.
|
||||
|X
|
||||
|X
|
||||
|Kubernetes API server
|
||||
|
||||
|`22623`
|
||||
|Bootstrap and control plane. You remove the bootstrap machine from the load
|
||||
balancer after the bootstrap machine initializes the cluster control plane.
|
||||
|X
|
||||
|
|
||||
|Machine config server
|
||||
|
||||
|===
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
The load balancer must be configured to take a maximum of 30 seconds from the
|
||||
time the API server turns off the `/readyz` endpoint to the removal of the API
|
||||
server instance from the pool. Within the time frame after `/readyz` returns an
|
||||
error or becomes healthy, the endpoint must have been removed or added. Probing
|
||||
every 5 or 10 seconds, with two successful requests to become healthy and three
|
||||
to become unhealthy, are well-tested values.
|
||||
====
|
||||
|
||||
. *Application Ingress load balancer*: Provides an Ingress point for application traffic flowing in from outside the cluster. Configure the following conditions:
|
||||
+
|
||||
--
|
||||
** Layer 4 load balancing only. This can be referred to as Raw TCP, SSL Passthrough, or SSL Bridge mode. If you use SSL Bridge mode, you must enable Server Name Indication (SNI) for the Ingress routes.
|
||||
** A connection-based or session-based persistence is recommended, based on the options available and types of applications that will be hosted on the platform.
|
||||
--
|
||||
+
|
||||
Configure the following ports on both the front and back of the load balancers:
|
||||
+
|
||||
.Application Ingress load balancer
|
||||
[cols="2,5,^2,^2,2",options="header"]
|
||||
|===
|
||||
|
||||
|Port
|
||||
|Back-end machines (pool members)
|
||||
|Internal
|
||||
|External
|
||||
|Description
|
||||
|
||||
|`443`
|
||||
|The machines that run the Ingress router pods, compute, or worker, by default.
|
||||
|X
|
||||
|X
|
||||
|HTTPS traffic
|
||||
|
||||
|`80`
|
||||
|The machines that run the Ingress router pods, compute, or worker, by default.
|
||||
|X
|
||||
|X
|
||||
|HTTP traffic
|
||||
|
||||
|===
|
||||
|
||||
[TIP]
|
||||
====
|
||||
If the true IP address of the client can be seen by the load balancer, enabling source IP-based session persistence can improve performance for applications that use end-to-end TLS encryption.
|
||||
====
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
A working configuration for the Ingress router is required for an
|
||||
{product-title} cluster. You must configure the Ingress router after the control
|
||||
plane initializes.
|
||||
====
|
||||
|
||||
ifdef::vsphere[]
|
||||
[discrete]
|
||||
== Ethernet adaptor hardware address requirements
|
||||
@@ -288,9 +202,15 @@ ifdef::vsphere[]
|
||||
endif::[]
|
||||
|
||||
[discrete]
|
||||
== NTP configuration
|
||||
== NTP configuration for user-provisioned infrastructure
|
||||
|
||||
An {product-title} cluster that is installed in a restricted network is configured to use a public Network Time Protocol (NTP) server by default. To avoid clock skew, reconfigure the cluster to use a private NTP server instead. For more information, see the documentation for _Configuring chrony time service_.
|
||||
Each {product-title} node in the cluster must have access to a Network Time Protocol (NTP) server.
|
||||
|
||||
{product-title} clusters are configured to use a public Network Time Protocol (NTP) server by default. If you want to use a local enterprise NTP server, or if your cluster is being deployed in a disconnected network, you can configure the cluster to use a specific time server. For more information, see the documentation for _Configuring chrony time service_.
|
||||
|
||||
ifndef::ibm-z[]
|
||||
If a DHCP server provides NTP server information, the chrony time service on the {op-system-first} machines read the information and can sync the clock with the NTP servers.
|
||||
endif::ibm-z[]
|
||||
|
||||
ifeval::["{context}" == "installing-ibm-z"]
|
||||
:!ibm-z:
|
||||
|
||||
@@ -98,7 +98,7 @@ $ tar xvf openshift-install-linux.tar.gz
|
||||
----
|
||||
|
||||
. From the
|
||||
link:https://cloud.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site, download your installation pull secret as a `.txt` file. This pull secret allows you to authenticate with the services that
|
||||
link:https://cloud.redhat.com/openshift/install/pull-secret[Pull Secret] page on the {cloud-redhat-com} site, download your installation pull secret. This pull secret allows you to authenticate with the services that
|
||||
are provided by the included authorities, including Quay.io, which serves the
|
||||
container images for {product-title} components.
|
||||
ifdef::openshift-origin[]
|
||||
|
||||
@@ -50,31 +50,43 @@ ifeval::["{context}" == "installing-platform-agnostic"]
|
||||
endif::[]
|
||||
|
||||
[id="installation-requirements-user-infra_{context}"]
|
||||
= Machine requirements for a cluster with user-provisioned infrastructure
|
||||
= Requirements for a cluster with user-provisioned infrastructure
|
||||
|
||||
For a cluster that contains user-provisioned infrastructure, you must deploy all
|
||||
of the required machines.
|
||||
|
||||
This section describes the requirements for deploying {product-title} on user-provisioned infrastructure.
|
||||
|
||||
[id="machine-requirements_{context}"]
|
||||
== Required machines
|
||||
|
||||
The smallest {product-title} clusters require the following hosts:
|
||||
|
||||
* One temporary bootstrap machine
|
||||
.Default monitoring stack components
|
||||
[options="header"]
|
||||
|===
|
||||
|
||||
* Three control plane, or master, machines
|
||||
|Hosts |Description
|
||||
|
||||
* At least two compute machines, which are also known as worker machines.
|
||||
ifdef::bare-metal[]
|
||||
If you are running a three-node cluster, running zero compute machines is supported. Running one compute machine is not supported.
|
||||
endif::bare-metal[]
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
The cluster requires the bootstrap machine to deploy the {product-title} cluster
|
||||
|One temporary bootstrap machine
|
||||
|The cluster requires the bootstrap machine to deploy the {product-title} cluster
|
||||
on the three control plane machines. You can remove the bootstrap machine after
|
||||
you install the cluster.
|
||||
|
||||
|Three control plane machines
|
||||
|The control plane machines run the Kubernetes and {product-title} services that form the control plane.
|
||||
|
||||
|At least two compute machines, which are also known as worker machines.
|
||||
|The workloads requested by {product-title} users run on the compute machines.
|
||||
|
||||
|===
|
||||
|
||||
ifdef::bare-metal[]
|
||||
[NOTE]
|
||||
====
|
||||
As an exception, you can run zero compute machines in a bare metal cluster that consists of three control plane machines only. This provides smaller, more resource efficient clusters for cluster administrators and developers to use for testing, development, and production. Running one compute machine is not supported.
|
||||
====
|
||||
endif::bare-metal[]
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
@@ -108,32 +120,6 @@ All virtual machines must reside in the same datastore and in the same folder as
|
||||
====
|
||||
endif::vsphere[]
|
||||
|
||||
|
||||
[id="network-connectivity_{context}"]
|
||||
== Network connectivity requirements
|
||||
|
||||
All the {op-system-first} machines require network in `initramfs` during boot to fetch Ignition config files from the Machine Config Server.
|
||||
ifndef::ibm-z[]
|
||||
During the initial boot, the machines require either a DHCP server or that static IP addresses be set in order to establish a network connection to download their Ignition config files.
|
||||
endif::ibm-z[]
|
||||
ifdef::ibm-z[]
|
||||
The machines are configured with static IP addresses. No DHCP server is required.
|
||||
endif::ibm-z[]
|
||||
Additionally, each {product-title} node in the cluster must have access to a Network Time Protocol (NTP) server.
|
||||
ifndef::ibm-z[]
|
||||
If a DHCP server provides NTP servers information, the chrony time service on the {op-system-first} machines read the information and can sync the clock with the NTP servers.
|
||||
endif::ibm-z[]
|
||||
|
||||
ifdef::ibm-z[]
|
||||
[id="ibm-z-network-connectivity_{context}"]
|
||||
== IBM Z network connectivity requirements
|
||||
|
||||
To install on IBM Z under z/VM, you require a single z/VM virtual NIC in layer 2 mode. You also need:
|
||||
|
||||
* A direct-attached OSA or RoCE network adapter
|
||||
* A z/VM VSwitch set up. For a preferred setup, use OSA link aggregation.
|
||||
endif::ibm-z[]
|
||||
|
||||
[id="minimum-resource-requirements_{context}"]
|
||||
== Minimum resource requirements
|
||||
|
||||
@@ -165,7 +151,7 @@ ifndef::ibm-power[|4]
|
||||
ifndef::openshift-origin[]
|
||||
|Compute
|
||||
ifdef::ibm-z,ibm-power[|{op-system}]
|
||||
ifndef::ibm-z,ibm-power[|{op-system} or RHEL 7.9]
|
||||
ifndef::ibm-z,ibm-power[|{op-system} or {op-system-base} 7.9 ^[2]^]
|
||||
|2
|
||||
|8 GB
|
||||
|120 GB
|
||||
@@ -186,6 +172,7 @@ ifdef::ibm-z[]
|
||||
endif::ibm-z[]
|
||||
ifndef::ibm-z[]
|
||||
1. 1 vCPU is equivalent to 1 physical core when simultaneous multithreading (SMT), or hyperthreading, is not enabled. When enabled, use the following formula to calculate the corresponding ratio: (threads per core × cores) × sockets = vCPUs.
|
||||
2. As with all user-provisioned installations, if you choose to use {op-system-base} 7 compute machines in your cluster, you take responsibility for all operating system life cycle management and maintenance, including performing system updates, applying patches, and completing all other required tasks. Use of {op-system-base} 7 compute machines is deprecated and planned for removal in a future release of {product-title} 4.
|
||||
endif::ibm-z[]
|
||||
--
|
||||
|
||||
@@ -215,6 +202,14 @@ On your z/VM instance, set up:
|
||||
* 2 guest virtual machines for {product-title} compute machines
|
||||
* 1 guest virtual machine for the temporary {product-title} bootstrap machine
|
||||
|
||||
[discrete]
|
||||
== IBM Z network connectivity requirements
|
||||
|
||||
To install on IBM Z under z/VM, you require a single z/VM virtual NIC in layer 2 mode. You also need:
|
||||
|
||||
* A direct-attached OSA or RoCE network adapter
|
||||
* A z/VM VSwitch set up. For a preferred setup, use OSA link aggregation.
|
||||
|
||||
[discrete]
|
||||
=== Disk storage for the z/VM guest virtual machines
|
||||
|
||||
@@ -236,7 +231,7 @@ On your z/VM instance, set up:
|
||||
|
||||
* 3 LPARs with 6 IFLs each that support SMT2
|
||||
* 1 or 2 OSA or RoCE network adapters, or both
|
||||
* Hipersockets, which are attached to a node either directly as a device or by bridging with one z/VM VSWITCH to be transparent to the z/VM guest. To directly connect Hipersockets to a node, you must set up a gateway to the external network via a RHEL 8 guest to bridge to the Hipersockets network.
|
||||
* Hipersockets, which are attached to a node either directly as a device or by bridging with one z/VM VSWITCH to be transparent to the z/VM guest. To directly connect Hipersockets to a node, you must set up a gateway to the external network via a {op-system-base} 8 guest to bridge to the Hipersockets network.
|
||||
|
||||
[discrete]
|
||||
=== Operating system requirements
|
||||
@@ -250,6 +245,14 @@ On your z/VM instances, set up:
|
||||
* 1 guest virtual machine for the temporary {product-title} bootstrap machine
|
||||
* To ensure the availability of integral components in an overcommitted environment, increase the priority of the control plane using the CP command `SET SHARE`. Do the same for infrastructure plane machines if they exist. See link:https://www.ibm.com/support/knowledgecenter/en/SSB27U_7.1.0/com.ibm.zvm.v710.hcpb7/setshare.htm[SET SHARE] in the IBM Knowledge Center.
|
||||
|
||||
[discrete]
|
||||
== IBM Z network connectivity requirements
|
||||
|
||||
To install on IBM Z under z/VM, you require a single z/VM virtual NIC in layer 2 mode. You also need:
|
||||
|
||||
* A direct-attached OSA or RoCE network adapter
|
||||
* A z/VM VSwitch set up. For a preferred setup, use OSA link aggregation.
|
||||
|
||||
[discrete]
|
||||
=== Disk storage for the z/VM guest virtual machines
|
||||
|
||||
@@ -347,7 +350,7 @@ On your IBM Power instance, set up:
|
||||
endif::ibm-power[]
|
||||
|
||||
[id="csr_management_{context}"]
|
||||
== Certificate signing requests management
|
||||
== Managing certificate signing requests
|
||||
|
||||
Because your cluster has limited access to automatic machine management when you
|
||||
use infrastructure that you provision, you must provide a mechanism for approving
|
||||
|
||||
@@ -15,11 +15,17 @@
|
||||
[id="installation-three-node-cluster_{context}"]
|
||||
= Configuring a three-node cluster
|
||||
|
||||
You can optionally install and run three-node clusters in {product-title} with no workers. This provides smaller, more resource efficient clusters for cluster administrators and developers to use for development, production, and testing.
|
||||
You can optionally deploy zero compute machines in a bare metal cluster that consists of three control plane machines only. This provides smaller, more resource efficient clusters for cluster administrators and developers to use for testing, development, and production.
|
||||
|
||||
In three-node {product-title} environments, the three control plane machines are schedulable, which means that your application workloads are scheduled to run on them.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You have an existing `install-config.yaml` file.
|
||||
|
||||
.Procedure
|
||||
|
||||
* Edit the `install-config.yaml` file to set the number of compute replicas, which are also known as worker replicas, to `0`, as shown in the following `compute` stanza:
|
||||
* Ensure that the number of compute replicas is set to `0` in your `install-config.yaml` file, as shown in the following `compute` stanza:
|
||||
+
|
||||
[source,yaml]
|
||||
----
|
||||
@@ -28,3 +34,18 @@ compute:
|
||||
platform: {}
|
||||
replicas: 0
|
||||
----
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
You must set the value of the `replicas` parameter for the compute machines to `0` when you install {product-title} on user-provisioned infrastructure, regardless of the number of compute machines you are deploying. In installer-provisioned installations, the parameter controls the number of compute machines that the cluster creates and manages for you. This does not apply to user-provisioned installations, where the compute machines are deployed manually.
|
||||
====
|
||||
|
||||
.Next steps
|
||||
|
||||
For three-node cluster installations, follow these next steps:
|
||||
|
||||
* If you are deploying a three-node cluster with zero compute nodes, the Ingress Controller pods run on the control plane nodes. In three-node cluster deployments, you must configure your application ingress load balancer to route HTTP and HTTPS traffic to the control plane nodes. See the _Load balancing requirements for user-provisioned infrastructure_ section for more information.
|
||||
|
||||
* When you create the Kubernetes manifest files in the following procedure, ensure that the `mastersSchedulable` parameter in the `<installation_directory>/manifests/cluster-scheduler-02-config.yml` file is set to `true`. This enables your application workloads to run on the control plane nodes.
|
||||
|
||||
* Do not deploy any compute nodes when you create the {op-system-first} machines.
|
||||
|
||||
@@ -77,13 +77,13 @@ endif::[]
|
||||
[id="installation-user-infra-generate-k8s-manifest-ignition_{context}"]
|
||||
= Creating the Kubernetes manifest and Ignition config files
|
||||
|
||||
Because you must modify some cluster definition files and manually start the cluster machines, you must generate the Kubernetes manifest and Ignition config files that the cluster needs to make its machines.
|
||||
Because you must modify some cluster definition files and manually start the cluster machines, you must generate the Kubernetes manifest and Ignition config files that the cluster needs to configure the machines.
|
||||
|
||||
The installation configuration file transforms into the Kubernetes manifests. The manifests wrap into the Ignition configuration files, which are later used to create the cluster.
|
||||
The installation configuration file transforms into the Kubernetes manifests. The manifests wrap into the Ignition configuration files, which are later used to configure the cluster machines.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
The Ignition config files that the installation program generates contain certificates that expire after 24 hours, which are then renewed at that time. If the cluster is shut down before renewing the certificates and the cluster is later restarted after the 24 hours have elapsed, the cluster automatically recovers the expired certificates. The exception is that you must manually approve the pending `node-bootstrapper` certificate signing requests (CSRs) to recover kubelet certificates. See the documentation for _Recovering from expired control plane certificates_ for more information.
|
||||
The Ignition config files that the {product-title} installation program generates contain certificates that expire after 24 hours, which are then renewed at that time. If the cluster is shut down before renewing the certificates and the cluster is later restarted after the 24 hours have elapsed, the cluster automatically recovers the expired certificates. The exception is that you must manually approve the pending `node-bootstrapper` certificate signing requests (CSRs) to recover kubelet certificates. See the documentation for _Recovering from expired control plane certificates_ for more information.
|
||||
====
|
||||
|
||||
.Prerequisites
|
||||
@@ -96,7 +96,7 @@ endif::restricted,baremetal-restricted[]
|
||||
|
||||
.Procedure
|
||||
|
||||
. Change to the directory that contains the installation program and generate the Kubernetes manifests for the cluster:
|
||||
. Change to the directory that contains the {product-title} installation program and generate the Kubernetes manifests for the cluster:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
@@ -157,13 +157,14 @@ to initialize them.
|
||||
+
|
||||
* You can preserve the machine set files to create compute machines by using the machine API, but you must update references to them to match your environment.
|
||||
endif::osp,vsphere,vmc[]
|
||||
|
||||
ifdef::baremetal,baremetal-restricted[]
|
||||
+
|
||||
[WARNING]
|
||||
====
|
||||
If you are running a three-node cluster, skip the following step to allow the masters to be schedulable.
|
||||
If you are installing a three-node cluster, skip the following step to allow the control plane nodes to be schedulable.
|
||||
====
|
||||
endif::baremetal,baremetal-restricted[]
|
||||
|
||||
. Check that the `mastersSchedulable` parameter in the `<installation_directory>/manifests/cluster-scheduler-02-config.yml` Kubernetes manifest file is set to `false`. This setting prevents pods from being scheduled on the control plane machines:
|
||||
+
|
||||
--
|
||||
@@ -288,7 +289,7 @@ $ ./openshift-install create ignition-configs --dir=<installation_directory> <1>
|
||||
----
|
||||
<1> For `<installation_directory>`, specify the same installation directory.
|
||||
+
|
||||
The following files are generated in the directory:
|
||||
Ignition config files are created for the bootstrap, control plane, and compute nodes in the installation directory. The `kubeadmin-password` and `kubeconfig` files are created in the `./<installation_directory>/auth` directory:
|
||||
+
|
||||
----
|
||||
.
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
// * installing_bare_metal/installing-bare-metal-network-customizations.adoc
|
||||
|
||||
[id="installation-user-infra-machines-advanced_{context}"]
|
||||
= Advanced {op-system-first} installation configuration
|
||||
= Advanced {op-system} installation configuration
|
||||
|
||||
A key benefit for manually provisioning the {op-system-first}
|
||||
nodes for {product-title} is to be able to do configuration that is not
|
||||
@@ -53,33 +53,41 @@ $ coreos-installer install --copy-network \
|
||||
|
||||
. Reboot into the installed system.
|
||||
|
||||
.Additional resources
|
||||
|
||||
* See 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] and 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] in the {op-system-base} 8 documentation for more information about the `nmcli` and `nmtui` tools.
|
||||
|
||||
[id="installation-user-infra-machines-advanced_disk_{context}"]
|
||||
== Disk partitioning
|
||||
|
||||
// This content is not modularized, so any updates to this "Disk partitioning" section should be checked against the module created for vSphere UPI parity in the module file named `installation-disk-partitioning.adoc` for consistency until such time as this large assembly can be modularized.
|
||||
|
||||
In most cases, data partitions are originally created by installing {op-system}, rather than by installing another operating system. In such cases, the {product-title} installer should be allowed to configure your disk partitions.
|
||||
The disk partitions are created on {product-title} cluster nodes during the {op-system-first} installation. Each {op-system} node of a particular architecture uses the same partition layout, unless the default partitioning configuration is overridden. During the {op-system} installation, the size of the root file system is increased to use the remaining available space on the target device.
|
||||
|
||||
However, there are two cases where you might want to intervene to override the default partitioning when installing an
|
||||
{product-title} node:
|
||||
There are two cases where you might want to override the default partitioning when installing {op-system} on an {product-title} cluster node:
|
||||
|
||||
* Create separate partitions: For greenfield installations on an empty
|
||||
* Creating separate partitions: For greenfield installations on an empty
|
||||
disk, you might want to add separate storage to a partition. This is
|
||||
officially supported for making `/var` or a subdirectory of `/var`, such as `/var/lib/etcd`, a separate partition, but not both.
|
||||
officially supported for mounting `/var` or a subdirectory of `/var`, such as `/var/lib/etcd`, on a separate partition, but not both.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
Kubernetes supports only two filesystem partitions. If you add more than one partition to the original configuration, Kubernetes cannot monitor all of them.
|
||||
Kubernetes supports only two file system partitions. If you add more than one partition to the original configuration, Kubernetes cannot monitor all of them.
|
||||
====
|
||||
|
||||
* Retaining existing partitions: For a brownfield installation where you are reinstalling {product-title} on an existing node and want to retain data partitions installed from your previous operating system, there are both boot arguments and options to `coreos-installer` that allow you to retain existing data partitions.
|
||||
|
||||
[WARNING]
|
||||
====
|
||||
The use of custom partitions could result in those partitions not being monitored by {product-title} or alerted on. If you are overriding the default partitioning, see link:https://access.redhat.com/articles/4766521[Understanding OpenShift File System Monitoring (eviction conditions)] for more information about how {product-title} monitors your host file systems.
|
||||
====
|
||||
* Retain existing partitions: For a brownfield installation where you are reinstalling {product-title} on an existing node and want to retain data partitions installed from your previous operating system, there are both boot arguments and options to `coreos-installer` that allow you to retain existing data partitions.
|
||||
|
||||
[id="installation-user-infra-machines-advanced_vardisk_{context}"]
|
||||
=== Creating a separate `/var` partition
|
||||
In general, disk partitioning for {product-title} should be left to the
|
||||
installer. However, there are cases where you might want to create separate partitions in a part of the filesystem that you expect to grow.
|
||||
In general, you should use the default disk partitioning that is created during the {op-system} installation. However, there are cases where you might want to create a separate partition for a directory that you expect to grow.
|
||||
|
||||
{product-title} supports the addition of a single partition to attach
|
||||
storage to either the `/var` partition or a subdirectory of `/var`.
|
||||
storage to either the `/var` directory or a subdirectory of `/var`.
|
||||
For example:
|
||||
|
||||
* `/var/lib/containers`: Holds container-related content that can grow
|
||||
@@ -89,40 +97,23 @@ as more images and containers are added to a system.
|
||||
|
||||
Storing the contents of a `/var` directory separately makes it easier to grow storage for those areas as needed and reinstall {product-title} at a later date and keep that data intact. With this method, you will not have to pull all your containers again, nor will you have to copy massive log files when you update systems.
|
||||
|
||||
Because `/var` must be in place before a fresh installation of
|
||||
{op-system-first}, the following procedure sets up the separate `/var` partition
|
||||
by creating a machine config that is inserted during the `openshift-install`
|
||||
preparation phases of an {product-title} installation.
|
||||
The use of a separate partition for the `/var` directory or a subdirectory of `/var` also prevents data growth in the partitioned directory from filling up the root file system.
|
||||
|
||||
The following procedure sets up a separate `/var` partition by adding a `MachineConfig` object that is wrapped into the Ignition config file for a node type during the preparation phase of an installation.
|
||||
|
||||
.Procedure
|
||||
|
||||
. Create a directory to hold the {product-title} installation files:
|
||||
. On your installation host, change to the directory that contains the {product-title} installation program and generate the Kubernetes manifests for the cluster:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ mkdir $HOME/clusterconfig
|
||||
$ openshift-install create manifests --dir=<installation_directory>
|
||||
----
|
||||
|
||||
. Run `openshift-install` to create a set of files in the `manifest` and
|
||||
`openshift` subdirectories. Answer the system questions as you are prompted:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ openshift-install create manifests --dir $HOME/clusterconfig
|
||||
? SSH Public Key ...
|
||||
$ ls $HOME/clusterconfig/openshift/
|
||||
99_kubeadmin-password-secret.yaml
|
||||
99_openshift-cluster-api_master-machines-0.yaml
|
||||
99_openshift-cluster-api_master-machines-1.yaml
|
||||
99_openshift-cluster-api_master-machines-2.yaml
|
||||
...
|
||||
----
|
||||
|
||||
. Create a `MachineConfig` object and add it to a file in the `openshift` directory.
|
||||
. Create a `MachineConfig` object and add it to a file in the `./<installation_directory>/openshift` directory.
|
||||
For example, name the file `98-var-partition.yaml`,
|
||||
change the disk device name to the name of the storage device on the `worker` systems,
|
||||
and set the storage size as appropriate. This attaches storage to a separate `/var`
|
||||
directory.
|
||||
change the disk device name to the name of the storage device on the compute nodes,
|
||||
and set the storage size as appropriate. This example mounts the `/var` directory on a separate partition:
|
||||
|
||||
+
|
||||
[source,yaml]
|
||||
@@ -141,8 +132,8 @@ spec:
|
||||
disks:
|
||||
- device: /dev/<device_name> <1>
|
||||
partitions:
|
||||
- sizeMiB: <partition_size>
|
||||
startMiB: <partition_start_offset> <2>
|
||||
- sizeMiB: <partition_size> <2>
|
||||
startMiB: <partition_start_offset> <3>
|
||||
label: var
|
||||
filesystems:
|
||||
- path: /var
|
||||
@@ -163,39 +154,55 @@ spec:
|
||||
----
|
||||
+
|
||||
<1> The storage device name of the disk that you want to partition.
|
||||
<2> When adding a data partition to the boot disk, a minimum value of 25000 mebibytes is recommended. The root file system is automatically resized to fill all available space up to the specified offset. If no value is specified, or if the specified value is smaller than the recommended minimum, the resulting root file system will be too small, and future reinstalls of {op-system} might overwrite the beginning of the data partition.
|
||||
<2> The size of the data partition in mebibytes.
|
||||
<3> When adding a data partition to the boot disk, a minimum offset value of 25000 mebibytes is recommended. The root file system is automatically resized to fill all available space up to the specified offset. If no offset value is specified, or if the specified value is smaller than the recommended minimum, the resulting root file system will be too small, and future reinstalls of {op-system} might overwrite the beginning of the data partition.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
When creating a separate `/var` partition, you cannot use different instance types for worker nodes, if the different instance types do not have the same device name.
|
||||
When creating a separate `/var` partition, you cannot use different instance types for compute nodes, if the different instance types do not have the same device name.
|
||||
====
|
||||
. Run `openshift-install` again to create Ignition configs from a set of files in the `manifest` and
|
||||
`openshift` subdirectories:
|
||||
. Create the Ignition config files:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ openshift-install create ignition-configs --dir $HOME/clusterconfig
|
||||
$ ls $HOME/clusterconfig/
|
||||
auth bootstrap.ign master.ign metadata.json worker.ign
|
||||
$ openshift-install create ignition-configs --dir=<installation_directory> <1>
|
||||
----
|
||||
<1> For `<installation_directory>`, specify the same installation directory.
|
||||
+
|
||||
Ignition config files are created for the bootstrap, control plane, and compute nodes in the installation directory:
|
||||
+
|
||||
----
|
||||
.
|
||||
├── auth
|
||||
│ ├── kubeadmin-password
|
||||
│ └── kubeconfig
|
||||
├── bootstrap.ign
|
||||
├── master.ign
|
||||
├── metadata.json
|
||||
└── worker.ign
|
||||
----
|
||||
+
|
||||
The files in the `<installation_directory>/manifest` and `<installation_directory>/openshift` directories are wrapped into the Ignition config files, including the file that contains the `98-var-partition` custom `MachineConfig` object.
|
||||
|
||||
Now you can use the Ignition config files as input to the ISO or PXE manual installation procedures to install {op-system-first} systems.
|
||||
.Next steps
|
||||
|
||||
* You can apply the custom disk partitioning by referencing the Ignition config files during the {op-system} installations.
|
||||
|
||||
[id="installation-user-infra-machines-advanced_retaindisk_{context}"]
|
||||
=== Retaining existing partitions
|
||||
For an ISO installation, you can add options to the `coreos-installer` command line
|
||||
that causes the installer to maintain one or more existing partitions.
|
||||
For a PXE installation, you can `APPEND` `coreos.inst.*` options to preserve partitions.
|
||||
|
||||
Saved partitions might be partitions from an existing {product-title}
|
||||
system that has data partitions that you want to keep. Here are a few tips:
|
||||
For an ISO installation, you can add options to the `coreos-installer` command
|
||||
that cause the installer to maintain one or more existing partitions.
|
||||
For a PXE installation, you can add `coreos.inst.*` options to the `APPEND` parameter to preserve partitions.
|
||||
|
||||
* If you save existing partitions, and those partitions do not leave enough space for {op-system}, installation will fail without damaging the saved partitions.
|
||||
Saved partitions might be data partitions from an existing {product-title} system. You can identify the disk partitions you want to keep either by partition label or by number.
|
||||
|
||||
* Identify the disk partitions you want to keep either by partition
|
||||
label or by number.
|
||||
[NOTE]
|
||||
====
|
||||
If you save existing partitions, and those partitions do not leave enough space for {op-system}, the installation will fail without damaging the saved partitions.
|
||||
====
|
||||
|
||||
.For an ISO installation
|
||||
.Retaining existing partitions during an ISO installation
|
||||
|
||||
This example preserves any partition in which the partition label begins with `data` (`data*`):
|
||||
|
||||
@@ -224,7 +231,7 @@ This example preserves partitions 5 and higher:
|
||||
|
||||
In the previous examples where partition saving is used, `coreos-installer` recreates the partition immediately.
|
||||
|
||||
.For a PXE installation
|
||||
.Retaining existing partitions during a PXE installation
|
||||
|
||||
This `APPEND` option preserves any partition in which the partition label begins with 'data' ('data*'):
|
||||
|
||||
@@ -258,7 +265,7 @@ installation.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
It is not recommended to modify these files.
|
||||
It is not recommended to modify these Ignition config files directly. You can update the manifest files that are wrapped into the Ignition config files, as outlined in examples in the preceding sections.
|
||||
====
|
||||
+
|
||||
For PXE installations, you pass the Ignition configs on the `APPEND` line using the
|
||||
@@ -268,15 +275,16 @@ command line with the `--ignition-url=` option. In both cases, only HTTP and HTT
|
||||
protocols are supported.
|
||||
+
|
||||
|
||||
* **Live install Ignition config**: This type must be created manually and should be avoided if possible, as it is not supported by Red Hat. With this method, the Ignition config passes to the live install medium, runs immediately upon booting, and performs setup tasks before and/or after the {op-system} system installs to disk. This method should only be used for performing tasks that must be performed once and not applied again later, such as with advanced partitioning that cannot be done using a machine config.
|
||||
* **Live install Ignition config**: This type must be created manually and should be avoided if possible, as it is not supported by Red Hat. With this method, the Ignition config passes to the live install medium, runs immediately upon booting, and performs setup tasks before and/or after the {op-system} system installs to disk. This method should only be used for performing tasks that must be done once and not applied again later, such as with advanced partitioning that cannot be done using a machine config.
|
||||
+
|
||||
For PXE or ISO boots, you can create the Ignition config
|
||||
and `APPEND` the `ignition.config.url=` option to identify the location of
|
||||
the Ignition config. You also need to append `ignition.firstboot ignition.platform.id=metal`
|
||||
or the `ignition.config.url` option will be ignored.
|
||||
|
||||
[id="installation-user-infra-machines-advanced_embedignition_{context}"]
|
||||
=== Embedding an Ignition config in the {op-system} ISO
|
||||
[id="installation-user-infra-machines-advanced_embed_ignition_{context}"]
|
||||
=== Embedding a live install Ignition config in the {op-system} ISO
|
||||
|
||||
You can embed a live install Ignition config directly in an {op-system} ISO image. When
|
||||
the ISO image is booted, the embedded config will be applied automatically.
|
||||
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc
|
||||
// * installing/installing_bare_metal/installing-bare-metal.adoc
|
||||
// * installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc
|
||||
// * installing_bare_metal/installing-bare-metal-network-customizations.adoc
|
||||
// * installing/installing_ibm_power/installing-ibm-power.adoc
|
||||
// * installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc
|
||||
// * installing/installing_platform_agnostic/installing-platform-agnostic.adoc
|
||||
// * installing/installing_ibm_z/installing-ibm-z.adoc
|
||||
|
||||
ifeval::["{context}" == "installing-ibm-power"]
|
||||
:ibm-power:
|
||||
@@ -14,34 +15,60 @@ ifeval::["{context}" == "installing-restricted-networks-ibm-power"]
|
||||
endif::[]
|
||||
|
||||
[id="installation-user-infra-machines-iso_{context}"]
|
||||
= Creating {op-system-first} machines using an ISO image
|
||||
= Installing {op-system} by using an ISO image
|
||||
|
||||
Before you install a cluster on
|
||||
ifdef::ibm-power[IBM Power Systems]
|
||||
infrastructure that you provision, you must create
|
||||
{op-system} machines for it to use. You can use an ISO image to create the
|
||||
machines.
|
||||
You can use an ISO image to install {op-system} on the machines.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* Obtain the Ignition config files for your cluster.
|
||||
* Have access to an HTTP server that can be accessed from your computer, and from the machines that you create.
|
||||
* You have created the Ignition config files for your cluster.
|
||||
* You have configured suitable network, DNS and load balancing infrastructure.
|
||||
* You have an HTTP server that can be accessed from your computer, and from the machines that you create.
|
||||
* You have reviewed the _Advanced {op-system} installation configuration_ section for different ways to configure features, such as networking and disk partitioning.
|
||||
|
||||
.Procedure
|
||||
|
||||
. Upload the control plane, compute, and bootstrap Ignition config files that the
|
||||
installation program created to your HTTP server. Note the URLs of these files.
|
||||
. Obtain the SHA512 digest for each of your Ignition config files. For example, you can use the following on a system running Linux to get the SHA512 digest for your `bootstrap.ign` Ignition config file:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sha512sum <installation_directory>/bootstrap.ign
|
||||
----
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
a5a2d43879223273c9b60af66b44202a1d1248fc01cf156c46d4a79f552b6bad47bc8cc78ddf0116e80c59d2ea9e32ba53bc807afbca581aa059311def2c3e3b installation_directory/bootstrap.ign
|
||||
----
|
||||
+
|
||||
The digests are provided to the `coreos-installer` in a later step to validate the authenticity of the Ignition config files on the cluster nodes.
|
||||
|
||||
. Upload the bootstrap, control plane, and compute node Ignition config files that the installation program created to your HTTP server. Note the URLs of these files.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
If you plan to add more compute machines to your cluster after you finish
|
||||
installation, do not delete these files.
|
||||
You can add or change configuration settings in your Ignition configs before saving them to your HTTP server. If you plan to add more compute machines to your cluster after you finish installation, do not delete these files.
|
||||
====
|
||||
|
||||
. From the installation host, validate that the Ignition config files are available on the URLs. The following example gets the Ignition config file for the bootstrap node:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ curl -k http://<HTTP_server>/bootstrap.ign <1>
|
||||
----
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
% Total % Received % Xferd Average Speed Time Time Time Current
|
||||
Dload Upload Total Spent Left Speed
|
||||
0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0{"ignition":{"version":"3.2.0"},"passwd":{"users":[{"name":"core","sshAuthorizedKeys":["ssh-rsa...
|
||||
----
|
||||
+
|
||||
Replace `bootstrap.ign` with `master.ign` or `worker.ign` in the command to validate that the Ignition config files for the control plane and compute nodes are also available.
|
||||
|
||||
ifndef::openshift-origin[]
|
||||
. Obtain the {op-system} images that are required for your preferred method
|
||||
of installing operating system instances from the
|
||||
. Obtain the {op-system} images that are required for your preferred method of installing operating system instances from the
|
||||
ifndef::ibm-power[]
|
||||
link:https://mirror.openshift.com/pub/openshift-v4/dependencies/rhcos/latest/[{op-system} image mirror]
|
||||
endif::ibm-power[]
|
||||
@@ -52,12 +79,7 @@ page.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
The {op-system} images might not change with every release of {product-title}.
|
||||
You must download images with the highest version that is less than or equal
|
||||
to the {product-title} version that you install. Use the image versions
|
||||
that match your {product-title} version if they are available.
|
||||
Use only ISO images for this procedure.
|
||||
{op-system} qcow2 images are not supported for this installation type.
|
||||
The {op-system} images might not change with every release of {product-title}. You must download images with the highest version that is less than or equal to the {product-title} version that you install. Use the image versions that match your {product-title} version if they are available. Use only ISO images for this procedure. {op-system} qcow2 images are not supported for this installation type.
|
||||
====
|
||||
+
|
||||
ISO file names resemble the following example:
|
||||
@@ -69,41 +91,59 @@ ifdef::openshift-origin[]
|
||||
link:https://getfedora.org/en/coreos/download?tab=metal_virtualized&stream=stable[{op-system} Downloads] page
|
||||
endif::openshift-origin[]
|
||||
|
||||
. Use the ISO to start the {op-system} installation. Use one of the following
|
||||
installation options:
|
||||
. Use the ISO to start the {op-system} installation. Use one of the following installation options:
|
||||
** Burn the ISO image to a disk and boot it directly.
|
||||
** Use ISO redirection via a LOM interface.
|
||||
** Use ISO redirection by using a lights-out management (LOM) interface.
|
||||
|
||||
. Boot the ISO image. You can interrupt the installation boot process to
|
||||
add kernel arguments. However, for this ISO procedure you should use
|
||||
the `coreos-installer` command instead of adding kernel arguments. If you
|
||||
run the live installer without options or interruption, the installer boots up to a
|
||||
shell prompt on the live system, ready for you to install {op-system} to disk.
|
||||
. Boot the {op-system} ISO image without specifying any options or interrupting the live boot sequence. Wait for the installer to boot into a shell prompt in the {op-system} live environment.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
It is possible to interrupt the {op-system} installation boot process to add kernel arguments. However, for this ISO procedure you should use the `coreos-installer` command as outlined in the following steps, instead of adding kernel arguments.
|
||||
====
|
||||
|
||||
. Review the _Advanced {op-system} installation reference_
|
||||
section for different ways of configuring features, such as networking
|
||||
and disk partitions, before running the `coreos-installer`.
|
||||
|
||||
. Run the `coreos-installer` command. At a minimum, you must identify
|
||||
the Ignition config file location for your node type, and the
|
||||
location of the disk you are installing to. Here is an example:
|
||||
. Run the `coreos-installer` command and specify the options that meet your installation requirements. At a minimum, you must specify the URL that points to the Ignition config file for the node type, and the device that you are installing to:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo coreos-installer install \
|
||||
--ignition-url=https://host/worker.ign /dev/sda
|
||||
$ sudo coreos-installer install --ignition-url=http://<HTTP_server>/<node_type>.ign <device> --ignition-hash=SHA512-<digest> <1><2>
|
||||
----
|
||||
<1> You must run the `coreos-installer` command by using `sudo`, because the `core` user does not have the required root privileges to perform the installation.
|
||||
<2> The `--ignition-hash` option is required when the Ignition config file is obtained through an HTTP URL to validate the authenticity of the Ignition config file on the cluster node. `<digest>` is the Ignition config file SHA512 digest obtained in a preceding step.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
If you want to provide your Ignition config files through an HTTPS server that uses TLS, you can add the internal certificate authority (CA) to the system trust store before running `coreos-installer`.
|
||||
====
|
||||
+
|
||||
The following example initializes a bootstrap node installation to the `/dev/sda` device. The Ignition config file for the bootstrap node is obtained from an HTTP web server with the IP address 192.168.1.2:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ sudo coreos-installer install --ignition-url=http://192.168.1.2:80/installation_directory/bootstrap.ign /dev/sda --ignition-hash=SHA512-a5a2d43879223273c9b60af66b44202a1d1248fc01cf156c46d4a79f552b6bad47bc8cc78ddf0116e80c59d2ea9e32ba53bc807afbca581aa059311def2c3e3b
|
||||
----
|
||||
|
||||
. After {op-system} installs, the system reboots. During the system reboot,
|
||||
it applies the Ignition config file that you specified.
|
||||
. Monitor the progress of the {op-system} installation on the console of the machine.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
Be sure that the installation is successful on each node before commencing with the {product-title} installation. Observing the installation process can also help to determine the cause of {op-system} installation issues that might arise.
|
||||
====
|
||||
|
||||
. After {op-system} installs, the system reboots. During the system reboot, it applies the Ignition config file that you specified.
|
||||
|
||||
. Continue to create the other machines for your cluster.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
You must create the bootstrap and control plane machines at this time. If the
|
||||
control plane machines are not made schedulable, which is the default, also
|
||||
create at least two compute machines before you install the cluster.
|
||||
You must create the bootstrap and control plane machines at this time. If the control plane machines are not made schedulable, also create at least two compute machines before you install {product-title}.
|
||||
====
|
||||
+
|
||||
If the required network, DNS, and load balancer infrastructure are in place, the {product-title} bootstrap process begins automatically after the {op-system} nodes have rebooted.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
{op-system} nodes do not include a default password for the `core` user. You can access the nodes by running `ssh core@<node>.<cluster_name>.<base_domain>` as a user with access to the SSH private key that is paired to the public key that you specified in your `install_config.yaml` file. {product-title} 4 cluster nodes running {op-system} are immutable and rely on Operators to apply cluster changes. Accessing cluster nodes by using SSH is not recommended. However, when investigating installation issues, if the {product-title} API is not available, or the kubelet is not properly functioning on a target node, SSH access might be required for debugging or disaster recovery.
|
||||
====
|
||||
|
||||
ifeval::["{context}" == "installing-ibm-power"]
|
||||
|
||||
@@ -1,23 +1,28 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc
|
||||
// * installing/installing_bare_metal/installing-bare-metal.adoc
|
||||
// * installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc
|
||||
// * installing/installing_ibm_power/installing-ibm-power.adoc
|
||||
// * installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc
|
||||
// * installing/installing_platform_agnostic/installing-platform-agnostic.adoc
|
||||
|
||||
[id="installation-user-infra-machines-pxe_{context}"]
|
||||
= Creating {op-system-first} machines by PXE or iPXE booting
|
||||
= Installing {op-system} by using PXE or iPXE booting
|
||||
|
||||
Before you install a cluster that uses manually-provisioned {op-system} nodes, such as bare metal, you must create {op-system} machines for it to use. You can use PXE or iPXE booting to create the machines.
|
||||
You can use PXE or iPXE booting to install {op-system} on the machines.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* Obtain the Ignition config files for your cluster.
|
||||
* Configure suitable PXE or iPXE infrastructure.
|
||||
* Have access to an HTTP server that you can access from your computer.
|
||||
* You have created the Ignition config files for your cluster.
|
||||
* You have configured suitable network, DNS and load balancing infrastructure.
|
||||
* You have configured suitable PXE or iPXE infrastructure.
|
||||
* You have an HTTP server that can be accessed from your computer, and from the machines that you create.
|
||||
* You have reviewed the _Advanced {op-system} installation configuration_ section for different ways to configure features, such as networking and disk partitioning.
|
||||
|
||||
.Procedure
|
||||
|
||||
. Upload the master, worker, and bootstrap Ignition config files that the
|
||||
. Upload the bootstrap, control plane, and compute node Ignition config files that the
|
||||
installation program created to your HTTP server. Note the URLs of these files.
|
||||
+
|
||||
[IMPORTANT]
|
||||
@@ -28,6 +33,23 @@ If you plan to add more compute machines to your cluster after you finish
|
||||
installation, do not delete these files.
|
||||
====
|
||||
|
||||
. From the installation host, validate that the Ignition config files are available on the URLs. The following example gets the Ignition config file for the bootstrap node:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ curl -k http://<HTTP_server>/bootstrap.ign <1>
|
||||
----
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
% Total % Received % Xferd Average Speed Time Time Time Current
|
||||
Dload Upload Total Spent Left Speed
|
||||
0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0{"ignition":{"version":"3.2.0"},"passwd":{"users":[{"name":"core","sshAuthorizedKeys":["ssh-rsa...
|
||||
----
|
||||
+
|
||||
Replace `bootstrap.ign` with `master.ign` or `worker.ign` in the command to validate that the Ignition config files for the control plane and compute nodes are also available.
|
||||
|
||||
ifndef::openshift-origin[]
|
||||
. Obtain the {op-system} `kernel`,
|
||||
`initramfs` and `rootfs` files from the
|
||||
@@ -43,7 +65,7 @@ You must download artifacts with the highest version that is less than or equal
|
||||
to the {product-title} version that you install. Only use
|
||||
the appropriate `kernel`, `initramfs`, and `rootfs` artifacts described below
|
||||
for this procedure.
|
||||
{op-system} qcow2 images are not supported for this installation type.
|
||||
{op-system} QCOW2 images are not supported for this installation type.
|
||||
====
|
||||
+
|
||||
The file names contain the {product-title} version number.
|
||||
@@ -70,7 +92,7 @@ installation, do not delete these files.
|
||||
. Configure the network boot infrastructure so that the machines boot from their
|
||||
local disks after {op-system} is installed on them.
|
||||
|
||||
. Configure PXE or iPXE installation for the {op-system} images.
|
||||
. Configure PXE or iPXE installation for the {op-system} images and begin the installation.
|
||||
+
|
||||
Modify one of the following example menu entries for your environment and verify
|
||||
that the image and Ignition files are properly accessible:
|
||||
@@ -90,7 +112,7 @@ server.
|
||||
The URL must be HTTP, TFTP, or FTP; HTTPS and NFS are not supported.
|
||||
<2> If you use multiple NICs, specify a single interface in the `ip` option.
|
||||
For example, to use DHCP on a NIC that is named `eno1`, set `ip=eno1:dhcp`.
|
||||
<3> Specify locations of the {op-system} files that you uploaded to your
|
||||
<3> Specify the locations of the {op-system} files that you uploaded to your
|
||||
HTTP server. The `initrd` parameter value is the location of the `initramfs` file,
|
||||
the `coreos.live.rootfs_url` parameter value is the location of the
|
||||
`rootfs` file, and the `coreos.inst.ignition_url` parameter value is the
|
||||
@@ -110,7 +132,7 @@ kernel http://<HTTP_server>/rhcos-<version>-live-kernel-<architecture> initrd=ma
|
||||
initrd --name main http://<HTTP_server>/rhcos-<version>-live-initramfs.<architecture>.img <3>
|
||||
boot
|
||||
----
|
||||
<1> Specify locations of the {op-system} files that you uploaded to your
|
||||
<1> Specify the locations of the {op-system} files that you uploaded to your
|
||||
HTTP server. The `kernel` parameter value is the location of the `kernel` file,
|
||||
the `initrd=main` argument is needed for booting on UEFI systems,
|
||||
the `coreos.live.rootfs_url` parameter value is the location of the `rootfs` file,
|
||||
@@ -124,12 +146,28 @@ For example, to use DHCP on a NIC that is named `eno1`, set `ip=eno1:dhcp`.
|
||||
====
|
||||
This configuration does not enable serial console access on machines with a graphical console. To configure a different console, add one or more `console=` arguments to the `kernel` line. For example, add `console=tty0 console=ttyS0` to set the first PC serial port as the primary console and the graphical console as a secondary console. For more information, see link:https://access.redhat.com/articles/7212[How does one set up a serial terminal and/or console in Red Hat Enterprise Linux?].
|
||||
====
|
||||
|
||||
. Monitor the progress of the {op-system} installation on the console of the machine.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
Be sure that the installation is successful on each node before commencing with the {product-title} installation. Observing the installation process can also help to determine the cause of {op-system} installation issues that might arise.
|
||||
====
|
||||
|
||||
. After {op-system} installs, the system reboots. During reboot, the system applies the Ignition config file that you specified.
|
||||
|
||||
. Continue to create the machines for your cluster.
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
You must create the bootstrap and control plane machines at this time. If the
|
||||
control plane machines are not made schedulable, which is the default, also
|
||||
control plane machines are not made schedulable, also
|
||||
create at least two compute machines before you install the cluster.
|
||||
====
|
||||
+
|
||||
If the required network, DNS, and load balancer infrastructure are in place, the {product-title} bootstrap process begins automatically after the {op-system} nodes have rebooted.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
{op-system} nodes do not include a default password for the `core` user. You can access the nodes by running `ssh core@<node>.<cluster_name>.<base_domain>` as a user with access to the SSH private key that is paired to the public key that you specified in your `install_config.yaml` file. {product-title} 4 cluster nodes running {op-system} are immutable and rely on Operators to apply cluster changes. Accessing cluster nodes by using SSH is not recommended. However, when investigating installation issues, if the {product-title} API is not available, or the kubelet is not properly functioning on a target node, SSH access might be required for debugging or disaster recovery.
|
||||
====
|
||||
|
||||
@@ -12,38 +12,42 @@
|
||||
|
||||
This section illustrates the networking configuration and other advanced options that allow you to modify the {op-system-first} manual installation process. The following tables describe the kernel arguments and command-line options you can use with the {op-system} live installer and the `coreos-installer` command.
|
||||
|
||||
[discrete]
|
||||
== Routing and bonding options at {op-system} boot prompt
|
||||
[id="installation-user-infra-machines-routing-bonding_{context}"]
|
||||
== Networking and bonding options for ISO installations
|
||||
|
||||
If you install {op-system} from an ISO image, you can add kernel arguments manually when you boot that image to configure the node's networking. If no networking arguments are used, the installation defaults to using DHCP.
|
||||
If you install {op-system} from an ISO image, you can add kernel arguments manually when you boot the image to configure networking for a node. If no networking arguments are specified, DHCP is activated in the initramfs when {op-system} detects that networking is required to fetch the Ignition config file.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
When adding networking arguments, you must also add the `rd.neednet=1` kernel argument.
|
||||
When adding networking arguments manually, you must also add the `rd.neednet=1` kernel argument to bring the network up in the initramfs.
|
||||
====
|
||||
|
||||
The following table describes how to use `ip=`, `nameserver=`, and `bond=` kernel arguments for live ISO installs.
|
||||
The following table provides examples for configuring networking and bonding on your {op-system} nodes for ISO installations. The examples describe how to use the `ip=`, `nameserver=`, and `bond=` kernel arguments.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
Ordering is important when adding kernel arguments: `ip=`, `nameserver=`, and then `bond=`.
|
||||
Ordering is important when adding the kernel arguments: `ip=`, `nameserver=`, and then `bond=`.
|
||||
====
|
||||
|
||||
.Routing and bonding options for ISO
|
||||
|
||||
The following table provides examples for configuring networking of your {op-system-first} nodes. These are networking options that are passed to the `dracut` tool during system boot. For more information about the networking options supported by `dracut`, see the `dracut.cmdline` manual page.
|
||||
The networking options are passed to the `dracut` tool during system boot. For more information about the networking options supported by `dracut`, see the `dracut.cmdline` manual page.
|
||||
|
||||
.Networking and bonding options for ISO installations
|
||||
|===
|
||||
|Description |Examples
|
||||
|
||||
a|To configure an IP address, either use DHCP (`ip=dhcp`) or set an individual
|
||||
static IP address (`ip=<host_ip>`). Then identify the DNS server IP address (`nameserver=<dns_ip>`) on each node. This example sets: +
|
||||
a|To configure an IP address, either use DHCP (`ip=dhcp`) or set an individual static IP address (`ip=<host_ip>`). If setting a static IP, you must then identify the DNS server IP address (`nameserver=<dns_ip>`) on each node. This example sets: +
|
||||
|
||||
* The node's IP address to `10.10.10.2` +
|
||||
* The gateway address to `10.10.10.254` +
|
||||
* The netmask to `255.255.255.0` +
|
||||
* The hostname to `core0.example.com` +
|
||||
* The DNS server address to `4.4.4.41`
|
||||
* The auto-configuration value to `none`. No auto-configuration is required when IP networking is configured statically.
|
||||
|
||||
[NOTE]
|
||||
====
|
||||
When you use DHCP to configure IP addressing for the {op-system} machines, the machines also obtain the DNS server information through DHCP. For DHCP-based deployments, you can define the DNS server address that is used by the {op-system} nodes through your DHCP server configuration.
|
||||
====
|
||||
|
||||
a|
|
||||
----
|
||||
@@ -58,7 +62,7 @@ ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp1s0:none
|
||||
ip=10.10.10.3::10.10.10.254:255.255.255.0:core0.example.com:enp2s0:none
|
||||
----
|
||||
|
||||
a|Disable DHCP on a single interface, such as when there are two or more network interfaces and only one interface is being used.
|
||||
a|Disable DHCP on a single interface, such as when there are two or more network interfaces and only one interface is being used. In the example, the `enp1s0` interface has a static networking configuration and DHCP is disabled for `enp2s0`, which is not used.
|
||||
a|
|
||||
----
|
||||
ip=10.10.10.2::10.10.10.254:255.255.255.0:core0.example.com:enp1s0:none
|
||||
@@ -101,7 +105,8 @@ a|Optional: Bonding multiple network interfaces to a single interface is support
|
||||
using the `bond=` option. In these two examples:
|
||||
|
||||
* The syntax for configuring a bonded interface is: `bond=name[:network_interfaces][:options]`
|
||||
* _name_ is the bonding device name (`bond0`), _network_interfaces_
|
||||
+
|
||||
_name_ is the bonding device name (`bond0`), _network_interfaces_
|
||||
represents a comma-separated list of physical (ethernet) interfaces (`em1,em2`),
|
||||
and _options_ is a comma-separated list of bonding options. Enter `modinfo bonding` to see available options.
|
||||
* When you
|
||||
@@ -145,16 +150,153 @@ vlan=bond0.100:bond0
|
||||
|
||||
|===
|
||||
|
||||
[discrete]
|
||||
== `coreos.inst` boot options for ISO or PXE install
|
||||
[id="installation-user-infra-machines-coreos-installer-options_{context}"]
|
||||
== `coreos-installer` options for ISO installations
|
||||
|
||||
While you can pass most standard installation boot arguments to the live installer, there are several arguments that are specific to the {op-system} live installer.
|
||||
You can install {op-system} by running `coreos-installer install <options> <device>` at the command prompt, after booting into the {op-system} live environment from an ISO image.
|
||||
|
||||
* For ISO, these options can be added by interrupting the {op-system} installer.
|
||||
The following table shows the subcommands, options, and arguments you can pass to the `coreos-installer` command.
|
||||
|
||||
* For PXE or iPXE, these options must be added to the `APPEND` line before starting the PXE kernel. You cannot interrupt a live PXE install.
|
||||
.`coreos-installer` subcommands, command-line options, and arguments
|
||||
|===
|
||||
|
||||
The following table shows the {op-system} live installer boot options for ISO and PXE installs.
|
||||
2+|*coreos-installer install subcommand*
|
||||
|
||||
|*_Subcommand_* |*_Description_*
|
||||
|
||||
a|`$ coreos-installer install <options> <device>`
|
||||
a|Embed an Ignition config in an ISO image.
|
||||
|
||||
2+|*coreos-installer install subcommand options*
|
||||
|
||||
|*_Option_* |*_Description_*
|
||||
|
||||
a| `-u`, `--image-url <url>`
|
||||
a|Specify the image URL manually.
|
||||
|
||||
a| `-f`, `--image-file <path>`
|
||||
a|Specify a local image file manually. Used for debugging.
|
||||
|
||||
a|`-i,` `--ignition-file <path>`
|
||||
a|Embed an Ignition config from a file.
|
||||
|
||||
a|`-I`, `--ignition-url <URL>`
|
||||
a|Embed an Ignition config from a URL.
|
||||
|
||||
a|`--ignition-hash <digest>`
|
||||
a|Digest `type-value` of the Ignition config.
|
||||
|
||||
a|`-p`, `--platform <name>`
|
||||
a|Override the Ignition platform ID for the installed system.
|
||||
|
||||
a|`--append-karg <arg>...`
|
||||
a|Append a default kernel argument to the installed system.
|
||||
|
||||
a|`--delete-karg <arg>...`
|
||||
a|Delete a default kernel argument from the installed system.
|
||||
|
||||
a|`-n`, `--copy-network`
|
||||
a|Copy the network configuration from the install environment.
|
||||
|
||||
a|`--network-dir <path>`
|
||||
a|For use with `-n`. Default is `/etc/NetworkManager/system-connections/`.
|
||||
|
||||
a|`--save-partlabel <lx>..`
|
||||
a|Save partitions with this label glob.
|
||||
|
||||
a|`--save-partindex <id>...`
|
||||
a|Save partitions with this number or range.
|
||||
|
||||
a|`--insecure`
|
||||
a|Skip signature verification.
|
||||
|
||||
a|`--insecure-ignition`
|
||||
a|Allow Ignition URL without HTTPS or hash.
|
||||
|
||||
a|`--architecture <name>`
|
||||
a|Target CPU architecture. Default is `x86_64`.
|
||||
|
||||
a|`--preserve-on-error`
|
||||
a|Do not clear partition table on error.
|
||||
|
||||
a|`-h`, `--help`
|
||||
a|Print help information.
|
||||
|
||||
2+|*coreos-install install subcommand argument*
|
||||
|
||||
|*_Argument_* |*_Description_*
|
||||
|
||||
a|`<device>`
|
||||
a|The destination device.
|
||||
|
||||
2+|*coreos-installer ISO Ignition subcommands*
|
||||
|
||||
|*_Subcommand_* |*_Description_*
|
||||
|
||||
a|`$ coreos-installer iso ignition embed <options> --ignition-file <file_path> <ISO_image>`
|
||||
a|Embed an Ignition config in an ISO image.
|
||||
|
||||
a|`coreos-installer iso ignition show <options> <ISO_image>`
|
||||
|Show the embedded Ignition config from an ISO image.
|
||||
|
||||
a|`coreos-installer iso ignition remove <options> <ISO_image>`
|
||||
a|Remove the embedded Ignition config from an ISO image.
|
||||
|
||||
2+|*coreos-installer ISO Ignition subcommand options*
|
||||
|
||||
|*_Option_* |*_Description_*
|
||||
|
||||
a|`-f`, `--force`
|
||||
a|Overwrite an existing Ignition config.
|
||||
|
||||
a|`-i`, `--ignition-file <path>`
|
||||
a|The Ignition config to be used. Default is `stdin`.
|
||||
|
||||
a|`-o`, `--output <path>`
|
||||
a|Write the ISO to a new output file.
|
||||
|
||||
a|`-h`, `--help`
|
||||
a|Print help information.
|
||||
|
||||
2+|*coreos-installer PXE Ignition subcommands*
|
||||
|
||||
|*_Subcommand_* |*_Description_*
|
||||
|
||||
2+|Note that not all of these options are accepted by all subcommands.
|
||||
|
||||
a|`coreos-installer pxe ignition wrap <options>`
|
||||
a|Wrap an Ignition config in an image.
|
||||
|
||||
a|`coreos-installer pxe ignition unwrap <options> <image_name>`
|
||||
a|Show the wrapped Ignition config in an image.
|
||||
|
||||
2+|*coreos-installer PXE Ignition subcommand options*
|
||||
|
||||
|*_Option_* |*_Description_*
|
||||
|
||||
2+|Note that not all of these options are accepted by all subcommands.
|
||||
|
||||
a|`-i`, `--ignition-file <path>`
|
||||
a|The Ignition config to be used. Default is `stdin`.
|
||||
|
||||
a|`-o,` `--output <path>`
|
||||
a|Write the ISO to a new output file.
|
||||
|
||||
a|`-h`, `--help`
|
||||
a|Print help information.
|
||||
|
||||
|===
|
||||
|
||||
[id="installation-user-infra-machines-coreos-inst-options_{context}"]
|
||||
== `coreos.inst` boot options for ISO or PXE installations
|
||||
|
||||
You can automatically invoke `coreos-installer` options at boot time by passing `coreos.inst` boot arguments to the {op-system} live installer. These are provided in addition to the standard boot arguments.
|
||||
|
||||
* For ISO installations, the `coreos.inst` options can be added by interrupting the automatic boot at the bootloader menu. You can interrupt the automatic boot by pressing `TAB` while the *RHEL CoreOS (Live)* menu option is highlighted.
|
||||
|
||||
* For PXE or iPXE installations, the `coreos.inst` options must be added to the `APPEND` line before the {op-system} live installer is booted.
|
||||
|
||||
The following table shows the {op-system} live installer `coreos.inst` boot options for ISO and PXE installations.
|
||||
|
||||
.`coreos.inst` boot options
|
||||
|===
|
||||
@@ -166,7 +308,7 @@ a|Required. The block device on the system to install to. It is recommended to u
|
||||
|
||||
a|`coreos.inst.ignition_url`
|
||||
|
||||
a|Optional: The URL of the Ignition config to embed into the installed system. If no URL is specified, no Ignition config is embedded.
|
||||
a|Optional: The URL of the Ignition config to embed into the installed system. If no URL is specified, no Ignition config is embedded. Only HTTP and HTTPS protocols are supported.
|
||||
|
||||
a|`coreos.inst.save_partlabel`
|
||||
|
||||
@@ -174,7 +316,7 @@ a|Optional: Comma-separated labels of partitions to preserve during the install.
|
||||
|
||||
a|`coreos.inst.save_partindex`
|
||||
|
||||
a|Optional: Comma-separated indexes of partitions to preserve during the install. Ranges `m`-`n` are permitted, and either `m` or `n` can be omitted. The specified partitions do not need to exist.
|
||||
a|Optional: Comma-separated indexes of partitions to preserve during the install. Ranges `m-n` are permitted, and either `m` or `n` can be omitted. The specified partitions do not need to exist.
|
||||
|
||||
a|`coreos.inst.insecure`
|
||||
|
||||
@@ -194,7 +336,7 @@ a|Optional: Download and install the specified {op-system} image.
|
||||
|
||||
a|`coreos.inst.skip_reboot`
|
||||
|
||||
a|Optional: The system will not reboot after installing. Once the install finishes, you will receive a prompt that allows you to inspect what is happening during installation. This argument should not be used in production environments and is intended for debugging purposes only.
|
||||
a|Optional: The system will not reboot after installing. After the install finishes, you will receive a prompt that allows you to inspect what is happening during installation. This argument should not be used in production environments and is intended for debugging purposes only.
|
||||
|
||||
a|`coreos.inst.platform_id`
|
||||
|
||||
@@ -204,137 +346,3 @@ a|`ignition.config.url`
|
||||
|
||||
a|Optional: The URL of the Ignition config for the live boot. For example, this can be used to customize how `coreos-installer` is invoked, or to run code before or after the installation. This is different from `coreos.inst.ignition_url`, which is the Ignition config for the installed system.
|
||||
|===
|
||||
|
||||
[discrete]
|
||||
== `coreos-installer` options for ISO install
|
||||
|
||||
You can also install {op-system} by invoking the `coreos-installer` command directly from the command line. The kernel arguments in the previous table provide a shortcut for automatically invoking `coreos-installer` at boot time, but you can pass similar arguments directly to `coreos-installer` when running it from a shell prompt.
|
||||
|
||||
The following table shows the options and subcommands you can pass to the `coreos-installer` command from a shell prompt during a live install.
|
||||
|
||||
.`coreos-installer` command-line options, arguments, and subcommands
|
||||
|===
|
||||
|
||||
2+|_Command-line options_
|
||||
|
||||
|*Option* |*Description*
|
||||
|
||||
a| `-u`, `--image-url <url>`
|
||||
a|Specify the image URL manually.
|
||||
|
||||
a| `-f`, `--image-file <path>`
|
||||
a|Specify a local image file manually.
|
||||
|
||||
a|`-i,` `--ignition-file <path>`
|
||||
a|Embed an Ignition config from a file.
|
||||
|
||||
a|`-I`, `--ignition-url <URL>`
|
||||
a|Embed an Ignition config from a URL.
|
||||
|
||||
a|`--ignition-hash <digest>`
|
||||
a|Digest `type-value` of the Ignition config.
|
||||
|
||||
a|`-p`, `--platform <name>`
|
||||
a|Override the Ignition platform ID.
|
||||
|
||||
a|`--append-karg <arg>...`
|
||||
a|Append the default kernel argument.
|
||||
|
||||
a|`--delete-karg <arg>...`
|
||||
a|Delete the default kernel argument.
|
||||
|
||||
a|`-n`, `--copy-network`
|
||||
a|Copy the network configuration from the install environment.
|
||||
|
||||
a|`--network-dir <path>`
|
||||
a|For use with `-n`. Default is `/etc/NetworkManager/system-connections/`.
|
||||
|
||||
a|`--save-partlabel <lx>..`
|
||||
a|Save partitions with this label glob.
|
||||
|
||||
a|`--save-partindex <id>...`
|
||||
a|Save partitions with this number or range.
|
||||
|
||||
a|`--offline`
|
||||
a|Force offline installation.
|
||||
|
||||
a|`--insecure`
|
||||
a|Skip signature verification.
|
||||
|
||||
a|`--insecure-ignition`
|
||||
a|Allow Ignition URL without HTTPS or hash.
|
||||
|
||||
a|`--architecture <name>`
|
||||
a|Target CPU architecture. Default is `x86_64`.
|
||||
|
||||
a|`--preserve-on-error`
|
||||
a|Do not clear partition table on error.
|
||||
|
||||
a|`-h`, `--help`
|
||||
a|Print help information.
|
||||
|
||||
2+|_Command-line argument_
|
||||
|
||||
|*Argument* |*Description*
|
||||
|
||||
a|`<device>`
|
||||
a|The destination device.
|
||||
|
||||
2+|_coreos-installer embedded Ignition commands_
|
||||
|
||||
|*Command* |*Description*
|
||||
|
||||
a|`$ coreos-installer iso ignition embed <options> --ignition-file <file_path> <ISO_image>`
|
||||
a|Embed an Ignition config in an ISO image.
|
||||
|
||||
a|`coreos-installer iso ignition show <options> <ISO_image>`
|
||||
|Show the embedded Ignition config from an ISO image.
|
||||
|
||||
a|`coreos-installer iso ignition remove <options> <ISO_image>`
|
||||
a|Remove the embedded Ignition config from an ISO image.
|
||||
|
||||
2+|_coreos-installer ISO Ignition options_
|
||||
|
||||
|*Option* |*Description*
|
||||
|
||||
a|`-f`, `--force`
|
||||
a|Overwrite an existing Ignition config.
|
||||
|
||||
a|`-i`, `--ignition-file <path>`
|
||||
a|The Ignition config to be used. Default is `stdin`.
|
||||
|
||||
a|`-o`, `--output <path>`
|
||||
a|Write the ISO to a new output file.
|
||||
|
||||
a|`-h`, `--help`
|
||||
a|Print help information.
|
||||
|
||||
2+|_coreos-installer PXE Ignition commands_
|
||||
|
||||
|*Command* |*Description*
|
||||
|
||||
2+|Note that not all of these options are accepted by all subcommands.
|
||||
|
||||
a|`coreos-installer pxe ignition wrap <options>`
|
||||
a|Wrap an Ignition config in an image.
|
||||
|
||||
a|`coreos-installer pxe ignition unwrap <options> <image_name>`
|
||||
a|Show the wrapped Ignition config in an image.
|
||||
|
||||
a|`coreos-installer pxe ignition unwrap <options> <initrd_name>`
|
||||
a|Show the wrapped Ignition config in an `initrd` image.
|
||||
|
||||
2+|_coreos-installer PXE Ignition options_
|
||||
|
||||
|*Option* |*Description*
|
||||
|
||||
a|`-i`, `--ignition-file <path>`
|
||||
a|The Ignition config to be used. Default is `stdin`.
|
||||
|
||||
a|`-o,` `--output <path>`
|
||||
a|Write the ISO to a new output file.
|
||||
|
||||
a|`-h`, `--help`
|
||||
a|Print help information.
|
||||
|
||||
|===
|
||||
|
||||
149
modules/installation-user-provisioned-validating-dns.adoc
Normal file
149
modules/installation-user-provisioned-validating-dns.adoc
Normal file
@@ -0,0 +1,149 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// * installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc
|
||||
// * installing/installing_bare_metal/installing-bare-metal.adoc
|
||||
// * installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc
|
||||
// * installing/installing_ibm_power/installing-ibm-power.adoc
|
||||
// * installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc
|
||||
// * installing/installing_ibm_z/installing-ibm-z-kvm.adoc
|
||||
// * installing/installing_ibm_z/installing-ibm-z.adoc
|
||||
// * installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc
|
||||
// * installing/installing_platform_agnostic/installing-platform-agnostic.adoc
|
||||
// * installing/installing_rhv/installing-rhv-restricted-network.adoc
|
||||
// * installing/installing_vmc/installing-restricted-networks-vmc-user-infra.adoc
|
||||
// * installing/installing_vmc/installing-vmc-network-customizations-user-infra.adoc
|
||||
// * installing/installing_vmc/installing-vmc-user-infra.adoc
|
||||
// * installing/installing_vsphere/installing-restricted-networks-vsphere.adoc
|
||||
// * installing/installing_vsphere/installing-vsphere-network-customizations.adoc
|
||||
// * installing/installing_vsphere/installing-vsphere.adoc
|
||||
|
||||
[id="installation-user-provisioned-validating-dns_{context}"]
|
||||
= Validating DNS resolution for user-provisioned infrastructure
|
||||
|
||||
You can validate your DNS configuration before installing {product-title} on user-provisioned infrastructure.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
The validation steps detailed in this section must succeed before you install your cluster.
|
||||
====
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You have configured the required DNS records for your user-provisioned infrastructure.
|
||||
|
||||
.Procedure
|
||||
|
||||
. From your installation node, run DNS lookups against the record names of the Kubernetes API, the wildcard routes, and the cluster nodes. Validate that the IP addresses contained in the responses correspond to the correct components.
|
||||
|
||||
.. Perform a lookup against the Kubernetes API record name. Check that the result points to the IP address of the API load balancer:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ dig +noall +answer @<nameserver_ip> api.<cluster_name>.<base_domain> <1>
|
||||
----
|
||||
+
|
||||
<1> Replace `<nameserver_ip>` with the IP address of the nameserver, `<cluster_name>` with your cluster name, and `<base_domain>` with your base domain name.
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
api.ocp4.example.com. 0 IN A 192.168.1.5
|
||||
----
|
||||
|
||||
.. Perform a lookup against the Kubernetes internal API record name. Check that the result points to the IP address of the API load balancer:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ dig +noall +answer @<nameserver_ip> api-int.<cluster_name>.<base_domain>
|
||||
----
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
api-int.ocp4.example.com. 0 IN A 192.168.1.5
|
||||
----
|
||||
|
||||
.. Test an example `*.apps.<cluster_name>.<base_domain>` DNS wildcard lookup. All of the application wildcard lookups must resolve to the IP address of the application ingress load balancer:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ dig +noall +answer @<nameserver_ip> random.apps.<cluster_name>.<base_domain>
|
||||
----
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
random.apps.ocp4.example.com. 0 IN A 192.168.1.5
|
||||
----
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
In the example outputs, the same load balancer is used for the Kubernetes API and application ingress traffic. In production scenarios, you can deploy the API and application ingress load balancers separately so that you can scale the load balancer infrastructure for each in isolation.
|
||||
====
|
||||
+
|
||||
You can replace `random` with another wildcard value. For example, you can query the route to the {product-title} console:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ dig +noall +answer @<nameserver_ip> console-openshift-console.apps.<cluster_name>.<base_domain>
|
||||
----
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
console-openshift-console.apps.ocp4.example.com. 0 IN A 192.168.1.5
|
||||
----
|
||||
|
||||
.. Run a lookup against the bootstrap DNS record name. Check that the result points to the IP address of the bootstrap node:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ dig +noall +answer @<nameserver_ip> bootstrap.<cluster_name>.<base_domain>
|
||||
----
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
bootstrap.ocp4.example.com. 0 IN A 192.168.1.96
|
||||
----
|
||||
|
||||
.. Use this method to perform lookups against the DNS record names for the control plane and compute nodes. Check that the results correspond to the IP addresses of each node.
|
||||
|
||||
. From your installation node, run reverse DNS lookups against the IP addresses of the load balancer and the cluster nodes. Validate that the record names contained in the responses correspond to the correct components.
|
||||
|
||||
.. Perform a reverse lookup against the IP address of the API load balancer. Check that the response includes the record names for the Kubernetes API and the Kubernetes internal API:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ dig +noall +answer @<nameserver_ip> -x 192.168.1.5
|
||||
----
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
5.1.168.192.in-addr.arpa. 0 IN PTR api-int.ocp4.example.com. <1>
|
||||
5.1.168.192.in-addr.arpa. 0 IN PTR api.ocp4.example.com. <2>
|
||||
----
|
||||
+
|
||||
<1> Provides the record name for the Kubernetes internal API.
|
||||
<2> Provides the record name for the Kubernetes API.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
A PTR record is not required for the {product-title} application wildcard. No validation step is needed for reverse DNS resolution against the IP address of the application ingress load balancer.
|
||||
====
|
||||
|
||||
.. Perform a reverse lookup against the IP address of the bootstrap node. Check that the result points to the DNS record name of the bootstrap node:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ dig +noall +answer @<nameserver_ip> -x 192.168.1.96
|
||||
----
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
96.1.168.192.in-addr.arpa. 0 IN PTR bootstrap.ocp4.example.com.
|
||||
----
|
||||
|
||||
.. Use this method to perform reverse lookups against the IP addresses for the control plane and compute nodes. Check that the results correspond to the DNS record names of each node.
|
||||
@@ -8,9 +8,9 @@
|
||||
// * installing/installing_vsphere/installing-vsphere-network-customizations.adoc
|
||||
|
||||
[id="installation-vsphere-machines_{context}"]
|
||||
= Creating {op-system-first} machines in vSphere
|
||||
= Installing {op-system} and starting the {product-title} bootstrap process
|
||||
|
||||
Before you install a cluster that contains user-provisioned infrastructure on VMware vSphere, you must create {op-system} machines on vSphere hosts for it to use.
|
||||
To install {product-title} on user-provisioned infrastructure on VMware vSphere, you must install {op-system-first} on vSphere hosts. When you install {op-system}, you must provide the Ignition config file that was generated by the {product-title} installation program for the type of machine you are installing. If you have configured suitable networking, DNS, and load balancing infrastructure, the {product-title} bootstrap process begins automatically after the {op-system} machines have rebooted.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
|
||||
@@ -9,9 +9,9 @@
|
||||
// * machine_management/user_infra/adding-vsphere-compute-user-infra.adoc
|
||||
|
||||
[id="machine-vsphere-machines_{context}"]
|
||||
= Creating more {op-system-first} machines in vSphere
|
||||
= Adding more compute machines to a cluster in vSphere
|
||||
|
||||
You can create more compute machines for your cluster that uses user-provisioned infrastructure on VMware vSphere.
|
||||
You can add more compute machines to a user-provisioned {product-title} cluster on VMware vSphere.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
|
||||
@@ -24,20 +24,17 @@ endif::[]
|
||||
[id="modifying-nwoperator-config-startup_{context}"]
|
||||
= Specifying advanced network configuration
|
||||
|
||||
You can use advanced configuration customization to integrate your cluster into your existing network environment by specifying additional configuration for your cluster network provider.
|
||||
You can use advanced network configuration for your cluster network provider to integrate your cluster into your existing network environment.
|
||||
You can specify advanced network configuration only before you install the cluster.
|
||||
|
||||
[IMPORTANT]
|
||||
====
|
||||
Modifying the {product-title} manifest files created by the installation program is not supported. Applying a manifest file that you create, as in the following procedure, is supported.
|
||||
Customizing your network configuration by modifying the {product-title} manifest files created by the installation program is not supported. Applying a manifest file that you create, as in the following procedure, is supported.
|
||||
====
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* Create the `install-config.yaml` file and complete any modifications to it.
|
||||
ifdef::ignition-config[]
|
||||
* Create the Ignition config files for your cluster.
|
||||
endif::ignition-config[]
|
||||
* You have created the `install-config.yaml` file and completed any modifications to it.
|
||||
|
||||
.Procedure
|
||||
|
||||
@@ -45,36 +42,22 @@ endif::ignition-config[]
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ ./openshift-install create manifests --dir=<installation_directory>
|
||||
$ ./openshift-install create manifests --dir=<installation_directory> <1>
|
||||
----
|
||||
+
|
||||
--
|
||||
where:
|
||||
|
||||
`<installation_directory>`:: Specifies the name of the directory that contains the `install-config.yaml` file for your cluster.
|
||||
--
|
||||
<1> `<installation_directory>` specifies the name of the directory that contains the `install-config.yaml` file for your cluster.
|
||||
|
||||
. Create a stub manifest file for the advanced network configuration that is named `cluster-network-03-config.yml` in the `<installation_directory>/manifests/` directory:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ cat <<EOF > <installation_directory>/manifests/cluster-network-03-config.yml
|
||||
apiVersion: operator.openshift.io/v1
|
||||
kind: Network
|
||||
metadata:
|
||||
name: cluster
|
||||
spec:
|
||||
EOF
|
||||
----
|
||||
+
|
||||
--
|
||||
where:
|
||||
|
||||
`<installation_directory>`:: Specifies the directory name that contains the
|
||||
`manifests/` directory for your cluster.
|
||||
--
|
||||
|
||||
. Open the `cluster-network-03-config.yml` file in an editor and specify the advanced network configuration for your cluster, such as in the following examples:
|
||||
. Specify the advanced network configuration for your cluster in the `cluster-network-03-config.yml` file, such as in the following examples:
|
||||
+
|
||||
--
|
||||
.Specify a different VXLAN port for the OpenShift SDN network provider
|
||||
@@ -104,10 +87,9 @@ spec:
|
||||
----
|
||||
--
|
||||
|
||||
. Save the `cluster-network-03-config.yml` file and quit the text editor.
|
||||
. Optional: Back up the `manifests/cluster-network-03-config.yml` file. The
|
||||
installation program deletes the `manifests/` directory when creating the
|
||||
cluster.
|
||||
installation program consumes the `manifests/` directory when you create the
|
||||
Ignition config files.
|
||||
|
||||
ifdef::vsphere,vmc[]
|
||||
. Remove the Kubernetes manifest files that define the control plane machines and compute machineSets:
|
||||
|
||||
@@ -14,22 +14,22 @@
|
||||
[id="nw-network-config_{context}"]
|
||||
= Network configuration phases
|
||||
|
||||
When specifying a cluster configuration prior to installation, there are several phases in the installation procedures when you can modify the network configuration:
|
||||
There are two phases prior to {product-title} installation where you can customize the network configuration.
|
||||
|
||||
Phase 1:: After entering the `openshift-install create install-config` command. In the `install-config.yaml` file, you can customize the following network-related fields:
|
||||
Phase 1:: You can customize the following network-related fields in the `install-config.yaml` file before you create the manifest files:
|
||||
+
|
||||
* `networking.networkType`
|
||||
* `networking.clusterNetwork`
|
||||
* `networking.serviceNetwork`
|
||||
* `networking.machineNetwork`
|
||||
+
|
||||
For more information on these fields, refer to "Installation configuration parameters".
|
||||
For more information on these fields, refer to _Installation configuration parameters_.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
Set the `networking.machineNetwork` to match the CIDR that the preferred NIC resides in.
|
||||
====
|
||||
|
||||
Phase 2:: After entering the `openshift-install create manifests` command. If you must specify advanced network configuration, during this phase you can define a customized Cluster Network Operator manifest with only the fields you want to modify.
|
||||
Phase 2:: After creating the manifest files by running `openshift-install create manifests`, you can define a customized Cluster Network Operator manifest with only the fields you want to modify. You can use the manifest to specify advanced network configuration.
|
||||
|
||||
You cannot override the values specified in phase 1 in the `install-config.yaml` file during phase 2. However, you can further customize the cluster network provider during phase 2.
|
||||
|
||||
@@ -74,7 +74,7 @@ ifdef::operator[]
|
||||
This value is ready-only and inherited from the `Network.config.openshift.io` object named `cluster` during cluster installation.
|
||||
endif::operator[]
|
||||
ifndef::operator[]
|
||||
This value is ready-only and specified in the `install-config.yaml` file.
|
||||
You can customize this field only in the `install-config.yaml` file before you create the manifests. The value is read-only in the manifest file.
|
||||
endif::operator[]
|
||||
|
||||
|`spec.serviceNetwork`
|
||||
@@ -92,7 +92,7 @@ ifdef::operator[]
|
||||
This value is ready-only and inherited from the `Network.config.openshift.io` object named `cluster` during cluster installation.
|
||||
endif::operator[]
|
||||
ifndef::operator[]
|
||||
This value is ready-only and specified in the `install-config.yaml` file.
|
||||
You can customize this field only in the `install-config.yaml` file before you create the manifests. The value is read-only in the manifest file.
|
||||
endif::operator[]
|
||||
|
||||
|`spec.defaultNetwork`
|
||||
@@ -170,7 +170,7 @@ endif::operator[]
|
||||
ifndef::operator[]
|
||||
The maximum transmission unit (MTU) for the VXLAN overlay network. This is detected automatically based on the MTU of the primary network interface. You do not normally need to override the detected MTU.
|
||||
|
||||
If the auto-detected value is not what you expected it to be, confirm that the MTU on the primary network interface on your nodes is correct. You cannot use this option to change the MTU value of the primary network interface on the nodes.
|
||||
If the auto-detected value is not what you expect it to be, confirm that the MTU on the primary network interface on your nodes is correct. You cannot use this option to change the MTU value of the primary network interface on the nodes.
|
||||
|
||||
If your cluster requires different MTU values for different nodes, you must set this value to `50` less than the lowest MTU value in your cluster. For example, if some nodes in your cluster have an MTU of `9001`, and some have an MTU of `1500`, you must set this value to `1450`.
|
||||
|
||||
@@ -228,9 +228,9 @@ The following table describes the configuration fields for the OVN-Kubernetes CN
|
||||
ifndef::operator[]
|
||||
The maximum transmission unit (MTU) for the Geneve (Generic Network Virtualization Encapsulation) overlay network. This is detected automatically based on the MTU of the primary network interface. You do not normally need to override the detected MTU.
|
||||
|
||||
If the auto-detected value is not what you expected it to be, confirm that the MTU on the primary network interface on your nodes is correct. You cannot use this option to change the MTU value of the primary network interface on the nodes.
|
||||
If the auto-detected value is not what you expect it to be, confirm that the MTU on the primary network interface on your nodes is correct. You cannot use this option to change the MTU value of the primary network interface on the nodes.
|
||||
|
||||
If your cluster requires different MTU values for different nodes, you must set this value to `100` less than the lowest MTU value in your cluster. For example, if some nodes in your cluster have an MTU of `9001`, and some have an MTU of `1500`, you must set this value to `1400`.
|
||||
If your cluster requires different MTU values for different nodes, you must set this value to `100` less than the lowest MTU value in your cluster. For example, if some nodes in your cluster have an MTU of `9001`, and some have an MTU of `1500`, you must set this value to `1400`.
|
||||
|
||||
This value cannot be changed after cluster installation.
|
||||
endif::operator[]
|
||||
|
||||
@@ -38,13 +38,13 @@ registry to use storage.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* Cluster administrator permissions.
|
||||
* A cluster
|
||||
* You have access to the cluster as a user with the `cluster-admin` role.
|
||||
* You have a cluster
|
||||
ifndef::ibm-z,ibm-power[that uses manually-provisioned {op-system-first} nodes, such as bare metal.]
|
||||
ifdef::ibm-z[on IBM Z.]
|
||||
ifdef::ibm-power[on IBM Power Systems.]
|
||||
ifndef::ibm-z[* Persistent storage provisioned for your cluster, such as Red Hat OpenShift Container Storage.]
|
||||
ifdef::ibm-z[* Persistent storage provisioned for your cluster.]
|
||||
ifndef::ibm-z[* You have provisioned persistent storage for your cluster, such as Red Hat OpenShift Container Storage.]
|
||||
ifdef::ibm-z[* You have provisioned persistent storage for your cluster.]
|
||||
+
|
||||
[IMPORTANT]
|
||||
====
|
||||
|
||||
@@ -120,24 +120,18 @@ ifeval::["{context}" == "installing-platform-agnostic"]
|
||||
endif::[]
|
||||
|
||||
[id="ssh-agent-using_{context}"]
|
||||
= Generating an SSH private key and adding it to the agent
|
||||
= Generating a key pair for cluster node SSH access
|
||||
|
||||
If you want to perform installation debugging or disaster recovery on your cluster, you must provide an SSH key to both your `ssh-agent` and the installation program. You can use this key to access the bootstrap machine in a public cluster to troubleshoot installation issues.
|
||||
[NOTE]
|
||||
====
|
||||
In a production environment, you require disaster recovery and debugging.
|
||||
====
|
||||
During an {product-title} installation, you can provide an SSH public key to the installation program. The key is passed to the {op-system-first} nodes through their Ignition config files and is used to authenticate SSH access to the nodes. The key is added to the `~/.ssh/authorized_keys` list for the `core` user on each node, which enables password-less authentication.
|
||||
|
||||
After the key is passed to the nodes, you can use the key pair to SSH in to the {op-system} nodes as the user `core`. To access the nodes through SSH, the private key identity must be managed by SSH for your local user.
|
||||
|
||||
If you want to SSH in to your cluster nodes to perform installation debugging or disaster recovery, you must provide the SSH public key during the installation process. The `./openshift-install gather` command also requires the SSH public key to be in place on the cluster nodes.
|
||||
|
||||
ifdef::ibm-z,ibm-z-kvm[]
|
||||
[IMPORTANT]
|
||||
====
|
||||
Do not skip this procedure in production environments where disaster recovery and debugging is required.
|
||||
Do not skip this procedure in production environments, where disaster recovery and debugging is required.
|
||||
====
|
||||
endif::[]
|
||||
|
||||
You can use this key to SSH into the master nodes as the user `core`. When you
|
||||
deploy the cluster, the key is added to the `core` user's
|
||||
`~/.ssh/authorized_keys` list.
|
||||
|
||||
ifndef::osp,ibm-z,ibm-z-kvm,rhv[]
|
||||
[NOTE]
|
||||
@@ -158,27 +152,41 @@ endif::openshift-origin[]
|
||||
|
||||
.Procedure
|
||||
|
||||
. If you do not have an SSH key that is configured for password-less authentication
|
||||
on your computer, create one.
|
||||
For example, on a computer that uses a Linux operating system, run the
|
||||
following command:
|
||||
. If you do not have an existing SSH key pair on your local machine to use for authentication onto your cluster nodes, create one. For example, on a computer that uses a Linux operating system, run the following command:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ ssh-keygen -t ed25519 -N '' \
|
||||
-f <path>/<file_name> <1>
|
||||
$ ssh-keygen -t ed25519 -N '' -f <path>/<file_name> <1>
|
||||
----
|
||||
<1> Specify the path and file name, such as `~/.ssh/id_rsa`, of the new SSH key. If you have an existing key pair, ensure your public key is in the your ``~/.ssh` directory.
|
||||
+
|
||||
Running this command generates an SSH key that does not require a password in
|
||||
the location that you specified.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
If you plan to install an {product-title} cluster that uses FIPS Validated / Modules in Process cryptographic libraries on the `x86_64` architecture, do not create a key that uses the `ed25519` algorithm. Instead, create a key that uses the `rsa` or `ecdsa` algorithm.
|
||||
====
|
||||
|
||||
. Start the `ssh-agent` process as a background task:
|
||||
. View the public SSH key:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ cat <path>/<file_name>.pub
|
||||
----
|
||||
+
|
||||
For example, run the following to view the `~/.ssh/id_rsa.pub` public key:
|
||||
+
|
||||
[source,termanal]
|
||||
----
|
||||
$ cat ~/.ssh/id_rsa.pub
|
||||
----
|
||||
|
||||
. Add the SSH private key identity to the SSH agent for your local user, if it has not already been added. SSH agent management of the key is required for password-less SSH authentication onto your cluster nodes, or if you want to use the `./openshift-install gather` command.
|
||||
+
|
||||
[NOTE]
|
||||
====
|
||||
On some distributions, default SSH private key identities such as `~/.ssh/id_rsa` and `~/.ssh/id_dsa` are managed automatically.
|
||||
====
|
||||
+
|
||||
.. If the `ssh-agent` process is not already running for your local user, start it as a background task:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
@@ -190,20 +198,27 @@ $ eval "$(ssh-agent -s)"
|
||||
----
|
||||
Agent pid 31874
|
||||
----
|
||||
|
||||
. Add your SSH private key to the `ssh-agent`:
|
||||
+
|
||||
.. List the public keys of the identities that are managed by the SSH agent:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ ssh-add -L
|
||||
----
|
||||
+
|
||||
.. If the SSH public key that you are passing to the {product-title} installation program is not listed in the output of the preceding command, add your private key identity to the `ssh-agent`:
|
||||
+
|
||||
[source,terminal]
|
||||
----
|
||||
$ ssh-add <path>/<file_name> <1>
|
||||
----
|
||||
<1> Specify the path and file name for your SSH private key, such as `~/.ssh/id_rsa`
|
||||
+
|
||||
.Example output
|
||||
[source,terminal]
|
||||
----
|
||||
Identity added: /home/<you>/<path>/<file_name> (<computer_name>)
|
||||
----
|
||||
<1> Specify the path and file name for your SSH private key, such as `~/.ssh/id_rsa`
|
||||
|
||||
ifdef::gcp[]
|
||||
. Set the `GOOGLE_APPLICATION_CREDENTIALS` environment variable to the full path to your service account private key file.
|
||||
@@ -224,7 +239,7 @@ endif::gcp[]
|
||||
|
||||
* When you install {product-title}, provide the SSH public key to the installation program.
|
||||
ifdef::user-infra[]
|
||||
If you install a cluster on infrastructure that you provision, you must provide this key to your cluster's machines.
|
||||
If you install a cluster on infrastructure that you provision, you must provide the key to the installation program.
|
||||
endif::user-infra[]
|
||||
|
||||
ifeval::["{context}" == "installing-restricted-networks-vsphere"]
|
||||
|
||||
@@ -36,7 +36,7 @@ include::modules/security-hardening-how.adoc[leveloffset=+1]
|
||||
* xref:../../nodes/nodes/nodes-nodes-managing.adoc#nodes-nodes-managing[Modifying Nodes]
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installation-initializing-manual_installing-bare-metal[Manually creating the installation configuration file]
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installation-user-infra-generate-k8s-manifest-ignition_installing-bare-metal[Creating the Kubernetes manifest and Ignition config files]
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installation-user-infra-machines-iso_installing-bare-metal[Creating {op-system-first} machines using an ISO image]
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installation-user-infra-machines-iso_installing-bare-metal[Installing {op-system} by using an ISO image]
|
||||
* xref:../../installing/install_config/installing-customizing.adoc#installing-customizing[Customizing nodes]
|
||||
* xref:../../nodes/nodes/nodes-nodes-working.adoc#nodes-nodes-kernel-arguments_nodes-nodes-working[Adding kernel arguments to Nodes]
|
||||
ifndef::openshift-origin[]
|
||||
|
||||
@@ -18,7 +18,7 @@ include::modules/security-hosts-vms-rhcos.adoc[leveloffset=+1]
|
||||
* xref:../../nodes/nodes/nodes-nodes-resources-configuring.adoc#allocate-node-enforcement_nodes-nodes-resources-configuring[How nodes enforce resource constraints]
|
||||
* xref:../../authentication/managing-security-context-constraints.adoc#managing-pod-security-policies[Managing security context constraints]
|
||||
* xref:../../architecture/architecture-installation.adoc#supported-platforms-for-openshift-clusters_architecture-installation[Supported platforms for OpenShift clusters]
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installation-requirements-user-infra_installing-bare-metal[Machine requirements for a cluster with user-provisioned infrastructure]
|
||||
* xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installation-requirements-user-infra_installing-bare-metal[Requirements for a cluster with user-provisioned infrastructure]
|
||||
* xref:../../architecture/architecture-rhcos.adoc#rhcos-configured_architecture-rhcos[Choosing how to configure {op-system}]
|
||||
* xref:../../architecture/architecture-rhcos.adoc#rhcos-about-ignition_architecture-rhcos[Ignition]
|
||||
* xref:../../installing/install_config/installing-customizing.adoc#installation-special-config-kargs_installing-customizing[Kernel arguments]
|
||||
|
||||
@@ -39,11 +39,9 @@ You can also deploy a cluster on AWS infrastructure that you provisioned yoursel
|
||||
|
||||
- **xref:../installing/installing_vsphere/installing-vsphere.adoc#installing-vsphere[Install a cluster on VMware vSphere]**: You can install {product-title} on supported versions of vSphere.
|
||||
|
||||
- **xref:../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[Install a cluster on bare metal]**: If none of the available platform and cloud providers meet your needs, you can install {product-title} on bare metal.
|
||||
|
||||
- **xref:../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install-overview[Install an installer-provisioned cluster on bare metal]**: You can install {product-title} on bare metal with an installer-provisioned architecture.
|
||||
|
||||
- **xref:../installing/installing_bare_metal/installing-bare-metal.adoc#creating-machines-bare-metal[Create {op-system-first} machines on bare metal]**: You can install {op-system} machines using ISO or PXE in a fully live environment and configure them with kernel arguments, Ignition configs, or the `coreos-installer` command.
|
||||
- **xref:../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[Install a user-provisioned cluster on bare metal]**: If none of the available platform and cloud provider deployment options meet your needs, you can install {product-title} on user-provisioned bare metal infrastructure.
|
||||
|
||||
- **Install a cluster on {rh-openstack-first}**: You can install a cluster on
|
||||
xref:../installing/installing_openstack/installing-openstack-installer-custom.adoc#installing-openstack-installer-custom[{rh-openstack} with customizations].
|
||||
|
||||
@@ -33,5 +33,5 @@ include::modules/configuring-secret-for-wmco.adoc[leveloffset=+1]
|
||||
[discrete]
|
||||
== Additional Resources
|
||||
|
||||
* xref:../installing/installing_azure/installing-azure-default.adoc#ssh-agent-using_installing-azure-default[Generating an SSH private key and adding it to the agent]
|
||||
* xref:../installing/installing_azure/installing-azure-default.adoc#ssh-agent-using_installing-azure-default[Generating a key pair for cluster node SSH access]
|
||||
* xref:../operators/admin/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[Adding Operators to a cluster].
|
||||
|
||||
Reference in New Issue
Block a user