From 58a481050f5fcd605f2af4e18ca692231cb4df18 Mon Sep 17 00:00:00 2001 From: dfitzmau Date: Tue, 9 Dec 2025 11:08:56 +0000 Subject: [PATCH] OSDOCS-17013-bm-upi: CQA2.0 complete for BM UPI doc --- .../openshift_cli/getting-started-cli.adoc | 10 +- .../openshift_cli/usage-oc-kubectl.adoc | 2 +- ...talling-mirroring-installation-images.adoc | 9 +- .../updating/mirroring-image-repository.adoc | 10 +- .../ipi/ipi-aws-preparing-to-install.adoc | 9 +- .../upi/upi-aws-preparing-to-install.adoc | 9 +- .../ipi/installing-azure-preparing-ipi.adoc | 9 +- .../upi/installing-azure-preparing-upi.adoc | 9 +- .../upi/installing-azure-user-infra.adoc | 9 +- ...icted-networks-azure-user-provisioned.adoc | 9 +- .../ipi/ipi-ash-preparing-to-install.adoc | 9 +- .../upi/upi-ash-preparing-to-install.adoc | 9 +- ...allation-config-parameters-bare-metal.adoc | 1 + ...ing-bare-metal-network-customizations.adoc | 10 +- .../upi/installing-bare-metal.adoc | 58 ++++----- .../installing-gcp-customizations.adoc | 10 +- .../installing-gcp-default.adoc | 9 +- .../installing-gcp-private.adoc | 10 +- .../installing-gcp-shared-vpc.adoc | 10 +- .../installing-gcp-user-infra-vpc.adoc | 9 +- .../installing-gcp-user-infra.adoc | 9 +- .../installing_gcp/installing-gcp-vpc.adoc | 10 +- ...ed-networks-gcp-installer-provisioned.adoc | 10 +- .../installing-ibm-cloud-customizations.adoc | 9 +- ...ling-ibm-cloud-network-customizations.adoc | 9 +- .../installing-ibm-cloud-private.adoc | 9 +- .../installing-ibm-cloud-restricted.adoc | 9 +- .../installing-ibm-cloud-vpc.adoc | 9 +- .../installing-ibm-power.adoc | 9 +- ...nstalling-ibm-power-vs-customizations.adoc | 9 +- ...stalling-ibm-power-vs-private-cluster.adoc | 9 +- .../installing-ibm-powervs-vpc.adoc | 9 +- ...ling-restricted-networks-ibm-power-vs.adoc | 9 +- .../upi/upi-ibm-z-preparing-to-install.adoc | 9 +- ...talling-nutanix-installer-provisioned.adoc | 9 +- ...etworks-nutanix-installer-provisioned.adoc | 9 +- .../installing-platform-agnostic.adoc | 9 +- .../ipi/ipi-vsphere-preparing-to-install.adoc | 9 +- .../upi/upi-vsphere-preparing-to-install.adoc | 9 +- .../microshift-oc-cli-install.adoc | 10 +- ...cli.adoc => cli-installing-cli-linux.adoc} | 109 +--------------- modules/cli-installing-cli-macos.adoc | 120 ++++++++++++++++++ modules/cli-installing-cli-windows.adoc | 115 +++++++++++++++++ ...installation-configuration-parameters.adoc | 1 + .../installation-machine-requirements.adoc | 5 + modules/installation-network-user-infra.adoc | 5 + .../installation-vsphere-encrypted-vms.adoc | 2 +- .../samples-operator-alt-registry.adoc | 10 +- .../security-hosts-vms.adoc | 1 - 49 files changed, 582 insertions(+), 189 deletions(-) rename modules/{cli-installing-cli.adoc => cli-installing-cli-linux.adoc} (57%) create mode 100644 modules/cli-installing-cli-macos.adoc create mode 100644 modules/cli-installing-cli-windows.adoc diff --git a/cli_reference/openshift_cli/getting-started-cli.adoc b/cli_reference/openshift_cli/getting-started-cli.adoc index 6315353503..180f97c801 100644 --- a/cli_reference/openshift_cli/getting-started-cli.adoc +++ b/cli_reference/openshift_cli/getting-started-cli.adoc @@ -15,8 +15,14 @@ include::modules/cli-about-cli.adoc[leveloffset=+1] You can install the OpenShift CLI (`oc`) either by downloading the binary or by using an RPM. -// Installing the CLI by downloading the binary -include::modules/cli-installing-cli.adoc[leveloffset=+2] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] // Installing the CLI by using the web console include::modules/cli-installing-cli-web-console.adoc[leveloffset=+2] diff --git a/cli_reference/openshift_cli/usage-oc-kubectl.adoc b/cli_reference/openshift_cli/usage-oc-kubectl.adoc index 0456bc5290..bdbb439b64 100644 --- a/cli_reference/openshift_cli/usage-oc-kubectl.adoc +++ b/cli_reference/openshift_cli/usage-oc-kubectl.adoc @@ -77,6 +77,6 @@ image:redcircle-3.png[] `oc` client might provide options and features that migh The `kubectl` binary is provided as a means to support existing workflows and scripts for new {product-title} users coming from a standard Kubernetes environment, or for those who prefer to use the `kubectl` CLI. Existing users of `kubectl` can continue to use the binary to interact with Kubernetes primitives, with no changes required to the {product-title} cluster. -You can install the supported `kubectl` binary by following the steps to xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#cli-installing-cli_cli-developer-commands[Install the OpenShift CLI]. The `kubectl` binary is included in the archive if you download the binary, or is installed when you install the CLI by using an RPM. +You can install the supported `kubectl` binary by following the steps to xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#cli-installing-cli-linux_cli-developer-commands[Install the OpenShift CLI]. The `kubectl` binary is included in the archive if you download the binary, or is installed when you install the CLI by using an RPM. For more information, see the link:https://kubernetes.io/docs/reference/kubectl/overview/[kubectl documentation]. diff --git a/disconnected/installing-mirroring-installation-images.adoc b/disconnected/installing-mirroring-installation-images.adoc index 045ff3a282..aff26d90bd 100644 --- a/disconnected/installing-mirroring-installation-images.adoc +++ b/disconnected/installing-mirroring-installation-images.adoc @@ -48,7 +48,14 @@ For information about viewing the CRI-O logs to view the image source, see xref: Before you perform the mirror procedure, you must prepare the host to retrieve content and push it to the remote location. -include::modules/cli-installing-cli.adoc[leveloffset=+2] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+2] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+2] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+2] include::modules/installation-adding-registry-pull-secret.adoc[leveloffset=+1] diff --git a/disconnected/updating/mirroring-image-repository.adoc b/disconnected/updating/mirroring-image-repository.adoc index 8f2a26ba32..0287d7c1fc 100644 --- a/disconnected/updating/mirroring-image-repository.adoc +++ b/disconnected/updating/mirroring-image-repository.adoc @@ -76,8 +76,14 @@ If you do not have an existing solution for a container image registry, the xref Before you perform the mirror procedure, you must prepare the host to retrieve content and push it to the remote location. -// Installing the OpenShift CLI by downloading the binary -include::modules/cli-installing-cli.adoc[leveloffset=+3] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+3] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+3] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+3] [role="_additional-resources"] .Additional resources diff --git a/installing/installing_aws/ipi/ipi-aws-preparing-to-install.adoc b/installing/installing_aws/ipi/ipi-aws-preparing-to-install.adoc index 64288954a8..6e99fb0f65 100644 --- a/installing/installing_aws/ipi/ipi-aws-preparing-to-install.adoc +++ b/installing/installing_aws/ipi/ipi-aws-preparing-to-install.adoc @@ -32,7 +32,14 @@ include::modules/cluster-entitlements.adoc[leveloffset=+1] include::modules/installation-obtaining-installer.adoc[leveloffset=+1] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/ssh-agent-using.adoc[leveloffset=+1] diff --git a/installing/installing_aws/upi/upi-aws-preparing-to-install.adoc b/installing/installing_aws/upi/upi-aws-preparing-to-install.adoc index b375373e29..6f2b6c8de8 100644 --- a/installing/installing_aws/upi/upi-aws-preparing-to-install.adoc +++ b/installing/installing_aws/upi/upi-aws-preparing-to-install.adoc @@ -34,7 +34,14 @@ include::modules/cluster-entitlements.adoc[leveloffset=+1] include::modules/installation-obtaining-installer.adoc[leveloffset=+1] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/ssh-agent-using.adoc[leveloffset=+1] diff --git a/installing/installing_azure/ipi/installing-azure-preparing-ipi.adoc b/installing/installing_azure/ipi/installing-azure-preparing-ipi.adoc index d78d338ba7..14f2a14944 100644 --- a/installing/installing_azure/ipi/installing-azure-preparing-ipi.adoc +++ b/installing/installing_azure/ipi/installing-azure-preparing-ipi.adoc @@ -20,7 +20,14 @@ include::modules/ssh-agent-using.adoc[leveloffset=+1] include::modules/installation-obtaining-installer.adoc[leveloffset=+1] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/cluster-telemetry.adoc[leveloffset=+1] diff --git a/installing/installing_azure/upi/installing-azure-preparing-upi.adoc b/installing/installing_azure/upi/installing-azure-preparing-upi.adoc index 927d716ed4..b087d94e27 100644 --- a/installing/installing_azure/upi/installing-azure-preparing-upi.adoc +++ b/installing/installing_azure/upi/installing-azure-preparing-upi.adoc @@ -20,7 +20,14 @@ include::modules/ssh-agent-using.adoc[leveloffset=+1] include::modules/installation-obtaining-installer.adoc[leveloffset=+1] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/cluster-telemetry.adoc[leveloffset=+1] diff --git a/installing/installing_azure/upi/installing-azure-user-infra.adoc b/installing/installing_azure/upi/installing-azure-user-infra.adoc index 3c5d9b8d03..254e66c993 100644 --- a/installing/installing_azure/upi/installing-azure-user-infra.adoc +++ b/installing/installing_azure/upi/installing-azure-user-infra.adoc @@ -148,7 +148,14 @@ include::modules/installation-creating-azure-worker.adoc[leveloffset=+1] include::modules/installation-arm-worker.adoc[leveloffset=+2] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] diff --git a/installing/installing_azure/upi/installing-restricted-networks-azure-user-provisioned.adoc b/installing/installing_azure/upi/installing-restricted-networks-azure-user-provisioned.adoc index a7795a109a..6e17faa544 100644 --- a/installing/installing_azure/upi/installing-restricted-networks-azure-user-provisioned.adoc +++ b/installing/installing_azure/upi/installing-restricted-networks-azure-user-provisioned.adoc @@ -140,7 +140,14 @@ include::modules/installation-creating-azure-worker.adoc[leveloffset=+1] include::modules/installation-arm-worker.adoc[leveloffset=+2] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] diff --git a/installing/installing_azure_stack_hub/ipi/ipi-ash-preparing-to-install.adoc b/installing/installing_azure_stack_hub/ipi/ipi-ash-preparing-to-install.adoc index bb06550c53..5983725377 100644 --- a/installing/installing_azure_stack_hub/ipi/ipi-ash-preparing-to-install.adoc +++ b/installing/installing_azure_stack_hub/ipi/ipi-ash-preparing-to-install.adoc @@ -26,7 +26,14 @@ include::modules/ssh-agent-using.adoc[leveloffset=+1] include::modules/installation-obtaining-installer.adoc[leveloffset=+1] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/cluster-telemetry.adoc[leveloffset=+1] diff --git a/installing/installing_azure_stack_hub/upi/upi-ash-preparing-to-install.adoc b/installing/installing_azure_stack_hub/upi/upi-ash-preparing-to-install.adoc index bf1c7136ec..3871021f26 100644 --- a/installing/installing_azure_stack_hub/upi/upi-ash-preparing-to-install.adoc +++ b/installing/installing_azure_stack_hub/upi/upi-ash-preparing-to-install.adoc @@ -24,4 +24,11 @@ include::modules/ssh-agent-using.adoc[leveloffset=+1] include::modules/installation-obtaining-installer.adoc[leveloffset=+1] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] diff --git a/installing/installing_bare_metal/upi/installation-config-parameters-bare-metal.adoc b/installing/installing_bare_metal/upi/installation-config-parameters-bare-metal.adoc index f2164d3bf4..2bfdfa4d6a 100644 --- a/installing/installing_bare_metal/upi/installation-config-parameters-bare-metal.adoc +++ b/installing/installing_bare_metal/upi/installation-config-parameters-bare-metal.adoc @@ -7,6 +7,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] Before you deploy an {product-title} cluster, you provide a customized `install-config.yaml` installation configuration file that describes the details for your environment. include::modules/installation-configuration-parameters.adoc[leveloffset=+1] diff --git a/installing/installing_bare_metal/upi/installing-bare-metal-network-customizations.adoc b/installing/installing_bare_metal/upi/installing-bare-metal-network-customizations.adoc index 1feecf7de2..a9e9ce0bde 100644 --- a/installing/installing_bare_metal/upi/installing-bare-metal-network-customizations.adoc +++ b/installing/installing_bare_metal/upi/installing-bare-metal-network-customizations.adoc @@ -88,7 +88,6 @@ include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../../../installing/installing_bare_metal/upi/installing-bare-metal-network-customizations.adoc#installation-requirements-user-infra_installing-bare-metal-network-customizations[Requirements for a cluster with user-provisioned infrastructure] * xref:../../../installing/installing_bare_metal/upi/installing-bare-metal-network-customizations.adoc#creating-machines-bare-metal_installing-bare-metal-network-customizations[Installing {op-system} and starting the {product-title} bootstrap process] * xref:../../../installing/installing_bare_metal/upi/installing-bare-metal-network-customizations.adoc#installation-host-names-dhcp-user-infra_installing-bare-metal-network-customizations[Setting the cluster node hostnames through DHCP] * xref:../../../installing/installing_bare_metal/upi/installing-bare-metal-network-customizations.adoc#installation-user-infra-machines-advanced_installing-bare-metal-network-customizations[Advanced RHCOS installation configuration] @@ -114,7 +113,14 @@ include::modules/ssh-agent-using.adoc[leveloffset=+1] include::modules/installation-obtaining-installer.adoc[leveloffset=+1] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/installation-initializing-manual.adoc[leveloffset=+1] diff --git a/installing/installing_bare_metal/upi/installing-bare-metal.adoc b/installing/installing_bare_metal/upi/installing-bare-metal.adoc index f949f6522f..0b333dd413 100644 --- a/installing/installing_bare_metal/upi/installing-bare-metal.adoc +++ b/installing/installing_bare_metal/upi/installing-bare-metal.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] In {product-title} {product-version}, you can install a cluster on bare-metal infrastructure that you provision. [IMPORTANT] @@ -31,15 +32,7 @@ include::modules/cluster-entitlements.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* See xref:../../../installing/installing_bare_metal/upi/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[Installing a user-provisioned bare metal cluster on a restricted network] for more information about performing a restricted network installation on bare metal infrastructure that you provision. - -[id="installation-requirements-user-infra_{context}"] -== 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. +* xref:../../../installing/installing_bare_metal/upi/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[Installing a user-provisioned bare metal cluster on a restricted network] // Required machines for cluster installation include::modules/installation-machine-requirements.adoc[leveloffset=+2] @@ -57,18 +50,13 @@ include::modules/csr-management.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* See xref:../../../installing/installing_bare_metal/upi/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/upi/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. - -[id="installation-requirements-baremetal-vsphere_{context}"] -=== Requirements for baremetal clusters on vSphere - -Ensure you enable the `disk.EnableUUID` parameter on all virtual machines in your cluster. +* xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installation-three-node-cluster_installing-bare-metal[Configuring a three-node cluster] +* xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installation-approve-csrs_installing-bare-metal[Approving the certificate signing requests for your machines] [role="_additional-resources"] .Additional resources -* See xref:../../../installing/installing_vsphere/upi/installing-vsphere.adoc#installation-vsphere-machines_installing-vsphere[Installing RHCOS and starting the OpenShift Container Platform bootstrap process] for details on setting the `disk.EnableUUID` parameter's value to `TRUE` on VMware vSphere for user-provisioned infrastructure. +* xref:../../../installing/installing_vsphere/upi/installing-vsphere.adoc#installation-vsphere-machines_installing-vsphere[Installing RHCOS and starting the {product-title} bootstrap process] // Networking requirements for user-provisioned infrastructure include::modules/installation-network-user-infra.adoc[leveloffset=+2] @@ -110,7 +98,6 @@ include::modules/installation-infrastructure-user-infra.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installation-requirements-user-infra_installing-bare-metal[Requirements for a cluster with user-provisioned infrastructure] * xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#creating-machines-bare-metal_installing-bare-metal[Installing {op-system} and starting the {product-title} bootstrap process] * xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installation-host-names-dhcp-user-infra_installing-bare-metal[Setting the cluster node hostnames through DHCP] * xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installation-user-infra-machines-advanced_installing-bare-metal[Advanced RHCOS installation configuration] @@ -139,8 +126,14 @@ include::modules/ssh-agent-using.adoc[leveloffset=+1] // Obtaining the installation program include::modules/installation-obtaining-installer.adoc[leveloffset=+1] -// Installing the OpenShift CLI -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] // Manually creating the installation configuration file include::modules/installation-initializing-manual.adoc[leveloffset=+1] @@ -155,9 +148,9 @@ include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* See xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installation-load-balancing-user-infra_installing-bare-metal[Load balancing requirements for user-provisioned infrastructure] for more information on the API and application ingress load balancing requirements. -* See xref:../../../installing/overview/cluster-capabilities.adoc#cluster-capabilities[Cluster capabilities] for more information on enabling cluster capabilities that were disabled before installation. -* See xref:../../../installing/overview/cluster-capabilities.adoc#explanation_of_capabilities_cluster-capabilities[Optional cluster capabilities in {product-title} {product-version}] for more information about the features provided by each capability. +* xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#installation-load-balancing-user-infra_installing-bare-metal[Load balancing requirements for user-provisioned infrastructure] +* xref:../../../installing/overview/cluster-capabilities.adoc#cluster-capabilities[Cluster capabilities] +* xref:../../../installing/overview/cluster-capabilities.adoc#explanation_of_capabilities_cluster-capabilities[Optional cluster capabilities in {product-title} {product-version}] include::modules/installation-configure-proxy.adoc[leveloffset=+2] @@ -168,7 +161,7 @@ include::modules/installation-user-infra-generate-k8s-manifest-ignition.adoc[lev [role="_additional-resources"] .Additional resources -* See xref:../../../backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-3-expired-certs.adoc#dr-recovering-expired-certs[Recovering from expired control plane certificates] for more information about recovering kubelet certificates. +* xref:../../../backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-3-expired-certs.adoc#dr-recovering-expired-certs[Recovering from expired control plane certificates] include::modules/creating-machines-bare-metal.adoc[leveloffset=+1] @@ -232,14 +225,14 @@ include::modules/rhcos-install-iscsi-ibft.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* See xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#creating-machines-bare-metal_installing-bare-metal[Installing {op-system} and starting the {product-title} bootstrap process] for more information on using special `coreos.inst.*` arguments to direct the live installer. +* xref:../../../installing/installing_bare_metal/upi/installing-bare-metal.adoc#creating-machines-bare-metal_installing-bare-metal[Installing {op-system} and starting the {product-title} bootstrap process] include::modules/installation-installing-bare-metal.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* 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. +* xref:../../../support/troubleshooting/troubleshooting-installations.adoc#monitoring-installation-progress_troubleshooting-installations[Monitoring installation progress] include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] @@ -250,8 +243,8 @@ include::modules/installation-operators-config.adoc[leveloffset=+1] [role="_additional-resources"] .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. +* xref:../../../support/troubleshooting/troubleshooting-installations.adoc#installation-bootstrap-gather_troubleshooting-installations[Gathering logs from a failed installation] +* xref:../../../support/troubleshooting/troubleshooting-operator-issues.adoc#troubleshooting-operator-issues[Troubleshooting Operator issues] include::modules/registry-removed.adoc[leveloffset=+2] @@ -270,12 +263,11 @@ include::modules/cluster-telemetry.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* See xref:../../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] for more information about the Telemetry service +* xref:../../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] == Next steps -* xref:../../../installing/validation_and_troubleshooting/validating-an-installation.adoc#validating-an-installation[Validating an installation]. +* xref:../../../installing/validation_and_troubleshooting/validating-an-installation.adoc#validating-an-installation[Validating an installation] * xref:../../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. -* If necessary, you can -xref:../../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting]. -* xref:../../../registry/configuring_registry_storage/configuring-registry-storage-baremetal.adoc#configuring-registry-storage-baremetal[Set up your registry and configure registry storage]. +* xref:../../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting] +* xref:../../../registry/configuring_registry_storage/configuring-registry-storage-baremetal.adoc#configuring-registry-storage-baremetal[Set up your registry and configure registry storage] diff --git a/installing/installing_gcp/installing-gcp-customizations.adoc b/installing/installing_gcp/installing-gcp-customizations.adoc index b99f9f69d6..831f493ebb 100644 --- a/installing/installing_gcp/installing-gcp-customizations.adoc +++ b/installing/installing_gcp/installing-gcp-customizations.adoc @@ -79,8 +79,14 @@ include::modules/installing-gcp-cluster-creation.adoc[leveloffset=+2] //Querying user-defined labels and tags for GCP include::modules/installing-gcp-querying-labels-tags-gcp.adoc[leveloffset=+2] -//Installing the OpenShift CLI by downloading the binary: Moved up to precede `ccoctl` steps, which require the use of `oc` -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] [id="installing-gcp-manual-modes_{context}"] == Alternatives to storing administrator-level secrets in the kube-system project diff --git a/installing/installing_gcp/installing-gcp-default.adoc b/installing/installing_gcp/installing-gcp-default.adoc index d21393f673..fcc9313c6d 100644 --- a/installing/installing_gcp/installing-gcp-default.adoc +++ b/installing/installing_gcp/installing-gcp-default.adoc @@ -24,7 +24,14 @@ include::modules/installation-obtaining-installer.adoc[leveloffset=+1] include::modules/installation-launching-installer.adoc[leveloffset=+1] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] diff --git a/installing/installing_gcp/installing-gcp-private.adoc b/installing/installing_gcp/installing-gcp-private.adoc index 1455abe85a..e78c342494 100644 --- a/installing/installing_gcp/installing-gcp-private.adoc +++ b/installing/installing_gcp/installing-gcp-private.adoc @@ -72,8 +72,14 @@ include::modules/nw-gcp-installing-global-access-configuration.adoc[leveloffset= include::modules/installation-configure-proxy.adoc[leveloffset=+2] -//Installing the OpenShift CLI by downloading the binary: Moved up to precede `ccoctl` steps, which require the use of `oc` -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] [id="installing-gcp-manual-modes_{context}"] == Alternatives to storing administrator-level secrets in the kube-system project diff --git a/installing/installing_gcp/installing-gcp-shared-vpc.adoc b/installing/installing_gcp/installing-gcp-shared-vpc.adoc index 255b5b8b62..b15ff218fb 100644 --- a/installing/installing_gcp/installing-gcp-shared-vpc.adoc +++ b/installing/installing_gcp/installing-gcp-shared-vpc.adoc @@ -54,8 +54,14 @@ include::modules/installation-gcp-shared-vpc-config.adoc[leveloffset=+2] include::modules/installation-configure-proxy.adoc[leveloffset=+2] -//Installing the OpenShift CLI by downloading the binary: Moved up to precede `ccoctl` steps, which require the use of `oc` -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] [id="installing-gcp-manual-modes_{context}"] == Alternatives to storing administrator-level secrets in the kube-system project diff --git a/installing/installing_gcp/installing-gcp-user-infra-vpc.adoc b/installing/installing_gcp/installing-gcp-user-infra-vpc.adoc index 4ebbf4c921..adc6acfb96 100644 --- a/installing/installing_gcp/installing-gcp-user-infra-vpc.adoc +++ b/installing/installing_gcp/installing-gcp-user-infra-vpc.adoc @@ -158,7 +158,14 @@ include::modules/installation-creating-gcp-worker.adoc[leveloffset=+1] include::modules/installation-deployment-manager-worker.adoc[leveloffset=+2] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] diff --git a/installing/installing_gcp/installing-gcp-user-infra.adoc b/installing/installing_gcp/installing-gcp-user-infra.adoc index 640ae0d481..4ec8404200 100644 --- a/installing/installing_gcp/installing-gcp-user-infra.adoc +++ b/installing/installing_gcp/installing-gcp-user-infra.adoc @@ -159,7 +159,14 @@ include::modules/installation-creating-gcp-worker.adoc[leveloffset=+1] include::modules/installation-deployment-manager-worker.adoc[leveloffset=+2] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] diff --git a/installing/installing_gcp/installing-gcp-vpc.adoc b/installing/installing_gcp/installing-gcp-vpc.adoc index 34f04c43a3..4e145a2662 100644 --- a/installing/installing_gcp/installing-gcp-vpc.adoc +++ b/installing/installing_gcp/installing-gcp-vpc.adoc @@ -68,8 +68,14 @@ include::modules/nw-gcp-installing-global-access-configuration.adoc[leveloffset= include::modules/installation-configure-proxy.adoc[leveloffset=+2] -//Installing the OpenShift CLI by downloading the binary: Moved up to precede `ccoctl` steps, which require the use of `oc` -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] [id="installing-gcp-manual-modes_{context}"] == Alternatives to storing administrator-level secrets in the kube-system project diff --git a/installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc b/installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc index 5ec6bed281..ed2453ac97 100644 --- a/installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc +++ b/installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc @@ -75,8 +75,14 @@ include::modules/nw-gcp-installing-global-access-configuration.adoc[leveloffset= include::modules/installation-configure-proxy.adoc[leveloffset=+2] -//Installing the OpenShift CLI by downloading the binary: Moved up to precede `ccoctl` steps, which require the use of `oc` -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] [id="installing-gcp-manual-modes_{context}"] == Alternatives to storing administrator-level secrets in the kube-system project diff --git a/installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc b/installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc index af9366f3cb..5e49344697 100644 --- a/installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc +++ b/installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc @@ -64,7 +64,14 @@ include::modules/nw-operator-cr.adoc[leveloffset=+1] include::modules/installation-launching-installer.adoc[leveloffset=+1] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] diff --git a/installing/installing_ibm_cloud/installing-ibm-cloud-network-customizations.adoc b/installing/installing_ibm_cloud/installing-ibm-cloud-network-customizations.adoc index 6aed25bb9f..56f533a370 100644 --- a/installing/installing_ibm_cloud/installing-ibm-cloud-network-customizations.adoc +++ b/installing/installing_ibm_cloud/installing-ibm-cloud-network-customizations.adoc @@ -62,7 +62,14 @@ include::modules/nw-operator-cr.adoc[leveloffset=+1] include::modules/installation-launching-installer.adoc[leveloffset=+1] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] diff --git a/installing/installing_ibm_cloud/installing-ibm-cloud-private.adoc b/installing/installing_ibm_cloud/installing-ibm-cloud-private.adoc index 2d6591999c..d9ba12db0a 100644 --- a/installing/installing_ibm_cloud/installing-ibm-cloud-private.adoc +++ b/installing/installing_ibm_cloud/installing-ibm-cloud-private.adoc @@ -54,7 +54,14 @@ include::modules/manually-create-iam-ibm-cloud.adoc[leveloffset=+1] include::modules/installation-launching-installer.adoc[leveloffset=+1] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] diff --git a/installing/installing_ibm_cloud/installing-ibm-cloud-restricted.adoc b/installing/installing_ibm_cloud/installing-ibm-cloud-restricted.adoc index 7190e29045..42a23daf30 100644 --- a/installing/installing_ibm_cloud/installing-ibm-cloud-restricted.adoc +++ b/installing/installing_ibm_cloud/installing-ibm-cloud-restricted.adoc @@ -57,7 +57,14 @@ include::modules/installation-ibm-cloud-tested-machine-types.adoc[leveloffset=+2 include::modules/installation-ibm-cloud-config-yaml.adoc[leveloffset=+2] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/manually-create-iam-ibm-cloud.adoc[leveloffset=+1] diff --git a/installing/installing_ibm_cloud/installing-ibm-cloud-vpc.adoc b/installing/installing_ibm_cloud/installing-ibm-cloud-vpc.adoc index 2794ef0782..13eafa5659 100644 --- a/installing/installing_ibm_cloud/installing-ibm-cloud-vpc.adoc +++ b/installing/installing_ibm_cloud/installing-ibm-cloud-vpc.adoc @@ -50,7 +50,14 @@ include::modules/manually-create-iam-ibm-cloud.adoc[leveloffset=+1] include::modules/installation-launching-installer.adoc[leveloffset=+1] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] diff --git a/installing/installing_ibm_power/installing-ibm-power.adoc b/installing/installing_ibm_power/installing-ibm-power.adoc index 705758f258..09bc3d3224 100644 --- a/installing/installing_ibm_power/installing-ibm-power.adoc +++ b/installing/installing_ibm_power/installing-ibm-power.adoc @@ -72,7 +72,14 @@ include::modules/ssh-agent-using.adoc[leveloffset=+1] include::modules/installation-obtaining-installer.adoc[leveloffset=+1] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/installation-initializing-manual.adoc[leveloffset=+1] diff --git a/installing/installing_ibm_powervs/installing-ibm-power-vs-customizations.adoc b/installing/installing_ibm_powervs/installing-ibm-power-vs-customizations.adoc index c3e2220ece..0697b9a768 100644 --- a/installing/installing_ibm_powervs/installing-ibm-power-vs-customizations.adoc +++ b/installing/installing_ibm_powervs/installing-ibm-power-vs-customizations.adoc @@ -39,7 +39,14 @@ include::modules/manually-create-iam-ibm-cloud.adoc[leveloffset=+1] include::modules/installation-launching-installer.adoc[leveloffset=+1] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] diff --git a/installing/installing_ibm_powervs/installing-ibm-power-vs-private-cluster.adoc b/installing/installing_ibm_powervs/installing-ibm-power-vs-private-cluster.adoc index 2dd8951bf6..8c4ec3bd6e 100644 --- a/installing/installing_ibm_powervs/installing-ibm-power-vs-private-cluster.adoc +++ b/installing/installing_ibm_powervs/installing-ibm-power-vs-private-cluster.adoc @@ -52,7 +52,14 @@ include::modules/manually-create-iam-ibm-cloud.adoc[leveloffset=+1] include::modules/installation-launching-installer.adoc[leveloffset=+1] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] diff --git a/installing/installing_ibm_powervs/installing-ibm-powervs-vpc.adoc b/installing/installing_ibm_powervs/installing-ibm-powervs-vpc.adoc index 459be3ea0c..dd7ad8694f 100644 --- a/installing/installing_ibm_powervs/installing-ibm-powervs-vpc.adoc +++ b/installing/installing_ibm_powervs/installing-ibm-powervs-vpc.adoc @@ -48,7 +48,14 @@ include::modules/manually-create-iam-ibm-cloud.adoc[leveloffset=+1] include::modules/installation-launching-installer.adoc[leveloffset=+1] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] diff --git a/installing/installing_ibm_powervs/installing-restricted-networks-ibm-power-vs.adoc b/installing/installing_ibm_powervs/installing-restricted-networks-ibm-power-vs.adoc index 4a4a80e9ed..f7f46bf90a 100644 --- a/installing/installing_ibm_powervs/installing-restricted-networks-ibm-power-vs.adoc +++ b/installing/installing_ibm_powervs/installing-restricted-networks-ibm-power-vs.adoc @@ -57,7 +57,14 @@ include::modules/manually-create-iam-ibm-cloud.adoc[leveloffset=+1] include::modules/installation-launching-installer.adoc[leveloffset=+1] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] diff --git a/installing/installing_ibm_z/upi/upi-ibm-z-preparing-to-install.adoc b/installing/installing_ibm_z/upi/upi-ibm-z-preparing-to-install.adoc index f82b4dcb16..89cccfb542 100644 --- a/installing/installing_ibm_z/upi/upi-ibm-z-preparing-to-install.adoc +++ b/installing/installing_ibm_z/upi/upi-ibm-z-preparing-to-install.adoc @@ -34,7 +34,14 @@ include::modules/cluster-entitlements.adoc[leveloffset=+1] include::modules/installation-obtaining-installer.adoc[leveloffset=+1] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/ssh-agent-using.adoc[leveloffset=+1] diff --git a/installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc b/installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc index 0097f838e0..66628f9871 100644 --- a/installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc +++ b/installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc @@ -52,7 +52,14 @@ include::modules/installation-configuring-nutanix-failure-domains.adoc[leveloffs include::modules/installation-configure-proxy.adoc[leveloffset=+2] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/manually-configure-iam-nutanix.adoc[leveloffset=+1] diff --git a/installing/installing_nutanix/installing-restricted-networks-nutanix-installer-provisioned.adoc b/installing/installing_nutanix/installing-restricted-networks-nutanix-installer-provisioned.adoc index 56e8814a60..ce666bd876 100644 --- a/installing/installing_nutanix/installing-restricted-networks-nutanix-installer-provisioned.adoc +++ b/installing/installing_nutanix/installing-restricted-networks-nutanix-installer-provisioned.adoc @@ -51,7 +51,14 @@ include::modules/installation-configuring-nutanix-failure-domains.adoc[leveloffs include::modules/installation-configure-proxy.adoc[leveloffset=+2] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/manually-configure-iam-nutanix.adoc[leveloffset=+1] diff --git a/installing/installing_platform_agnostic/installing-platform-agnostic.adoc b/installing/installing_platform_agnostic/installing-platform-agnostic.adoc index bfb5c2c606..05efc57835 100644 --- a/installing/installing_platform_agnostic/installing-platform-agnostic.adoc +++ b/installing/installing_platform_agnostic/installing-platform-agnostic.adoc @@ -60,7 +60,14 @@ include::modules/ssh-agent-using.adoc[leveloffset=+1] include::modules/installation-obtaining-installer.adoc[leveloffset=+1] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/installation-initializing-manual.adoc[leveloffset=+1] diff --git a/installing/installing_vsphere/ipi/ipi-vsphere-preparing-to-install.adoc b/installing/installing_vsphere/ipi/ipi-vsphere-preparing-to-install.adoc index fc688c7979..4556a5c78b 100644 --- a/installing/installing_vsphere/ipi/ipi-vsphere-preparing-to-install.adoc +++ b/installing/installing_vsphere/ipi/ipi-vsphere-preparing-to-install.adoc @@ -25,7 +25,14 @@ If you are installing in a disconnected environment, install `oc` to the mirror include::modules/installation-obtaining-installer.adoc[leveloffset=+1] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/ssh-agent-using.adoc[leveloffset=+1] diff --git a/installing/installing_vsphere/upi/upi-vsphere-preparing-to-install.adoc b/installing/installing_vsphere/upi/upi-vsphere-preparing-to-install.adoc index 9832fedcc0..418375cee2 100644 --- a/installing/installing_vsphere/upi/upi-vsphere-preparing-to-install.adoc +++ b/installing/installing_vsphere/upi/upi-vsphere-preparing-to-install.adoc @@ -26,7 +26,14 @@ If you are installing in a disconnected environment, install `oc` to the mirror include::modules/installation-obtaining-installer.adoc[leveloffset=+1] -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/ssh-agent-using.adoc[leveloffset=+1] diff --git a/microshift_cli_ref/microshift-oc-cli-install.adoc b/microshift_cli_ref/microshift-oc-cli-install.adoc index 808d1c3159..97a8c89cc0 100644 --- a/microshift_cli_ref/microshift-oc-cli-install.adoc +++ b/microshift_cli_ref/microshift-oc-cli-install.adoc @@ -8,8 +8,14 @@ toc::[] To use the {oc-first} tool, you must download and install it separately from your {microshift-short} installation. You can install `oc` by downloading the binary or by using Homebrew. -// Installing the CLI by downloading the binary -include::modules/cli-installing-cli.adoc[leveloffset=+1] +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] // Installing the CLI by using Homebrew include::modules/cli-installing-cli-brew.adoc[leveloffset=+1] diff --git a/modules/cli-installing-cli.adoc b/modules/cli-installing-cli-linux.adoc similarity index 57% rename from modules/cli-installing-cli.adoc rename to modules/cli-installing-cli-linux.adoc index 86172a79b4..45fe8b41f4 100644 --- a/modules/cli-installing-cli.adoc +++ b/modules/cli-installing-cli-linux.adoc @@ -52,10 +52,11 @@ ifeval::["{context}" == "mirroring-ocp-image-repository"] endif::[] :_mod-docs-content-type: PROCEDURE -[id="cli-installing-cli_{context}"] -= Installing the OpenShift CLI +[id="cli-installing-cli-linux_{context}"] += Installing the OpenShift CLI on Linux -You can install the {oc-first} to interact with {product-title} from a command-line interface. You can install `oc` on Linux, Windows, or macOS. +[role="_abstract"] +You can install the {oc-first} binary on Linux by using the following procedure. [IMPORTANT] ==== @@ -67,11 +68,6 @@ If you are updating a cluster in a disconnected environment, install the `oc` ve endif::restricted[] ==== - -== Installing the OpenShift CLI on Linux - -You can install the OpenShift CLI (`oc`) binary on Linux by using the following procedure. - ifdef::microshift[] [NOTE] ==== @@ -121,103 +117,6 @@ $ echo $PATH $ oc ---- - -== Installing the OpenShift CLI on Windows - -You can install the OpenShift CLI (`oc`) binary on Windows by using the following procedure. -ifdef::microshift[] -[NOTE] -==== -{product-title} version numbering matches {OCP} version numbering. Use the `oc` binary that matches your {microshift-short} version and has the appropriate RHEL compatibility. -==== - -endif::microshift[] -.Procedure - -ifdef::openshift-origin[] -. Navigate to link:https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/[https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/] and choose the folder for your operating system and architecture. -. Download `oc.zip`. -endif::[] -ifndef::openshift-origin,microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] -. Navigate to the link:https://access.redhat.com/downloads/content/290[Download {product-title}] page on the Red{nbsp}Hat Customer Portal. -. Select the appropriate version from the *Version* list. -. Click *Download Now* next to the *OpenShift v{product-version} Windows Client* entry and save the file. -endif::openshift-origin,microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] -ifdef::microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] -. Navigate to the link:https://access.redhat.com/downloads/content/290[Download {OCP}] page on the Red Hat Customer Portal. -. Select the appropriate version from the *Version* list. -. Click *Download Now* next to the *OpenShift v{product-version} Windows Client* entry and save the file. -endif::microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] -. Unzip the archive with a ZIP program. -. Move the `oc` binary to a directory that is on your `PATH`. -+ -To check your `PATH`, open the command prompt and execute the following command: -+ -[source,terminal] ----- -C:\> path ----- - -.Verification - -* After you install the OpenShift CLI, it is available using the `oc` command: -+ -[source,terminal] ----- -C:\> oc ----- - - -== Installing the OpenShift CLI on macOS - -You can install the OpenShift CLI (`oc`) binary on macOS by using the following procedure. -ifdef::microshift[] -[NOTE] -==== -{product-title} version numbering matches {OCP} version numbering. Use the `oc` binary that matches your {microshift-short} version and has the appropriate RHEL compatibility. -==== - -endif::microshift[] -.Procedure - -ifdef::openshift-origin[] -. Navigate to link:https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/[https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/] and choose the folder for your operating system and architecture. -. Download `oc.tar.gz`. -endif::[] -ifndef::openshift-origin,microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] -. Navigate to the link:https://access.redhat.com/downloads/content/290[Download {product-title}] page on the Red{nbsp}Hat Customer Portal. -. Select the appropriate version from the *Version* drop-down list. -. Click *Download Now* next to the *OpenShift v{product-version} macOS Clients* entry and save the file. -+ -[NOTE] -==== -For macOS arm64, choose the *OpenShift v{product-version} macOS arm64 Client* entry. -==== -endif::openshift-origin,microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] -ifdef::microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] -. Navigate to the link:https://access.redhat.com/downloads/content/290[Download {OCP}] on the Red{nbsp}Hat Customer Portal. -. Select the appropriate version from the *Version* drop-down list. -. Click *Download Now* next to the *OpenShift v{product-version} macOS Clients* entry and save the file. -endif::microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] -. Unpack and unzip the archive. -. Move the `oc` binary to a directory on your PATH. -+ -To check your `PATH`, open a terminal and execute the following command: -+ -[source,terminal] ----- -$ echo $PATH ----- - -.Verification - -* Verify your installation by using an `oc` command: -+ -[source,terminal] ----- -$ oc ----- - ifeval::["{context}" == "mirroring-ocp-image-repository"] :!restricted: endif::[] diff --git a/modules/cli-installing-cli-macos.adoc b/modules/cli-installing-cli-macos.adoc new file mode 100644 index 0000000000..0338d68a17 --- /dev/null +++ b/modules/cli-installing-cli-macos.adoc @@ -0,0 +1,120 @@ +// Module included in the following assemblies: +// +// * cli_reference/openshift_cli/getting-started.adoc +// * 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-china.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-localzone.adoc +// * installing/installaing_aws/installing-aws-wavelength-zone.adoc +// * installing/installing_aws/installing-restricted-networks-aws-installer-provisioned.adoc +// * installing/installing_aws/installing-aws-outposts-remote-workers.adocs +// * 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_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_gcp/installing-gcp-user-infra.adoc +// * installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.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_ibm_cloud/installing-ibm-cloud-restricted.adoc +// * installing/install_config/installing-restricted-networks-preparations.adoc +// * openshift_images/samples-operator-alt-registry.adoc +// * updating/updating-restricted-network-cluster/mirroring-image-repository.adoc +// * microshift_cli_ref/microshift-oc-cli-install.adoc +// * updating/updating_a_cluster/updating_disconnected_cluster/mirroring-image-repository.adoc +// * installing/installing-nutanix-installer-provisioned.adoc +// * installing/installing-restricted-networks-nutanix-installer-provisioned.adoc +// * installing/installing_ibm_powervs/installing-ibm-power-vs-private-cluster.adoc +// * installing/installing_ibm_powervs/installing-restricted-networks-ibm-power-vs.adoc +// * installing/installing_ibm_powervs/installing-ibm-powervs-vpc.adoc +// * installing/installing-restricted-networks-azure-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_ibm_z/upi-ibm-z-preparing-to-install.adoc +// AMQ docs link to this; do not change anchor + +ifeval::["{context}" == "mirroring-ocp-image-repository"] +:restricted: +endif::[] + +:_mod-docs-content-type: PROCEDURE +[id="cli-installing-cli-macos_{context}"] += Installing the OpenShift CLI on macOS + +[role="_abstract"] +You can install the {oc-first} binary on macOS by using the following procedure. + +[IMPORTANT] +==== +If you installed an earlier version of `oc`, you cannot use it to complete all of the commands in {product-title}. + +Download and install the new version of `oc`. +ifdef::restricted[] +If you are updating a cluster in a disconnected environment, install the `oc` version that you plan to update to. +endif::restricted[] +==== + +ifdef::microshift[] +[NOTE] +==== +{product-title} version numbering matches {OCP} version numbering. Use the `oc` binary that matches your {microshift-short} version and has the appropriate RHEL compatibility. +==== + +endif::microshift[] +.Procedure + +ifdef::openshift-origin[] +. Navigate to link:https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/[https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/] and choose the folder for your operating system and architecture. +. Download `oc.tar.gz`. +endif::[] +ifndef::openshift-origin,microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +. Navigate to the link:https://access.redhat.com/downloads/content/290[Download {product-title}] page on the Red{nbsp}Hat Customer Portal. +. Select the appropriate version from the *Version* drop-down list. +. Click *Download Now* next to the *OpenShift v{product-version} macOS Clients* entry and save the file. ++ +[NOTE] +==== +For macOS arm64, choose the *OpenShift v{product-version} macOS arm64 Client* entry. +==== +endif::openshift-origin,microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +ifdef::microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +. Navigate to the link:https://access.redhat.com/downloads/content/290[Download {OCP}] on the Red{nbsp}Hat Customer Portal. +. Select the appropriate version from the *Version* drop-down list. +. Click *Download Now* next to the *OpenShift v{product-version} macOS Clients* entry and save the file. +endif::microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +. Unpack and unzip the archive. +. Move the `oc` binary to a directory on your PATH. ++ +To check your `PATH`, open a terminal and execute the following command: ++ +[source,terminal] +---- +$ echo $PATH +---- + +.Verification + +* Verify your installation by using an `oc` command: ++ +[source,terminal] +---- +$ oc +---- + +ifeval::["{context}" == "mirroring-ocp-image-repository"] +:!restricted: +endif::[] diff --git a/modules/cli-installing-cli-windows.adoc b/modules/cli-installing-cli-windows.adoc new file mode 100644 index 0000000000..8395f2e086 --- /dev/null +++ b/modules/cli-installing-cli-windows.adoc @@ -0,0 +1,115 @@ +// Module included in the following assemblies: +// +// * cli_reference/openshift_cli/getting-started.adoc +// * 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-china.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-localzone.adoc +// * installing/installaing_aws/installing-aws-wavelength-zone.adoc +// * installing/installing_aws/installing-restricted-networks-aws-installer-provisioned.adoc +// * installing/installing_aws/installing-aws-outposts-remote-workers.adocs +// * 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_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_gcp/installing-gcp-user-infra.adoc +// * installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.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_ibm_cloud/installing-ibm-cloud-restricted.adoc +// * installing/install_config/installing-restricted-networks-preparations.adoc +// * openshift_images/samples-operator-alt-registry.adoc +// * updating/updating-restricted-network-cluster/mirroring-image-repository.adoc +// * microshift_cli_ref/microshift-oc-cli-install.adoc +// * updating/updating_a_cluster/updating_disconnected_cluster/mirroring-image-repository.adoc +// * installing/installing-nutanix-installer-provisioned.adoc +// * installing/installing-restricted-networks-nutanix-installer-provisioned.adoc +// * installing/installing_ibm_powervs/installing-ibm-power-vs-private-cluster.adoc +// * installing/installing_ibm_powervs/installing-restricted-networks-ibm-power-vs.adoc +// * installing/installing_ibm_powervs/installing-ibm-powervs-vpc.adoc +// * installing/installing-restricted-networks-azure-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_ibm_z/upi-ibm-z-preparing-to-install.adoc +// AMQ docs link to this; do not change anchor + +ifeval::["{context}" == "mirroring-ocp-image-repository"] +:restricted: +endif::[] + +:_mod-docs-content-type: PROCEDURE +[id="cli-installing-cli-windows_{context}"] += Installing the OpenShift CLI on Windows + +[role="_abstract"] +You can install the {oc-first} binary on Windows by using the following procedure. + +[IMPORTANT] +==== +If you installed an earlier version of `oc`, you cannot use it to complete all of the commands in {product-title}. + +Download and install the new version of `oc`. +ifdef::restricted[] +If you are updating a cluster in a disconnected environment, install the `oc` version that you plan to update to. +endif::restricted[] +==== + +ifdef::microshift[] +[NOTE] +==== +{product-title} version numbering matches {OCP} version numbering. Use the `oc` binary that matches your {microshift-short} version and has the appropriate RHEL compatibility. +==== + +endif::microshift[] +.Procedure + +ifdef::openshift-origin[] +. Navigate to link:https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/[https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/] and choose the folder for your operating system and architecture. +. Download `oc.zip`. +endif::[] +ifndef::openshift-origin,microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +. Navigate to the link:https://access.redhat.com/downloads/content/290[Download {product-title}] page on the Red{nbsp}Hat Customer Portal. +. Select the appropriate version from the *Version* list. +. Click *Download Now* next to the *OpenShift v{product-version} Windows Client* entry and save the file. +endif::openshift-origin,microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +ifdef::microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +. Navigate to the link:https://access.redhat.com/downloads/content/290[Download {OCP}] page on the Red Hat Customer Portal. +. Select the appropriate version from the *Version* list. +. Click *Download Now* next to the *OpenShift v{product-version} Windows Client* entry and save the file. +endif::microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +. Extract the archive with a ZIP program. +. Move the `oc` binary to a directory that is on your `PATH`. ++ +To check your `PATH`, open the command prompt and execute the following command: ++ +[source,terminal] +---- +C:\> path +---- + +.Verification + +* After you install the OpenShift CLI, it is available using the `oc` command: ++ +[source,terminal] +---- +C:\> oc +---- + +ifeval::["{context}" == "mirroring-ocp-image-repository"] +:!restricted: +endif::[] diff --git a/modules/installation-configuration-parameters.adoc b/modules/installation-configuration-parameters.adoc index c0421ffe96..8ea050019e 100644 --- a/modules/installation-configuration-parameters.adoc +++ b/modules/installation-configuration-parameters.adoc @@ -61,6 +61,7 @@ endif::[] ifndef::agent[] = Available installation configuration parameters for {platform} +[role="_abstract"] The following tables specify the required, optional, and {platform}-specific installation configuration parameters that you can set as part of the installation process. [IMPORTANT] diff --git a/modules/installation-machine-requirements.adoc b/modules/installation-machine-requirements.adoc index 258194fd14..b091d8bf3b 100644 --- a/modules/installation-machine-requirements.adoc +++ b/modules/installation-machine-requirements.adoc @@ -41,6 +41,11 @@ endif::[] The smallest {product-title} clusters require the following hosts: +[IMPORTANT] +==== +For a cluster that contains user-provisioned infrastructure, you must deploy all of the required machines. +==== + .Minimum required hosts [options="header"] |=== diff --git a/modules/installation-network-user-infra.adoc b/modules/installation-network-user-infra.adoc index 44087d6f2d..152c0d5c81 100644 --- a/modules/installation-network-user-infra.adoc +++ b/modules/installation-network-user-infra.adoc @@ -77,6 +77,11 @@ endif::[] All the {op-system-first} machines require networking to be configured in `initramfs` during boot to fetch their Ignition config files. +[IMPORTANT] +==== +Ensure you enable the `disk.EnableUUID` parameter on all virtual machines in your cluster. +==== + ifndef::azure,gcp[] ifdef::ibm-z[] During the initial boot, the machines require an HTTP or HTTPS server to diff --git a/modules/installation-vsphere-encrypted-vms.adoc b/modules/installation-vsphere-encrypted-vms.adoc index bc62ba17c4..0473e45808 100644 --- a/modules/installation-vsphere-encrypted-vms.adoc +++ b/modules/installation-vsphere-encrypted-vms.adoc @@ -17,4 +17,4 @@ The Native key provider in vCenter is not supported. For more information, see l * You have enabled host encryption mode on all of the ESXi hosts that are hosting the cluster. For more information, see link:https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.security.doc/GUID-A9E1F016-51B3-472F-B8DE-803F6BDB70BC.html[Enabling host encryption mode]. * You have a vSphere account which has all cryptographic privileges enabled. For more information, see link:https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.security.doc/GUID-660CCB35-847F-46B3-81CA-10DDDB9D7AA9.html[Cryptographic Operations Privileges]. -When you deploy the OVF template in the section titled "Installing RHCOS and starting the OpenShift Container Platform bootstrap process", select the option to "Encrypt this virtual machine" when you are selecting storage for the OVF template. After completing cluster installation, create a storage class that uses the encryption storage policy you used to encrypt the virtual machines. +When you deploy the OVF template in the section titled "Installing RHCOS and starting the {product-title} bootstrap process", select the option to "Encrypt this virtual machine" when you are selecting storage for the OVF template. After completing cluster installation, create a storage class that uses the encryption storage policy you used to encrypt the virtual machines. diff --git a/openshift_images/samples-operator-alt-registry.adoc b/openshift_images/samples-operator-alt-registry.adoc index ccd31dd092..d8c7b0c310 100644 --- a/openshift_images/samples-operator-alt-registry.adoc +++ b/openshift_images/samples-operator-alt-registry.adoc @@ -14,8 +14,14 @@ include::modules/installation-about-mirror-registry.adoc[leveloffset=+1] //Incorrect rendering of ROSA attributes discovered during Pruning HCP task. I believe some of the following content is not correct for managed OpenShift. I have created JIRA issue to investigate further. -include::modules/cli-installing-cli.adoc[leveloffset=+2] -//the CLI module will need to be made compliant in a separate PR; touches too many files (SD, during CQA 2.0) +// Installing the OpenShift CLI on Linux +include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on Windows +include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] + +// Installing the OpenShift CLI on macOS +include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] include::modules/installation-adding-registry-pull-secret.adoc[leveloffset=+1] diff --git a/security/container_security/security-hosts-vms.adoc b/security/container_security/security-hosts-vms.adoc index 47886729c0..49b697be10 100644 --- a/security/container_security/security-hosts-vms.adoc +++ b/security/container_security/security-hosts-vms.adoc @@ -21,7 +21,6 @@ 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/upi/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]