diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 601e211f5a..fb771ad2ff 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -112,14 +112,20 @@ Dir: installing Distros: openshift-origin,openshift-enterprise,openshift-webscale Topics: - Name: Installation overview - File: index - Distros: openshift-origin,openshift-enterprise -- Name: Selecting an installation method and preparing a cluster - File: installing-preparing - Distros: openshift-origin,openshift-enterprise -- Name: Cluster capabilities - File: cluster-capabilities - Distros: openshift-origin,openshift-enterprise + Dir: overview + Topics: + - Name: Installation overview + File: index + Distros: openshift-origin,openshift-enterprise + - Name: Selecting an installation method and preparing a cluster + File: installing-preparing + Distros: openshift-origin,openshift-enterprise + - Name: Cluster capabilities + File: cluster-capabilities + Distros: openshift-origin,openshift-enterprise + - Name: Support for FIPS cryptography + File: installing-fips + Distros: openshift-enterprise,openshift-online - Name: Disconnected installation mirroring Dir: disconnected_install Distros: openshift-origin,openshift-enterprise @@ -567,15 +573,15 @@ Topics: - Name: Enabling Linux control group version 1 (cgroup v1) File: enabling-cgroup-v1 Distros: openshift-enterprise -- Name: Validating an installation - File: validating-an-installation - Distros: openshift-origin,openshift-enterprise -- Name: Troubleshooting installation issues - File: installing-troubleshooting - Distros: openshift-origin,openshift-enterprise -- Name: Support for FIPS cryptography - File: installing-fips - Distros: openshift-enterprise,openshift-online +- Name: Validation and troubleshooting + Dir: validation_and_troubleshooting + Topics: + - Name: Validating an installation + File: validating-an-installation + Distros: openshift-origin,openshift-enterprise + - Name: Troubleshooting installation issues + File: installing-troubleshooting + Distros: openshift-origin,openshift-enterprise --- Name: Postinstallation configuration Dir: post_installation_configuration diff --git a/architecture/architecture-installation.adoc b/architecture/architecture-installation.adoc index e1fda2cf5b..bac8f1a4c6 100644 --- a/architecture/architecture-installation.adoc +++ b/architecture/architecture-installation.adoc @@ -29,4 +29,4 @@ include::modules/unmanaged-operators.adoc[leveloffset=+1] [id="architecture-installation-next-steps"] == Next steps -* xref:../installing/installing-preparing.adoc#installing-preparing[Selecting a cluster installation method and preparing it for users] \ No newline at end of file +* xref:../installing/overview/installing-preparing.adoc#installing-preparing[Selecting a cluster installation method and preparing it for users] diff --git a/cicd/gitops/installing-openshift-gitops.adoc b/cicd/gitops/installing-openshift-gitops.adoc index ae9a07411e..de93e364f2 100644 --- a/cicd/gitops/installing-openshift-gitops.adoc +++ b/cicd/gitops/installing-openshift-gitops.adoc @@ -15,7 +15,7 @@ toc::[] * You have access to the {product-title} web console. * You are logged in as a user with the `cluster-admin` role. * You are logged in to the {product-title} cluster as an administrator. -* Your cluster has the xref:../../installing/cluster-capabilities.adoc#marketplace-operator_cluster-capabilities[Marketplace capability] enabled or the Red Hat Operator catalog source configured manually. +* Your cluster has the xref:../../installing/overview/cluster-capabilities.adoc#marketplace-operator_cluster-capabilities[Marketplace capability] enabled or the Red Hat Operator catalog source configured manually. [WARNING] ==== diff --git a/cicd/pipelines/installing-pipelines.adoc b/cicd/pipelines/installing-pipelines.adoc index 1bcf8a8c47..8bff38ba4c 100644 --- a/cicd/pipelines/installing-pipelines.adoc +++ b/cicd/pipelines/installing-pipelines.adoc @@ -16,7 +16,7 @@ This guide walks cluster administrators through the process of installing the {p * You have access to an {product-title} cluster using an account with `cluster-admin` permissions. * You have installed `oc` CLI. * You have installed xref:../../cli_reference/tkn_cli/installing-tkn.adoc#installing-tkn[{pipelines-shortname} (`tkn`) CLI] on your local system. -* Your cluster has the xref:../../installing/cluster-capabilities.adoc#marketplace-operator_cluster-capabilities[Marketplace capability] enabled or the Red Hat Operator catalog source configured manually. +* Your cluster has the xref:../../installing/overview/cluster-capabilities.adoc#marketplace-operator_cluster-capabilities[Marketplace capability] enabled or the Red Hat Operator catalog source configured manually. ifdef::openshift-origin[] * Ensure that you have downloaded the {cluster-manager-url-pull} as shown in the xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#installation-obtaining-installer_installing-gcp-customizations[Obtaining the installation program] to install this Operator. diff --git a/getting_started/openshift-overview.adoc b/getting_started/openshift-overview.adoc index 77287976f9..d5b948fded 100644 --- a/getting_started/openshift-overview.adoc +++ b/getting_started/openshift-overview.adoc @@ -28,10 +28,10 @@ The {product-title} installation program offers you flexibility. You can use the For more information about the installation process, the supported platforms, and choosing a method of installing and preparing your cluster, see the following: -* xref:../installing/index.adoc#installation-overview_ocp-installation-overview[OpenShift Container Platform installation overview] -* xref:../installing/index.adoc#installation-process_ocp-installation-overview[Installation process] -* xref:../installing/index.adoc#supported-platforms-for-openshift-clusters_ocp-installation-overview[Supported platforms for OpenShift Container Platform clusters] -* xref:../installing/installing-preparing.adoc#installing-preparing-selecting-cluster-type[Selecting a cluster installation type] +* xref:../installing/overview/index.adoc#installation-overview_ocp-installation-overview[OpenShift Container Platform installation overview] +* xref:../installing/overview/index.adoc#installation-process_ocp-installation-overview[Installation process] +* xref:../installing/overview/index.adoc#supported-platforms-for-openshift-clusters_ocp-installation-overview[Supported platforms for OpenShift Container Platform clusters] +* xref:../installing/overview/installing-preparing.adoc#installing-preparing-selecting-cluster-type[Selecting a cluster installation type] include::modules/installation-openshift-local.adoc[leveloffset=+2] diff --git a/installing/disconnected_install/installing-mirroring-disconnected.adoc b/installing/disconnected_install/installing-mirroring-disconnected.adoc index bedd847aba..ace125e656 100644 --- a/installing/disconnected_install/installing-mirroring-disconnected.adoc +++ b/installing/disconnected_install/installing-mirroring-disconnected.adoc @@ -19,7 +19,7 @@ include::modules/oc-mirror-support.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* For information on updating oc-mirror, see xref:../../installing/validating-an-installation.adoc#viewing-the-image-pull-source_validating-an-installation[Viewing the image pull source]. +* For information on updating oc-mirror, see xref:../../installing/validation_and_troubleshooting/validating-an-installation.adoc#viewing-the-image-pull-source_validating-an-installation[Viewing the image pull source]. // About the mirror registry include::modules/installation-about-mirror-registry.adoc[leveloffset=+1] @@ -27,7 +27,7 @@ include::modules/installation-about-mirror-registry.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* For information about viewing the CRI-O logs to view the image source, see xref:../../installing/validating-an-installation.adoc#viewing-the-image-pull-source_validating-an-installation[Viewing the image pull source]. +* For information about viewing the CRI-O logs to view the image source, see xref:../../installing/validation_and_troubleshooting/validating-an-installation.adoc#viewing-the-image-pull-source_validating-an-installation[Viewing the image pull source]. [id="prerequisites_installing-mirroring-disconnected"] == Prerequisites diff --git a/installing/disconnected_install/installing-mirroring-installation-images.adoc b/installing/disconnected_install/installing-mirroring-installation-images.adoc index 3142b4959b..9f8578d69f 100644 --- a/installing/disconnected_install/installing-mirroring-installation-images.adoc +++ b/installing/disconnected_install/installing-mirroring-installation-images.adoc @@ -40,7 +40,7 @@ include::modules/installation-about-mirror-registry.adoc[leveloffset=+1] .Additional information -For information about viewing the CRI-O logs to view the image source, see xref:../../installing/validating-an-installation.adoc#viewing-the-image-pull-source_validating-an-installation[Viewing the image pull source]. +For information about viewing the CRI-O logs to view the image source, see xref:../../installing/validation_and_troubleshooting/validating-an-installation.adoc#viewing-the-image-pull-source_validating-an-installation[Viewing the image pull source]. [id="installing-preparing-mirror"] == Preparing your mirror host diff --git a/installing/install_config/enabling-cgroup-v1.adoc b/installing/install_config/enabling-cgroup-v1.adoc index 9824f23511..066854438c 100644 --- a/installing/install_config/enabling-cgroup-v1.adoc +++ b/installing/install_config/enabling-cgroup-v1.adoc @@ -33,5 +33,5 @@ endif::openshift-origin[] .Additional resources -* xref:../../installing/index.adoc#ocp-installation-overview[OpenShift Container Platform installation overview] +* xref:../../installing/overview/index.adoc#ocp-installation-overview[OpenShift Container Platform installation overview] * xref:../../nodes/clusters/nodes-cluster-cgroups-2.adoc#nodes-clusters-cgroups-2_nodes-cluster-cgroups-2[Configuring the Linux cgroup on your nodes] diff --git a/installing/install_config/installing-customizing.adoc b/installing/install_config/installing-customizing.adoc index 1b380a79b5..cc683ed522 100644 --- a/installing/install_config/installing-customizing.adoc +++ b/installing/install_config/installing-customizing.adoc @@ -54,5 +54,5 @@ include::modules/installation-special-config-chrony.adoc[leveloffset=+1] * For information on Butane, see xref:../../installing/install_config/installing-customizing.adoc#installation-special-config-butane_installing-customizing[Creating machine configs with Butane]. ifndef::openshift-origin[] -* For information on FIPS support, see xref:../../installing/installing-fips.adoc#installing-fips[Support for FIPS cryptography]. +* For information on FIPS support, see xref:../../installing/overview/installing-fips.adoc#installing-fips[Support for FIPS cryptography]. endif::[] diff --git a/installing/installing-preparing.adoc b/installing/installing-preparing.adoc deleted file mode 100644 index 373099fe6f..0000000000 --- a/installing/installing-preparing.adoc +++ /dev/null @@ -1,591 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="installing-preparing"] -= Selecting a cluster installation method and preparing it for users -include::_attributes/common-attributes.adoc[] -:context: installing-preparing - -toc::[] - -Before you install {product-title}, decide what kind of installation process to follow and verify that you have all of the required resources to prepare the cluster for users. - -[id="installing-preparing-selecting-cluster-type"] -== Selecting a cluster installation type -Before you install an {product-title} cluster, you need to select the best installation instructions to follow. Think about your answers to the following questions to select the best option. - -[id="installing-preparing-install-manage"] -=== Do you want to install and manage an {product-title} cluster yourself? - -If you want to install and manage {product-title} yourself, you can install it on the following platforms: - -* Amazon Web Services (AWS) on 64-bit x86 instances -ifndef::openshift-origin[] -* Amazon Web Services (AWS) on 64-bit ARM instances -endif::openshift-origin[] -* Microsoft Azure on 64-bit x86 instances -* Microsoft Azure on 64-bit ARM instances -* Microsoft Azure Stack Hub -* Google Cloud Platform (GCP) on 64-bit x86 instances -* Google Cloud Platform (GCP) on 64-bit ARM instances -* {rh-openstack-first} -* {ibm-cloud-name} -* {ibm-z-name} or {ibm-linuxone-name} -* {ibm-z-name} or {ibm-linuxone-name} for {op-system-base-full} KVM -* {ibm-power-name} -* {ibm-power-server-name} -* Nutanix -* VMware vSphere -* Bare metal or other platform agnostic infrastructure -// might want a note about single node here - -You can deploy an {product-title} 4 cluster to both on-premise hardware and to cloud hosting services, but all of the machines in a cluster must be in the same data center or cloud hosting service. - -If you want to use {product-title} but do not want to manage the cluster yourself, you have several managed service options. If you want a cluster that is fully managed by Red Hat, you can use link:https://www.openshift.com/products/dedicated/[OpenShift Dedicated] or link:https://www.openshift.com/products/online/[OpenShift Online]. You can also use OpenShift as a managed service on Azure, AWS, {ibm-cloud-name}, or Google Cloud. For more information about managed services, see the link:https://www.openshift.com/products[OpenShift Products] page. If you install an {product-title} cluster with a cloud virtual machine as a virtual bare metal, the corresponding cloud-based storage is not supported. - -[id="installing-preparing-migrate"] -=== Have you used {product-title} 3 and want to use {product-title} 4? - -If you used {product-title} 3 and want to try {product-title} 4, you need to understand how different {product-title} 4 is. {product-title} 4 weaves the Operators that package, deploy, and manage Kubernetes applications and the operating system that the platform runs on, {op-system-first}, together seamlessly. Instead of deploying machines and configuring their operating systems so that you can install {product-title} on them, the {op-system} operating system is an integral part of the {product-title} cluster. Deploying the operating system for the cluster machines is part of the installation process for {product-title}. See xref:../migrating_from_ocp_3_to_4/planning-migration-3-4.adoc#migration-comparing-ocp-3-4[Differences between {product-title} 3 and 4]. - -Because you need to provision machines as part of the {product-title} cluster installation process, you cannot upgrade an {product-title} 3 cluster to {product-title} 4. Instead, you must create a new {product-title} 4 cluster and migrate your {product-title} 3 workloads to them. For more information about migrating, see xref:../migrating_from_ocp_3_to_4/index.adoc#migration-from-version-3-to-4-overview[Migrating from {product-title} 3 to 4 overview]. Because you must migrate to {product-title} 4, you can use any type of production cluster installation process to create your new cluster. - -[id="installing-preparing-existing-components"] -=== Do you want to use existing components in your cluster? - -Because the operating system is integral to {product-title}, it is easier to let the installation program for {product-title} stand up all of the infrastructure. These are called _installer provisioned infrastructure_ installations. In this type of installation, you can provide some existing infrastructure to the cluster, but the installation program deploys all of the machines that your cluster initially needs. - -You can deploy an installer-provisioned infrastructure cluster without specifying any customizations to the cluster or its underlying machines to xref:../installing/installing_aws/ipi/installing-aws-default.adoc#installing-aws-default[AWS], xref:../installing/installing_azure/ipi/installing-azure-default.adoc#installing-azure-default[Azure], xref:../installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc#installing-azure-stack-hub-default[Azure Stack Hub], xref:../installing/installing_gcp/installing-gcp-default.adoc#installing-gcp-default[GCP], xref:../installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc#installing-nutanix-installer-provisioned[Nutanix]. - -If you need to perform basic configuration for your installer-provisioned infrastructure cluster, such as the instance type for the cluster machines, you can customize an installation for xref:../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[AWS], xref:../installing/installing_azure/ipi/installing-azure-customizations.adoc#installing-azure-customizations[Azure], xref:../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[GCP], xref:../installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc#installing-nutanix-installer-provisioned[Nutanix]. - -For installer-provisioned infrastructure installations, you can use an existing xref:../installing/installing_aws/ipi/installing-aws-vpc.adoc#installing-aws-vpc[VPC in AWS], xref:../installing/installing_azure/ipi/installing-azure-vnet.adoc#installing-azure-vnet[vNet in Azure], or xref:../installing/installing_gcp/installing-gcp-vpc.adoc#installing-gcp-vpc[VPC in GCP]. You can also reuse part of your networking infrastructure so that your cluster in xref:../installing/installing_aws/ipi/installing-aws-network-customizations.adoc#installing-aws-network-customizations[AWS], xref:../installing/installing_azure/ipi/installing-azure-network-customizations.adoc#installing-azure-network-customizations[Azure], xref:../installing/installing_gcp/installing-gcp-network-customizations.adoc#installing-gcp-network-customizations[GCP] can coexist with existing IP address allocations in your environment and integrate with existing MTU and VXLAN configurations. If you have existing accounts and credentials on these clouds, you can re-use them, but you might need to modify the accounts to have the required permissions to install {product-title} clusters on them. - - -You can use the installer-provisioned infrastructure method to create appropriate machine instances on your hardware for xref:../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned.adoc#installing-vsphere-installer-provisioned[vSphere], and xref:../installing/installing_bare_metal_ipi/ipi-install-overview#ipi-install-overview[bare metal]. Additionally, for xref:../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-network-customizations.adoc#installing-vsphere-installer-provisioned-network-customizations[vSphere], you can also customize additional network parameters during installation. - - -If you want to reuse extensive cloud infrastructure, you can complete a _user-provisioned infrastructure_ installation. With these installations, you manually deploy the machines that your cluster requires during the installation process. If you perform a user-provisioned infrastructure installation on xref:../installing/installing_aws/upi/installing-aws-user-infra.adoc#installing-aws-user-infra[AWS], xref:../installing/installing_azure/upi/installing-azure-user-infra.adoc#installing-azure-user-infra[Azure], xref:../installing/installing_azure_stack_hub/installing-azure-stack-hub-user-infra.adoc#installing-azure-stack-hub-user-infra[Azure Stack Hub], you can use the provided templates to help you stand up all of the required components. You can also reuse a shared xref:../installing/installing_gcp/installing-gcp-user-infra-vpc.adoc#installing-gcp-user-infra-vpc[VPC on GCP]. Otherwise, you can use the xref:../installing/installing_platform_agnostic/installing-platform-agnostic.adoc#installing-platform-agnostic[provider-agnostic] installation method to deploy a cluster into other clouds. - - -You can also complete a user-provisioned infrastructure installation on your existing hardware. If you use xref:../installing/installing_openstack/installing-openstack-user.adoc#installing-openstack-user[{rh-openstack}], xref:../installing/installing_ibm_z/installing-ibm-z.adoc#installing-ibm-z[{ibm-z-name} or {ibm-linuxone-name}], xref:../installing/installing_ibm_z/installing-ibm-z-kvm.adoc#installing-ibm-z-kvm[{ibm-z-name} and {ibm-linuxone-name} with {op-system-base} KVM], xref:../installing/installing_ibm_power/installing-ibm-power.adoc#installing-ibm-power[{ibm-power-title}], or xref:../installing/installing_vsphere/upi/installing-vsphere.adoc#installing-vsphere[vSphere], use the specific installation instructions to deploy your cluster. If you use other supported hardware, follow the xref:../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[bare metal installation] procedure. For some of these platforms, such as xref:../installing/installing_vsphere/upi/installing-vsphere-network-customizations.adoc#installing-vsphere-network-customizations[vSphere], and xref:../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installing-bare-metal-network-customizations[bare metal], you can also customize additional network parameters during installation. - - -[id="installing-preparing-security"] -=== Do you need extra security for your cluster? - -If you use a user-provisioned installation method, you can configure a proxy for your cluster. The instructions are included in each installation procedure. - -If you want to prevent your cluster on a public cloud from exposing endpoints externally, you can deploy a private cluster with installer-provisioned infrastructure on xref:../installing/installing_aws/ipi/installing-aws-private.adoc#installing-aws-private[AWS], xref:../installing/installing_azure/ipi/installing-azure-private.adoc#installing-azure-private[Azure], or xref:../installing/installing_gcp/installing-gcp-private.adoc#installing-gcp-private[GCP]. - -If you need to install your cluster that has limited access to the internet, such as a disconnected or restricted network cluster, you can xref:../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[mirror the installation packages] and install the cluster from them. Follow detailed instructions for user-provisioned infrastructure installations into restricted networks for xref:../installing/installing_aws/upi/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[AWS], xref:../installing/installing_gcp/installing-restricted-networks-gcp.adoc#installing-restricted-networks-gcp[GCP], xref:../installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc#installing-restricted-networks-ibm-z[{ibm-z-name} or {ibm-linuxone-name}], xref:../installing/installing_ibm_z/installing-restricted-networks-ibm-z-kvm.adoc#installing-restricted-networks-ibm-z-kvm[{ibm-z-name} or {ibm-linuxone-name} with {op-system-base} KVM], xref:../installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc#installing-restricted-networks-ibm-power[{ibm-power-name}], xref:../installing/installing_vsphere/upi/installing-restricted-networks-vsphere.adoc#installing-restricted-networks-vsphere[vSphere], or xref:../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[bare metal]. You can also install a cluster into a restricted network using installer-provisioned infrastructure by following detailed instructions for xref:../installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc#installing-restricted-networks-aws-installer-provisioned[AWS], xref:../installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc#installing-restricted-networks-gcp-installer-provisioned[GCP], xref:../installing/installing_ibm_cloud_public/installing-ibm-cloud-restricted.adoc#installing-ibm-cloud-restricted[{ibm-cloud-name}], xref:../installing/installing_nutanix/installing-restricted-networks-nutanix-installer-provisioned.adoc#installing-restricted-networks-nutanix-installer-provisioned[Nutanix], xref:../installing/installing_openstack/installing-openstack-installer-restricted.adoc#installing-openstack-installer-restricted[{rh-openstack}], and xref:../installing/installing_vsphere/ipi/installing-restricted-networks-installer-provisioned-vsphere.adoc#installing-restricted-networks-installer-provisioned-vsphere[vSphere]. - - -If you need to deploy your cluster to an xref:../installing/installing_aws/ipi/installing-aws-government-region.adoc#installing-aws-government-region[AWS GovCloud region], xref:../installing/installing_aws/ipi/installing-aws-china.adoc#installing-aws-china-region[AWS China region], or xref:../installing/installing_azure/ipi/installing-azure-government-region.adoc#installing-azure-government-region[Azure government region], you can configure those custom regions during an installer-provisioned infrastructure installation. - -ifndef::openshift-origin[] -You can also configure the cluster machines to use the {op-system-base} cryptographic libraries that have been submitted to NIST for xref:../installing/installing-fips.adoc#installing-fips[FIPS 140-2/140-3 Validation] during installation. - -[IMPORTANT] -==== -When running {op-system-base-full} or {op-system-first} booted in FIPS mode, {product-title} core components use the {op-system-base} cryptographic libraries that have been submitted to NIST for FIPS 140-2/140-3 Validation on only the x86_64, ppc64le, and s390x architectures. -==== - -endif::[] - -//// -[id="installing-preparing-single-node"] -=== Are you installing single-node clusters at the edge? - -You can use the assisted installer to deploy xref:../installing/installing_sno/install-sno-installing-sno.adoc#installing-sno[single node] clusters for edge workloads. -//// - -[id="installing-preparing-cluster-for-users"] -== Preparing your cluster for users after installation - -Some configuration is not required to install the cluster but recommended before your users access the cluster. You can customize the cluster itself by xref:../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[customizing] the Operators that make up your cluster and integrate you cluster with other required systems, such as an identity provider. -//This link will change when we consolidate the customizations page with the postinstallation activities. - -For a production cluster, you must configure the following integrations: - -* xref:../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Persistent storage] -* xref:../authentication/understanding-identity-provider.adoc#understanding-identity-provider[An identity provider] -* xref:../observability/monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[Monitoring core OpenShift Container Platform components] - -[id="installing-preparing-cluster-for-workloads"] -== Preparing your cluster for workloads - -Depending on your workload needs, you might need to take extra steps before you begin deploying applications. For example, after you prepare infrastructure to support your application xref:../cicd/builds/build-strategies.adoc#build-strategies[build strategy], you might need to make provisions for xref:../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-low-latency-perf-profile[low-latency] workloads or to xref:../nodes/pods/nodes-pods-secrets.adoc#nodes-pods-secrets[protect sensitive workloads]. You can also configure xref:../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[monitoring] for application workloads. -If you plan to run xref:../windows_containers/enabling-windows-container-workloads.adoc#enabling-windows-container-workloads[Windows workloads], you must enable xref:../networking/ovn_kubernetes_network_provider/configuring-hybrid-networking.adoc#configuring-hybrid-networking[hybrid networking with OVN-Kubernetes] during the installation process; hybrid networking cannot be enabled after your cluster is installed. - -[id="supported-installation-methods-for-different-platforms"] -== Supported installation methods for different platforms - -You can perform different types of installations on different platforms. - -[NOTE] -==== -Not all installation options are supported for all platforms, as shown in the following tables. A checkmark indicates that the option is supported and links to the relevant section. -==== - -.Installer-provisioned infrastructure options -//This table is for all flavors of OpenShift, except OKD. A separate table is required because OKD does not support multiple AWS architecture types. Trying to maintain one table using conditions, while convenient, is very fragile and prone to publishing errors. -ifndef::openshift-origin[] -|=== -||AWS (64-bit x86) |AWS (64-bit ARM) |Azure (64-bit x86) |Azure (64-bit ARM)|Azure Stack Hub |GCP (64-bit x86) |GCP (64-bit ARM) |Nutanix |{rh-openstack} |Bare metal (64-bit x86) |Bare metal (64-bit ARM) |vSphere |{ibm-cloud-name} |{ibm-z-name} |{ibm-power-name} |{ibm-power-server-name} - -|Default -|xref:../installing/installing_aws/ipi/installing-aws-default.adoc#installing-aws-default[✓] -|xref:../installing/installing_aws/ipi/installing-aws-default.adoc#installing-aws-default[✓] -|xref:../installing/installing_azure/ipi/installing-azure-default.adoc#installing-azure-default[✓] -|xref:../installing/installing_azure/ipi/installing-azure-default.adoc#installing-azure-default[✓] -|xref:../installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc#installing-azure-stack-hub-default[✓] -|xref:../installing/installing_gcp/installing-gcp-default.adoc#installing-gcp-default[✓] -|xref:../installing/installing_gcp/installing-gcp-default.adoc#installing-gcp-default[✓] -|xref:../installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc#installing-nutanix-installer-provisioned[✓] -| -|xref:../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install-overview[✓] -|xref:../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install-overview[✓] -|xref:../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned.adoc#installing-vsphere-installer-provisioned[✓] -|xref:../installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[✓] -| -| -| - -|Custom -|xref:../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[✓] -|xref:../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[✓] -|xref:../installing/installing_azure/ipi/installing-azure-customizations.adoc#installing-azure-customizations[✓] -|xref:../installing/installing_azure/ipi/installing-azure-customizations.adoc#installing-azure-customizations[✓] -|xref:../installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc#installing-azure-stack-hub-default[✓] -|xref:../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[✓] -|xref:../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[✓] -|xref:../installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc#installing-nutanix-installer-provisioned[✓] -|xref:../installing/installing_openstack/installing-openstack-installer-custom.adoc#installing-openstack-installer-custom[✓] -| -| -|xref:../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc#installing-vsphere-installer-provisioned-customizations[✓] -|xref:../installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[✓] -| -| -|xref:../installing/installing_ibm_powervs/installing-ibm-power-vs-customizations.adoc#installing-ibm-power-vs-customizations[✓] - - -|Network customization -|xref:../installing/installing_aws/ipi/installing-aws-network-customizations.adoc#installing-aws-network-customizations[✓] -|xref:../installing/installing_aws/ipi/installing-aws-network-customizations.adoc#installing-aws-network-customizations[✓] -|xref:../installing/installing_azure/ipi/installing-azure-network-customizations.adoc#installing-azure-network-customizations[✓] -|xref:../installing/installing_azure/ipi/installing-azure-network-customizations.adoc#installing-azure-network-customizations[✓] -|xref:../installing/installing_azure_stack_hub/installing-azure-stack-hub-network-customizations.adoc#installing-azure-stack-hub-network-customizations[✓] -|xref:../installing/installing_gcp/installing-gcp-network-customizations.adoc#installing-gcp-network-customizations[✓] -|xref:../installing/installing_gcp/installing-gcp-network-customizations.adoc#installing-gcp-network-customizations[✓] -| -| -| -| -|xref:../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-network-customizations.adoc#installing-vsphere-installer-provisioned-network-customizations[✓] -|xref:../installing/installing_ibm_cloud_public/installing-ibm-cloud-network-customizations.adoc#installing-ibm-cloud-network-customizations[✓] -| -| -| - -|Restricted network -|xref:../installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc#installing-restricted-networks-aws-installer-provisioned[✓] -|xref:../installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc#installing-restricted-networks-aws-installer-provisioned[✓] -|xref:../installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc#installing-restricted-networks-azure-installer-provisioned[✓] -|xref:../installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc#installing-restricted-networks-azure-installer-provisioned[✓] -| -|xref:../installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc#installing-restricted-networks-gcp-installer-provisioned[✓] -|xref:../installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc#installing-restricted-networks-gcp-installer-provisioned[✓] -|xref:../installing/installing_nutanix/installing-restricted-networks-nutanix-installer-provisioned.adoc#installing-restricted-networks-nutanix-installer-provisioned[✓] -|xref:../installing/installing_openstack/installing-openstack-installer-restricted.adoc#installing-openstack-installer-restricted[✓] -|xref:../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#ipi-install-installation-workflow[✓] -|xref:../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#ipi-install-installation-workflow[✓] -|xref:../installing/installing_vsphere/ipi/installing-restricted-networks-installer-provisioned-vsphere.adoc#installing-restricted-networks-installer-provisioned-vsphere[✓] -|xref:../installing/installing_ibm_cloud_public/installing-ibm-cloud-restricted.adoc#installing-ibm-cloud-restricted[✓] -| -| -|xref:../installing/installing_ibm_powervs/installing-restricted-networks-ibm-power-vs.adoc#installing-restricted-networks-ibm-power-vs[✓] - -|Private clusters -|xref:../installing/installing_aws/ipi/installing-aws-private.adoc#installing-aws-private[✓] -|xref:../installing/installing_aws/ipi/installing-aws-private.adoc#installing-aws-private[✓] -|xref:../installing/installing_azure/ipi/installing-azure-private.adoc#installing-azure-private[✓] -|xref:../installing/installing_azure/ipi/installing-azure-private.adoc#installing-azure-private[✓] -| -|xref:../installing/installing_gcp/installing-gcp-private.adoc#installing-gcp-private[✓] -|xref:../installing/installing_gcp/installing-gcp-private.adoc#installing-gcp-private[✓] -| -| -| -| -| -|xref:../installing/installing_ibm_cloud_public/installing-ibm-cloud-private.adoc#installing-ibm-cloud-private[✓] -| -| -|xref:../installing/installing_ibm_powervs/installing-ibm-power-vs-private-cluster.adoc#installing-ibm-power-vs-private-cluster[✓] - -|Existing virtual private networks -|xref:../installing/installing_aws/ipi/installing-aws-vpc.adoc#installing-aws-vpc[✓] -|xref:../installing/installing_aws/ipi/installing-aws-vpc.adoc#installing-aws-vpc[✓] -|xref:../installing/installing_azure/ipi/installing-azure-vnet.adoc#installing-azure-vnet[✓] -|xref:../installing/installing_azure/ipi/installing-azure-vnet.adoc#installing-azure-vnet[✓] -| -|xref:../installing/installing_gcp/installing-gcp-vpc.adoc#installing-gcp-vpc[✓] -|xref:../installing/installing_gcp/installing-gcp-vpc.adoc#installing-gcp-vpc[✓] -| -| -| -| -| -|xref:../installing/installing_ibm_cloud_public/installing-ibm-cloud-vpc.adoc#installing-ibm-cloud-vpc[✓] -| -| -|xref:../installing/installing_ibm_powervs/installing-ibm-powervs-vpc.adoc#installing-ibm-powervs-vpc[✓] - -|Government regions -|xref:../installing/installing_aws/ipi/installing-aws-government-region.adoc#installing-aws-government-region[✓] -| -|xref:../installing/installing_azure/ipi/installing-azure-government-region.adoc#installing-azure-government-region[✓] -| -| -| -| -| -| -| -| -| -| -| -| -| - -|Secret regions -|xref:../installing/installing_aws/ipi/installing-aws-secret-region.adoc#installing-aws-secret-region[✓] -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| - -|China regions -|xref:../installing/installing_aws/ipi/installing-aws-china.adoc#installing-aws-china-region[✓] -| -| -| -| -| -| -| -| -| -| -| -| -| -| -| -|=== -endif::openshift-origin[] - -//This table is for OKD only. A separate table is required because OKD does not support multiple AWS architecture types. Trying to maintain one table using conditions, while convenient, is very fragile and prone to publishing errors. -ifdef::openshift-origin[] -|=== -||AWS |Azure |Azure Stack Hub |GCP |Nutanix |{rh-openstack} |Bare metal |vSphere |{ibm-cloud-name} |{ibm-z-name} |{ibm-power-name} - - -|Default -|xref:../installing/installing_aws/ipi/installing-aws-default.adoc#installing-aws-default[✓] -|xref:../installing/installing_azure/ipi/installing-azure-default.adoc#installing-azure-default[✓] -|xref:../installing/installing_azure/ipi/installing-azure-default.adoc#installing-azure-default[✓] -|xref:../installing/installing_gcp/installing-gcp-default.adoc#installing-gcp-default[✓] -|xref:../installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc#installing-nutanix-installer-provisioned[✓] -| -|xref:../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install-overview[✓] -|xref:../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned.adoc#installing-vsphere-installer-provisioned[✓] -|xref:../installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[✓] -| -| - -|Custom -|xref:../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[✓] -|xref:../installing/installing_azure/ipi/installing-azure-customizations.adoc#installing-azure-customizations[✓] -|xref:../installing/installing_azure/ipi/installing-azure-default.adoc#installing-azure-default[✓] -|xref:../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[✓] -|xref:../installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc#installing-nutanix-installer-provisioned[✓] -|xref:../installing/installing_openstack/installing-openstack-installer-custom.adoc#installing-openstack-installer-custom[✓] -| -|xref:../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc#installing-vsphere-installer-provisioned-customizations[✓] -|xref:../installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[✓] -| -| - -|Network customization -|xref:../installing/installing_aws/ipi/installing-aws-network-customizations.adoc#installing-aws-network-customizations[✓] -|xref:../installing/installing_azure/ipi/installing-azure-network-customizations.adoc#installing-azure-network-customizations[✓] -|xref:../installing/installing_azure_stack_hub/installing-azure-stack-hub-network-customizations.adoc#installing-azure-stack-hub-network-customizations[✓] -|xref:../installing/installing_gcp/installing-gcp-network-customizations.adoc#installing-gcp-network-customizations[✓] -| -| -| -|xref:../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-network-customizations.adoc#installing-vsphere-installer-provisioned-network-customizations[✓] -|xref:../installing/installing_ibm_cloud_public/installing-ibm-cloud-network-customizations.adoc#installing-ibm-cloud-network-customizations[✓] -| -| - -|Restricted network -|xref:../installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc#installing-restricted-networks-aws-installer-provisioned[✓] -| -| -|xref:../installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc#installing-restricted-networks-gcp-installer-provisioned[✓] -|xref:../installing/installing_nutanix/installing-restricted-networks-nutanix-installer-provisioned.adoc#installing-restricted-networks-nutanix-installer-provisioned[✓] -|xref:../installing/installing_openstack/installing-openstack-installer-restricted.adoc#installing-openstack-installer-restricted[✓] -| -|xref:../installing/installing_vsphere/ipi/installing-restricted-networks-installer-provisioned-vsphere.adoc#installing-restricted-networks-installer-provisioned-vsphere[✓] -|xref:../installing/installing_ibm_cloud_public/installing-ibm-cloud-restricted.adoc#installing-ibm-cloud-restricted[✓] -| -| - -|Private clusters -|xref:../installing/installing_aws/ipi/installing-aws-private.adoc#installing-aws-private[✓] -|xref:../installing/installing_azure/ipi/installing-azure-private.adoc#installing-azure-private[✓] -| -|xref:../installing/installing_gcp/installing-gcp-private.adoc#installing-gcp-private[✓] -| -| -| -| -|xref:../installing/installing_ibm_cloud_public/installing-ibm-cloud-private.adoc#installing-ibm-cloud-private[✓] -| -| - -|Existing virtual private networks -|xref:../installing/installing_aws/ipi/installing-aws-vpc.adoc#installing-aws-vpc[✓] -|xref:../installing/installing_azure/ipi/installing-azure-vnet.adoc#installing-azure-vnet[✓] -| -|xref:../installing/installing_gcp/installing-gcp-vpc.adoc#installing-gcp-vpc[✓] -| -| -| -| -|xref:../installing/installing_ibm_cloud_public/installing-ibm-cloud-vpc.adoc#installing-ibm-cloud-vpc[✓] -| -| - -|Government regions -|xref:../installing/installing_aws/ipi/installing-aws-government-region.adoc#installing-aws-government-region[✓] -|xref:../installing/installing_azure/ipi/installing-azure-government-region.adoc#installing-azure-government-region[✓] -| -| -| -| -| -| -| -| -| - -|Secret regions -|xref:../installing/installing_aws/ipi/installing-aws-secret-region.adoc#installing-aws-secret-region[✓] -| -| -| -| -| -| -| -| -| -| - -|China regions -|xref:../installing/installing_aws/ipi/installing-aws-china.adoc#installing-aws-china-region[✓] -| -| -| -| -| -| -| -| -| -| -|=== -endif::openshift-origin[] - -.User-provisioned infrastructure options -//This table is for all flavors of OpenShift, except OKD. A separate table is required because OKD does not support multiple AWS architecture types. Trying to maintain one table using conditions, while convenient, is very fragile and prone to publishing errors. -ifndef::openshift-origin[] -|=== -||AWS (64-bit x86) |AWS (64-bit ARM) |Azure (64-bit x86) |Azure (64-bit ARM) |Azure Stack Hub |GCP (64-bit x86) |GCP (64-bit ARM) |Nutanix |{rh-openstack} |Bare metal (64-bit x86) |Bare metal (64-bit ARM) |vSphere |{ibm-cloud-name} |{ibm-z-name} |{ibm-z-name} with {op-system-base} KVM |{ibm-power-name} |Platform agnostic - - -|Custom -|xref:../installing/installing_aws/upi/installing-aws-user-infra.adoc#installing-aws-user-infra[✓] -|xref:../installing/installing_aws/upi/installing-aws-user-infra.adoc#installing-aws-user-infra[✓] -|xref:../installing/installing_azure/upi/installing-azure-user-infra.adoc#installing-azure-user-infra[✓] -|xref:../installing/installing_azure/upi/installing-azure-user-infra.adoc#installing-azure-user-infra[✓] -|xref:../installing/installing_azure_stack_hub/installing-azure-stack-hub-user-infra.adoc#installing-azure-stack-hub-user-infra[✓] -|xref:../installing/installing_gcp/installing-gcp-user-infra.adoc#installing-gcp-user-infra[✓] -|xref:../installing/installing_gcp/installing-gcp-user-infra.adoc#installing-gcp-user-infra[✓] -| -|xref:../installing/installing_openstack/installing-openstack-user.adoc#installing-openstack-user[✓] -|xref:../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[✓] -|xref:../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[✓] -|xref:../installing/installing_vsphere/upi/installing-vsphere.adoc#installing-vsphere[✓] -| -|xref:../installing/installing_ibm_z/installing-ibm-z.adoc#installing-ibm-z[✓] -|xref:../installing/installing_ibm_z/installing-ibm-z-kvm.adoc#installing-ibm-z-kvm[✓] -|xref:../installing/installing_ibm_power/installing-ibm-power.adoc#installing-ibm-power[✓] -|xref:../installing/installing_platform_agnostic/installing-platform-agnostic.adoc#installing-platform-agnostic[✓] - - -|Network customization -| -| -| -| -| -| -| -| -| -|xref:../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installing-bare-metal-network-customizations[✓] -|xref:../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installing-bare-metal-network-customizations[✓] -|xref:../installing/installing_vsphere/upi/installing-vsphere-network-customizations.adoc#installing-vsphere-network-customizations[✓] -| -| -| -| -| - -|Restricted network -|xref:../installing/installing_aws/upi/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[✓] -|xref:../installing/installing_aws/upi/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[✓] -| -| -| -|xref:../installing/installing_gcp/installing-restricted-networks-gcp.adoc#installing-restricted-networks-gcp[✓] -|xref:../installing/installing_gcp/installing-restricted-networks-gcp.adoc#installing-restricted-networks-gcp[✓] -| -| -|xref:../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[✓] -|xref:../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[✓] -|xref:../installing/installing_vsphere/upi/installing-restricted-networks-vsphere.adoc#installing-restricted-networks-vsphere[✓] -| -|xref:../installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc#installing-restricted-networks-ibm-z[✓] -|xref:../installing/installing_ibm_z/installing-restricted-networks-ibm-z-kvm.adoc#installing-restricted-networks-ibm-z-kvm[✓] -|xref:../installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc#installing-restricted-networks-ibm-power[✓] -| - -|Shared VPC hosted outside of cluster project -| -| -| -| -| -|xref:../installing/installing_gcp/installing-gcp-user-infra-vpc.adoc#installing-gcp-user-infra-vpc[✓] -|xref:../installing/installing_gcp/installing-gcp-user-infra-vpc.adoc#installing-gcp-user-infra-vpc[✓] -| -| -| -| -| -| -| -| -| -| -| -|=== -endif::openshift-origin[] - -//This table is for OKD only. A separate table is required because OKD does not support multiple AWS architecture types. Trying to maintain one table using conditions, while convenient, is very fragile and prone to publishing errors. -ifdef::openshift-origin[] -|=== -||AWS |Azure |Azure Stack Hub |GCP |Nutanix |{rh-openstack}|Bare metal |vSphere |{ibm-cloud-name} |{ibm-z-name} |{ibm-z-name} with {op-system-base} KVM |{ibm-power-name} |Platform agnostic - - -|Custom -|xref:../installing/installing_aws/upi/installing-aws-user-infra.adoc#installing-aws-user-infra[✓] -|xref:../installing/installing_azure/upi/installing-azure-user-infra.adoc#installing-azure-user-infra[✓] -|xref:../installing/installing_azure_stack_hub/installing-azure-stack-hub-user-infra.adoc#installing-azure-stack-hub-user-infra[✓] -|xref:../installing/installing_gcp/installing-gcp-user-infra.adoc#installing-gcp-user-infra[✓] -| -|xref:../installing/installing_openstack/installing-openstack-user.adoc#installing-openstack-user[✓] -|xref:../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[✓] -|xref:../installing/installing_vsphere/upi/installing-vsphere.adoc#installing-vsphere[✓] -| -|xref:../installing/installing_ibm_z/installing-ibm-z.adoc#installing-ibm-z[✓] -|xref:../installing/installing_ibm_z/installing-ibm-z-kvm.adoc#installing-ibm-z-kvm[✓] -|xref:../installing/installing_ibm_power/installing-ibm-power.adoc#installing-ibm-power[✓] -|xref:../installing/installing_platform_agnostic/installing-platform-agnostic.adoc#installing-platform-agnostic[✓] - - -|Network customization -| -| -| -| -| -| -|xref:../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installing-bare-metal-network-customizations[✓] -|xref:../installing/installing_vsphere/upi/installing-vsphere-network-customizations.adoc#installing-vsphere-network-customizations[✓] -| -| -| -| -| - -|Restricted network -|xref:../installing/installing_aws/upi/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[✓] -| -| -|xref:../installing/installing_gcp/installing-restricted-networks-gcp.adoc#installing-restricted-networks-gcp[✓] -| -| -|xref:../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[✓] -|xref:../installing/installing_vsphere/upi/installing-restricted-networks-vsphere.adoc#installing-restricted-networks-vsphere[✓] -| -|xref:../installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc#installing-restricted-networks-ibm-z[✓] -|xref:../installing/installing_ibm_z/installing-restricted-networks-ibm-z-kvm.adoc#installing-restricted-networks-ibm-z-kvm[✓] -|xref:../installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc#installing-restricted-networks-ibm-power[✓] -| - -|Shared VPC hosted outside of cluster project -| -| -| -|xref:../installing/installing_gcp/installing-gcp-user-infra-vpc.adoc#installing-gcp-user-infra-vpc[✓] -| -| -| -| -| -| -| -| -| -|=== -endif::openshift-origin[] - -//// -.Special use cases -|=== -|Single Node - -|xref:../installing/installing_sno/install-sno-installing-sno.adoc#installing-sno[✓] - - -|=== -//// -// sync diff --git a/installing/installing_aws/ipi/installing-aws-china.adoc b/installing/installing_aws/ipi/installing-aws-china.adoc index 77c2bcb1d7..c09482e924 100644 --- a/installing/installing_aws/ipi/installing-aws-china.adoc +++ b/installing/installing_aws/ipi/installing-aws-china.adoc @@ -15,7 +15,7 @@ In {product-title} version {product-version}, you can install a cluster to the f * You have an Internet Content Provider (ICP) license. * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[configured an AWS account] to host the cluster. * If you use a firewall, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. @@ -108,7 +108,7 @@ include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+1] == Next steps -* xref:../../../installing/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/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting]. * If necessary, you can xref:../../../post_installation_configuration/changing-cloud-credentials-configuration.adoc#manually-removing-cloud-creds_changing-cloud-credentials-configuration[remove cloud provider credentials]. diff --git a/installing/installing_aws/ipi/installing-aws-customizations.adoc b/installing/installing_aws/ipi/installing-aws-customizations.adoc index 7ce7e34743..0f31a04ca5 100644 --- a/installing/installing_aws/ipi/installing-aws-customizations.adoc +++ b/installing/installing_aws/ipi/installing-aws-customizations.adoc @@ -20,7 +20,7 @@ The scope of the {product-title} installation configurations is intentionally na == Prerequisites * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[configured an AWS account] to host the cluster. + [IMPORTANT] @@ -105,7 +105,7 @@ include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+1] == Next steps -* xref:../../../installing/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/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting]. * If necessary, you can xref:../../../post_installation_configuration/changing-cloud-credentials-configuration.adoc#manually-removing-cloud-creds_changing-cloud-credentials-configuration[remove cloud provider credentials]. diff --git a/installing/installing_aws/ipi/installing-aws-default.adoc b/installing/installing_aws/ipi/installing-aws-default.adoc index 7fee3f3ab8..a585db684e 100644 --- a/installing/installing_aws/ipi/installing-aws-default.adoc +++ b/installing/installing_aws/ipi/installing-aws-default.adoc @@ -12,7 +12,7 @@ Amazon Web Services (AWS) that uses the default configuration options. == Prerequisites * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[configured an AWS account] to host the cluster. + [IMPORTANT] @@ -39,7 +39,7 @@ include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+1] == Next steps -* xref:../../../installing/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/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting]. * If necessary, you can xref:../../../post_installation_configuration/changing-cloud-credentials-configuration.adoc#manually-removing-cloud-creds_changing-cloud-credentials-configuration[remove cloud provider credentials]. diff --git a/installing/installing_aws/ipi/installing-aws-government-region.adoc b/installing/installing_aws/ipi/installing-aws-government-region.adoc index 13675e838c..0734bd508d 100644 --- a/installing/installing_aws/ipi/installing-aws-government-region.adoc +++ b/installing/installing_aws/ipi/installing-aws-government-region.adoc @@ -14,7 +14,7 @@ install the cluster. == Prerequisites * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[configured an AWS account] to host the cluster. + [IMPORTANT] @@ -109,7 +109,7 @@ include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+1] == Next steps -* xref:../../../installing/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/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting]. * If necessary, you can xref:../../../post_installation_configuration/changing-cloud-credentials-configuration.adoc#manually-removing-cloud-creds_changing-cloud-credentials-configuration[remove cloud provider credentials]. diff --git a/installing/installing_aws/ipi/installing-aws-localzone.adoc b/installing/installing_aws/ipi/installing-aws-localzone.adoc index 283b7c3da8..c23ea940e6 100644 --- a/installing/installing_aws/ipi/installing-aws-localzone.adoc +++ b/installing/installing_aws/ipi/installing-aws-localzone.adoc @@ -16,7 +16,7 @@ AWS {zone-type} is an infrastructure that place Cloud Resources close to metropo == Infrastructure prerequisites * You reviewed details about xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You are familiar with xref:../../../installing/installing-preparing.adoc#installing-preparing[Selecting a cluster installation method and preparing it for users]. +* You are familiar with xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[Selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[configured an AWS account] to host the cluster. + [WARNING] @@ -215,5 +215,5 @@ include::modules/machine-edge-pool-review-nodes.adoc[leveloffset=+2] .Next steps //* xref:../../../post_installation_configuration/aws-compute-edge-zone-tasks#installation-extend-edge-nodes-aws-local-zones_aws-compute-edge-zone-tasks[Creating user workloads in AWS Local Zones or Wavelength Zones] -* xref:../../../installing/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]. * 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]. diff --git a/installing/installing_aws/ipi/installing-aws-network-customizations.adoc b/installing/installing_aws/ipi/installing-aws-network-customizations.adoc index c4a0557a46..5b12e63afe 100644 --- a/installing/installing_aws/ipi/installing-aws-network-customizations.adoc +++ b/installing/installing_aws/ipi/installing-aws-network-customizations.adoc @@ -19,7 +19,7 @@ cluster. == Prerequisites * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[configured an AWS account] to host the cluster. + [IMPORTANT] @@ -122,7 +122,7 @@ include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+1] == Next steps -* xref:../../../installing/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/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting]. * If necessary, you can xref:../../../post_installation_configuration/changing-cloud-credentials-configuration.adoc#manually-removing-cloud-creds_changing-cloud-credentials-configuration[remove cloud provider credentials]. diff --git a/installing/installing_aws/ipi/installing-aws-private.adoc b/installing/installing_aws/ipi/installing-aws-private.adoc index 43335975de..a0a4580a74 100644 --- a/installing/installing_aws/ipi/installing-aws-private.adoc +++ b/installing/installing_aws/ipi/installing-aws-private.adoc @@ -12,7 +12,7 @@ parameters in the `install-config.yaml` file before you install the cluster. == Prerequisites * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[configured an AWS account] to host the cluster. + [IMPORTANT] @@ -103,7 +103,7 @@ include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+1] == Next steps -* xref:../../../installing/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/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting]. * If necessary, you can xref:../../../post_installation_configuration/changing-cloud-credentials-configuration.adoc#manually-removing-cloud-creds_changing-cloud-credentials-configuration[remove cloud provider credentials]. diff --git a/installing/installing_aws/ipi/installing-aws-secret-region.adoc b/installing/installing_aws/ipi/installing-aws-secret-region.adoc index 9dd1627ab3..de3095c096 100644 --- a/installing/installing_aws/ipi/installing-aws-secret-region.adoc +++ b/installing/installing_aws/ipi/installing-aws-secret-region.adoc @@ -24,7 +24,7 @@ There is a known issue with Network Load Balancers' support for security groups == Prerequisites * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[configured an AWS account] to host the cluster. + [IMPORTANT] @@ -109,7 +109,7 @@ include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+1] [id="next-steps_installing-aws-secret-region"] == Next steps -* xref:../../../installing/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/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting]. * If necessary, you can xref:../../../post_installation_configuration/changing-cloud-credentials-configuration.adoc#manually-removing-cloud-creds_changing-cloud-credentials-configuration[remove cloud provider credentials]. diff --git a/installing/installing_aws/ipi/installing-aws-vpc.adoc b/installing/installing_aws/ipi/installing-aws-vpc.adoc index cce3443c4b..562d35efb1 100644 --- a/installing/installing_aws/ipi/installing-aws-vpc.adoc +++ b/installing/installing_aws/ipi/installing-aws-vpc.adoc @@ -12,7 +12,7 @@ parameters in the `install-config.yaml` file before you install the cluster. == Prerequisites * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[configured an AWS account] to host the cluster. * If the existing VPC is owned by a different account than the cluster, you link:https://docs.aws.amazon.com/vpc/latest/userguide/vpc-sharing.html[shared the VPC] between accounts. + @@ -101,7 +101,7 @@ include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+1] == Next steps -* xref:../../../installing/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/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting]. * If necessary, you can xref:../../../post_installation_configuration/changing-cloud-credentials-configuration.adoc#manually-removing-cloud-creds_changing-cloud-credentials-configuration[remove cloud provider credentials]. diff --git a/installing/installing_aws/ipi/installing-aws-wavelength-zone.adoc b/installing/installing_aws/ipi/installing-aws-wavelength-zone.adoc index 56da8c676e..c646c3402b 100644 --- a/installing/installing_aws/ipi/installing-aws-wavelength-zone.adoc +++ b/installing/installing_aws/ipi/installing-aws-wavelength-zone.adoc @@ -23,7 +23,7 @@ A Wavelength Zone embeds AWS compute and storage services within the 5G network == Infrastructure prerequisites * You reviewed details about xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You are familiar with xref:../../../installing/installing-preparing.adoc#installing-preparing[Selecting a cluster installation method and preparing it for users]. +* You are familiar with xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[Selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[configured an AWS account] to host the cluster. + [WARNING] @@ -228,5 +228,5 @@ include::modules/machine-edge-pool-review-nodes.adoc[leveloffset=+2] .Next steps //* xref:../../../post_installation_configuration/aws-compute-edge-zone-tasks#installation-extend-edge-nodes-aws-local-zones_aws-compute-edge-zone-tasks[Creating user workloads in AWS Local Zones or Wavelength Zones] -* xref:../../../installing/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]. * 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]. diff --git a/installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc b/installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc index 4cd38d5c28..180fdb29ab 100644 --- a/installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc +++ b/installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc @@ -12,7 +12,7 @@ In {product-title} version {product-version}, you can install a cluster on Amazo == Prerequisites * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installation-about-mirror-registry_installing-mirroring-installation-images[mirrored the images for a disconnected installation] to your registry and obtained the `imageContentSources` data for your version of {product-title}. + [IMPORTANT] @@ -106,7 +106,7 @@ include::modules/olm-restricted-networks-configuring-operatorhub.adoc[leveloffse [id="next-steps_installing-restricted-networks-aws-installer-provisioned"] == Next steps -* xref:../../../installing/validating-an-installation.adoc#validating-an-installation[Validate an installation]. +* xref:../../../installing/validation_and_troubleshooting/validating-an-installation.adoc#validating-an-installation[Validate an installation]. * xref:../../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. * xref:../../../post_installation_configuration/cluster-tasks.adoc#post-install-must-gather-disconnected[Configure image streams] for the Cluster Samples Operator and the `must-gather` tool. * Learn how to xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[use Operator Lifecycle Manager (OLM) on restricted networks]. diff --git a/installing/installing_aws/upi/installing-aws-user-infra.adoc b/installing/installing_aws/upi/installing-aws-user-infra.adoc index a6bae794b1..827d7cb437 100644 --- a/installing/installing_aws/upi/installing-aws-user-infra.adoc +++ b/installing/installing_aws/upi/installing-aws-user-infra.adoc @@ -19,7 +19,7 @@ The steps for performing a user-provisioned infrastructure installation are prov == Prerequisites * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/installing_aws/installing-aws-account.adoc#installing-aws-account[configured an AWS account] to host the cluster. + [IMPORTANT] @@ -180,7 +180,7 @@ include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+1] [id="installing-aws-user-infra-next-steps"] == Next steps -* xref:../../../installing/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/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting]. * If necessary, you can xref:../../../post_installation_configuration/changing-cloud-credentials-configuration.adoc#manually-removing-cloud-creds_changing-cloud-credentials-configuration[remove cloud provider credentials]. diff --git a/installing/installing_aws/upi/installing-restricted-networks-aws.adoc b/installing/installing_aws/upi/installing-restricted-networks-aws.adoc index 8a5aa665e9..69c90f0bf4 100644 --- a/installing/installing_aws/upi/installing-restricted-networks-aws.adoc +++ b/installing/installing_aws/upi/installing-restricted-networks-aws.adoc @@ -29,7 +29,7 @@ The steps for performing a user-provisioned infrastructure installation are prov == Prerequisites * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a mirror registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}. + [IMPORTANT] @@ -177,7 +177,7 @@ include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+1] [id="installing-restricted-networks-aws-next-steps"] == Next steps -* xref:../../../installing/validating-an-installation.adoc#validating-an-installation[Validate an installation]. +* xref:../../../installing/validation_and_troubleshooting/validating-an-installation.adoc#validating-an-installation[Validate an installation]. * xref:../../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. * xref:../../../post_installation_configuration/cluster-tasks.adoc#post-install-must-gather-disconnected[Configure image streams] for the Cluster Samples Operator and the `must-gather` tool. * Learn how to xref:../../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[use Operator Lifecycle Manager (OLM) on restricted networks]. diff --git a/installing/installing_azure/ipi/installing-azure-customizations.adoc b/installing/installing_azure/ipi/installing-azure-customizations.adoc index f3624ffeb5..d4ff939f02 100644 --- a/installing/installing_azure/ipi/installing-azure-customizations.adoc +++ b/installing/installing_azure/ipi/installing-azure-customizations.adoc @@ -15,7 +15,7 @@ parameters in the `install-config.yaml` file before you install the cluster. == Prerequisites * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[configured an Azure account] to host the cluster and determined the tested and validated region to deploy the cluster to. * If you use a firewall, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. * If you use customer-managed encryption keys, you xref:../../../installing/installing_azure/ipi/installing-azure-preparing-ipi.adoc#preparing-disk-encryption-sets_installing-azure-preparing-ipi[prepared your Azure environment for encryption]. diff --git a/installing/installing_azure/ipi/installing-azure-government-region.adoc b/installing/installing_azure/ipi/installing-azure-government-region.adoc index b68fe596a5..735b4dc51c 100644 --- a/installing/installing_azure/ipi/installing-azure-government-region.adoc +++ b/installing/installing_azure/ipi/installing-azure-government-region.adoc @@ -14,7 +14,7 @@ cluster. == Prerequisites * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[configured an Azure account] to host the cluster and determined the tested and validated government region to deploy the cluster to. * If you use a firewall, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. * If the cloud identity and access management (IAM) APIs are not accessible in your environment, or if you do not want to store an administrator-level credential secret in the `kube-system` namespace, you can xref:../../../installing/installing_azure/ipi/installing-azure-customizations.adoc#manually-create-iam_installing-azure-customizations[manually create and maintain long-term credentials]. diff --git a/installing/installing_azure/ipi/installing-azure-network-customizations.adoc b/installing/installing_azure/ipi/installing-azure-network-customizations.adoc index 585efbf602..d520340cb0 100644 --- a/installing/installing_azure/ipi/installing-azure-network-customizations.adoc +++ b/installing/installing_azure/ipi/installing-azure-network-customizations.adoc @@ -19,7 +19,7 @@ cluster. == Prerequisites * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[configured an Azure account] to host the cluster and determined the tested and validated region to deploy the cluster to. * If you use a firewall, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. * If you use customer-managed encryption keys, you xref:../../../installing/installing_azure/ipi/installing-azure-preparing-ipi.adoc#preparing-disk-encryption-sets_installing-azure-preparing-ipi[prepared your Azure environment for encryption]. diff --git a/installing/installing_azure/ipi/installing-azure-preparing-ipi.adoc b/installing/installing_azure/ipi/installing-azure-preparing-ipi.adoc index 42d4ddc0d4..77a0188972 100644 --- a/installing/installing_azure/ipi/installing-azure-preparing-ipi.adoc +++ b/installing/installing_azure/ipi/installing-azure-preparing-ipi.adoc @@ -8,7 +8,7 @@ toc::[] To prepare for installation of an {product-title} cluster on {azure-short}, complete the following steps: -* You have xref:../../../installing/installing-preparing.adoc#installing-preparing[selected a cluster installation method]. +* You have xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selected a cluster installation method]. * You xref:../../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[configured an Azure account] to host the cluster and determined the tested and validated region to deploy the cluster to. @@ -27,7 +27,7 @@ include::modules/cluster-telemetry.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* For more information about the Telemetry service, 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, see xref:../../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] include::modules/installation-azure-preparing-diskencryptionsets.adoc[leveloffset=+1] diff --git a/installing/installing_azure/ipi/installing-azure-private.adoc b/installing/installing_azure/ipi/installing-azure-private.adoc index 4a390708fb..a76da7662f 100644 --- a/installing/installing_azure/ipi/installing-azure-private.adoc +++ b/installing/installing_azure/ipi/installing-azure-private.adoc @@ -11,7 +11,7 @@ In {product-title} version {product-version}, you can install a private cluster == Prerequisites * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[configured an Azure account] to host the cluster and determined the tested and validated region to deploy the cluster to. * If you use a firewall, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. * If you use customer-managed encryption keys, you xref:../../../installing/installing_azure/ipi/installing-azure-preparing-ipi.adoc#preparing-disk-encryption-sets_installing-azure-preparing-ipi[prepared your Azure environment for encryption]. diff --git a/installing/installing_azure/ipi/installing-azure-vnet.adoc b/installing/installing_azure/ipi/installing-azure-vnet.adoc index 1d78fe2a7b..8a55dd5b32 100644 --- a/installing/installing_azure/ipi/installing-azure-vnet.adoc +++ b/installing/installing_azure/ipi/installing-azure-vnet.adoc @@ -11,7 +11,7 @@ In {product-title} version {product-version}, you can install a cluster into an == Prerequisites * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[configured an Azure account] to host the cluster and determined the tested and validated region to deploy the cluster to. * If you use a firewall, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. * If you use customer-managed encryption keys, you xref:../../../installing/installing_azure/ipi/installing-azure-preparing-ipi.adoc#preparing-disk-encryption-sets_installing-azure-preparing-ipi[prepared your Azure environment for encryption]. diff --git a/installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc b/installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc index b51be67ea0..707566311b 100644 --- a/installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc +++ b/installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc @@ -17,7 +17,7 @@ You can install an {product-title} cluster by using mirrored installation releas == Prerequisites * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[configured an Azure account] to host the cluster and determined the tested and validated region to deploy the cluster. * You xref:../../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installation-about-mirror-registry_installing-mirroring-installation-images[mirrored the images for a disconnected installation] to your registry and obtained the `imageContentSources` data for your version of {product-title}. + diff --git a/installing/installing_azure/upi/installing-azure-preparing-upi.adoc b/installing/installing_azure/upi/installing-azure-preparing-upi.adoc index d39813564a..927d716ed4 100644 --- a/installing/installing_azure/upi/installing-azure-preparing-upi.adoc +++ b/installing/installing_azure/upi/installing-azure-preparing-upi.adoc @@ -8,7 +8,7 @@ toc::[] To prepare for installation of an {product-title} cluster on {azure-short}, complete the following steps: -* You have xref:../../../installing/installing-preparing.adoc#installing-preparing[selected a cluster installation method]. +* You have xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selected a cluster installation method]. * You xref:../../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[configured an Azure account] to host the cluster and determined the tested and validated region to deploy the cluster to. diff --git a/installing/installing_azure/upi/installing-azure-user-infra.adoc b/installing/installing_azure/upi/installing-azure-user-infra.adoc index d40acc0f23..42fccce4d6 100644 --- a/installing/installing_azure/upi/installing-azure-user-infra.adoc +++ b/installing/installing_azure/upi/installing-azure-user-infra.adoc @@ -19,7 +19,7 @@ The steps for performing a user-provisioned infrastructure installation are prov == Prerequisites * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[configured an Azure account] to host the cluster. * You downloaded the Azure CLI and installed it on your computer. See link:https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest[Install the Azure CLI] in the Azure documentation. The documentation below was last tested using version `2.38.0` of the Azure CLI. Azure CLI commands might perform differently based on the version you use. * If the cloud identity and access management (IAM) APIs are not accessible in your environment, or if you do not want to store an administrator-level credential secret in the `kube-system` namespace, see xref:../../../installing/installing_azure/ipi/installing-azure-customizations.adoc#installing-azure-manual-modes_installing-azure-customizations[Alternatives to storing administrator-level secrets in the kube-system project]. 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 bf0a92fff3..e9aac7dd8d 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 @@ -18,7 +18,7 @@ The steps for performing a user-provisioned infrastructure installation are prov .Prerequisites * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[configured an Azure account] to host the cluster and determined the tested and validated region to deploy the cluster to. * You xref:../../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installation-about-mirror-registry_installing-mirroring-installation-images[mirrored the images for a disconnected installation] to your registry and obtained the `imageContentSources` data for your version of {product-title}. + diff --git a/installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc b/installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc index 12a579d9fe..150a198218 100644 --- a/installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc +++ b/installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc @@ -17,7 +17,7 @@ While you can select `azure` when using the installation program to deploy a clu == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/installing_azure_stack_hub/installing-azure-stack-hub-account.adoc#installing-azure-stack-hub-account[configured an Azure Stack Hub account] to host the cluster. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. * You verified that you have approximately 16 GB of local disk space. Installing the cluster requires that you download the {op-system} virtual hard disk (VHD) cluster image and upload it to your Azure Stack Hub environment so that it is accessible during deployment. Decompressing the VHD files requires this amount of local disk space. @@ -70,7 +70,7 @@ include::modules/cluster-telemetry.adoc[leveloffset=+1] [id="next-steps_installing-azure-stack-hub-default"] == Next steps -* xref:../../installing/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/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting]. * If necessary, you can xref:../../post_installation_configuration/changing-cloud-credentials-configuration.adoc#manually-removing-cloud-creds_changing-cloud-credentials-configuration[remove cloud provider credentials]. diff --git a/installing/installing_azure_stack_hub/installing-azure-stack-hub-network-customizations.adoc b/installing/installing_azure_stack_hub/installing-azure-stack-hub-network-customizations.adoc index d8e01c05e2..2c7fc3fea2 100644 --- a/installing/installing_azure_stack_hub/installing-azure-stack-hub-network-customizations.adoc +++ b/installing/installing_azure_stack_hub/installing-azure-stack-hub-network-customizations.adoc @@ -16,7 +16,7 @@ While you can select `azure` when using the installation program to deploy a clu == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/installing_azure_stack_hub/installing-azure-stack-hub-account.adoc#installing-azure-stack-hub-account[configured an Azure Stack Hub account] to host the cluster. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. * You verified that you have approximately 16 GB of local disk space. Installing the cluster requires that you download the {op-system} virtual hard disk (VHD) cluster image and upload it to your Azure Stack Hub environment so that it is accessible during deployment. Decompressing the VHD files requires this amount of local disk space. @@ -84,7 +84,7 @@ include::modules/cluster-telemetry.adoc[leveloffset=+1] [id="next-steps_installing-azure-stack-hub-network-customizations"] == Next steps -* xref:../../installing/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/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting]. * If necessary, you can xref:../../post_installation_configuration/changing-cloud-credentials-configuration.adoc#manually-removing-cloud-creds_changing-cloud-credentials-configuration[remove cloud provider credentials]. diff --git a/installing/installing_azure_stack_hub/installing-azure-stack-hub-user-infra.adoc b/installing/installing_azure_stack_hub/installing-azure-stack-hub-user-infra.adoc index ce01828882..0c86a1c810 100644 --- a/installing/installing_azure_stack_hub/installing-azure-stack-hub-user-infra.adoc +++ b/installing/installing_azure_stack_hub/installing-azure-stack-hub-user-infra.adoc @@ -19,7 +19,7 @@ The steps for performing a user-provisioned infrastructure installation are prov == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/installing_azure_stack_hub/installing-azure-stack-hub-account.adoc#installing-azure-stack-hub-account[configured an Azure Stack Hub account] to host the cluster. * You downloaded the Azure CLI and installed it on your computer. See link:https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest[Install the Azure CLI] in the Azure documentation. The documentation below was tested using version `2.28.0` of the Azure CLI. Azure CLI commands might perform differently based on the version you use. * If you use a firewall and plan to use the Telemetry service, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured the firewall to allow the sites] that your cluster requires access to. diff --git a/installing/installing_azure_stack_hub/preparing-to-install-on-azure-stack-hub.adoc b/installing/installing_azure_stack_hub/preparing-to-install-on-azure-stack-hub.adoc index b837665289..08dc4e0cd4 100644 --- a/installing/installing_azure_stack_hub/preparing-to-install-on-azure-stack-hub.adoc +++ b/installing/installing_azure_stack_hub/preparing-to-install-on-azure-stack-hub.adoc @@ -10,7 +10,7 @@ toc::[] == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You have installed Azure Stack Hub version 2008 or later. [id="requirements-for-installing-ocp-on-ash"] diff --git a/installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc b/installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc index c4b0ce1c68..09cf4323c4 100644 --- a/installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc +++ b/installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc @@ -18,7 +18,7 @@ cluster. == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * If you use a firewall and plan to use the Telemetry service, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured the firewall to allow the sites] that your cluster requires access to. include::modules/cluster-entitlements.adoc[leveloffset=+1] @@ -216,7 +216,7 @@ include::modules/cluster-telemetry.adoc[leveloffset=+1] == Next steps -* xref:../../installing/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/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting]. diff --git a/installing/installing_bare_metal/installing-bare-metal.adoc b/installing/installing_bare_metal/installing-bare-metal.adoc index 3f7aaf554b..cbe77402b1 100644 --- a/installing/installing_bare_metal/installing-bare-metal.adoc +++ b/installing/installing_bare_metal/installing-bare-metal.adoc @@ -21,7 +21,7 @@ before you attempt to install an {product-title} cluster in such an environment. == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. + [NOTE] @@ -139,7 +139,7 @@ include::modules/installation-bare-metal-config-yaml.adoc[leveloffset=+2] * 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. * See xref:../../post_installation_configuration/enabling-cluster-capabilities.adoc[Enabling cluster capabilities] for more information on enabling cluster capabilities that were disabled prior to installation. -* See xref:../../installing/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. +* 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. include::modules/installation-configure-proxy.adoc[leveloffset=+2] @@ -253,7 +253,7 @@ include::modules/cluster-telemetry.adoc[leveloffset=+1] == Next steps -* xref:../../installing/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/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting]. diff --git a/installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc b/installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc index ee4cdd247b..dfbbd69e17 100644 --- a/installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc +++ b/installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc @@ -21,7 +21,7 @@ before you attempt to install an {product-title} cluster in such an environment. == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}. + [IMPORTANT] @@ -243,7 +243,7 @@ include::modules/cluster-telemetry.adoc[leveloffset=+1] == Next steps -* xref:../../installing/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]. * xref:../../post_installation_configuration/cluster-tasks.adoc#post-install-must-gather-disconnected[Configure image streams] for the Cluster Samples Operator and the `must-gather` tool. * Learn how to xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[use Operator Lifecycle Manager (OLM) on restricted networks]. diff --git a/installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc b/installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc index 5a2895980c..1005fd585f 100644 --- a/installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc +++ b/installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc @@ -10,7 +10,7 @@ toc::[] == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You have read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You have read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. include::modules/virt-planning-bare-metal-cluster-for-ocp-virt.adoc[leveloffset=+1] diff --git a/installing/installing_gcp/installing-gcp-customizations.adoc b/installing/installing_gcp/installing-gcp-customizations.adoc index 640eba6bf0..9edd601f55 100644 --- a/installing/installing_gcp/installing-gcp-customizations.adoc +++ b/installing/installing_gcp/installing-gcp-customizations.adoc @@ -15,7 +15,7 @@ parameters in the `install-config.yaml` file before you install the cluster. == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/installing_gcp/installing-gcp-account.adoc#installing-gcp-account[configured a GCP project] to host the cluster. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. diff --git a/installing/installing_gcp/installing-gcp-default.adoc b/installing/installing_gcp/installing-gcp-default.adoc index 4c0a03e5f2..4d44f2e43e 100644 --- a/installing/installing_gcp/installing-gcp-default.adoc +++ b/installing/installing_gcp/installing-gcp-default.adoc @@ -12,7 +12,7 @@ Google Cloud Platform (GCP) that uses the default configuration options. == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/installing_gcp/installing-gcp-account.adoc#installing-gcp-account[configured a GCP project] to host the cluster. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. diff --git a/installing/installing_gcp/installing-gcp-network-customizations.adoc b/installing/installing_gcp/installing-gcp-network-customizations.adoc index bcee1341c6..6ba82d5890 100644 --- a/installing/installing_gcp/installing-gcp-network-customizations.adoc +++ b/installing/installing_gcp/installing-gcp-network-customizations.adoc @@ -21,7 +21,7 @@ cluster. == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/installing_gcp/installing-gcp-account.adoc#installing-gcp-account[configured a GCP project] to host the cluster. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. diff --git a/installing/installing_gcp/installing-gcp-private.adoc b/installing/installing_gcp/installing-gcp-private.adoc index e60454e08f..591c96a450 100644 --- a/installing/installing_gcp/installing-gcp-private.adoc +++ b/installing/installing_gcp/installing-gcp-private.adoc @@ -12,7 +12,7 @@ parameters in the `install-config.yaml` file before you install the cluster. == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/installing_gcp/installing-gcp-account.adoc#installing-gcp-account[configured a GCP project] to host the cluster. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. diff --git a/installing/installing_gcp/installing-gcp-shared-vpc.adoc b/installing/installing_gcp/installing-gcp-shared-vpc.adoc index 7868edffab..5d19b1f68a 100644 --- a/installing/installing_gcp/installing-gcp-shared-vpc.adoc +++ b/installing/installing_gcp/installing-gcp-shared-vpc.adoc @@ -15,7 +15,7 @@ The installation program provisions the rest of the required infrastructure, whi == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. * You have a GCP host project which contains a shared VPC network. * You xref:../../installing/installing_gcp/installing-gcp-account.adoc#installing-gcp-account[configured a GCP project] to host the cluster. This project, known as the service project, must be attached to the host project. For more information, see link:https://cloud.google.com/vpc/docs/provisioning-shared-vpc#create-shared[Attaching service projects in the GCP documentation]. diff --git a/installing/installing_gcp/installing-gcp-user-infra-vpc.adoc b/installing/installing_gcp/installing-gcp-user-infra-vpc.adoc index d09b03b8f5..21bb586f48 100644 --- a/installing/installing_gcp/installing-gcp-user-infra-vpc.adoc +++ b/installing/installing_gcp/installing-gcp-user-infra-vpc.adoc @@ -23,7 +23,7 @@ The steps for performing a user-provisioned infrastructure installation are prov == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * If you use a firewall and plan to use the Telemetry service, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured the firewall to allow the sites] that your cluster requires access to. * If the cloud identity and access management (IAM) APIs are not accessible in your environment, or if you do not want to store an administrator-level credential secret in the `kube-system` namespace, you can xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#manually-create-iam_installing-gcp-customizations[manually create and maintain long-term credentials]. + diff --git a/installing/installing_gcp/installing-gcp-user-infra.adoc b/installing/installing_gcp/installing-gcp-user-infra.adoc index 20cc3fe471..837d578225 100644 --- a/installing/installing_gcp/installing-gcp-user-infra.adoc +++ b/installing/installing_gcp/installing-gcp-user-infra.adoc @@ -19,7 +19,7 @@ The steps for performing a user-provisioned infrastructure installation are prov == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * If you use a firewall and plan to use the Telemetry service, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured the firewall to allow the sites] that your cluster requires access to. * If the cloud identity and access management (IAM) APIs are not accessible in your environment, or if you do not want to store an administrator-level credential secret in the `kube-system` namespace, you can xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#manually-create-iam_installing-gcp-customizations[manually create and maintain long-term credentials]. + diff --git a/installing/installing_gcp/installing-gcp-vpc.adoc b/installing/installing_gcp/installing-gcp-vpc.adoc index e6eedf4a48..f582ad3ae9 100644 --- a/installing/installing_gcp/installing-gcp-vpc.adoc +++ b/installing/installing_gcp/installing-gcp-vpc.adoc @@ -12,7 +12,7 @@ parameters in the `install-config.yaml` file before you install the cluster. == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/installing_gcp/installing-gcp-account.adoc#installing-gcp-account[configured a GCP project] to host the cluster. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. 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 c5d66766df..0161c2eaea 100644 --- a/installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc +++ b/installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc @@ -17,7 +17,7 @@ You can install an {product-title} cluster by using mirrored installation releas == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/installing_gcp/installing-gcp-account.adoc#installing-gcp-account[configured a GCP project] to host the cluster. * You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installation-about-mirror-registry_installing-mirroring-installation-images[mirrored the images for a disconnected installation] to your registry and obtained the `imageContentSources` data for your version of {product-title}. + @@ -111,7 +111,7 @@ include::modules/cluster-telemetry.adoc[leveloffset=+1] [id="next-steps_installing-restricted-networks-gcp-installer-provisioned"] == Next steps -* xref:../../installing/validating-an-installation.adoc#validating-an-installation[Validate an installation]. +* xref:../../installing/validation_and_troubleshooting/validating-an-installation.adoc#validating-an-installation[Validate an installation]. * xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. * xref:../../post_installation_configuration/cluster-tasks.adoc#post-install-must-gather-disconnected[Configure image streams] for the Cluster Samples Operator and the `must-gather` tool. * Learn how to xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[use Operator Lifecycle Manager (OLM) on restricted networks]. diff --git a/installing/installing_gcp/installing-restricted-networks-gcp.adoc b/installing/installing_gcp/installing-restricted-networks-gcp.adoc index 204857898c..3f0c654b70 100644 --- a/installing/installing_gcp/installing-restricted-networks-gcp.adoc +++ b/installing/installing_gcp/installing-restricted-networks-gcp.adoc @@ -24,7 +24,7 @@ The steps for performing a user-provisioned infrastructure installation are prov == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}. + [IMPORTANT] diff --git a/installing/installing_gcp/preparing-to-install-on-gcp.adoc b/installing/installing_gcp/preparing-to-install-on-gcp.adoc index 6d849b0d3a..07f7ec6448 100644 --- a/installing/installing_gcp/preparing-to-install-on-gcp.adoc +++ b/installing/installing_gcp/preparing-to-install-on-gcp.adoc @@ -11,7 +11,7 @@ toc::[] * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. [id="requirements-for-installing-ocp-on-gcp"] == Requirements for installing {product-title} on GCP diff --git a/installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc b/installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc index de9c14a5a5..0ad4f0b1a2 100644 --- a/installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc +++ b/installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc @@ -12,7 +12,7 @@ In {product-title} version {product-version}, you can install a customized clust == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/installing_ibm_cloud_public/installing-ibm-cloud-account.adoc#installing-ibm-cloud-account[configured an {ibm-cloud-name} account] to host the cluster. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. * You configured the `ccoctl` utility before you installed the cluster. For more information, see xref:../../installing/installing_ibm_cloud_public/configuring-iam-ibm-cloud.adoc#configuring-iam-ibm-cloud[Configuring IAM for {ibm-cloud-name}]. diff --git a/installing/installing_ibm_cloud_public/installing-ibm-cloud-network-customizations.adoc b/installing/installing_ibm_cloud_public/installing-ibm-cloud-network-customizations.adoc index 20c757be47..4f39bf8a35 100644 --- a/installing/installing_ibm_cloud_public/installing-ibm-cloud-network-customizations.adoc +++ b/installing/installing_ibm_cloud_public/installing-ibm-cloud-network-customizations.adoc @@ -15,7 +15,7 @@ You must set most of the network configuration parameters during installation, a == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/installing_ibm_cloud_public/installing-ibm-cloud-account.adoc#installing-ibm-cloud-account[configured an {ibm-cloud-name} account] to host the cluster. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. * You configured the `ccoctl` utility before you installed the cluster. For more information, see xref:../../installing/installing_ibm_cloud_public/configuring-iam-ibm-cloud.adoc#configuring-iam-ibm-cloud[Configuring IAM for {ibm-cloud-name}]. diff --git a/installing/installing_ibm_cloud_public/installing-ibm-cloud-private.adoc b/installing/installing_ibm_cloud_public/installing-ibm-cloud-private.adoc index 717b5489e0..e34459829d 100644 --- a/installing/installing_ibm_cloud_public/installing-ibm-cloud-private.adoc +++ b/installing/installing_ibm_cloud_public/installing-ibm-cloud-private.adoc @@ -12,7 +12,7 @@ In {product-title} version {product-version}, you can install a private cluster == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/installing_ibm_cloud_public/installing-ibm-cloud-account.adoc#installing-ibm-cloud-account[configured an {ibm-cloud-name} account] to host the cluster. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. * You configured the `ccoctl` utility before you installed the cluster. For more information, see xref:../../installing/installing_ibm_cloud_public/configuring-iam-ibm-cloud.adoc#configuring-iam-ibm-cloud[Configuring IAM for {ibm-cloud-name}]. diff --git a/installing/installing_ibm_cloud_public/installing-ibm-cloud-vpc.adoc b/installing/installing_ibm_cloud_public/installing-ibm-cloud-vpc.adoc index dfb6165278..a7fab2396d 100644 --- a/installing/installing_ibm_cloud_public/installing-ibm-cloud-vpc.adoc +++ b/installing/installing_ibm_cloud_public/installing-ibm-cloud-vpc.adoc @@ -12,7 +12,7 @@ In {product-title} version {product-version}, you can install a cluster into an == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/installing_ibm_cloud_public/installing-ibm-cloud-account.adoc#installing-ibm-cloud-account[configured an {ibm-cloud-name} account] to host the cluster. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. * You configured the `ccoctl` utility before you installed the cluster. For more information, see xref:../../installing/installing_ibm_cloud_public/configuring-iam-ibm-cloud.adoc#configuring-iam-ibm-cloud[Configuring IAM for {ibm-cloud-name}]. diff --git a/installing/installing_ibm_cloud_public/preparing-to-install-on-ibm-cloud.adoc b/installing/installing_ibm_cloud_public/preparing-to-install-on-ibm-cloud.adoc index 408e844c14..7fa81e2569 100644 --- a/installing/installing_ibm_cloud_public/preparing-to-install-on-ibm-cloud.adoc +++ b/installing/installing_ibm_cloud_public/preparing-to-install-on-ibm-cloud.adoc @@ -13,7 +13,7 @@ The installation workflows documented in this section are for {ibm-cloud-name} i * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. [id="requirements-for-installing-ocp-on-ibm-cloud"] == Requirements for installing {product-title} on {ibm-cloud-title} diff --git a/installing/installing_ibm_power/installing-ibm-power.adoc b/installing/installing_ibm_power/installing-ibm-power.adoc index ce30aa1d55..7b94a1be96 100644 --- a/installing/installing_ibm_power/installing-ibm-power.adoc +++ b/installing/installing_ibm_power/installing-ibm-power.adoc @@ -18,7 +18,7 @@ link:https://access.redhat.com/articles/4207611[guidelines for deploying {produc == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * Before you begin the installation process, you must clean the installation directory. This ensures that the required installation files are created and updated during the installation process. * You provisioned xref:../../storage/persistent_storage/persistent-storage-ocs.adoc#persistent-storage-ocs[persistent storage using {rh-storage}] or other supported storage protocols for your cluster. To deploy a private image registry, you must set up persistent storage with `ReadWriteMany` access. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. diff --git a/installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc b/installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc index b5b10f6643..9728f6e98f 100644 --- a/installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc +++ b/installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc @@ -18,7 +18,7 @@ link:https://access.redhat.com/articles/4207611[guidelines for deploying {produc == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a mirror registry for installation in a restricted network] and obtained 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. + diff --git a/installing/installing_ibm_power/preparing-to-install-on-ibm-power.adoc b/installing/installing_ibm_power/preparing-to-install-on-ibm-power.adoc index eecf651cdd..c2e2ca51cd 100644 --- a/installing/installing_ibm_power/preparing-to-install-on-ibm-power.adoc +++ b/installing/installing_ibm_power/preparing-to-install-on-ibm-power.adoc @@ -10,7 +10,7 @@ toc::[] == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. [id="choosing-an-method-to-install-ocp-on-ibm-power"] == Choosing a method to install {product-title} on {ibm-power-title} 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 33f75b5dc9..b649f0cce8 100644 --- a/installing/installing_ibm_powervs/installing-ibm-power-vs-customizations.adoc +++ b/installing/installing_ibm_powervs/installing-ibm-power-vs-customizations.adoc @@ -12,7 +12,7 @@ In {product-title} version {product-version}, you can install a customized clust == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/installing_ibm_powervs/installing-ibm-cloud-account-power-vs.adoc#installing-ibm-cloud-account-power-vs[configured an {ibm-cloud-name} account] to host the cluster. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. * You configured the `ccoctl` utility before you installed the cluster. For more information, see xref:../../installing/installing_ibm_powervs/preparing-to-install-on-ibm-power-vs.adoc#cco-ccoctl-configuring_preparing-to-install-on-ibm-power-vs[Configuring the Cloud Credential Operator utility]. 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 2234426cb2..816182794c 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 @@ -12,7 +12,7 @@ In {product-title} version {product-version}, you can install a private cluster == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/installing_ibm_powervs/installing-ibm-cloud-account-power-vs.adoc#installing-ibm-cloud-account-power-vs[configured an {ibm-cloud-name} account] to host the cluster. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. * You configured the `ccoctl` utility before you installed the cluster. For more information, see xref:../../installing/installing_ibm_powervs/preparing-to-install-on-ibm-power-vs.adoc#cco-ccoctl-configuring_preparing-to-install-on-ibm-power-vs[Configuring the Cloud Credential Operator utility]. diff --git a/installing/installing_ibm_powervs/installing-ibm-powervs-vpc.adoc b/installing/installing_ibm_powervs/installing-ibm-powervs-vpc.adoc index 04cab27299..b30622b473 100644 --- a/installing/installing_ibm_powervs/installing-ibm-powervs-vpc.adoc +++ b/installing/installing_ibm_powervs/installing-ibm-powervs-vpc.adoc @@ -12,7 +12,7 @@ In {product-title} version {product-version}, you can install a cluster into an == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/installing_ibm_powervs/installing-ibm-cloud-account-power-vs.adoc#installing-ibm-cloud-account-power-vs[configured an {ibm-cloud-name} account] to host the cluster. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. * You configured the `ccoctl` utility before you installed the cluster. For more information, see xref:../../installing/installing_ibm_powervs/preparing-to-install-on-ibm-power-vs.adoc#cco-ccoctl-configuring_preparing-to-install-on-ibm-power-vs[Configuring the Cloud Credential Operator utility]. 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 470d742c87..959655696f 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 @@ -12,7 +12,7 @@ In {product-title} {product-version}, you can install a cluster on {ibm-cloud-na == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/installing_ibm_powervs/installing-ibm-cloud-account-power-vs.adoc#installing-ibm-cloud-account-power-vs[configured an {ibm-cloud-name} account] to host the cluster. * You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installation-about-mirror-registry_installing-mirroring-installation-images[mirrored the images for a disconnected installation] to your registry and obtained the `imageContentSources` data for your version of {product-title}. + diff --git a/installing/installing_ibm_powervs/preparing-to-install-on-ibm-power-vs.adoc b/installing/installing_ibm_powervs/preparing-to-install-on-ibm-power-vs.adoc index 4cad47812e..cc10ac8929 100644 --- a/installing/installing_ibm_powervs/preparing-to-install-on-ibm-power-vs.adoc +++ b/installing/installing_ibm_powervs/preparing-to-install-on-ibm-power-vs.adoc @@ -13,7 +13,7 @@ The installation workflows documented in this section are for {ibm-power-server- * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. [id="requirements-for-installing-ocp-on-ibm-power-vs"] == Requirements for installing {product-title} on {ibm-power-server-title} diff --git a/installing/installing_ibm_z/installing-ibm-z-kvm.adoc b/installing/installing_ibm_z/installing-ibm-z-kvm.adoc index 118e20d113..b2c1b004d9 100644 --- a/installing/installing_ibm_z/installing-ibm-z-kvm.adoc +++ b/installing/installing_ibm_z/installing-ibm-z-kvm.adoc @@ -24,7 +24,7 @@ link:https://access.redhat.com/articles/4207611[guidelines for deploying {produc == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * Before you begin the installation process, you must clean the installation directory. This ensures that the required installation files are created and updated during the installation process. * You provisioned xref:../../storage/persistent_storage/persistent-storage-ocs.adoc#persistent-storage-ocs[persistent storage using {rh-storage}] or other supported storage protocols for your cluster. To deploy a private image registry, you must set up persistent storage with `ReadWriteMany` access. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. diff --git a/installing/installing_ibm_z/installing-ibm-z-lpar.adoc b/installing/installing_ibm_z/installing-ibm-z-lpar.adoc index d5f6ce61f8..2211505f08 100644 --- a/installing/installing_ibm_z/installing-ibm-z-lpar.adoc +++ b/installing/installing_ibm_z/installing-ibm-z-lpar.adoc @@ -23,7 +23,7 @@ link:https://access.redhat.com/articles/4207611[guidelines for deploying {produc == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * Before you begin the installation process, you must clean the installation directory. This ensures that the required installation files are created and updated during the installation process. * You provisioned xref:../../storage/persistent_storage/persistent-storage-ocs.adoc#persistent-storage-ocs[persistent storage using {rh-storage}] or other supported storage protocols for your cluster. To deploy a private image registry, you must set up persistent storage with `ReadWriteMany` access. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. diff --git a/installing/installing_ibm_z/installing-ibm-z.adoc b/installing/installing_ibm_z/installing-ibm-z.adoc index 73e94843a3..93342aad55 100644 --- a/installing/installing_ibm_z/installing-ibm-z.adoc +++ b/installing/installing_ibm_z/installing-ibm-z.adoc @@ -24,7 +24,7 @@ link:https://access.redhat.com/articles/4207611[guidelines for deploying {produc == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * Before you begin the installation process, you must clean the installation directory. This ensures that the required installation files are created and updated during the installation process. * You provisioned xref:../../storage/persistent_storage/persistent-storage-ocs.adoc#persistent-storage-ocs[persistent storage using {rh-storage}] or other supported storage protocols for your cluster. To deploy a private image registry, you must set up persistent storage with `ReadWriteMany` access. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. diff --git a/installing/installing_ibm_z/installing-restricted-networks-ibm-z-kvm.adoc b/installing/installing_ibm_z/installing-restricted-networks-ibm-z-kvm.adoc index 130da2176f..353024de57 100644 --- a/installing/installing_ibm_z/installing-restricted-networks-ibm-z-kvm.adoc +++ b/installing/installing_ibm_z/installing-restricted-networks-ibm-z-kvm.adoc @@ -24,7 +24,7 @@ link:https://access.redhat.com/articles/4207611[guidelines for deploying {produc == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}. * You must move or remove any existing installation files, before you begin the installation process. This ensures that the required installation files are created and updated during the installation process. + diff --git a/installing/installing_ibm_z/installing-restricted-networks-ibm-z-lpar.adoc b/installing/installing_ibm_z/installing-restricted-networks-ibm-z-lpar.adoc index 4e74f98209..b214971fa1 100644 --- a/installing/installing_ibm_z/installing-restricted-networks-ibm-z-lpar.adoc +++ b/installing/installing_ibm_z/installing-restricted-networks-ibm-z-lpar.adoc @@ -23,7 +23,7 @@ link:https://access.redhat.com/articles/4207611[guidelines for deploying {produc == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a mirror registry for installation in a restricted network] and obtained 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. + diff --git a/installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc b/installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc index 724c55e96b..e7fe3e3884 100644 --- a/installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc +++ b/installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc @@ -24,7 +24,7 @@ link:https://access.redhat.com/articles/4207611[guidelines for deploying {produc == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a mirror registry for installation in a restricted network] and obtained 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. + diff --git a/installing/installing_ibm_z/preparing-to-install-on-ibm-z.adoc b/installing/installing_ibm_z/preparing-to-install-on-ibm-z.adoc index 892ffabc08..1528470aa3 100644 --- a/installing/installing_ibm_z/preparing-to-install-on-ibm-z.adoc +++ b/installing/installing_ibm_z/preparing-to-install-on-ibm-z.adoc @@ -10,7 +10,7 @@ toc::[] == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * Before you begin the installation process, you must clean the installation directory. This ensures that the required installation files are created and updated during the installation process. * You provisioned xref:../../storage/persistent_storage/persistent-storage-ocs.adoc#persistent-storage-ocs[persistent storage using {rh-storage}] or other supported storage protocols for your cluster. To deploy a private image registry, you must set up persistent storage with `ReadWriteMany` access. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. diff --git a/installing/installing_oci/installing-oci-agent-based-installer.adoc b/installing/installing_oci/installing-oci-agent-based-installer.adoc index 7b2a0c6bd2..2952f95a6f 100644 --- a/installing/installing_oci/installing-oci-agent-based-installer.adoc +++ b/installing/installing_oci/installing-oci-agent-based-installer.adoc @@ -36,7 +36,7 @@ include::modules/creating-config-files-cluster-install-oci.adoc[leveloffset=+1] .Additional resources * xref:../../architecture/architecture-installation.adoc#installation-overview_architecture-installation[About {product-title} installation] -* xref:../../installing/installing-preparing.adoc#installing-preparing-selecting-cluster-type[Selecting a cluster installation type] +* xref:../../installing/overview/installing-preparing.adoc#installing-preparing-selecting-cluster-type[Selecting a cluster installation type] * xref:../../installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc#about-the-agent-based-installer[Preparing to install with the Agent-based Installer] * xref:../../installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc#installing-ocp-agent-retrieve_installing-with-agent-based-installer[Downloading the Agent-based Installer] * xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installation-mirror-repository_installing-mirroring-installation-images[Mirroring the {product-title} image repository] diff --git a/installing/installing_openstack/installing-openstack-installer-custom.adoc b/installing/installing_openstack/installing-openstack-installer-custom.adoc index 64b4ca6e33..de78454f63 100644 --- a/installing/installing_openstack/installing-openstack-installer-custom.adoc +++ b/installing/installing_openstack/installing-openstack-installer-custom.adoc @@ -12,7 +12,7 @@ In {product-title} version {product-version}, you can install a customized clust == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You verified that {product-title} {product-version} is compatible with your {rh-openstack} version by using the xref:../../architecture/architecture-installation.adoc#supported-platforms-for-openshift-clusters_architecture-installation[Supported platforms for OpenShift clusters] section. You can also compare platform support across different versions by viewing the link:https://access.redhat.com/articles/4679401[{product-title} on {rh-openstack} support matrix]. * You have a storage service installed in {rh-openstack}, such as block storage (Cinder) or object storage (Swift). Object storage is the recommended storage technology for {product-title} registry cluster deployment. For more information, see xref:../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage]. * You understand performance and scalability practices for cluster scaling, control plane sizing, and etcd. For more information, see xref:../../scalability_and_performance/recommended-performance-scale-practices/recommended-control-plane-practices.adoc#recommended-host-practices[Recommended practices for scaling the cluster]. diff --git a/installing/installing_openstack/installing-openstack-installer-restricted.adoc b/installing/installing_openstack/installing-openstack-installer-restricted.adoc index d77df8362d..251b9aae8d 100644 --- a/installing/installing_openstack/installing-openstack-installer-restricted.adoc +++ b/installing/installing_openstack/installing-openstack-installer-restricted.adoc @@ -12,7 +12,7 @@ In {product-title} {product-version}, you can install a cluster on == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You verified that {product-title} {product-version} is compatible with your {rh-openstack} version by using the xref:../../architecture/architecture-installation.adoc#supported-platforms-for-openshift-clusters_architecture-installation[Supported platforms for OpenShift clusters] section. You can also compare platform support across different versions by viewing the link:https://access.redhat.com/articles/4679401[{product-title} on {rh-openstack} support matrix]. * You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}. + diff --git a/installing/installing_openstack/installing-openstack-installer.adoc b/installing/installing_openstack/installing-openstack-installer.adoc index edda546c12..2b70009cfd 100644 --- a/installing/installing_openstack/installing-openstack-installer.adoc +++ b/installing/installing_openstack/installing-openstack-installer.adoc @@ -12,7 +12,7 @@ In {product-title} version {product-version}, you can install a cluster on == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * On {rh-openstack}, you have access to an external network that does not overlap these CIDR ranges: ** `10.0.0.0/16` ** `172.30.0.0/16` diff --git a/installing/installing_openstack/installing-openstack-user-sr-iov.adoc b/installing/installing_openstack/installing-openstack-user-sr-iov.adoc index 7a0d827faa..3076737385 100644 --- a/installing/installing_openstack/installing-openstack-user-sr-iov.adoc +++ b/installing/installing_openstack/installing-openstack-user-sr-iov.adoc @@ -14,7 +14,7 @@ Using your own infrastructure allows you to integrate your cluster with existing == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You verified that {product-title} {product-version} is compatible with your {rh-openstack} version by using the xref:../../architecture/architecture-installation.adoc#supported-platforms-for-openshift-clusters_architecture-installation[Supported platforms for OpenShift clusters] section. You can also compare platform support across different versions by viewing the link:https://access.redhat.com/articles/4679401[{product-title} on {rh-openstack} support matrix]. * Your network configuration does not rely on a provider network. Provider networks are not supported. * You have an {rh-openstack} account where you want to install {product-title}. diff --git a/installing/installing_openstack/installing-openstack-user.adoc b/installing/installing_openstack/installing-openstack-user.adoc index b3a9876fc1..6d30809b54 100644 --- a/installing/installing_openstack/installing-openstack-user.adoc +++ b/installing/installing_openstack/installing-openstack-user.adoc @@ -14,7 +14,7 @@ Using your own infrastructure allows you to integrate your cluster with existing == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You verified that {product-title} {product-version} is compatible with your {rh-openstack} version by using the xref:../../architecture/architecture-installation.adoc#supported-platforms-for-openshift-clusters_architecture-installation[Supported platforms for OpenShift clusters] section. You can also compare platform support across different versions by viewing the link:https://access.redhat.com/articles/4679401[{product-title} on {rh-openstack} support matrix]. * You have an {rh-openstack} account where you want to install {product-title}. * You understand performance and scalability practices for cluster scaling, control plane sizing, and etcd. For more information, see xref:../../scalability_and_performance/recommended-performance-scale-practices/recommended-control-plane-practices.adoc#recommended-host-practices[Recommended practices for scaling the cluster]. diff --git a/installing/installing_openstack/preparing-to-install-on-openstack.adoc b/installing/installing_openstack/preparing-to-install-on-openstack.adoc index a85401a730..8f4dd59827 100644 --- a/installing/installing_openstack/preparing-to-install-on-openstack.adoc +++ b/installing/installing_openstack/preparing-to-install-on-openstack.adoc @@ -13,7 +13,7 @@ ifdef::openshift-origin[{product-title} version {product-version} supports OpenS == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. [id="choosing-an-method-to-install-ocp-on-openstack"] == Choosing a method to install {product-title} on OpenStack diff --git a/installing/installing_platform_agnostic/installing-platform-agnostic.adoc b/installing/installing_platform_agnostic/installing-platform-agnostic.adoc index 21d78aecf8..952873c28d 100644 --- a/installing/installing_platform_agnostic/installing-platform-agnostic.adoc +++ b/installing/installing_platform_agnostic/installing-platform-agnostic.adoc @@ -17,7 +17,7 @@ Review the information in the link:https://access.redhat.com/articles/4207611[gu == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. + [NOTE] diff --git a/installing/installing_sno/install-sno-installing-sno.adoc b/installing/installing_sno/install-sno-installing-sno.adoc index 9cc219944a..ca4a887af0 100644 --- a/installing/installing_sno/install-sno-installing-sno.adoc +++ b/installing/installing_sno/install-sno-installing-sno.adoc @@ -78,7 +78,7 @@ include::modules/install-sno-generating-the-install-iso-manually.adoc[leveloffse * See xref:../../installing/installing_sno/install-sno-preparing-to-install-sno.adoc#preparing-to-install-sno[Requirements for installing OpenShift on a single node] for more information about installing {product-title} on a single node. * See xref:../../post_installation_configuration/enabling-cluster-capabilities.adoc[Enabling cluster capabilities] for more information about enabling cluster capabilities that were disabled prior to installation. -* See xref:../../installing/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. +* 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. include::modules/install-sno-monitoring-the-installation-manually.adoc[leveloffset=+2] diff --git a/installing/installing_sno/install-sno-preparing-to-install-sno.adoc b/installing/installing_sno/install-sno-preparing-to-install-sno.adoc index 8a80793a3b..9388b6473c 100644 --- a/installing/installing_sno/install-sno-preparing-to-install-sno.adoc +++ b/installing/installing_sno/install-sno-preparing-to-install-sno.adoc @@ -10,7 +10,7 @@ toc::[] == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You have read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You have read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. include::modules/install-sno-about-installing-on-a-single-node.adoc[leveloffset=+1] diff --git a/installing/installing_vmc/installing-restricted-networks-vmc-user-infra.adoc b/installing/installing_vmc/installing-restricted-networks-vmc-user-infra.adoc index bbd0c8be59..137a3f77b8 100644 --- a/installing/installing_vmc/installing-restricted-networks-vmc-user-infra.adoc +++ b/installing/installing_vmc/installing-restricted-networks-vmc-user-infra.adoc @@ -18,7 +18,7 @@ include::modules/vmc-sizer-tool.adoc[leveloffset=+2] == vSphere prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtain the `imageContentSources` data for your version of {product-title}. + [IMPORTANT] diff --git a/installing/installing_vmc/installing-vmc-network-customizations-user-infra.adoc b/installing/installing_vmc/installing-vmc-network-customizations-user-infra.adoc index 19087890fa..bc344e047c 100644 --- a/installing/installing_vmc/installing-vmc-network-customizations-user-infra.adoc +++ b/installing/installing_vmc/installing-vmc-network-customizations-user-infra.adoc @@ -20,7 +20,7 @@ include::modules/vmc-sizer-tool.adoc[leveloffset=+2] == vSphere prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You provisioned xref:../../registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc#installation-registry-storage-block-recreate-rollout_configuring-registry-storage-vsphere[block registry storage]. For more information on persistent storage, see xref:../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Understanding persistent storage]. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. diff --git a/installing/installing_vmc/installing-vmc-user-infra.adoc b/installing/installing_vmc/installing-vmc-user-infra.adoc index 66fad8ce2e..0990e6c4d5 100644 --- a/installing/installing_vmc/installing-vmc-user-infra.adoc +++ b/installing/installing_vmc/installing-vmc-user-infra.adoc @@ -19,7 +19,7 @@ include::modules/vmc-sizer-tool.adoc[leveloffset=+2] == vSphere prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You provisioned xref:../../registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc#installation-registry-storage-block-recreate-rollout_configuring-registry-storage-vsphere[block registry storage]. For more information on persistent storage, see xref:../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Understanding persistent storage]. * If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. + diff --git a/installing/installing_vsphere/ipi/installing-restricted-networks-installer-provisioned-vsphere.adoc b/installing/installing_vsphere/ipi/installing-restricted-networks-installer-provisioned-vsphere.adoc index a03a71f50b..0cc8723f4a 100644 --- a/installing/installing_vsphere/ipi/installing-restricted-networks-installer-provisioned-vsphere.adoc +++ b/installing/installing_vsphere/ipi/installing-restricted-networks-installer-provisioned-vsphere.adoc @@ -16,7 +16,7 @@ include::snippets/vcenter-support.adoc[] * You have completed the tasks in xref:../../../installing/installing_vsphere/ipi/ipi-vsphere-preparing-to-install.adoc#ipi-vsphere-preparing-to-install[Preparing to install a cluster using installer-provisioned infrastructure]. * You reviewed your VMware platform licenses. Red{nbsp}Hat does not place any restrictions on your VMware licenses, but some VMware infrastructure components require licensing. * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}. + [IMPORTANT] diff --git a/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc b/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc index 2dc7eced94..04caf8a850 100644 --- a/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc +++ b/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc @@ -18,7 +18,7 @@ include::snippets/vcenter-support.adoc[] * You have completed the tasks in xref:../../../installing/installing_vsphere/ipi/ipi-vsphere-preparing-to-install.adoc#ipi-vsphere-preparing-to-install[Preparing to install a cluster using installer-provisioned infrastructure]. * You reviewed your VMware platform licenses. Red{nbsp}Hat does not place any restrictions on your VMware licenses, but some VMware infrastructure components require licensing. * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You provisioned xref:../../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[persistent storage] for your cluster. To deploy a private image registry, your storage must provide `ReadWriteMany` access modes. * The {product-title} installer requires access to port 443 on the vCenter and ESXi hosts. You verified that port 443 is accessible. * If you use a firewall, you confirmed with the administrator that port 443 is accessible. Control plane nodes must be able to reach vCenter and ESXi hosts on port 443 for the installation to succeed. diff --git a/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-network-customizations.adoc b/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-network-customizations.adoc index 7edb639515..2725734d34 100644 --- a/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-network-customizations.adoc +++ b/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-network-customizations.adoc @@ -19,7 +19,7 @@ include::snippets/vcenter-support.adoc[] * You have completed the tasks in xref:../../../installing/installing_vsphere/ipi/ipi-vsphere-preparing-to-install.adoc#ipi-vsphere-preparing-to-install[Preparing to install a cluster using installer-provisioned infrastructure]. * You reviewed your VMware platform licenses. Red{nbsp}Hat does not place any restrictions on your VMware licenses, but some VMware infrastructure components require licensing. * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You provisioned xref:../../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[persistent storage] for your cluster. To deploy a private image registry, your storage must provide `ReadWriteMany` access modes. * The {product-title} installer requires access to port 443 on the vCenter and ESXi hosts. You verified that port 443 is accessible. diff --git a/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned.adoc b/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned.adoc index b60c0219bf..fc0dbee2b8 100644 --- a/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned.adoc +++ b/installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned.adoc @@ -17,7 +17,7 @@ include::snippets/vcenter-support.adoc[] * You have completed the tasks in xref:../../../installing/installing_vsphere/ipi/ipi-vsphere-preparing-to-install.adoc#ipi-vsphere-preparing-to-install[Preparing to install a cluster using installer-provisioned infrastructure]. * You reviewed your VMware platform licenses. Red{nbsp}Hat does not place any restrictions on your VMware licenses, but some VMware infrastructure components require licensing. * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You provisioned xref:../../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[persistent storage] for your cluster. To deploy a private image registry, your storage must provide `ReadWriteMany` access modes. * The {product-title} installer requires access to port 443 on the vCenter and ESXi hosts. You verified that port 443 is accessible. diff --git a/installing/installing_vsphere/upi/installing-restricted-networks-vsphere.adoc b/installing/installing_vsphere/upi/installing-restricted-networks-vsphere.adoc index b194c31ef4..cf23f2848d 100644 --- a/installing/installing_vsphere/upi/installing-restricted-networks-vsphere.adoc +++ b/installing/installing_vsphere/upi/installing-restricted-networks-vsphere.adoc @@ -22,7 +22,7 @@ The steps for performing a user-provisioned infrastructure installation are prov * You have completed the tasks in xref:../../../installing/installing_vsphere/upi/upi-vsphere-preparing-to-install.adoc#upi-vsphere-preparing-to-install[Preparing to install a cluster using user-provisioned infrastructure]. * You reviewed your VMware platform licenses. Red{nbsp}Hat does not place any restrictions on your VMware licenses, but some VMware infrastructure components require licensing. * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You xref:../../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[created a registry on your mirror host] and obtained the `imageContentSources` data for your version of {product-title}. + [IMPORTANT] diff --git a/installing/installing_vsphere/upi/installing-vsphere-network-customizations.adoc b/installing/installing_vsphere/upi/installing-vsphere-network-customizations.adoc index 1516e287e7..0fccdf39dd 100644 --- a/installing/installing_vsphere/upi/installing-vsphere-network-customizations.adoc +++ b/installing/installing_vsphere/upi/installing-vsphere-network-customizations.adoc @@ -29,7 +29,7 @@ The steps for performing a user-provisioned infrastructure installation are prov * You have completed the tasks in xref:../../../installing/installing_vsphere/upi/upi-vsphere-preparing-to-install.adoc#upi-vsphere-preparing-to-install[Preparing to install a cluster using user-provisioned infrastructure]. * You reviewed your VMware platform licenses. Red{nbsp}Hat does not place any restrictions on your VMware licenses, but some VMware infrastructure components require licensing. * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * Completing the installation requires that you upload the {op-system-first} OVA on vSphere hosts. The machine from which you complete this process requires access to port 443 on the vCenter and ESXi hosts. Verify that port 443 is accessible. * If you use a firewall, you confirmed with the administrator that port 443 is accessible. Control plane nodes must be able to reach vCenter and ESXi hosts on port 443 for the installation to succeed. * If you use a firewall, you xref:../../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. diff --git a/installing/installing_vsphere/upi/installing-vsphere.adoc b/installing/installing_vsphere/upi/installing-vsphere.adoc index 7d23071877..3f7ff5f895 100644 --- a/installing/installing_vsphere/upi/installing-vsphere.adoc +++ b/installing/installing_vsphere/upi/installing-vsphere.adoc @@ -23,7 +23,7 @@ The steps for performing a user-provisioned infrastructure installation are prov * You have completed the tasks in xref:../../../installing/installing_vsphere/upi/upi-vsphere-preparing-to-install.adoc#upi-vsphere-preparing-to-install[Preparing to install a cluster using user-provisioned infrastructure]. * You reviewed your VMware platform licenses. Red{nbsp}Hat does not place any restrictions on your VMware licenses, but some VMware infrastructure components require licensing. * You reviewed details about the xref:../../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * You provisioned xref:../../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[persistent storage] for your cluster. To deploy a private image registry, your storage must provide `ReadWriteMany` access modes. * Completing the installation requires that you upload the {op-system-first} OVA on vSphere hosts. The machine from which you complete this process requires access to port 443 on the vCenter and ESXi hosts. You verified that port 443 is accessible. * If you use a firewall, you confirmed with the administrator that port 443 is accessible. Control plane nodes must be able to reach vCenter and ESXi hosts on port 443 for the installation to succeed. diff --git a/installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc b/installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc index 2e622e4200..8a84919a3b 100644 --- a/installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc +++ b/installing/installing_with_agent_based_installer/installing-with-agent-based-installer.adoc @@ -12,7 +12,7 @@ Use the following procedures to install an {product-title} cluster using the Age == Prerequisites * You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. +* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. * If you use a firewall or proxy, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configured it to allow the sites] that your cluster requires access to. diff --git a/installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc b/installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc index 1b3e47f0ba..658216528e 100644 --- a/installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc +++ b/installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc @@ -61,7 +61,7 @@ include::modules/agent-installer-configuring-fips-compliance.adoc[leveloffset=+1 * link:https://access.redhat.com/articles/5059881[OpenShift Security Guide Book] -* xref:../../installing/installing-fips.adoc#installing-fips[Support for FIPS cryptography] +* xref:../../installing/overview/installing-fips.adoc#installing-fips[Support for FIPS cryptography] // Host configuration include::modules/agent-host-config.adoc[leveloffset=+1] diff --git a/installing/overview/_attributes b/installing/overview/_attributes new file mode 120000 index 0000000000..20cc1dcb77 --- /dev/null +++ b/installing/overview/_attributes @@ -0,0 +1 @@ +../../_attributes/ \ No newline at end of file diff --git a/installing/cluster-capabilities.adoc b/installing/overview/cluster-capabilities.adoc similarity index 51% rename from installing/cluster-capabilities.adoc rename to installing/overview/cluster-capabilities.adoc index d53a83c767..55f2e0e80a 100644 --- a/installing/cluster-capabilities.adoc +++ b/installing/overview/cluster-capabilities.adoc @@ -19,23 +19,23 @@ include::snippets/capabilities-table.adoc[] [role="_additional-resources"] .Additional resources -* xref:../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[Installing a cluster on AWS with customizations] -* xref:../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[Installing a cluster on GCP with customizations] +* xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[Installing a cluster on AWS with customizations] +* xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[Installing a cluster on GCP with customizations] include::modules/explanation-of-capabilities.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../operators/operator-reference.adoc#cluster-operator-reference[Cluster Operators reference] +* xref:../../operators/operator-reference.adoc#cluster-operator-reference[Cluster Operators reference] // Bare-metal capability include::modules/cluster-bare-metal-operator.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install-overview[Deploying installer-provisioned clusters on bare metal] -* xref:../installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc#preparing-to-install-on-bare-metal[Preparing for bare metal cluster installation] -* xref:../post_installation_configuration/post-install-bare-metal-configuration.adoc#post-install-bare-metal-configuration[Bare metal configuration] +* xref:../../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install-overview[Deploying installer-provisioned clusters on bare metal] +* xref:../../installing/installing_bare_metal/preparing-to-install-on-bare-metal.adoc#preparing-to-install-on-bare-metal[Preparing for bare metal cluster installation] +* xref:../../post_installation_configuration/post-install-bare-metal-configuration.adoc#post-install-bare-metal-configuration[Bare metal configuration] // Build capability include::modules/build-config-capability.adoc[leveloffset=+2] @@ -48,7 +48,7 @@ include::modules/cloud-credential-operator.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc#about-cloud-credential-operator[About the Cloud Credential Operator] +* xref:../../authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc#about-cloud-credential-operator[About the Cloud Credential Operator] // Cluster storage capability include::modules/cluster-storage-operator.adoc[leveloffset=+2] @@ -58,14 +58,14 @@ include::modules/console-operator.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../web_console/web-console-overview.adoc#web-console-overview[Web console overview] +* xref:../../web_console/web-console-overview.adoc#web-console-overview[Web console overview] // CSI snapshot controller capability include::modules/cluster-csi-snapshot-controller-operator.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../storage/container_storage_interface/persistent-storage-csi-snapshots.adoc#persistent-storage-csi-snapshots[CSI volume snapshots] +* xref:../../storage/container_storage_interface/persistent-storage-csi-snapshots.adoc#persistent-storage-csi-snapshots[CSI volume snapshots] // DeploymentConfig capability include::modules/deployment-config-capability.adoc[leveloffset=+2] @@ -78,55 +78,55 @@ include::modules/insights-operator.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../support/remote_health_monitoring/using-insights-operator.adoc#using-insights-operator[Using Insights Operator] +* xref:../../support/remote_health_monitoring/using-insights-operator.adoc#using-insights-operator[Using Insights Operator] // Machine API capability include::modules/machine-api-capability.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../machine_management/index.html#index[Overview of machine management] -* xref:../operators/operator-reference.html#machine-api-operator_cluster-operators-ref[Machine API Operator] -* xref:../operators/operator-reference.html#cluster-autoscaler-operator_cluster-operators-ref[Cluster Autoscaler Operator] -* xref:../operators/operator-reference.html#control-plane-machine-set-operator_cluster-operators-ref[Control Plane Machine Set Operator] +* xref:../../machine_management/index.html#index[Overview of machine management] +* xref:../../operators/operator-reference.html#machine-api-operator_cluster-operators-ref[Machine API Operator] +* xref:../../operators/operator-reference.html#cluster-autoscaler-operator_cluster-operators-ref[Cluster Autoscaler Operator] +* xref:../../operators/operator-reference.html#control-plane-machine-set-operator_cluster-operators-ref[Control Plane Machine Set Operator] // Marketplace capability include::modules/operator-marketplace.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../operators/understanding/olm-rh-catalogs.adoc#olm-rh-catalogs[Red Hat-provided Operator catalogs] +* xref:../../operators/understanding/olm-rh-catalogs.adoc#olm-rh-catalogs[Red Hat-provided Operator catalogs] // OperatorLifecycleManager capability include::modules/olm-overview.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[Operator Lifecycle Manager concepts and resources] +* xref:../../operators/understanding/olm/olm-understanding-olm.adoc#olm-understanding-olm[Operator Lifecycle Manager concepts and resources] // Node Tuning capability include::modules/node-tuning-operator.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../scalability_and_performance/using-node-tuning-operator.adoc#using-node-tuning-operator[Using the Node Tuning Operator] +* xref:../../scalability_and_performance/using-node-tuning-operator.adoc#using-node-tuning-operator[Using the Node Tuning Operator] // OpenShift samples capability include::modules/cluster-samples-operator.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../openshift_images/configuring-samples-operator.adoc#configuring-samples-operator[Configuring the Cluster Samples Operator] +* xref:../../openshift_images/configuring-samples-operator.adoc#configuring-samples-operator[Configuring the Cluster Samples Operator] // Cluster Image Registry capability include::modules/cluster-image-registry-operator.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../registry/configuring-registry-operator.adoc#configuring-registry-operator[Image Registry Operator in {product-title}] -* xref:../nodes/pods/nodes-pods-secrets.adoc#auto-generated-sa-token-secrets_nodes-pods-secrets[Automatically generated secrets] +* xref:../../registry/configuring-registry-operator.adoc#configuring-registry-operator[Image Registry Operator in {product-title}] +* xref:../../nodes/pods/nodes-pods-secrets.adoc#auto-generated-sa-token-secrets_nodes-pods-secrets[Automatically generated secrets] [role="_additional-resources"] [id="additional-resources_{context}"] == Additional resources -* xref:../post_installation_configuration/enabling-cluster-capabilities.adoc#enabling-cluster-capabilities[Enabling cluster capabilities after installation] +* xref:../../post_installation_configuration/enabling-cluster-capabilities.adoc#enabling-cluster-capabilities[Enabling cluster capabilities after installation] diff --git a/installing/overview/images b/installing/overview/images new file mode 120000 index 0000000000..847b03ed05 --- /dev/null +++ b/installing/overview/images @@ -0,0 +1 @@ +../../images/ \ No newline at end of file diff --git a/installing/index.adoc b/installing/overview/index.adoc similarity index 53% rename from installing/index.adoc rename to installing/overview/index.adoc index ce9a6d5ba4..935ad701d5 100644 --- a/installing/index.adoc +++ b/installing/overview/index.adoc @@ -23,13 +23,13 @@ include::modules/ipi-verifying-nodes-after-installation.adoc[leveloffset=+2] [role="_additional-resources"] .Additional resources -* xref:../post_installation_configuration/post-install-bare-metal-configuration.adoc#getting-the-baremetalhost-resource_post-install-bare-metal-configuration[Getting the BareMetalHost resource] +* xref:../../post_installation_configuration/post-install-bare-metal-configuration.adoc#getting-the-baremetalhost-resource_post-install-bare-metal-configuration[Getting the BareMetalHost resource] -* xref:../installing/installing_bare_metal_ipi/ipi-install-installation.adoc#ipi-install-troubleshooting-following-the-installation_ipi-install-installation[Following the installation] +* xref:../../installing/installing_bare_metal_ipi/ipi-install-installation.adoc#ipi-install-troubleshooting-following-the-installation_ipi-install-installation[Following the installation] -* xref:../installing/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:../installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc#preparing-to-install-with-agent-based-installer[Agent-based Installer] +* xref:../../installing/installing_with_agent_based_installer/preparing-to-install-with-agent-based-installer.adoc#preparing-to-install-with-agent-based-installer[Agent-based Installer] * link:https://access.redhat.com/documentation/en-us/assisted_installer_for_openshift_container_platform[Assisted Installer for OpenShift Container Platform] @@ -41,7 +41,7 @@ The scope of the {product-title} installation program is intentionally narrow. I [role="_additional-resources"] .Additional resources -* See xref:../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Available cluster customizations] for details about {product-title} configuration resources. +* See xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Available cluster customizations] for details about {product-title} configuration resources. include::modules/installation-openshift-local.adoc[leveloffset=+2] @@ -50,8 +50,8 @@ include::modules/supported-platforms-for-openshift-clusters.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* See xref:../installing/installing-preparing.adoc#supported-installation-methods-for-different-platforms[Supported installation methods for different platforms] for more information about the types of installations that are available for each supported platform. +* See xref:../../installing/overview/installing-preparing.adoc#supported-installation-methods-for-different-platforms[Supported installation methods for different platforms] for more information about the types of installations that are available for each supported platform. -* See xref:../installing/installing-preparing.adoc#installing-preparing[Selecting a cluster installation method and preparing it for users] for information about choosing an installation method and preparing the required resources. +* See xref:../../installing/overview/installing-preparing.adoc#installing-preparing[Selecting a cluster installation method and preparing it for users] for information about choosing an installation method and preparing the required resources. * link:https://access.redhat.com/labs/ocpnc/[Red Hat OpenShift Network Calculator] can help you design your cluster network during both the deployment and expansion phases. It addresses common questions related to the cluster network and provides output in a convenient JSON format. diff --git a/installing/installing-fips.adoc b/installing/overview/installing-fips.adoc similarity index 74% rename from installing/installing-fips.adoc rename to installing/overview/installing-fips.adoc index 17c066b8bd..0bde731779 100644 --- a/installing/installing-fips.adoc +++ b/installing/overview/installing-fips.adoc @@ -28,7 +28,7 @@ include::modules/installation-obtaining-fips-installer-oc.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#retrieving-the-openshift-installer_ipi-install-installation-workflow[Extracting the OpenShift Container Platform installation program] +* xref:../../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#retrieving-the-openshift-installer_ipi-install-installation-workflow[Extracting the OpenShift Container Platform installation program] include::modules/installation-obtaining-fips-installer-mirror.adoc[leveloffset=+1] @@ -69,14 +69,14 @@ Although the {product-title} cluster itself uses FIPS validated or Modules In Pr [id="installation-about-fips-components-etcd_{context}"] === etcd -To ensure that the secrets that are stored in etcd use FIPS validated or Modules In Process encryption, boot the node in FIPS mode. After you install the cluster in FIPS mode, you can xref:../security/encrypting-etcd.adoc#encrypting-etcd[encrypt the etcd data] by using the FIPS-approved `aes cbc` cryptographic algorithm. +To ensure that the secrets that are stored in etcd use FIPS validated or Modules In Process encryption, boot the node in FIPS mode. After you install the cluster in FIPS mode, you can xref:../../security/encrypting-etcd.adoc#encrypting-etcd[encrypt the etcd data] by using the FIPS-approved `aes cbc` cryptographic algorithm. [id="installation-about-fips-components-storage_{context}"] === Storage For local storage, use {op-system-base}-provided disk encryption or Container Native Storage that uses {op-system-base}-provided disk encryption. By storing all data in volumes that use {op-system-base}-provided disk encryption and enabling FIPS mode for your cluster, both data at rest and data in motion, or network data, are protected by FIPS validated or Modules In Process encryption. You can configure your cluster to encrypt the root filesystem of each node, as described -in xref:../installing/install_config/installing-customizing.adoc#installing-customizing[Customizing nodes]. +in xref:../../installing/install_config/installing-customizing.adoc#installing-customizing[Customizing nodes]. [id="installation-about-fips-components-runtimes_{context}"] === Runtimes @@ -93,22 +93,22 @@ To install a cluster in FIPS mode, follow the instructions to install a customiz To enable FIPS mode for your cluster, you must run the installation program from a {op-system-base} computer configured to operate in FIPS mode. For more information about configuring FIPS mode on RHEL, see link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/security_hardening/assembly_installing-the-system-in-fips-mode_security-hardening[Installing the system in FIPS mode]. ==== -* xref:../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[Amazon Web Services] -* xref:../installing/installing_azure/ipi/installing-azure-customizations.adoc#installing-azure-customizations[Microsoft Azure] -* xref:../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[Bare metal] -* xref:../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[Google Cloud Platform] -* xref:../installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[{ibm-cloud-name}] -* xref:../installing/installing_ibm_power/installing-ibm-power.adoc#installing-ibm-power[{ibm-power-name}] -* xref:../installing/installing_ibm_z/installing-ibm-z.adoc#installing-ibm-z[{ibm-z-name} and {ibm-linuxone-name}] -* xref:../installing/installing_ibm_z/installing-ibm-z-kvm.adoc#installing-ibm-z-kvm[{ibm-z-name} and {ibm-linuxone-name} with {op-system-base} KVM] -* xref:../installing/installing_openstack/installing-openstack-installer-custom.adoc#installing-openstack-installer-custom[{rh-openstack-first}] -* xref:../installing/installing_vsphere/upi/installing-vsphere.adoc#installing-vsphere[VMware vSphere] +* xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[Amazon Web Services] +* xref:../../installing/installing_azure/ipi/installing-azure-customizations.adoc#installing-azure-customizations[Microsoft Azure] +* xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[Bare metal] +* xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[Google Cloud Platform] +* xref:../../installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[{ibm-cloud-name}] +* xref:../../installing/installing_ibm_power/installing-ibm-power.adoc#installing-ibm-power[{ibm-power-name}] +* xref:../../installing/installing_ibm_z/installing-ibm-z.adoc#installing-ibm-z[{ibm-z-name} and {ibm-linuxone-name}] +* xref:../../installing/installing_ibm_z/installing-ibm-z-kvm.adoc#installing-ibm-z-kvm[{ibm-z-name} and {ibm-linuxone-name} with {op-system-base} KVM] +* xref:../../installing/installing_openstack/installing-openstack-installer-custom.adoc#installing-openstack-installer-custom[{rh-openstack-first}] +* xref:../../installing/installing_vsphere/upi/installing-vsphere.adoc#installing-vsphere[VMware vSphere] [NOTE] ==== If you are using Azure File storage, you cannot enable FIPS mode. ==== -To apply `AES CBC` encryption to your etcd data store, follow the xref:../security/encrypting-etcd.adoc#encrypting-etcd[Encrypting etcd data] process after you install your cluster. +To apply `AES CBC` encryption to your etcd data store, follow the xref:../../security/encrypting-etcd.adoc#encrypting-etcd[Encrypting etcd data] process after you install your cluster. -If you add {op-system-base} nodes to your cluster, ensure that you enable FIPS mode on the machines before their initial boot. See xref:../machine_management/adding-rhel-compute.adoc#adding-rhel-compute[Adding RHEL compute machines to an {product-title} cluster] and link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/security_hardening/assembly_installing-the-system-in-fips-mode_security-hardening[Installing the system in FIPS mode]. +If you add {op-system-base} nodes to your cluster, ensure that you enable FIPS mode on the machines before their initial boot. See xref:../../machine_management/adding-rhel-compute.adoc#adding-rhel-compute[Adding RHEL compute machines to an {product-title} cluster] and link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html/security_hardening/assembly_installing-the-system-in-fips-mode_security-hardening[Installing the system in FIPS mode]. diff --git a/installing/overview/installing-preparing.adoc b/installing/overview/installing-preparing.adoc new file mode 100644 index 0000000000..34b94e231d --- /dev/null +++ b/installing/overview/installing-preparing.adoc @@ -0,0 +1,591 @@ +:_mod-docs-content-type: ASSEMBLY +[id="installing-preparing"] += Selecting a cluster installation method and preparing it for users +include::_attributes/common-attributes.adoc[] +:context: installing-preparing + +toc::[] + +Before you install {product-title}, decide what kind of installation process to follow and verify that you have all of the required resources to prepare the cluster for users. + +[id="installing-preparing-selecting-cluster-type"] +== Selecting a cluster installation type +Before you install an {product-title} cluster, you need to select the best installation instructions to follow. Think about your answers to the following questions to select the best option. + +[id="installing-preparing-install-manage"] +=== Do you want to install and manage an {product-title} cluster yourself? + +If you want to install and manage {product-title} yourself, you can install it on the following platforms: + +* Amazon Web Services (AWS) on 64-bit x86 instances +ifndef::openshift-origin[] +* Amazon Web Services (AWS) on 64-bit ARM instances +endif::openshift-origin[] +* Microsoft Azure on 64-bit x86 instances +* Microsoft Azure on 64-bit ARM instances +* Microsoft Azure Stack Hub +* Google Cloud Platform (GCP) on 64-bit x86 instances +* Google Cloud Platform (GCP) on 64-bit ARM instances +* {rh-openstack-first} +* {ibm-cloud-name} +* {ibm-z-name} or {ibm-linuxone-name} +* {ibm-z-name} or {ibm-linuxone-name} for {op-system-base-full} KVM +* {ibm-power-name} +* {ibm-power-server-name} +* Nutanix +* VMware vSphere +* Bare metal or other platform agnostic infrastructure +// might want a note about single node here + +You can deploy an {product-title} 4 cluster to both on-premise hardware and to cloud hosting services, but all of the machines in a cluster must be in the same data center or cloud hosting service. + +If you want to use {product-title} but do not want to manage the cluster yourself, you have several managed service options. If you want a cluster that is fully managed by Red Hat, you can use link:https://www.openshift.com/products/dedicated/[OpenShift Dedicated] or link:https://www.openshift.com/products/online/[OpenShift Online]. You can also use OpenShift as a managed service on Azure, AWS, {ibm-cloud-name}, or Google Cloud. For more information about managed services, see the link:https://www.openshift.com/products[OpenShift Products] page. If you install an {product-title} cluster with a cloud virtual machine as a virtual bare metal, the corresponding cloud-based storage is not supported. + +[id="installing-preparing-migrate"] +=== Have you used {product-title} 3 and want to use {product-title} 4? + +If you used {product-title} 3 and want to try {product-title} 4, you need to understand how different {product-title} 4 is. {product-title} 4 weaves the Operators that package, deploy, and manage Kubernetes applications and the operating system that the platform runs on, {op-system-first}, together seamlessly. Instead of deploying machines and configuring their operating systems so that you can install {product-title} on them, the {op-system} operating system is an integral part of the {product-title} cluster. Deploying the operating system for the cluster machines is part of the installation process for {product-title}. See xref:../../migrating_from_ocp_3_to_4/planning-migration-3-4.adoc#migration-comparing-ocp-3-4[Differences between {product-title} 3 and 4]. + +Because you need to provision machines as part of the {product-title} cluster installation process, you cannot upgrade an {product-title} 3 cluster to {product-title} 4. Instead, you must create a new {product-title} 4 cluster and migrate your {product-title} 3 workloads to them. For more information about migrating, see xref:../../migrating_from_ocp_3_to_4/index.adoc#migration-from-version-3-to-4-overview[Migrating from {product-title} 3 to 4 overview]. Because you must migrate to {product-title} 4, you can use any type of production cluster installation process to create your new cluster. + +[id="installing-preparing-existing-components"] +=== Do you want to use existing components in your cluster? + +Because the operating system is integral to {product-title}, it is easier to let the installation program for {product-title} stand up all of the infrastructure. These are called _installer provisioned infrastructure_ installations. In this type of installation, you can provide some existing infrastructure to the cluster, but the installation program deploys all of the machines that your cluster initially needs. + +You can deploy an installer-provisioned infrastructure cluster without specifying any customizations to the cluster or its underlying machines to xref:../../installing/installing_aws/ipi/installing-aws-default.adoc#installing-aws-default[AWS], xref:../../installing/installing_azure/ipi/installing-azure-default.adoc#installing-azure-default[Azure], xref:../../installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc#installing-azure-stack-hub-default[Azure Stack Hub], xref:../../installing/installing_gcp/installing-gcp-default.adoc#installing-gcp-default[GCP], xref:../../installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc#installing-nutanix-installer-provisioned[Nutanix]. + +If you need to perform basic configuration for your installer-provisioned infrastructure cluster, such as the instance type for the cluster machines, you can customize an installation for xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[AWS], xref:../../installing/installing_azure/ipi/installing-azure-customizations.adoc#installing-azure-customizations[Azure], xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[GCP], xref:../../installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc#installing-nutanix-installer-provisioned[Nutanix]. + +For installer-provisioned infrastructure installations, you can use an existing xref:../../installing/installing_aws/ipi/installing-aws-vpc.adoc#installing-aws-vpc[VPC in AWS], xref:../../installing/installing_azure/ipi/installing-azure-vnet.adoc#installing-azure-vnet[vNet in Azure], or xref:../../installing/installing_gcp/installing-gcp-vpc.adoc#installing-gcp-vpc[VPC in GCP]. You can also reuse part of your networking infrastructure so that your cluster in xref:../../installing/installing_aws/ipi/installing-aws-network-customizations.adoc#installing-aws-network-customizations[AWS], xref:../../installing/installing_azure/ipi/installing-azure-network-customizations.adoc#installing-azure-network-customizations[Azure], xref:../../installing/installing_gcp/installing-gcp-network-customizations.adoc#installing-gcp-network-customizations[GCP] can coexist with existing IP address allocations in your environment and integrate with existing MTU and VXLAN configurations. If you have existing accounts and credentials on these clouds, you can re-use them, but you might need to modify the accounts to have the required permissions to install {product-title} clusters on them. + + +You can use the installer-provisioned infrastructure method to create appropriate machine instances on your hardware for xref:../../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned.adoc#installing-vsphere-installer-provisioned[vSphere], and xref:../../installing/installing_bare_metal_ipi/ipi-install-overview#ipi-install-overview[bare metal]. Additionally, for xref:../../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-network-customizations.adoc#installing-vsphere-installer-provisioned-network-customizations[vSphere], you can also customize additional network parameters during installation. + + +If you want to reuse extensive cloud infrastructure, you can complete a _user-provisioned infrastructure_ installation. With these installations, you manually deploy the machines that your cluster requires during the installation process. If you perform a user-provisioned infrastructure installation on xref:../../installing/installing_aws/upi/installing-aws-user-infra.adoc#installing-aws-user-infra[AWS], xref:../../installing/installing_azure/upi/installing-azure-user-infra.adoc#installing-azure-user-infra[Azure], xref:../../installing/installing_azure_stack_hub/installing-azure-stack-hub-user-infra.adoc#installing-azure-stack-hub-user-infra[Azure Stack Hub], you can use the provided templates to help you stand up all of the required components. You can also reuse a shared xref:../../installing/installing_gcp/installing-gcp-user-infra-vpc.adoc#installing-gcp-user-infra-vpc[VPC on GCP]. Otherwise, you can use the xref:../../installing/installing_platform_agnostic/installing-platform-agnostic.adoc#installing-platform-agnostic[provider-agnostic] installation method to deploy a cluster into other clouds. + + +You can also complete a user-provisioned infrastructure installation on your existing hardware. If you use xref:../../installing/installing_openstack/installing-openstack-user.adoc#installing-openstack-user[{rh-openstack}], xref:../../installing/installing_ibm_z/installing-ibm-z.adoc#installing-ibm-z[{ibm-z-name} or {ibm-linuxone-name}], xref:../../installing/installing_ibm_z/installing-ibm-z-kvm.adoc#installing-ibm-z-kvm[{ibm-z-name} and {ibm-linuxone-name} with {op-system-base} KVM], xref:../../installing/installing_ibm_power/installing-ibm-power.adoc#installing-ibm-power[{ibm-power-title}], or xref:../../installing/installing_vsphere/upi/installing-vsphere.adoc#installing-vsphere[vSphere], use the specific installation instructions to deploy your cluster. If you use other supported hardware, follow the xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[bare metal installation] procedure. For some of these platforms, such as xref:../../installing/installing_vsphere/upi/installing-vsphere-network-customizations.adoc#installing-vsphere-network-customizations[vSphere], and xref:../../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installing-bare-metal-network-customizations[bare metal], you can also customize additional network parameters during installation. + + +[id="installing-preparing-security"] +=== Do you need extra security for your cluster? + +If you use a user-provisioned installation method, you can configure a proxy for your cluster. The instructions are included in each installation procedure. + +If you want to prevent your cluster on a public cloud from exposing endpoints externally, you can deploy a private cluster with installer-provisioned infrastructure on xref:../../installing/installing_aws/ipi/installing-aws-private.adoc#installing-aws-private[AWS], xref:../../installing/installing_azure/ipi/installing-azure-private.adoc#installing-azure-private[Azure], or xref:../../installing/installing_gcp/installing-gcp-private.adoc#installing-gcp-private[GCP]. + +If you need to install your cluster that has limited access to the internet, such as a disconnected or restricted network cluster, you can xref:../../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[mirror the installation packages] and install the cluster from them. Follow detailed instructions for user-provisioned infrastructure installations into restricted networks for xref:../../installing/installing_aws/upi/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[AWS], xref:../../installing/installing_gcp/installing-restricted-networks-gcp.adoc#installing-restricted-networks-gcp[GCP], xref:../../installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc#installing-restricted-networks-ibm-z[{ibm-z-name} or {ibm-linuxone-name}], xref:../../installing/installing_ibm_z/installing-restricted-networks-ibm-z-kvm.adoc#installing-restricted-networks-ibm-z-kvm[{ibm-z-name} or {ibm-linuxone-name} with {op-system-base} KVM], xref:../../installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc#installing-restricted-networks-ibm-power[{ibm-power-name}], xref:../../installing/installing_vsphere/upi/installing-restricted-networks-vsphere.adoc#installing-restricted-networks-vsphere[vSphere], or xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[bare metal]. You can also install a cluster into a restricted network using installer-provisioned infrastructure by following detailed instructions for xref:../../installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc#installing-restricted-networks-aws-installer-provisioned[AWS], xref:../../installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc#installing-restricted-networks-gcp-installer-provisioned[GCP], xref:../../installing/installing_ibm_cloud_public/installing-ibm-cloud-restricted.adoc#installing-ibm-cloud-restricted[{ibm-cloud-name}], xref:../../installing/installing_nutanix/installing-restricted-networks-nutanix-installer-provisioned.adoc#installing-restricted-networks-nutanix-installer-provisioned[Nutanix], xref:../../installing/installing_openstack/installing-openstack-installer-restricted.adoc#installing-openstack-installer-restricted[{rh-openstack}], and xref:../../installing/installing_vsphere/ipi/installing-restricted-networks-installer-provisioned-vsphere.adoc#installing-restricted-networks-installer-provisioned-vsphere[vSphere]. + + +If you need to deploy your cluster to an xref:../../installing/installing_aws/ipi/installing-aws-government-region.adoc#installing-aws-government-region[AWS GovCloud region], xref:../../installing/installing_aws/ipi/installing-aws-china.adoc#installing-aws-china-region[AWS China region], or xref:../../installing/installing_azure/ipi/installing-azure-government-region.adoc#installing-azure-government-region[Azure government region], you can configure those custom regions during an installer-provisioned infrastructure installation. + +ifndef::openshift-origin[] +You can also configure the cluster machines to use the {op-system-base} cryptographic libraries that have been submitted to NIST for xref:../../installing/overview/installing-fips.adoc#installing-fips[FIPS 140-2/140-3 Validation] during installation. + +[IMPORTANT] +==== +When running {op-system-base-full} or {op-system-first} booted in FIPS mode, {product-title} core components use the {op-system-base} cryptographic libraries that have been submitted to NIST for FIPS 140-2/140-3 Validation on only the x86_64, ppc64le, and s390x architectures. +==== + +endif::[] + +//// +[id="installing-preparing-single-node"] +=== Are you installing single-node clusters at the edge? + +You can use the assisted installer to deploy xref:../../installing/installing_sno/install-sno-installing-sno.adoc#installing-sno[single node] clusters for edge workloads. +//// + +[id="installing-preparing-cluster-for-users"] +== Preparing your cluster for users after installation + +Some configuration is not required to install the cluster but recommended before your users access the cluster. You can customize the cluster itself by xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[customizing] the Operators that make up your cluster and integrate you cluster with other required systems, such as an identity provider. +//This link will change when we consolidate the customizations page with the postinstallation activities. + +For a production cluster, you must configure the following integrations: + +* xref:../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Persistent storage] +* xref:../../authentication/understanding-identity-provider.adoc#understanding-identity-provider[An identity provider] +* xref:../../observability/monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[Monitoring core OpenShift Container Platform components] + +[id="installing-preparing-cluster-for-workloads"] +== Preparing your cluster for workloads + +Depending on your workload needs, you might need to take extra steps before you begin deploying applications. For example, after you prepare infrastructure to support your application xref:../../cicd/builds/build-strategies.adoc#build-strategies[build strategy], you might need to make provisions for xref:../../scalability_and_performance/low_latency_tuning/cnf-tuning-low-latency-nodes-with-perf-profile.adoc#cnf-low-latency-perf-profile[low-latency] workloads or to xref:../../nodes/pods/nodes-pods-secrets.adoc#nodes-pods-secrets[protect sensitive workloads]. You can also configure xref:../../observability/monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[monitoring] for application workloads. +If you plan to run xref:../../windows_containers/enabling-windows-container-workloads.adoc#enabling-windows-container-workloads[Windows workloads], you must enable xref:../../networking/ovn_kubernetes_network_provider/configuring-hybrid-networking.adoc#configuring-hybrid-networking[hybrid networking with OVN-Kubernetes] during the installation process; hybrid networking cannot be enabled after your cluster is installed. + +[id="supported-installation-methods-for-different-platforms"] +== Supported installation methods for different platforms + +You can perform different types of installations on different platforms. + +[NOTE] +==== +Not all installation options are supported for all platforms, as shown in the following tables. A checkmark indicates that the option is supported and links to the relevant section. +==== + +.Installer-provisioned infrastructure options +//This table is for all flavors of OpenShift, except OKD. A separate table is required because OKD does not support multiple AWS architecture types. Trying to maintain one table using conditions, while convenient, is very fragile and prone to publishing errors. +ifndef::openshift-origin[] +|=== +||AWS (64-bit x86) |AWS (64-bit ARM) |Azure (64-bit x86) |Azure (64-bit ARM)|Azure Stack Hub |GCP (64-bit x86) |GCP (64-bit ARM) |Nutanix |{rh-openstack} |Bare metal (64-bit x86) |Bare metal (64-bit ARM) |vSphere |{ibm-cloud-name} |{ibm-z-name} |{ibm-power-name} |{ibm-power-server-name} + +|Default +|xref:../../installing/installing_aws/ipi/installing-aws-default.adoc#installing-aws-default[✓] +|xref:../../installing/installing_aws/ipi/installing-aws-default.adoc#installing-aws-default[✓] +|xref:../../installing/installing_azure/ipi/installing-azure-default.adoc#installing-azure-default[✓] +|xref:../../installing/installing_azure/ipi/installing-azure-default.adoc#installing-azure-default[✓] +|xref:../../installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc#installing-azure-stack-hub-default[✓] +|xref:../../installing/installing_gcp/installing-gcp-default.adoc#installing-gcp-default[✓] +|xref:../../installing/installing_gcp/installing-gcp-default.adoc#installing-gcp-default[✓] +|xref:../../installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc#installing-nutanix-installer-provisioned[✓] +| +|xref:../../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install-overview[✓] +|xref:../../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install-overview[✓] +|xref:../../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned.adoc#installing-vsphere-installer-provisioned[✓] +|xref:../../installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[✓] +| +| +| + +|Custom +|xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[✓] +|xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[✓] +|xref:../../installing/installing_azure/ipi/installing-azure-customizations.adoc#installing-azure-customizations[✓] +|xref:../../installing/installing_azure/ipi/installing-azure-customizations.adoc#installing-azure-customizations[✓] +|xref:../../installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc#installing-azure-stack-hub-default[✓] +|xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[✓] +|xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[✓] +|xref:../../installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc#installing-nutanix-installer-provisioned[✓] +|xref:../../installing/installing_openstack/installing-openstack-installer-custom.adoc#installing-openstack-installer-custom[✓] +| +| +|xref:../../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc#installing-vsphere-installer-provisioned-customizations[✓] +|xref:../../installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[✓] +| +| +|xref:../../installing/installing_ibm_powervs/installing-ibm-power-vs-customizations.adoc#installing-ibm-power-vs-customizations[✓] + + +|Network customization +|xref:../../installing/installing_aws/ipi/installing-aws-network-customizations.adoc#installing-aws-network-customizations[✓] +|xref:../../installing/installing_aws/ipi/installing-aws-network-customizations.adoc#installing-aws-network-customizations[✓] +|xref:../../installing/installing_azure/ipi/installing-azure-network-customizations.adoc#installing-azure-network-customizations[✓] +|xref:../../installing/installing_azure/ipi/installing-azure-network-customizations.adoc#installing-azure-network-customizations[✓] +|xref:../../installing/installing_azure_stack_hub/installing-azure-stack-hub-network-customizations.adoc#installing-azure-stack-hub-network-customizations[✓] +|xref:../../installing/installing_gcp/installing-gcp-network-customizations.adoc#installing-gcp-network-customizations[✓] +|xref:../../installing/installing_gcp/installing-gcp-network-customizations.adoc#installing-gcp-network-customizations[✓] +| +| +| +| +|xref:../../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-network-customizations.adoc#installing-vsphere-installer-provisioned-network-customizations[✓] +|xref:../../installing/installing_ibm_cloud_public/installing-ibm-cloud-network-customizations.adoc#installing-ibm-cloud-network-customizations[✓] +| +| +| + +|Restricted network +|xref:../../installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc#installing-restricted-networks-aws-installer-provisioned[✓] +|xref:../../installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc#installing-restricted-networks-aws-installer-provisioned[✓] +|xref:../../installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc#installing-restricted-networks-azure-installer-provisioned[✓] +|xref:../../installing/installing_azure/ipi/installing-restricted-networks-azure-installer-provisioned.adoc#installing-restricted-networks-azure-installer-provisioned[✓] +| +|xref:../../installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc#installing-restricted-networks-gcp-installer-provisioned[✓] +|xref:../../installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc#installing-restricted-networks-gcp-installer-provisioned[✓] +|xref:../../installing/installing_nutanix/installing-restricted-networks-nutanix-installer-provisioned.adoc#installing-restricted-networks-nutanix-installer-provisioned[✓] +|xref:../../installing/installing_openstack/installing-openstack-installer-restricted.adoc#installing-openstack-installer-restricted[✓] +|xref:../../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#ipi-install-installation-workflow[✓] +|xref:../../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#ipi-install-installation-workflow[✓] +|xref:../../installing/installing_vsphere/ipi/installing-restricted-networks-installer-provisioned-vsphere.adoc#installing-restricted-networks-installer-provisioned-vsphere[✓] +|xref:../../installing/installing_ibm_cloud_public/installing-ibm-cloud-restricted.adoc#installing-ibm-cloud-restricted[✓] +| +| +|xref:../../installing/installing_ibm_powervs/installing-restricted-networks-ibm-power-vs.adoc#installing-restricted-networks-ibm-power-vs[✓] + +|Private clusters +|xref:../../installing/installing_aws/ipi/installing-aws-private.adoc#installing-aws-private[✓] +|xref:../../installing/installing_aws/ipi/installing-aws-private.adoc#installing-aws-private[✓] +|xref:../../installing/installing_azure/ipi/installing-azure-private.adoc#installing-azure-private[✓] +|xref:../../installing/installing_azure/ipi/installing-azure-private.adoc#installing-azure-private[✓] +| +|xref:../../installing/installing_gcp/installing-gcp-private.adoc#installing-gcp-private[✓] +|xref:../../installing/installing_gcp/installing-gcp-private.adoc#installing-gcp-private[✓] +| +| +| +| +| +|xref:../../installing/installing_ibm_cloud_public/installing-ibm-cloud-private.adoc#installing-ibm-cloud-private[✓] +| +| +|xref:../../installing/installing_ibm_powervs/installing-ibm-power-vs-private-cluster.adoc#installing-ibm-power-vs-private-cluster[✓] + +|Existing virtual private networks +|xref:../../installing/installing_aws/ipi/installing-aws-vpc.adoc#installing-aws-vpc[✓] +|xref:../../installing/installing_aws/ipi/installing-aws-vpc.adoc#installing-aws-vpc[✓] +|xref:../../installing/installing_azure/ipi/installing-azure-vnet.adoc#installing-azure-vnet[✓] +|xref:../../installing/installing_azure/ipi/installing-azure-vnet.adoc#installing-azure-vnet[✓] +| +|xref:../../installing/installing_gcp/installing-gcp-vpc.adoc#installing-gcp-vpc[✓] +|xref:../../installing/installing_gcp/installing-gcp-vpc.adoc#installing-gcp-vpc[✓] +| +| +| +| +| +|xref:../../installing/installing_ibm_cloud_public/installing-ibm-cloud-vpc.adoc#installing-ibm-cloud-vpc[✓] +| +| +|xref:../../installing/installing_ibm_powervs/installing-ibm-powervs-vpc.adoc#installing-ibm-powervs-vpc[✓] + +|Government regions +|xref:../../installing/installing_aws/ipi/installing-aws-government-region.adoc#installing-aws-government-region[✓] +| +|xref:../../installing/installing_azure/ipi/installing-azure-government-region.adoc#installing-azure-government-region[✓] +| +| +| +| +| +| +| +| +| +| +| +| +| + +|Secret regions +|xref:../../installing/installing_aws/ipi/installing-aws-secret-region.adoc#installing-aws-secret-region[✓] +| +| +| +| +| +| +| +| +| +| +| +| +| +| +| + +|China regions +|xref:../../installing/installing_aws/ipi/installing-aws-china.adoc#installing-aws-china-region[✓] +| +| +| +| +| +| +| +| +| +| +| +| +| +| +| +|=== +endif::openshift-origin[] + +//This table is for OKD only. A separate table is required because OKD does not support multiple AWS architecture types. Trying to maintain one table using conditions, while convenient, is very fragile and prone to publishing errors. +ifdef::openshift-origin[] +|=== +||AWS |Azure |Azure Stack Hub |GCP |Nutanix |{rh-openstack} |Bare metal |vSphere |{ibm-cloud-name} |{ibm-z-name} |{ibm-power-name} + + +|Default +|xref:../../installing/installing_aws/ipi/installing-aws-default.adoc#installing-aws-default[✓] +|xref:../../installing/installing_azure/ipi/installing-azure-default.adoc#installing-azure-default[✓] +|xref:../../installing/installing_azure/ipi/installing-azure-default.adoc#installing-azure-default[✓] +|xref:../../installing/installing_gcp/installing-gcp-default.adoc#installing-gcp-default[✓] +|xref:../../installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc#installing-nutanix-installer-provisioned[✓] +| +|xref:../../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install-overview[✓] +|xref:../../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned.adoc#installing-vsphere-installer-provisioned[✓] +|xref:../../installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[✓] +| +| + +|Custom +|xref:../../installing/installing_aws/ipi/installing-aws-customizations.adoc#installing-aws-customizations[✓] +|xref:../../installing/installing_azure/ipi/installing-azure-customizations.adoc#installing-azure-customizations[✓] +|xref:../../installing/installing_azure/ipi/installing-azure-default.adoc#installing-azure-default[✓] +|xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[✓] +|xref:../../installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc#installing-nutanix-installer-provisioned[✓] +|xref:../../installing/installing_openstack/installing-openstack-installer-custom.adoc#installing-openstack-installer-custom[✓] +| +|xref:../../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-customizations.adoc#installing-vsphere-installer-provisioned-customizations[✓] +|xref:../../installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[✓] +| +| + +|Network customization +|xref:../../installing/installing_aws/ipi/installing-aws-network-customizations.adoc#installing-aws-network-customizations[✓] +|xref:../../installing/installing_azure/ipi/installing-azure-network-customizations.adoc#installing-azure-network-customizations[✓] +|xref:../../installing/installing_azure_stack_hub/installing-azure-stack-hub-network-customizations.adoc#installing-azure-stack-hub-network-customizations[✓] +|xref:../../installing/installing_gcp/installing-gcp-network-customizations.adoc#installing-gcp-network-customizations[✓] +| +| +| +|xref:../../installing/installing_vsphere/ipi/installing-vsphere-installer-provisioned-network-customizations.adoc#installing-vsphere-installer-provisioned-network-customizations[✓] +|xref:../../installing/installing_ibm_cloud_public/installing-ibm-cloud-network-customizations.adoc#installing-ibm-cloud-network-customizations[✓] +| +| + +|Restricted network +|xref:../../installing/installing_aws/ipi/installing-restricted-networks-aws-installer-provisioned.adoc#installing-restricted-networks-aws-installer-provisioned[✓] +| +| +|xref:../../installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc#installing-restricted-networks-gcp-installer-provisioned[✓] +|xref:../../installing/installing_nutanix/installing-restricted-networks-nutanix-installer-provisioned.adoc#installing-restricted-networks-nutanix-installer-provisioned[✓] +|xref:../../installing/installing_openstack/installing-openstack-installer-restricted.adoc#installing-openstack-installer-restricted[✓] +| +|xref:../../installing/installing_vsphere/ipi/installing-restricted-networks-installer-provisioned-vsphere.adoc#installing-restricted-networks-installer-provisioned-vsphere[✓] +|xref:../../installing/installing_ibm_cloud_public/installing-ibm-cloud-restricted.adoc#installing-ibm-cloud-restricted[✓] +| +| + +|Private clusters +|xref:../../installing/installing_aws/ipi/installing-aws-private.adoc#installing-aws-private[✓] +|xref:../../installing/installing_azure/ipi/installing-azure-private.adoc#installing-azure-private[✓] +| +|xref:../../installing/installing_gcp/installing-gcp-private.adoc#installing-gcp-private[✓] +| +| +| +| +|xref:../../installing/installing_ibm_cloud_public/installing-ibm-cloud-private.adoc#installing-ibm-cloud-private[✓] +| +| + +|Existing virtual private networks +|xref:../../installing/installing_aws/ipi/installing-aws-vpc.adoc#installing-aws-vpc[✓] +|xref:../../installing/installing_azure/ipi/installing-azure-vnet.adoc#installing-azure-vnet[✓] +| +|xref:../../installing/installing_gcp/installing-gcp-vpc.adoc#installing-gcp-vpc[✓] +| +| +| +| +|xref:../../installing/installing_ibm_cloud_public/installing-ibm-cloud-vpc.adoc#installing-ibm-cloud-vpc[✓] +| +| + +|Government regions +|xref:../../installing/installing_aws/ipi/installing-aws-government-region.adoc#installing-aws-government-region[✓] +|xref:../../installing/installing_azure/ipi/installing-azure-government-region.adoc#installing-azure-government-region[✓] +| +| +| +| +| +| +| +| +| + +|Secret regions +|xref:../../installing/installing_aws/ipi/installing-aws-secret-region.adoc#installing-aws-secret-region[✓] +| +| +| +| +| +| +| +| +| +| + +|China regions +|xref:../../installing/installing_aws/ipi/installing-aws-china.adoc#installing-aws-china-region[✓] +| +| +| +| +| +| +| +| +| +| +|=== +endif::openshift-origin[] + +.User-provisioned infrastructure options +//This table is for all flavors of OpenShift, except OKD. A separate table is required because OKD does not support multiple AWS architecture types. Trying to maintain one table using conditions, while convenient, is very fragile and prone to publishing errors. +ifndef::openshift-origin[] +|=== +||AWS (64-bit x86) |AWS (64-bit ARM) |Azure (64-bit x86) |Azure (64-bit ARM) |Azure Stack Hub |GCP (64-bit x86) |GCP (64-bit ARM) |Nutanix |{rh-openstack} |Bare metal (64-bit x86) |Bare metal (64-bit ARM) |vSphere |{ibm-cloud-name} |{ibm-z-name} |{ibm-z-name} with {op-system-base} KVM |{ibm-power-name} |Platform agnostic + + +|Custom +|xref:../../installing/installing_aws/upi/installing-aws-user-infra.adoc#installing-aws-user-infra[✓] +|xref:../../installing/installing_aws/upi/installing-aws-user-infra.adoc#installing-aws-user-infra[✓] +|xref:../../installing/installing_azure/upi/installing-azure-user-infra.adoc#installing-azure-user-infra[✓] +|xref:../../installing/installing_azure/upi/installing-azure-user-infra.adoc#installing-azure-user-infra[✓] +|xref:../../installing/installing_azure_stack_hub/installing-azure-stack-hub-user-infra.adoc#installing-azure-stack-hub-user-infra[✓] +|xref:../../installing/installing_gcp/installing-gcp-user-infra.adoc#installing-gcp-user-infra[✓] +|xref:../../installing/installing_gcp/installing-gcp-user-infra.adoc#installing-gcp-user-infra[✓] +| +|xref:../../installing/installing_openstack/installing-openstack-user.adoc#installing-openstack-user[✓] +|xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[✓] +|xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[✓] +|xref:../../installing/installing_vsphere/upi/installing-vsphere.adoc#installing-vsphere[✓] +| +|xref:../../installing/installing_ibm_z/installing-ibm-z.adoc#installing-ibm-z[✓] +|xref:../../installing/installing_ibm_z/installing-ibm-z-kvm.adoc#installing-ibm-z-kvm[✓] +|xref:../../installing/installing_ibm_power/installing-ibm-power.adoc#installing-ibm-power[✓] +|xref:../../installing/installing_platform_agnostic/installing-platform-agnostic.adoc#installing-platform-agnostic[✓] + + +|Network customization +| +| +| +| +| +| +| +| +| +|xref:../../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installing-bare-metal-network-customizations[✓] +|xref:../../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installing-bare-metal-network-customizations[✓] +|xref:../../installing/installing_vsphere/upi/installing-vsphere-network-customizations.adoc#installing-vsphere-network-customizations[✓] +| +| +| +| +| + +|Restricted network +|xref:../../installing/installing_aws/upi/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[✓] +|xref:../../installing/installing_aws/upi/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[✓] +| +| +| +|xref:../../installing/installing_gcp/installing-restricted-networks-gcp.adoc#installing-restricted-networks-gcp[✓] +|xref:../../installing/installing_gcp/installing-restricted-networks-gcp.adoc#installing-restricted-networks-gcp[✓] +| +| +|xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[✓] +|xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[✓] +|xref:../../installing/installing_vsphere/upi/installing-restricted-networks-vsphere.adoc#installing-restricted-networks-vsphere[✓] +| +|xref:../../installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc#installing-restricted-networks-ibm-z[✓] +|xref:../../installing/installing_ibm_z/installing-restricted-networks-ibm-z-kvm.adoc#installing-restricted-networks-ibm-z-kvm[✓] +|xref:../../installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc#installing-restricted-networks-ibm-power[✓] +| + +|Shared VPC hosted outside of cluster project +| +| +| +| +| +|xref:../../installing/installing_gcp/installing-gcp-user-infra-vpc.adoc#installing-gcp-user-infra-vpc[✓] +|xref:../../installing/installing_gcp/installing-gcp-user-infra-vpc.adoc#installing-gcp-user-infra-vpc[✓] +| +| +| +| +| +| +| +| +| +| +| +|=== +endif::openshift-origin[] + +//This table is for OKD only. A separate table is required because OKD does not support multiple AWS architecture types. Trying to maintain one table using conditions, while convenient, is very fragile and prone to publishing errors. +ifdef::openshift-origin[] +|=== +||AWS |Azure |Azure Stack Hub |GCP |Nutanix |{rh-openstack}|Bare metal |vSphere |{ibm-cloud-name} |{ibm-z-name} |{ibm-z-name} with {op-system-base} KVM |{ibm-power-name} |Platform agnostic + + +|Custom +|xref:../../installing/installing_aws/upi/installing-aws-user-infra.adoc#installing-aws-user-infra[✓] +|xref:../../installing/installing_azure/upi/installing-azure-user-infra.adoc#installing-azure-user-infra[✓] +|xref:../../installing/installing_azure_stack_hub/installing-azure-stack-hub-user-infra.adoc#installing-azure-stack-hub-user-infra[✓] +|xref:../../installing/installing_gcp/installing-gcp-user-infra.adoc#installing-gcp-user-infra[✓] +| +|xref:../../installing/installing_openstack/installing-openstack-user.adoc#installing-openstack-user[✓] +|xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[✓] +|xref:../../installing/installing_vsphere/upi/installing-vsphere.adoc#installing-vsphere[✓] +| +|xref:../../installing/installing_ibm_z/installing-ibm-z.adoc#installing-ibm-z[✓] +|xref:../../installing/installing_ibm_z/installing-ibm-z-kvm.adoc#installing-ibm-z-kvm[✓] +|xref:../../installing/installing_ibm_power/installing-ibm-power.adoc#installing-ibm-power[✓] +|xref:../../installing/installing_platform_agnostic/installing-platform-agnostic.adoc#installing-platform-agnostic[✓] + + +|Network customization +| +| +| +| +| +| +|xref:../../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installing-bare-metal-network-customizations[✓] +|xref:../../installing/installing_vsphere/upi/installing-vsphere-network-customizations.adoc#installing-vsphere-network-customizations[✓] +| +| +| +| +| + +|Restricted network +|xref:../../installing/installing_aws/upi/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[✓] +| +| +|xref:../../installing/installing_gcp/installing-restricted-networks-gcp.adoc#installing-restricted-networks-gcp[✓] +| +| +|xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[✓] +|xref:../../installing/installing_vsphere/upi/installing-restricted-networks-vsphere.adoc#installing-restricted-networks-vsphere[✓] +| +|xref:../../installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc#installing-restricted-networks-ibm-z[✓] +|xref:../../installing/installing_ibm_z/installing-restricted-networks-ibm-z-kvm.adoc#installing-restricted-networks-ibm-z-kvm[✓] +|xref:../../installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc#installing-restricted-networks-ibm-power[✓] +| + +|Shared VPC hosted outside of cluster project +| +| +| +|xref:../../installing/installing_gcp/installing-gcp-user-infra-vpc.adoc#installing-gcp-user-infra-vpc[✓] +| +| +| +| +| +| +| +| +| +|=== +endif::openshift-origin[] + +//// +.Special use cases +|=== +|Single Node + +|xref:../../installing/installing_sno/install-sno-installing-sno.adoc#installing-sno[✓] + + +|=== +//// +// sync diff --git a/installing/overview/modules b/installing/overview/modules new file mode 120000 index 0000000000..36719b9de7 --- /dev/null +++ b/installing/overview/modules @@ -0,0 +1 @@ +../../modules/ \ No newline at end of file diff --git a/installing/overview/snippets b/installing/overview/snippets new file mode 120000 index 0000000000..5a3f5add14 --- /dev/null +++ b/installing/overview/snippets @@ -0,0 +1 @@ +../../snippets/ \ No newline at end of file diff --git a/installing/validating-an-installation.adoc b/installing/validating-an-installation.adoc deleted file mode 100644 index f34acca8c7..0000000000 --- a/installing/validating-an-installation.adoc +++ /dev/null @@ -1,74 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -[id="validating-an-installation"] -= Validating an installation -include::_attributes/common-attributes.adoc[] -:context: validating-an-installation - -toc::[] - -You can check the status of an {product-title} cluster after an installation by following the procedures in this document. - -//Reviewing the installation log -include::modules/reviewing-the-installation-log.adoc[leveloffset=+1] - -//Viewing the image pull source -include::modules/viewing-the-image-pull-source.adoc[leveloffset=+1] - -//Getting cluster version, status, and update details -include::modules/getting-cluster-version-status-and-update-details.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* See xref:../support/troubleshooting/troubleshooting-installations.adoc#querying-operator-status-after-installation_troubleshooting-installations[Querying Operator status after installation] for more information about querying Operator status if your installation is still progressing. - -* See xref:../support/troubleshooting/troubleshooting-operator-issues.adoc#troubleshooting-operator-issues[Troubleshooting Operator issues] for information about investigating issues with Operators. - -* See xref:../updating/updating_a_cluster/updating-cluster-web-console.adoc#updating-cluster-web-console[Updating a cluster using the web console] for more information on updating your cluster. - -* See xref:../updating/understanding_updates/understanding-update-channels-release.adoc#understanding-update-channels-releases[Understanding update channels and releases] for an overview about update release channels. - -// Verification steps for the Cloud Credential Operator utility (`ccoctl`) -include::modules/cco-ccoctl-install-verifying.adoc[leveloffset=+1] - -//Querying the status of the cluster nodes by using the CLI -include::modules/querying-the-status-of-cluster-nodes-using-the-cli.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* See xref:../support/troubleshooting/verifying-node-health.adoc#verifying-node-health[Verifying node health] for more details about reviewing node health and investigating node issues. - -//Reviewing the cluster status from the OpenShift Container Platform web console -include::modules/reviewing-cluster-status-from-the-openshift-web-console.adoc[leveloffset=+1] - -//Reviewing the cluster status from {cluster-manager} -include::modules/reviewing-cluster-status-from-the-openshift-cluster-manager.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* See xref:../support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Using Insights to identify issues with your cluster] for more information about reviewing potential issues with your cluster. - -//Checking cluster resource availability and utilization -include::modules/checking-cluster-resource-availability-and-utilization.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* See xref:../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] for more information about the {product-title} monitoring stack. - -//Listing alerts that are firing -include::modules/listing-alerts-that-are-firing.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources - -* See xref:../observability/monitoring/managing-alerts.adoc#managing-alerts[Managing alerts] for further details about alerting in {product-title}. - -[id="validating-an-installation-next-steps"] -== Next steps - -* See xref:../support/troubleshooting/troubleshooting-installations.adoc#troubleshooting-installations[Troubleshooting installations] if you experience issues when installing your cluster. - -* After installing {product-title}, you can xref:../post_installation_configuration/cluster-tasks.adoc#post-install-cluster-tasks[further expand and customize your cluster]. diff --git a/installing/validation_and_troubleshooting/_attributes b/installing/validation_and_troubleshooting/_attributes new file mode 120000 index 0000000000..20cc1dcb77 --- /dev/null +++ b/installing/validation_and_troubleshooting/_attributes @@ -0,0 +1 @@ +../../_attributes/ \ No newline at end of file diff --git a/installing/validation_and_troubleshooting/images b/installing/validation_and_troubleshooting/images new file mode 120000 index 0000000000..847b03ed05 --- /dev/null +++ b/installing/validation_and_troubleshooting/images @@ -0,0 +1 @@ +../../images/ \ No newline at end of file diff --git a/installing/installing-troubleshooting.adoc b/installing/validation_and_troubleshooting/installing-troubleshooting.adoc similarity index 65% rename from installing/installing-troubleshooting.adoc rename to installing/validation_and_troubleshooting/installing-troubleshooting.adoc index 58d96243ca..f477dfbbe4 100644 --- a/installing/installing-troubleshooting.adoc +++ b/installing/validation_and_troubleshooting/installing-troubleshooting.adoc @@ -6,11 +6,11 @@ include::_attributes/common-attributes.adoc[] toc::[] -To assist in troubleshooting a failed {product-title} installation, you can gather logs from the bootstrap and control plane machines. You can also get debug information from the installation program. If you are unable to resolve the issue using the logs and debug information, see xref:../support/troubleshooting/troubleshooting-installations.adoc#determining-where-installation-issues-occur_troubleshooting-installations[Determining where installation issues occur] for component-specific troubleshooting. +To assist in troubleshooting a failed {product-title} installation, you can gather logs from the bootstrap and control plane machines. You can also get debug information from the installation program. If you are unable to resolve the issue using the logs and debug information, see xref:../../support/troubleshooting/troubleshooting-installations.adoc#determining-where-installation-issues-occur_troubleshooting-installations[Determining where installation issues occur] for component-specific troubleshooting. [NOTE] ==== -If your {product-title} installation fails and the debug output or logs contain network timeouts or other connectivity errors, review the guidelines for xref:../installing/install_config/configuring-firewall.adoc#configuring-firewall[configuring your firewall]. Gathering logs from your firewall and load balancer can help you diagnose network-related errors. +If your {product-title} installation fails and the debug output or logs contain network timeouts or other connectivity errors, review the guidelines for xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configuring your firewall]. Gathering logs from your firewall and load balancer can help you diagnose network-related errors. ==== == Prerequisites @@ -29,4 +29,4 @@ include::modules/restarting-installation.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../installing/index.adoc#ocp-installation-overview[Installing an {product-title} cluster] +* xref:../../installing/overview/index.adoc#ocp-installation-overview[Installing an {product-title} cluster] diff --git a/installing/validation_and_troubleshooting/modules b/installing/validation_and_troubleshooting/modules new file mode 120000 index 0000000000..36719b9de7 --- /dev/null +++ b/installing/validation_and_troubleshooting/modules @@ -0,0 +1 @@ +../../modules/ \ No newline at end of file diff --git a/installing/validation_and_troubleshooting/snippets b/installing/validation_and_troubleshooting/snippets new file mode 120000 index 0000000000..5a3f5add14 --- /dev/null +++ b/installing/validation_and_troubleshooting/snippets @@ -0,0 +1 @@ +../../snippets/ \ No newline at end of file diff --git a/installing/validation_and_troubleshooting/validating-an-installation.adoc b/installing/validation_and_troubleshooting/validating-an-installation.adoc new file mode 100644 index 0000000000..82b541feee --- /dev/null +++ b/installing/validation_and_troubleshooting/validating-an-installation.adoc @@ -0,0 +1,74 @@ +:_mod-docs-content-type: ASSEMBLY +[id="validating-an-installation"] += Validating an installation +include::_attributes/common-attributes.adoc[] +:context: validating-an-installation + +toc::[] + +You can check the status of an {product-title} cluster after an installation by following the procedures in this document. + +//Reviewing the installation log +include::modules/reviewing-the-installation-log.adoc[leveloffset=+1] + +//Viewing the image pull source +include::modules/viewing-the-image-pull-source.adoc[leveloffset=+1] + +//Getting cluster version, status, and update details +include::modules/getting-cluster-version-status-and-update-details.adoc[leveloffset=+1] + +[role="_additional-resources"] +.Additional resources + +* See xref:../../support/troubleshooting/troubleshooting-installations.adoc#querying-operator-status-after-installation_troubleshooting-installations[Querying Operator status after installation] for more information about querying Operator status if your installation is still progressing. + +* See xref:../../support/troubleshooting/troubleshooting-operator-issues.adoc#troubleshooting-operator-issues[Troubleshooting Operator issues] for information about investigating issues with Operators. + +* See xref:../../updating/updating_a_cluster/updating-cluster-web-console.adoc#updating-cluster-web-console[Updating a cluster using the web console] for more information on updating your cluster. + +* See xref:../../updating/understanding_updates/understanding-update-channels-release.adoc#understanding-update-channels-releases[Understanding update channels and releases] for an overview about update release channels. + +// Verification steps for the Cloud Credential Operator utility (`ccoctl`) +include::modules/cco-ccoctl-install-verifying.adoc[leveloffset=+1] + +//Querying the status of the cluster nodes by using the CLI +include::modules/querying-the-status-of-cluster-nodes-using-the-cli.adoc[leveloffset=+1] + +[role="_additional-resources"] +.Additional resources + +* See xref:../../support/troubleshooting/verifying-node-health.adoc#verifying-node-health[Verifying node health] for more details about reviewing node health and investigating node issues. + +//Reviewing the cluster status from the OpenShift Container Platform web console +include::modules/reviewing-cluster-status-from-the-openshift-web-console.adoc[leveloffset=+1] + +//Reviewing the cluster status from {cluster-manager} +include::modules/reviewing-cluster-status-from-the-openshift-cluster-manager.adoc[leveloffset=+1] + +[role="_additional-resources"] +.Additional resources + +* See xref:../../support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Using Insights to identify issues with your cluster] for more information about reviewing potential issues with your cluster. + +//Checking cluster resource availability and utilization +include::modules/checking-cluster-resource-availability-and-utilization.adoc[leveloffset=+1] + +[role="_additional-resources"] +.Additional resources + +* See xref:../../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] for more information about the {product-title} monitoring stack. + +//Listing alerts that are firing +include::modules/listing-alerts-that-are-firing.adoc[leveloffset=+1] + +[role="_additional-resources"] +.Additional resources + +* See xref:../../observability/monitoring/managing-alerts.adoc#managing-alerts[Managing alerts] for further details about alerting in {product-title}. + +[id="validating-an-installation-next-steps"] +== Next steps + +* See xref:../../support/troubleshooting/troubleshooting-installations.adoc#troubleshooting-installations[Troubleshooting installations] if you experience issues when installing your cluster. + +* After installing {product-title}, you can xref:../../post_installation_configuration/cluster-tasks.adoc#post-install-cluster-tasks[further expand and customize your cluster]. diff --git a/modules/build-config-capability.adoc b/modules/build-config-capability.adoc index 4b685eb364..48148f7aa7 100644 --- a/modules/build-config-capability.adoc +++ b/modules/build-config-capability.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/cluster-capabilities.adoc +// * installing/overview/cluster-capabilities.adoc :_mod-docs-content-type: REFERENCE [id="build-config-capability_{context}"] diff --git a/modules/cco-ccoctl-install-verifying.adoc b/modules/cco-ccoctl-install-verifying.adoc index 26f40cc6d7..415eaa9622 100644 --- a/modules/cco-ccoctl-install-verifying.adoc +++ b/modules/cco-ccoctl-install-verifying.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/validating-an-installation.adoc +// * installing/validation_and_troubleshooting/validating-an-installation.adoc // * post_installation_configuration/cluster-tasks.adoc :_mod-docs-content-type: PROCEDURE diff --git a/modules/checking-cluster-resource-availability-and-utilization.adoc b/modules/checking-cluster-resource-availability-and-utilization.adoc index 204a60ce30..95851c0776 100644 --- a/modules/checking-cluster-resource-availability-and-utilization.adoc +++ b/modules/checking-cluster-resource-availability-and-utilization.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// *installing/validating-an-installation.adoc +// *installing/validation_and_troubleshooting/validating-an-installation.adoc :_mod-docs-content-type: PROCEDURE [id="checking-cluster-resource-availability-and-utilization_{context}"] diff --git a/modules/cluster-bare-metal-operator.adoc b/modules/cluster-bare-metal-operator.adoc index a4b02efcc0..7616ec975a 100644 --- a/modules/cluster-bare-metal-operator.adoc +++ b/modules/cluster-bare-metal-operator.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // // * operators/operator-reference.adoc -// * installing/cluster-capabilities.adoc +// * installing/overview/cluster-capabilities.adoc ifeval::["{context}" == "cluster-operators-ref"] :operator-ref: diff --git a/modules/cluster-csi-snapshot-controller-operator.adoc b/modules/cluster-csi-snapshot-controller-operator.adoc index eab49dc72a..16469b8776 100644 --- a/modules/cluster-csi-snapshot-controller-operator.adoc +++ b/modules/cluster-csi-snapshot-controller-operator.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // // * operators/operator-reference.adoc -// * installing/cluster-capabilities.adoc +// * installing/overview/cluster-capabilities.adoc ifeval::["{context}" == "cluster-operators-ref"] :operator-ref: diff --git a/modules/cluster-image-registry-operator.adoc b/modules/cluster-image-registry-operator.adoc index b77cacc030..dff8bf10ba 100644 --- a/modules/cluster-image-registry-operator.adoc +++ b/modules/cluster-image-registry-operator.adoc @@ -1,14 +1,14 @@ // Module included in the following assemblies: // // * operators/operator-reference.adoc -// * installing/cluster-capabilities.adoc +// * installing/overview/cluster-capabilities.adoc // operators/operator-reference.adoc ifeval::["{context}" == "cluster-operators-ref"] :operator-ref: endif::[] -// installing/cluster-capabilities.adoc +// installing/overview/cluster-capabilities.adoc ifeval::["{context}" == "cluster-capabilities"] :cluster-caps: endif::[] diff --git a/modules/cluster-samples-operator.adoc b/modules/cluster-samples-operator.adoc index 6234ae123e..5156f4bd45 100644 --- a/modules/cluster-samples-operator.adoc +++ b/modules/cluster-samples-operator.adoc @@ -1,14 +1,14 @@ // Module included in the following assemblies: // // * operators/operator-reference.adoc -// * installing/cluster-capabilities.adoc +// * installing/overview/cluster-capabilities.adoc // operators/operator-reference.adoc ifeval::["{context}" == "cluster-operators-ref"] :operator-ref: endif::[] -// installing/cluster-capabilities.adoc +// installing/overview/cluster-capabilities.adoc ifeval::["{context}" == "cluster-capabilities"] :cluster-caps: endif::[] diff --git a/modules/cluster-storage-operator.adoc b/modules/cluster-storage-operator.adoc index 794f37e0d3..83159a13fd 100644 --- a/modules/cluster-storage-operator.adoc +++ b/modules/cluster-storage-operator.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // // * operators/operator-reference.adoc -// * installing/cluster-capabilities.adoc +// * installing/overview/cluster-capabilities.adoc ifeval::["{context}" == "cluster-operators-ref"] :operator-ref: @@ -33,12 +33,12 @@ The Cluster Storage Operator provides the features for the `Storage` capability. endif::cluster-caps[] -The Cluster Storage Operator sets {product-title} cluster-wide storage defaults. It ensures a default `storageclass` exists for {product-title} clusters. It also installs Container Storage Interface (CSI) drivers which enable your cluster to use various storage backends. +The Cluster Storage Operator sets {product-title} cluster-wide storage defaults. It ensures a default `storageclass` exists for {product-title} clusters. It also installs Container Storage Interface (CSI) drivers which enable your cluster to use various storage backends. ifdef::cluster-caps[] [IMPORTANT] ==== -If the cluster storage capability is disabled, the cluster will not have a default `storageclass` or any CSI drivers. Users with administrator privileges can create a default `storageclass` and manually install CSI drivers if the cluster storage capability is disabled. +If the cluster storage capability is disabled, the cluster will not have a default `storageclass` or any CSI drivers. Users with administrator privileges can create a default `storageclass` and manually install CSI drivers if the cluster storage capability is disabled. ==== endif::cluster-caps[] diff --git a/modules/console-operator.adoc b/modules/console-operator.adoc index edec4ab1a8..fc2fa7a86e 100644 --- a/modules/console-operator.adoc +++ b/modules/console-operator.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // // * operators/operator-reference.adoc -// * installing/cluster-capabilities.adoc +// * installing/overview/cluster-capabilities.adoc // operators/operator-reference.adoc ifeval::["{context}" == "cluster-operators-ref"] diff --git a/modules/deployment-config-capability.adoc b/modules/deployment-config-capability.adoc index fdb254efe2..5ec5b7bcf5 100644 --- a/modules/deployment-config-capability.adoc +++ b/modules/deployment-config-capability.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/cluster-capabilities.adoc +// * installing/overview/cluster-capabilities.adoc :_mod-docs-content-type: REFERENCE [id="deployment-config-capability_{context}"] diff --git a/modules/explanation-of-capabilities.adoc b/modules/explanation-of-capabilities.adoc index defb137435..a90b341ede 100644 --- a/modules/explanation-of-capabilities.adoc +++ b/modules/explanation-of-capabilities.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/cluster-capabilities.adoc +// * installing/overview/cluster-capabilities.adoc :_mod-docs-content-type: REFERENCE [id="explanation_of_capabilities_{context}"] diff --git a/modules/getting-cluster-version-status-and-update-details.adoc b/modules/getting-cluster-version-status-and-update-details.adoc index 66f876c37d..508290324b 100644 --- a/modules/getting-cluster-version-status-and-update-details.adoc +++ b/modules/getting-cluster-version-status-and-update-details.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// *installing/validating-an-installation.adoc +// *installing/validation_and_troubleshooting/validating-an-installation.adoc :_mod-docs-content-type: PROCEDURE [id="getting-cluster-version-and-update-details_{context}"] diff --git a/modules/ingress-operator.adoc b/modules/ingress-operator.adoc index 4ce1f0ca60..c8cab751a9 100644 --- a/modules/ingress-operator.adoc +++ b/modules/ingress-operator.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // // * operators/operator-reference.adoc -// * installing/cluster-capabilities.adoc +// * installing/overview/cluster-capabilities.adoc ifeval::["{context}" == "cluster-capabilities"] :cluster-caps: diff --git a/modules/insights-operator.adoc b/modules/insights-operator.adoc index 38525c5b14..369efa2c5a 100644 --- a/modules/insights-operator.adoc +++ b/modules/insights-operator.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // // * operators/operator-reference.adoc -// * installing/cluster-capabilities.adoc +// * installing/overview/cluster-capabilities.adoc ifeval::["{context}" == "cluster-capabilities"] :cluster-caps: diff --git a/modules/install-openshift-common-terms.adoc b/modules/install-openshift-common-terms.adoc index d9f4efe36c..1dee6e59ec 100644 --- a/modules/install-openshift-common-terms.adoc +++ b/modules/install-openshift-common-terms.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/index.adoc +// * installing/overview/index.adoc :_mod-docs-content-type: REFERENCE [id="install-openshift-common-terms_{context}"] diff --git a/modules/installation-openshift-local.adoc b/modules/installation-openshift-local.adoc index 01cc205f53..3a1dc0488c 100644 --- a/modules/installation-openshift-local.adoc +++ b/modules/installation-openshift-local.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // // * getting_started/openshift-overview.adoc -// * installing/index.adoc +// * installing/overview/index.adoc :_mod-docs-content-type: CONCEPT [id="installation-openshift-local_{context}"] diff --git a/modules/installation-overview.adoc b/modules/installation-overview.adoc index 66d49dce49..c99892199c 100644 --- a/modules/installation-overview.adoc +++ b/modules/installation-overview.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/index.adoc +// * installing/overview/index.adoc // * architecture/architecture-installation.adoc :_mod-docs-content-type: CONCEPT diff --git a/modules/installation-process.adoc b/modules/installation-process.adoc index ac031450d1..23ef2fa631 100644 --- a/modules/installation-process.adoc +++ b/modules/installation-process.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/index.adoc +// * installing/overview/index.adoc // * architecture/architecture-installation.adoc :_mod-docs-content-type: CONCEPT diff --git a/modules/ipi-verifying-nodes-after-installation.adoc b/modules/ipi-verifying-nodes-after-installation.adoc index e40742f2fb..5f561393f8 100644 --- a/modules/ipi-verifying-nodes-after-installation.adoc +++ b/modules/ipi-verifying-nodes-after-installation.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/index.adoc +// * installing/overview/index.adoc :_module-type: PROCEDURE [id="ipi-verifying-nodes-after-installation_{context}"] diff --git a/modules/listing-alerts-that-are-firing.adoc b/modules/listing-alerts-that-are-firing.adoc index 5d48212b24..419dba0195 100644 --- a/modules/listing-alerts-that-are-firing.adoc +++ b/modules/listing-alerts-that-are-firing.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// *installing/validating-an-installation.adoc +// *installing/validation_and_troubleshooting/validating-an-installation.adoc :_mod-docs-content-type: PROCEDURE [id="listing-alerts-that-are-firing_{context}"] diff --git a/modules/logging-in-by-using-the-web-console.adoc b/modules/logging-in-by-using-the-web-console.adoc index 2449e1b4a0..8d89107ba9 100644 --- a/modules/logging-in-by-using-the-web-console.adoc +++ b/modules/logging-in-by-using-the-web-console.adoc @@ -2,7 +2,7 @@ // // * installing/installing_aws/installing-aws-china.adoc. // * installing/installing_aws/installing-aws-secret-region.adoc -// *installing/validating-an-installation.adoc +// *installing/validation_and_troubleshooting/validating-an-installation.adoc // *installing/installing_aws/installing-aws-user-infra.adoc // *installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc // *installing/installing_aws/installing-restricted-networks-aws.adoc diff --git a/modules/logging-into-a-cluster-after-installation.adoc b/modules/logging-into-a-cluster-after-installation.adoc index 6196889d4f..41bc1cd417 100644 --- a/modules/logging-into-a-cluster-after-installation.adoc +++ b/modules/logging-into-a-cluster-after-installation.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// *installing/validating-an-installation.adoc +// *installing/validation_and_troubleshooting/validating-an-installation.adoc [id="logging-into-a-cluster-after-installation_{context}"] = Logging into a cluster after an installation diff --git a/modules/machine-api-capability.adoc b/modules/machine-api-capability.adoc index 5d6c226b6a..6ec53d36aa 100644 --- a/modules/machine-api-capability.adoc +++ b/modules/machine-api-capability.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/cluster-capabilities.adoc +// * installing/overview/cluster-capabilities.adoc :_mod-docs-content-type: REFERENCE [id="machine-api-capability_{context}"] diff --git a/modules/olm-overview.adoc b/modules/olm-overview.adoc index b51fdaa3b2..a1e302a91f 100644 --- a/modules/olm-overview.adoc +++ b/modules/olm-overview.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/cluster-capabilities.adoc +// * installing/overview/cluster-capabilities.adoc // * operators/understanding/olm/olm-understanding-olm.adoc // * operators/operator-reference.adoc @@ -42,7 +42,7 @@ endif::openshift-dedicated,openshift-rosa[] ifdef::openshift-dedicated,openshift-rosa[] administrators with the `dedicated-admin` role endif::openshift-dedicated,openshift-rosa[] -in installing, upgrading, and granting access to Operators running on their cluster. The {product-title} web console provides management screens for +in installing, upgrading, and granting access to Operators running on their cluster. The {product-title} web console provides management screens for ifndef::openshift-dedicated,openshift-rosa[] cluster administrators endif::openshift-dedicated,openshift-rosa[] @@ -57,7 +57,7 @@ endif::[] ifdef::cluster-caps[] If an Operator requires any of the following APIs, then you must enable the `OperatorLifecycleManager` capability: -* `ClusterServiceVersion` +* `ClusterServiceVersion` * `CatalogSource` * `Subscription` * `InstallPlan` diff --git a/modules/operator-marketplace.adoc b/modules/operator-marketplace.adoc index 85a3f8444c..c7f7eed27a 100644 --- a/modules/operator-marketplace.adoc +++ b/modules/operator-marketplace.adoc @@ -1,14 +1,14 @@ // Module included in the following assemblies: // // * operators/operator-reference.adoc -// * installing/cluster-capabilities.adoc +// * installing/overview/cluster-capabilities.adoc // operators/operator-reference.adoc ifeval::["{context}" == "cluster-operators-ref"] :operator-ref: endif::[] -// installing/cluster-capabilities.adoc +// installing/overview/cluster-capabilities.adoc ifeval::["{context}" == "cluster-capabilities"] :cluster-caps: endif::[] diff --git a/modules/querying-the-status-of-cluster-nodes-using-the-cli.adoc b/modules/querying-the-status-of-cluster-nodes-using-the-cli.adoc index 1bd741b0f4..a49746226a 100644 --- a/modules/querying-the-status-of-cluster-nodes-using-the-cli.adoc +++ b/modules/querying-the-status-of-cluster-nodes-using-the-cli.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// *installing/validating-an-installation.adoc +// *installing/validation_and_troubleshooting/validating-an-installation.adoc :_mod-docs-content-type: PROCEDURE [id="querying-the-status-of-cluster-nodes-using-the-cli_{context}"] diff --git a/modules/reviewing-cluster-status-from-the-openshift-cluster-manager.adoc b/modules/reviewing-cluster-status-from-the-openshift-cluster-manager.adoc index c2489704c1..56a65fcc4e 100644 --- a/modules/reviewing-cluster-status-from-the-openshift-cluster-manager.adoc +++ b/modules/reviewing-cluster-status-from-the-openshift-cluster-manager.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// *installing/validating-an-installation.adoc +// *installing/validation_and_troubleshooting/validating-an-installation.adoc :_mod-docs-content-type: PROCEDURE [id="reviewing-cluster-status-from-the-openshift-cluster-manager_{context}"] diff --git a/modules/reviewing-cluster-status-from-the-openshift-web-console.adoc b/modules/reviewing-cluster-status-from-the-openshift-web-console.adoc index d4554472e0..9512e9c374 100644 --- a/modules/reviewing-cluster-status-from-the-openshift-web-console.adoc +++ b/modules/reviewing-cluster-status-from-the-openshift-web-console.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// *installing/validating-an-installation.adoc +// *installing/validation_and_troubleshooting/validating-an-installation.adoc :_mod-docs-content-type: PROCEDURE [id="reviewing-cluster-status-from-the-openshift-web-console_{context}"] diff --git a/modules/reviewing-the-installation-log.adoc b/modules/reviewing-the-installation-log.adoc index a49f9a883d..5fa1afc745 100644 --- a/modules/reviewing-the-installation-log.adoc +++ b/modules/reviewing-the-installation-log.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// *installing/validating-an-installation.adoc +// *installing/validation_and_troubleshooting/validating-an-installation.adoc :_mod-docs-content-type: PROCEDURE [id="reviewing-the-installation-log_{context}"] diff --git a/modules/selecting-cluster-capabilities.adoc b/modules/selecting-cluster-capabilities.adoc index ce80703573..44a728b058 100644 --- a/modules/selecting-cluster-capabilities.adoc +++ b/modules/selecting-cluster-capabilities.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * installing/cluster-capabilities.adoc +// * installing/overview/cluster-capabilities.adoc :_mod-docs-content-type: PROCEDURE [id="selecting-cluster-capabilities_{context}"] diff --git a/modules/supported-platforms-for-openshift-clusters.adoc b/modules/supported-platforms-for-openshift-clusters.adoc index 56fe6ceb3c..0fbca4febe 100644 --- a/modules/supported-platforms-for-openshift-clusters.adoc +++ b/modules/supported-platforms-for-openshift-clusters.adoc @@ -1,7 +1,7 @@ // Module included in the following assemblies: // // * architecture/architecture-installation.adoc -// * installing/index.adoc +// * installing/overview/index.adoc :_mod-docs-content-type: REFERENCE [id="supported-platforms-for-openshift-clusters_{context}"] diff --git a/modules/viewing-the-image-pull-source.adoc b/modules/viewing-the-image-pull-source.adoc index d83064a7e8..0898539d35 100644 --- a/modules/viewing-the-image-pull-source.adoc +++ b/modules/viewing-the-image-pull-source.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// *installing/validating-an-installation.adoc +// *installing/validation_and_troubleshooting/validating-an-installation.adoc :_mod-docs-content-type: PROCEDURE [id="viewing-the-image-pull-source_{context}"] diff --git a/networking/network_security/configuring-ipsec-ovn.adoc b/networking/network_security/configuring-ipsec-ovn.adoc index 41f3275c93..3584aa41f8 100644 --- a/networking/network_security/configuring-ipsec-ovn.adoc +++ b/networking/network_security/configuring-ipsec-ovn.adoc @@ -8,7 +8,7 @@ toc::[] With IPsec enabled, you can encrypt both internal pod-to-pod cluster traffic between nodes and external traffic between pods and IPsec endpoints external to your cluster. All pod-to-pod network traffic between nodes on the OVN-Kubernetes cluster network is encrypted with IPsec in _Transport mode_. -IPsec is disabled by default. It can be enabled either during or after installing the cluster. For information about cluster installation, see xref:../../installing/index.adoc#ocp-installation-overview[{product-title} installation overview]. +IPsec is disabled by default. It can be enabled either during or after installing the cluster. For information about cluster installation, see xref:../../installing/overview/index.adoc#ocp-installation-overview[{product-title} installation overview]. [IMPORTANT] ==== diff --git a/nodes/clusters/nodes-cluster-cgroups-2.adoc b/nodes/clusters/nodes-cluster-cgroups-2.adoc index e7cfe033c3..7b8d63707f 100644 --- a/nodes/clusters/nodes-cluster-cgroups-2.adoc +++ b/nodes/clusters/nodes-cluster-cgroups-2.adoc @@ -42,4 +42,4 @@ include::modules/nodes-clusters-cgroups-2.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../../installing/index.adoc#ocp-installation-overview[OpenShift Container Platform installation overview] +* xref:../../installing/overview/index.adoc#ocp-installation-overview[OpenShift Container Platform installation overview] diff --git a/openshift_images/samples-operator-alt-registry.adoc b/openshift_images/samples-operator-alt-registry.adoc index 81becf3f2b..a9e290654e 100644 --- a/openshift_images/samples-operator-alt-registry.adoc +++ b/openshift_images/samples-operator-alt-registry.adoc @@ -18,7 +18,7 @@ include::modules/installation-about-mirror-registry.adoc[leveloffset=+1] ifndef::openshift-rosa,openshift-dedicated[] .Additional information -For information on viewing the CRI-O logs to view the image source, see xref:../installing/validating-an-installation.adoc#viewing-the-image-pull-source_validating-an-installation[Viewing the image pull source]. +For information on viewing the CRI-O logs to view the image source, see xref:../installing/validation_and_troubleshooting/validating-an-installation.adoc#viewing-the-image-pull-source_validating-an-installation[Viewing the image pull source]. endif::openshift-rosa,openshift-dedicated[] [id="samples-preparing-bastion"] diff --git a/operators/operator-reference.adoc b/operators/operator-reference.adoc index 7caf9178c6..32ac63c138 100644 --- a/operators/operator-reference.adoc +++ b/operators/operator-reference.adoc @@ -15,13 +15,13 @@ Cluster administrators can view cluster Operators in the {product-title} web con Cluster Operators are not managed by Operator Lifecycle Manager (OLM) and OperatorHub. OLM and OperatorHub are part of the link:https://operatorframework.io/[Operator Framework] used in {product-title} for installing and running optional xref:../architecture/control-plane.adoc#olm-operators_control-plane[add-on Operators]. ==== -Some of the following cluster Operators can be disabled prior to installation. For more information see xref:../installing/cluster-capabilities.adoc#cluster-capabilities[cluster capabilities]. +Some of the following cluster Operators can be disabled prior to installation. For more information see xref:../installing/overview/cluster-capabilities.adoc#cluster-capabilities[cluster capabilities]. include::modules/cluster-bare-metal-operator.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../installing/cluster-capabilities.adoc#cluster-bare-metal-operator_cluster-capabilities[Bare-metal capability] +* xref:../installing/overview/cluster-capabilities.adoc#cluster-bare-metal-operator_cluster-capabilities[Bare-metal capability] include::modules/baremetal-event-relay.adoc[leveloffset=+1] @@ -48,7 +48,7 @@ include::modules/cluster-csi-snapshot-controller-operator.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../installing/cluster-capabilities.adoc#cluster-csi-snapshot-controller-operator_cluster-capabilities[CSI snapshot controller capability] +* xref:../installing/overview/cluster-capabilities.adoc#cluster-csi-snapshot-controller-operator_cluster-capabilities[CSI snapshot controller capability] include::modules/cluster-image-registry-operator.adoc[leveloffset=+1] @@ -63,13 +63,13 @@ include::modules/cluster-samples-operator.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../installing/cluster-capabilities.adoc#cluster-samples-operator_cluster-capabilities[OpenShift samples capability] +* xref:../installing/overview/cluster-capabilities.adoc#cluster-samples-operator_cluster-capabilities[OpenShift samples capability] include::modules/cluster-storage-operator.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../installing/cluster-capabilities.adoc#cluster-storage-operator_cluster-capabilities[Storage capability] +* xref:../installing/overview/cluster-capabilities.adoc#cluster-storage-operator_cluster-capabilities[Storage capability] include::modules/cluster-version-operator.adoc[leveloffset=+1] @@ -81,7 +81,7 @@ include::modules/console-operator.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../installing/cluster-capabilities.adoc#console-operator_cluster-capabilities[Web console capability] +* xref:../installing/overview/cluster-capabilities.adoc#console-operator_cluster-capabilities[Web console capability] include::modules/control-plane-machine-set-operator.adoc[leveloffset=+1] @@ -103,7 +103,7 @@ include::modules/insights-operator.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../installing/cluster-capabilities.adoc#insights-operator_cluster-capabilities[Insights capability] +* xref:../installing/overview/cluster-capabilities.adoc#insights-operator_cluster-capabilities[Insights capability] * See xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] for details about Insights Operator and Telemetry. include::modules/kube-apiserver-operator.adoc[leveloffset=+1] @@ -122,7 +122,7 @@ include::modules/operator-marketplace.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -* xref:../installing/cluster-capabilities.adoc#marketplace-operator_cluster-capabilities[Marketplace capability] +* xref:../installing/overview/cluster-capabilities.adoc#marketplace-operator_cluster-capabilities[Marketplace capability] include::modules/node-tuning-operator.adoc[leveloffset=+1] diff --git a/operators/operator_sdk/osdk-generating-csvs.adoc b/operators/operator_sdk/osdk-generating-csvs.adoc index e8a24c2e30..a46a0e7f39 100644 --- a/operators/operator_sdk/osdk-generating-csvs.adoc +++ b/operators/operator_sdk/osdk-generating-csvs.adoc @@ -38,7 +38,7 @@ include::modules/osdk-csv-annotations-infra.adoc[leveloffset=+2] .Additional resources * xref:../../operators/operator_sdk/osdk-generating-csvs.adoc#olm-enabling-operator-for-restricted-network_osdk-generating-csvs[Enabling your Operator for restricted network environments] (disconnected mode) ifndef::openshift-dedicated,openshift-rosa[] -* xref:../../installing/installing-fips.adoc#installing-fips[Support for FIPS cryptography] +* xref:../../installing/overview/installing-fips.adoc#installing-fips[Support for FIPS cryptography] endif::openshift-dedicated,openshift-rosa[] include::modules/osdk-csv-annotations-dep.adoc[leveloffset=+2] diff --git a/post_installation_configuration/cluster-tasks.adoc b/post_installation_configuration/cluster-tasks.adoc index a0b76948b0..a7d9de65b2 100644 --- a/post_installation_configuration/cluster-tasks.adoc +++ b/post_installation_configuration/cluster-tasks.adoc @@ -666,7 +666,7 @@ include::modules/dr-restoring-cluster-state.adoc[leveloffset=+2] .Additional resources * xref:../scalability_and_performance/recommended-performance-scale-practices/recommended-etcd-practices.adoc#recommended-etcd-practices[Recommended etcd practices] * xref:../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[Installing a user-provisioned cluster on bare metal] -* xref:../installing/index.adoc#replacing-a-bare-metal-control-plane-node_ipi-install-expanding[Replacing a bare-metal control plane node] +* xref:../installing/overview/index.adoc#replacing-a-bare-metal-control-plane-node_ipi-install-expanding[Replacing a bare-metal control plane node] include::modules/dr-scenario-cluster-state-issues.adoc[leveloffset=+2] diff --git a/post_installation_configuration/enabling-cluster-capabilities.adoc b/post_installation_configuration/enabling-cluster-capabilities.adoc index 80afaa5df0..e7de2a648c 100644 --- a/post_installation_configuration/enabling-cluster-capabilities.adoc +++ b/post_installation_configuration/enabling-cluster-capabilities.adoc @@ -22,4 +22,4 @@ include::modules/enabling-additional-enabled-capabilities.adoc[leveloffset=+1] [role="_additional-resources"] [id="additional-resources_{context}"] == Additional resources -* xref:../installing/cluster-capabilities.adoc#cluster-capabilities[Cluster capabilities] \ No newline at end of file +* xref:../installing/overview/cluster-capabilities.adoc#cluster-capabilities[Cluster capabilities] \ No newline at end of file diff --git a/rosa_architecture/index.adoc b/rosa_architecture/index.adoc index 63b5c31034..37d853d361 100644 --- a/rosa_architecture/index.adoc +++ b/rosa_architecture/index.adoc @@ -70,7 +70,7 @@ ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] == Cluster installer activities Explore the following {product-title} installation tasks: -- **xref:../installing/index.adoc#ocp-installation-overview[{product-title} installation overview]**: Depending on the platform, you can install {product-title} on installer-provisioned or user-provisioned infrastructure. The {product-title} installation program provides the flexibility to deploy {product-title} on a range of different platforms. +- **xref:../installing/overview/index.adoc#ocp-installation-overview[{product-title} installation overview]**: Depending on the platform, you can install {product-title} on installer-provisioned or user-provisioned infrastructure. The {product-title} installation program provides the flexibility to deploy {product-title} on a range of different platforms. // PR open https://github.com/openshift/openshift-docs/pull/77474 //- **xref:../installing/installing_alibaba/installing-alibaba-assisted-installer[Installing a cluster on {alibaba} by using the Assisted Installer]**: On {alibaba}, you can install {product-title} by using the Assisted Installer. This is currently a Technology Preview feature only. diff --git a/rosa_architecture/learn_more_about_openshift.adoc b/rosa_architecture/learn_more_about_openshift.adoc index cd0d2a02d1..4c1c18f62b 100644 --- a/rosa_architecture/learn_more_about_openshift.adoc +++ b/rosa_architecture/learn_more_about_openshift.adoc @@ -41,7 +41,7 @@ Use the following sections to find content to help you learn about and use {prod |Learn about {product-title} |Deploy {product-title} |Manage {product-title} |Additional resources | link:https://www.openshift.com/blog/enterprise-kubernetes-with-openshift-part-one?extIdCarryOver=true&sc_cid=701f2000001Css5AAC[Enterprise Kubernetes with OpenShift] -| xref:../installing/installing-preparing.adoc#installing-preparing[Installing {product-title}] +| xref:../installing/overview/installing-preparing.adoc#installing-preparing[Installing {product-title}] | xref:../support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Using Insights to identify issues with your cluster] | xref:../support/getting-support.adoc#getting-support[Getting Support] diff --git a/security/cert_manager_operator/index.adoc b/security/cert_manager_operator/index.adoc index 53558f8a70..f8920383ca 100644 --- a/security/cert_manager_operator/index.adoc +++ b/security/cert_manager_operator/index.adoc @@ -29,5 +29,5 @@ include::modules/cert-manager-fips-support.adoc[leveloffset=+1] * link:https://cert-manager.io/docs/[cert-manager project documentation] * xref:../../security/container_security/security-compliance.adoc#security-compliance[Understanding compliance] -* xref:../../installing/installing-fips.adoc#installing-fips-mode_installing-fips[Installing a cluster in FIPS mode] -* xref:../../installing/installing-preparing.adoc#installing-preparing-security[Do you need extra security for your cluster?] \ No newline at end of file +* xref:../../installing/overview/installing-fips.adoc#installing-fips-mode_installing-fips[Installing a cluster in FIPS mode] +* xref:../../installing/overview/installing-preparing.adoc#installing-preparing-security[Do you need extra security for your cluster?] \ No newline at end of file diff --git a/security/container_security/security-compliance.adoc b/security/container_security/security-compliance.adoc index 8a7904378f..1459d22d90 100644 --- a/security/container_security/security-compliance.adoc +++ b/security/container_security/security-compliance.adoc @@ -17,5 +17,5 @@ ifndef::openshift-origin[] [role="_additional-resources"] .Additional resources -* xref:../../installing/installing-fips.adoc#installing-fips-mode_installing-fips[Installing a cluster in FIPS mode] +* xref:../../installing/overview/installing-fips.adoc#installing-fips-mode_installing-fips[Installing a cluster in FIPS mode] endif::[] diff --git a/security/container_security/security-hardening.adoc b/security/container_security/security-hardening.adoc index 8195ea2fd1..0b4b476835 100644 --- a/security/container_security/security-hardening.adoc +++ b/security/container_security/security-hardening.adoc @@ -44,6 +44,6 @@ include::modules/security-hardening-how.adoc[leveloffset=+1] * xref:../../nodes/nodes/nodes-nodes-managing.adoc#nodes-nodes-kernel-arguments_nodes-nodes-managing[Adding kernel arguments to nodes] ifndef::openshift-origin[] * xref:../../installing/installing_aws/installation-config-parameters-aws.adoc#installation-configuration-parameters-optional_installation-config-parameters-aws[Optional configuration parameters] -* xref:../../installing/installing-fips.adoc#installing-fips[Support for FIPS cryptography] +* xref:../../installing/overview/installing-fips.adoc#installing-fips[Support for FIPS cryptography] * link:https://access.redhat.com/articles/3359851[{op-system-base} core crypto components] endif::[] diff --git a/security/container_security/security-hosts-vms.adoc b/security/container_security/security-hosts-vms.adoc index f113568840..a7dd444908 100644 --- a/security/container_security/security-hosts-vms.adoc +++ b/security/container_security/security-hosts-vms.adoc @@ -30,7 +30,7 @@ include::modules/security-hosts-vms-rhcos.adoc[leveloffset=+1] * xref:../../installing/install_config/installing-customizing.adoc#installation-special-config-chrony_installing-customizing[Chrony time service] * xref:../../updating/understanding_updates/intro-to-updates.adoc#update-service-about_understanding-openshift-updates[About the OpenShift Update Service] ifndef::openshift-origin[] -* xref:../../installing/installing-fips.adoc#installing-fips[FIPS cryptography] +* xref:../../installing/overview/installing-fips.adoc#installing-fips[FIPS cryptography] endif::[] // Virtualization versus containers @@ -42,5 +42,5 @@ include::modules/security-hosts-vms-openshift.adoc[leveloffset=+1] ifndef::openshift-origin[] [role="_additional-resources"] .Additional resources -* xref:../../installing/installing-fips.adoc#installing-fips[FIPS cryptography] +* xref:../../installing/overview/installing-fips.adoc#installing-fips[FIPS cryptography] endif::[] diff --git a/serverless/install/preparing-serverless-install.adoc b/serverless/install/preparing-serverless-install.adoc index d11df4e1ff..2afbfc5f80 100644 --- a/serverless/install/preparing-serverless-install.adoc +++ b/serverless/install/preparing-serverless-install.adoc @@ -62,5 +62,5 @@ endif::[] ifdef::openshift-enterprise[] * xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks] * xref:../../operators/understanding/olm-understanding-operatorhub.adoc#olm-operatorhub-overview[Understanding OperatorHub] -* xref:../../installing/cluster-capabilities.adoc#cluster-capabilities[Cluster capabilities] +* xref:../../installing/overview/cluster-capabilities.adoc#cluster-capabilities[Cluster capabilities] endif::[] diff --git a/service_mesh/v1x/preparing-ossm-installation.adoc b/service_mesh/v1x/preparing-ossm-installation.adoc index 77b62212d5..08465cb608 100644 --- a/service_mesh/v1x/preparing-ossm-installation.adoc +++ b/service_mesh/v1x/preparing-ossm-installation.adoc @@ -24,7 +24,7 @@ ifdef::openshift-enterprise[] + [NOTE] ==== -If you are installing {SMProductName} on a xref:../../installing/installing-preparing.adoc#supported-installation-methods-for-different-platforms[restricted network], follow the instructions for your chosen {product-title} infrastructure. +If you are installing {SMProductName} on a xref:../../installing/overview/installing-preparing.adoc#supported-installation-methods-for-different-platforms[restricted network], follow the instructions for your chosen {product-title} infrastructure. ==== + endif::[] diff --git a/service_mesh/v2x/preparing-ossm-installation.adoc b/service_mesh/v2x/preparing-ossm-installation.adoc index f87fd58f3e..7e206cd457 100644 --- a/service_mesh/v2x/preparing-ossm-installation.adoc +++ b/service_mesh/v2x/preparing-ossm-installation.adoc @@ -14,7 +14,7 @@ Before you can install {SMProductName}, you must subscribe to {product-title} an ifdef::openshift-enterprise[] * Review the xref:../../architecture/architecture-installation.adoc#installation-overview_architecture-installation[{product-title} {product-version} overview]. -* Install {product-title} {product-version}. If you are installing {SMProductName} on a xref:../../installing/installing-preparing.adoc#supported-installation-methods-for-different-platforms[restricted network], follow the instructions for your chosen {product-title} infrastructure. +* Install {product-title} {product-version}. If you are installing {SMProductName} on a xref:../../installing/overview/installing-preparing.adoc#supported-installation-methods-for-different-platforms[restricted network], follow the instructions for your chosen {product-title} infrastructure. ** xref:../../installing/installing_aws/ipi/installing-aws-default.adoc#installing-aws-default[Install {product-title} {product-version} on AWS] ** xref:../../installing/installing_aws/upi/installing-aws-user-infra.adoc#installing-aws-user-infra[Install {product-title} {product-version} on AWS with user-provisioned infrastructure] ** xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[Install {product-title} {product-version} on bare metal] diff --git a/updating/updating_a_cluster/migrating-to-multi-payload.adoc b/updating/updating_a_cluster/migrating-to-multi-payload.adoc index 0420a0052d..e0caf07b65 100644 --- a/updating/updating_a_cluster/migrating-to-multi-payload.adoc +++ b/updating/updating_a_cluster/migrating-to-multi-payload.adoc @@ -29,10 +29,10 @@ include::modules/migrating-to-multi-arch-cli.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources * xref:../../post_installation_configuration/configuring-multi-arch-compute-machines/multi-architecture-configuration.adoc#multi-architecture-configuration[Configuring multi-architecture compute machines on an {product-title} cluster] -* xref:../../post_installation_configuration/configuring-multi-arch-compute-machines/multiarch-tuning-operator.adoc#multiarch-tuning-operator[Managing workloads on multi-architecture clusters by using the Multiarch Tuning Operator]. +* xref:../../post_installation_configuration/configuring-multi-arch-compute-machines/multiarch-tuning-operator.adoc#multiarch-tuning-operator[Managing workloads on multi-architecture clusters by using the Multiarch Tuning Operator]. * xref:../../updating/updating_a_cluster/updating-cluster-web-console.adoc#updating-cluster-web-console[Updating a cluster using the web console] * xref:../../updating/updating_a_cluster/updating-cluster-cli.adoc#updating-cluster-cli[Updating a cluster using the CLI] * xref:../../updating/understanding_updates/intro-to-updates.adoc#understanding-clusterversion-conditiontypes_understanding-openshift-updates[Understanding cluster version condition types] * xref:../../updating/understanding_updates/understanding-update-channels-release.adoc#understanding-update-channels-releases[Understanding update channels and releases] -* xref:../../installing/installing-preparing.adoc#installing-preparing-selecting-cluster-type[Selecting a cluster installation type] +* xref:../../installing/overview/installing-preparing.adoc#installing-preparing-selecting-cluster-type[Selecting a cluster installation type] * xref:../../machine_management/deploying-machine-health-checks.adoc#machine-health-checks-about_deploying-machine-health-checks[About machine health checks] diff --git a/virt/install/preparing-cluster-for-virt.adoc b/virt/install/preparing-cluster-for-virt.adoc index 218e8d8c4b..e433b28390 100644 --- a/virt/install/preparing-cluster-for-virt.adoc +++ b/virt/install/preparing-cluster-for-virt.adoc @@ -28,7 +28,7 @@ endif::openshift-rosa,openshift-dedicated[] ifndef::openshift-rosa,openshift-dedicated[] .FIPS mode -If you install your cluster in xref:../../installing/installing-fips.adoc#installing-fips-mode_installing-fips[FIPS mode], no additional setup is required for {VirtProductName}. +If you install your cluster in xref:../../installing/overview/installing-fips.adoc#installing-fips-mode_installing-fips[FIPS mode], no additional setup is required for {VirtProductName}. endif::openshift-rosa,openshift-dedicated[] [id="supported-platforms_preparing-cluster-for-virt"] diff --git a/welcome/index.adoc b/welcome/index.adoc index c104c1bf3f..166f4b166a 100644 --- a/welcome/index.adoc +++ b/welcome/index.adoc @@ -70,7 +70,7 @@ ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] == Cluster installer activities Explore the following {product-title} installation tasks: -- **xref:../installing/index.adoc#ocp-installation-overview[{product-title} installation overview]**: Depending on the platform, you can install {product-title} on installer-provisioned or user-provisioned infrastructure. The {product-title} installation program provides the flexibility to deploy {product-title} on a range of different platforms. +- **xref:../installing/overview/index.adoc#ocp-installation-overview[{product-title} installation overview]**: Depending on the platform, you can install {product-title} on installer-provisioned or user-provisioned infrastructure. The {product-title} installation program provides the flexibility to deploy {product-title} on a range of different platforms. // PR open https://github.com/openshift/openshift-docs/pull/77474 //- **xref:../installing/installing_alibaba/installing-alibaba-assisted-installer[Installing a cluster on {alibaba} by using the Assisted Installer]**: On {alibaba}, you can install {product-title} by using the Assisted Installer. This is currently a Technology Preview feature only. @@ -148,7 +148,7 @@ xref:../installing/installing_ibm_cloud_public/preparing-to-install-on-ibm-cloud - **xref:../installing/installing_bare_metal/installing-bare-metal.adoc#rhcos-install-iscsi-manual_installing-bare-metal[Installing RHCOS manually on an iSCSI boot device] and xref:../installing/installing_bare_metal/installing-bare-metal.adoc#rhcos-install-iscsi-ibft_installing-bare-metal[Installing RHCOS on an iSCSI boot device using iBFT]**: You can target iSCSI devices as the root disk for installation of {op-system}. Multipathing is also supported. -- **xref:../installing/installing-troubleshooting.adoc#installing-troubleshooting[Check installation logs]**: Access installation logs to evaluate issues that occur during {product-title} installation. +- **xref:../installing/validation_and_troubleshooting/installing-troubleshooting.adoc#installing-troubleshooting[Check installation logs]**: Access installation logs to evaluate issues that occur during {product-title} installation. - **xref:../web_console/web-console.adoc#web-console[Access {product-title}]**: Use credentials output at the end of the installation process to log in to the {product-title} cluster from the command line or web console. diff --git a/welcome/learn_more_about_openshift.adoc b/welcome/learn_more_about_openshift.adoc index cd0d2a02d1..4c1c18f62b 100644 --- a/welcome/learn_more_about_openshift.adoc +++ b/welcome/learn_more_about_openshift.adoc @@ -41,7 +41,7 @@ Use the following sections to find content to help you learn about and use {prod |Learn about {product-title} |Deploy {product-title} |Manage {product-title} |Additional resources | link:https://www.openshift.com/blog/enterprise-kubernetes-with-openshift-part-one?extIdCarryOver=true&sc_cid=701f2000001Css5AAC[Enterprise Kubernetes with OpenShift] -| xref:../installing/installing-preparing.adoc#installing-preparing[Installing {product-title}] +| xref:../installing/overview/installing-preparing.adoc#installing-preparing[Installing {product-title}] | xref:../support/remote_health_monitoring/using-insights-to-identify-issues-with-your-cluster.adoc#using-insights-to-identify-issues-with-your-cluster[Using Insights to identify issues with your cluster] | xref:../support/getting-support.adoc#getting-support[Getting Support]