openshift-docs/modules/installation-obtaining-installer.adoc

// Module included in the following assemblies:
//
// * installing/installing_aws/installing-aws-user-infra.adoc
// * installing/installing_aws/installing-aws-customizations.adoc
// * installing/installing_aws/installing-aws-default.adoc
// * installing/installing_aws/installing-aws-government-region.adoc
// * installing/installing_aws/installing-aws-secret-region.adoc
// * installing/installing_aws/installing-aws-private.adoc
// * installing/installing_aws/installing-aws-vpc.adoc
// * installing/installing_aws/installing-aws-outposts-remote-workers.adoc
// * installing/installing_aws/installing-aws-localzone.adoc
// * installing/installaing_aws/installing-aws-wavelength-zone.adoc
// * installing/installing_azure/installing-azure-customizations.adoc
// * installing/installing_azure/installing-azure-default.adoc
// * installing/installing_azure/installing-azure-government-region.adoc
// * installing/installing_azure/installing-azure-private.adoc
// * installing/installing_azure/installing-azure-vnet.adoc
// * installing/installing_azure/installing-azure-user-infra.adoc
// * installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc
// * installing/installing_bare_metal/upi/installing-bare-metal.adoc
// * installing/installing_gcp/installing-gcp-customizations.adoc
// * installing/installing_gcp/installing-gcp-private.adoc
// * installing/installing_gcp/installing-gcp-default.adoc
// * installing/installing_gcp/installing-gcp-vpc.adoc
// * installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc
// * installing/installing_ibm_cloud/installing-ibm-cloud-vpc.adoc
// * installing/installing_ibm_cloud/installing-ibm-cloud-private.adoc
// * installing/installing_openstack/installing-openstack-installer-custom.adoc
// * installing/installing_openstack/installing-openstack-installer.adoc
// * installing/installing_platform_agnostic/installing-platform-agnostic.adoc
// * installing/installing_ibm_powervs/installing-ibm-power-vs-private-cluster.adoc
// * installing/installing_ibm_powervs/installing-ibm-powervs-vpc.adoc
// * installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc
// * installing/installing_azure/installing-restricted-networks-azure-user-provisioned.adoc
// * installing/installing_vsphere/ipi/ipi-vsphere-preparing-to-install.adoc
// * installing/installing_vsphere/upi/upi-vsphere-preparing-to-install.adoc
// * installing/installing_vsphere/upi/upi-ibm-z-preparing-to-install.adoc


ifeval::["{context}" == "upi-ibm-z-preparing-to-install"]
:ibm-z:
endif::[]
ifeval::["{context}" == "installing-azure-stack-hub-default"]
:ash:
endif::[]
ifeval::["{context}" == "installing-azure-stack-hub-user-infra"]
:ash:
endif::[]
ifeval::["{context}" == "installing-azure-stack-hub-network-customizations"]
:ash:
endif::[]
ifeval::["{context}" == "installing-ibm-cloud-private"]
:private:
endif::[]
ifeval::["{context}" == "ipi-vsphere-preparing-to-install"]
:vsphere:
endif::[]

:_mod-docs-content-type: PROCEDURE
[id="installation-obtaining-installer_{context}"]
= Obtaining the installation program

[role="_abstract"]
Before you install {product-title}, download the installation file on
ifdef::restricted[]
the mirror host, so that installation assets exist for deployment in your environment.
endif::restricted[]
ifndef::restricted[]
ifdef::ibm-z[ your provisioning machine.]
ifndef::ibm-z,private[ the host you are using for installation.]
ifdef::private[]
a bastion host on your cloud network or a machine that has access to the to the network through a VPN. This ensures that installation assets exist for deployment in your environment.

For more information about private cluster installation requirements, see "Private clusters".
endif::private[]
endif::restricted[]
//mpytlak: Added "private" in the context of a review for the {ibm-cloud-title} private work. In an effort to keep updates to other platforms separate, I will open a doc story for each platform that supports a private install.

.Prerequisites

ifdef::ibm-z,private,vsphere[]
* You have a machine that runs Linux, for example Red Hat Enterprise Linux 8, with 500 MB of local disk space.
endif::ibm-z,private,vsphere[]
ifdef::vsphere[]
+
[IMPORTANT]
====
If you attempt to run the installation program on macOS, a known issue related to the `golang` compiler causes the installation of the {product-title} cluster to fail. For more information about this issue, see the section named "Known Issues" in the _{product-title} {product-version} release notes_ document.
====
endif::vsphere[]
ifndef::ibm-z,private,vsphere[* You have a computer that runs Linux or macOS, with 500 MB of local disk space.]

.Procedure

ifndef::openshift-origin[]
. Go to the link:https://console.redhat.com/openshift/install[Cluster Type] page on the {hybrid-console}. If you have a Red{nbsp}Hat account, log in with your credentials. If you do not, create an account.
+
[TIP]
====
You can also link:https://mirror.openshift.com/pub/openshift-v4/clients/ocp/[download the binaries for a specific {product-title} release].
====

. Select your infrastructure provider from the *Run it yourself* section of the page.

. Select your host operating system and architecture from the dropdown menus under *OpenShift Installer* and click *Download Installer*.

. Place the downloaded file in the directory where you want to store the installation configuration files.
endif::[]
ifdef::openshift-origin[]

. Download the installation program from https://github.com/openshift/okd/releases.
endif::[]
+
[IMPORTANT]
====
* The installation program creates several files on the computer that you use to install your cluster. You must keep the installation program and the files that the installation program creates after you finish installing the cluster. Both of the files are required to delete the cluster.

* Deleting the files created by the installation program does not remove your cluster, even if the cluster failed during installation. To remove your cluster, complete the {product-title} uninstallation procedures for your specific cloud provider.
====

. Extract the installation program. For example, on a computer that uses a Linux operating system, run the following command:
+
[source,terminal]
----
$ tar -xvf openshift-install-linux.tar.gz
----

. Download your installation {cluster-manager-url-pull}. 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[]
+
Using a {cluster-manager-url-pull} is not required. You can use a pull secret for another private registry. Or, if you do not need the cluster to pull images from a private registry, you can use `{"auths":{"fake":{"auth":"aWQ6cGFzcwo="}}}` as the pull secret when prompted during the installation.
+
If you do not use the {cluster-manager-url-pull}:
+
* Red{nbsp}Hat Operators are not available.
* The Telemetry and {insights-operator}s do not send data to Red{nbsp}Hat.
* Content from the link:https://catalog.redhat.com/software/containers/explore[Red{nbsp}Hat Ecosystem Catalog Container images] registry, such as image streams and Operators, are not available.
endif::openshift-origin[]
ifndef::openshift-origin[]
+
[TIP]
====
Alternatively, you can retrieve the installation program from the link:https://access.redhat.com/downloads/content/290/[Red{nbsp}Hat Customer Portal], where you can specify a version of the installation program to download.
However, you must have an active subscription to access this page.
====
endif::openshift-origin[]

ifeval::["{context}" == "upi-ibm-z-preparing-to-install"]
:!ibm-z:
endif::[]
ifeval::["{context}" == "installing-azure-stack-hub-default"]
:!ash:
endif::[]
ifeval::["{context}" == "installing-azure-stack-hub-user-infra"]
:!ash:
endif::[]
ifeval::["{context}" == "installing-azure-stack-hub-network-customizations"]
:!ash:
endif::[]
ifeval::["{context}" == "installing-ibm-cloud-private"]
:!private:
endif::[]
ifeval::["{context}" == "ipi-vsphere-preparing-to-install"]
:!vsphere:
endif::[]