From f24f9c2e66a9da681b8c50476352d2cd531a9775 Mon Sep 17 00:00:00 2001 From: aburdenthehand Date: Fri, 12 Feb 2021 14:36:06 +0100 Subject: [PATCH] Revert "[enterprise-4.7] OSDOCS-1686 - Enhancing reader direction for OCP on AWS installations" --- _topic_map.yml | 53 +- architecture/architecture-installation.adoc | 11 +- architecture/cicd_gitops.adoc | 2 +- installing/index.adoc | 26 - .../configuring-private-cluster.adoc | 0 installing/install_config/customizations.adoc | 484 ++++++++++++++++++ .../install_config/installation-types.adoc | 144 ++++++ installing/installing-preparing.adoc | 146 +----- .../installing-aws-customizations.adoc | 10 +- .../installing-aws-default.adoc | 5 +- .../installing-aws-government-region.adoc | 5 +- ...installing-aws-network-customizations.adoc | 5 +- .../installing-aws-private.adoc | 5 +- .../installing-aws-user-infra.adoc | 2 +- .../installing_aws/installing-aws-vpc.adoc | 5 +- .../installing-restricted-networks-aws.adoc | 2 +- .../installing-azure-customizations.adoc | 2 +- .../installing-azure-default.adoc | 2 +- .../installing-azure-government-region.adoc | 2 +- ...stalling-azure-network-customizations.adoc | 2 +- .../installing-azure-private.adoc | 2 +- .../installing-azure-vnet.adoc | 2 +- ...ing-bare-metal-network-customizations.adoc | 2 +- .../installing-bare-metal.adoc | 2 +- ...alling-restricted-networks-bare-metal.adoc | 2 +- .../installing-gcp-customizations.adoc | 2 +- .../installing-gcp-default.adoc | 2 +- ...installing-gcp-network-customizations.adoc | 2 +- .../installing-gcp-private.adoc | 2 +- .../installing-gcp-user-infra-vpc.adoc | 2 +- .../installing-gcp-user-infra.adoc | 2 +- .../installing_gcp/installing-gcp-vpc.adoc | 2 +- .../installing-restricted-networks-gcp.adoc | 2 +- .../installing-ibm-power.adoc | 2 +- ...talling-restricted-networks-ibm-power.adoc | 2 +- .../installing-ibm-z-kvm.adoc | 2 +- .../installing_ibm_z/installing-ibm-z.adoc | 2 +- .../installing-restricted-networks-ibm-z.adoc | 2 +- ...installing-openstack-installer-custom.adoc | 2 +- .../installing-openstack-installer-kuryr.adoc | 2 +- ...alling-openstack-installer-restricted.adoc | 6 +- .../installing-openstack-installer.adoc | 2 +- .../installing-openstack-user-kuryr.adoc | 2 +- .../installing-openstack-user.adoc | 2 +- .../installing-rhv-customizations.adoc | 2 +- ...nstalling-restricted-networks-vsphere.adoc | 2 +- ...-installer-provisioned-customizations.adoc | 2 +- ...er-provisioned-network-customizations.adoc | 2 +- ...talling-vsphere-installer-provisioned.adoc | 2 +- ...alling-vsphere-network-customizations.adoc | 2 +- .../installing-vsphere.adoc | 2 +- modules/images-update-global-pull-secret.adoc | 3 +- modules/installation-initializing.adoc | 8 +- modules/installation-overview.adoc | 236 ++++++++- modules/installation-process.adoc | 96 ---- modules/nw-aws-nlb-new-cluster.adoc | 3 +- .../nw-modifying-operator-install-config.adoc | 2 +- modules/nw-operator-cr.adoc | 5 +- modules/private-clusters-about.adoc | 2 +- .../private-clusters-setting-api-private.adoc | 2 +- .../private-clusters-setting-dns-private.adoc | 2 +- ...vate-clusters-setting-ingress-private.adoc | 2 +- ...rted-platforms-for-openshift-clusters.adoc | 43 -- .../cluster-tasks.adoc | 483 ----------------- .../security-hosts-vms.adoc | 2 +- .../v1x/preparing-ossm-installation.adoc | 2 +- .../v2x/preparing-ossm-installation.adoc | 2 +- .../understanding-the-update-service.adoc | 9 - welcome/index.adoc | 2 - 69 files changed, 963 insertions(+), 920 deletions(-) delete mode 100644 installing/index.adoc rename {post_installation_configuration => installing/install_config}/configuring-private-cluster.adoc (100%) create mode 100644 installing/install_config/customizations.adoc create mode 100644 installing/install_config/installation-types.adoc delete mode 100644 modules/installation-process.adoc delete mode 100644 modules/supported-platforms-for-openshift-clusters.adoc delete mode 100644 updating/understanding-the-update-service.adoc diff --git a/_topic_map.yml b/_topic_map.yml index e63c44e97d..cbde5515b0 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -122,8 +122,6 @@ Name: Installing Dir: installing Distros: openshift-origin,openshift-enterprise,openshift-webscale Topics: -- Name: Installation overview - File: index - Name: Selecting an installation method and preparing a cluster File: installing-preparing - Name: Installing on AWS @@ -300,12 +298,20 @@ Topics: - Name: Installation configuration Dir: install_config Topics: + - Name: Supported installation methods for different platforms + File: installation-types - Name: Customizing nodes File: installing-customizing - Name: Creating a mirror registry for a restricted network File: installing-restricted-networks-preparations + - Name: Available cluster customizations + File: customizations + Distros: openshift-enterprise,openshift-webscale,openshift-origin - Name: Configuring your firewall File: configuring-firewall + - Name: Configuring a private cluster + Distros: openshift-enterprise,openshift-webscale,openshift-origin + File: configuring-private-cluster - Name: Validating an installation File: validating-an-installation - Name: Troubleshooting installation issues @@ -314,34 +320,10 @@ Topics: File: installing-fips Distros: openshift-enterprise,openshift-webscale,openshift-dedicated,openshift-online --- -Name: Post-installation configuration -Dir: post_installation_configuration -Distros: openshift-origin,openshift-enterprise,openshift-webscale -Topics: -- Name: Configuring a private cluster - Distros: openshift-enterprise,openshift-webscale,openshift-origin - File: configuring-private-cluster -- Name: Machine configuration tasks - File: machine-configuration-tasks -- Name: Cluster tasks - File: cluster-tasks -- Name: Node tasks - File: node-tasks -- Name: Network configuration - File: network-configuration -- Name: Storage configuration - File: storage-configuration -- Name: Preparing for users - File: preparing-for-users -- Name: Configuring alert notifications - File: configuring-alert-notifications ---- Name: Updating clusters Dir: updating Distros: openshift-origin,openshift-enterprise,openshift-webscale Topics: -- Name: Understanding the update service - File: understanding-the-update-service - Name: Updating a cluster between minor versions File: updating-cluster-between-minor - Name: Updating a cluster within a minor version from the web console @@ -357,6 +339,25 @@ Topics: # - Name: Troubleshooting an update # File: updating-troubleshooting --- +Name: Post-installation configuration +Dir: post_installation_configuration +Distros: openshift-origin,openshift-enterprise,openshift-webscale +Topics: +- Name: Machine configuration tasks + File: machine-configuration-tasks +- Name: Cluster tasks + File: cluster-tasks +- Name: Node tasks + File: node-tasks +- Name: Network configuration + File: network-configuration +- Name: Storage configuration + File: storage-configuration +- Name: Preparing for users + File: preparing-for-users +- Name: Configuring alert notifications + File: configuring-alert-notifications +--- Name: Support Dir: support Distros: openshift-enterprise,openshift-webscale,openshift-online,openshift-dedicated diff --git a/architecture/architecture-installation.adoc b/architecture/architecture-installation.adoc index 8f098fae2a..21f281fd39 100644 --- a/architecture/architecture-installation.adoc +++ b/architecture/architecture-installation.adoc @@ -6,18 +6,9 @@ toc::[] include::modules/installation-overview.adoc[leveloffset=+1] -include::modules/supported-platforms-for-openshift-clusters.adoc[leveloffset=+2] - -include::modules/installation-process.adoc[leveloffset=+2] - -[discrete] -=== Installation scope - -The scope of the {product-title} installation program is intentionally narrow. It is designed for simplicity and ensured success. You can complete many more configuration tasks after installation completes. - .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:../installing/install_config/customizations.adoc#customizations[Available cluster customizations] for details about {product-title} configuration resources. include::modules/update-service-overview.adoc[leveloffset=+1] diff --git a/architecture/cicd_gitops.adoc b/architecture/cicd_gitops.adoc index 8ddca5d567..36d0173a29 100644 --- a/architecture/cicd_gitops.adoc +++ b/architecture/cicd_gitops.adoc @@ -26,7 +26,7 @@ By using {product-title} to automate both your cluster configuration and contain With GitOps integration, you can declaratively configure and store your {product-title} cluster configuration -GitOps works well with {product-title} because you can both declaratively configure clusters and store the state of the cluster configuration in Git. For more information, see xref:../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Available cluster customizations]. +GitOps works well with {product-title} because you can both declaratively configure clusters and store the state of the cluster configuration in Git. For more information, see xref:../installing/install_config/customizations.adoc#customizations[Available cluster customizations]. [id="cicd_gitops_cluster_administration"] === GitOps for single-cluster and multi-cluster administration diff --git a/installing/index.adoc b/installing/index.adoc deleted file mode 100644 index 4b451ea6d1..0000000000 --- a/installing/index.adoc +++ /dev/null @@ -1,26 +0,0 @@ -[id="ocp-installation-overview"] -= {product-title} installation overview -include::modules/common-attributes.adoc[] -:context: ocp-installation-overview -toc::[] - -include::modules/installation-overview.adoc[leveloffset=+1] - -include::modules/installation-process.adoc[leveloffset=+2] - -[discrete] -=== Installation scope - -The scope of the {product-title} installation program is intentionally narrow. It is designed for simplicity and ensured success. You can complete many more configuration tasks after installation completes. - -.Additional resources - -* See xref:../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Available cluster customizations] for details about {product-title} configuration resources. - -include::modules/supported-platforms-for-openshift-clusters.adoc[leveloffset=+1] - -.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/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. diff --git a/post_installation_configuration/configuring-private-cluster.adoc b/installing/install_config/configuring-private-cluster.adoc similarity index 100% rename from post_installation_configuration/configuring-private-cluster.adoc rename to installing/install_config/configuring-private-cluster.adoc diff --git a/installing/install_config/customizations.adoc b/installing/install_config/customizations.adoc new file mode 100644 index 0000000000..62869599d2 --- /dev/null +++ b/installing/install_config/customizations.adoc @@ -0,0 +1,484 @@ +[id="customizations"] += Available cluster customizations +include::modules/common-attributes.adoc[] +:context: customizations +toc::[] + +You complete most of the cluster configuration and customization after you +deploy your {product-title} cluster. A number of +_configuration resources_ +//and _Custom Resources_ +are available. + +You modify the configuration resources to configure the major features of the +cluster, such as the image registry, networking configuration, image build +behavior, and the identity provider. + +For current documentation of the settings that you control by using these resources, use +the `oc explain` command, for example `oc explain builds --api-version=config.openshift.io/v1` + +[id="configuration-resources_{context}"] +== Cluster configuration resources + +All cluster configuration resources are globally scoped (not namespaced) and named `cluster`. +//// +Config changes should not require coordinated changes between config resources, if you find +yourself struggling to update these docs to explain coordinated changes, please reach out +to @api-approvers (github) or #forum-api-review (slack). +//// + +[cols="2a,8a",options="header"] +|=== +|Resource name +|Description + +|`apiserver.config.openshift.io` +|Provides API server configuration such as xref:../../security/certificates/api-server.adoc#api-server-certificates[certificates and certificate authorities]. + +|`authentication.config.openshift.io` +|Controls the xref:../../authentication/understanding-identity-provider.adoc#understanding-identity-provider[identity provider] and authentication configuration for the cluster. + +|`build.config.openshift.io` +|Controls default and enforced xref:../../cicd/builds/build-configuration.adoc#build-configuration[configuration] for all builds on the cluster. + +|`console.config.openshift.io` +|Configures the behavior of the web console interface, including the xref:../../web_console/configuring-web-console.adoc#configuring-web-console[logout behavior]. + +|`featuregate.config.openshift.io` +|Enables xref:../../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling[FeatureGates] +so that you can use Tech Preview features. + +|`image.config.openshift.io` +|Configures how specific xref:../../openshift_images/image-configuration.adoc#image-configuration[image registries] should be treated (allowed, disallowed, insecure, CA details). + +|`ingress.config.openshift.io` +|Configuration details related to xref:../../networking/ingress-operator.adoc#nw-installation-ingress-config-asset_configuring-ingress[routing] such as the default domain for routes. + +|`oauth.config.openshift.io` +|Configures identity providers and other behavior related to xref:../../authentication/configuring-internal-oauth.adoc#configuring-internal-oauth[internal OAuth server] flows. + +|`project.config.openshift.io` +|Configures xref:../../applications/projects/configuring-project-creation.adoc#configuring-project-creation[how projects are created] including the project template. + +|`proxy.config.openshift.io` +|Defines proxies to be used by components needing external network access. Note: not all components currently consume this value. + +|`scheduler.config.openshift.io` +|Configures xref:../../nodes/scheduling/nodes-scheduler-default.adoc#nodes-scheduler-default[scheduler] behavior such as policies and default node selectors. + +|=== + +[id="operator-configuration-resources_{context}"] +== Operator configuration resources + +These configuration resources are cluster-scoped instances, named `cluster`, which control the behavior of a specific component as +owned by a particular Operator. + +[cols="2a,8a",options="header"] +|=== +|Resource name +|Description + +|`consoles.operator.openshift.io` +|Controls console appearance such as branding customizations + +|`config.imageregistry.operator.openshift.io` +|Configures xref:../../registry/configuring-registry-operator.adoc#registry-operator-configuration-resource-overview_configuring-registry-operator[internal image registry settings] such as public routing, log levels, proxy settings, resource constraints, replica counts, and storage type. + +|`config.samples.operator.openshift.io` +|Configures the +xref:../../openshift_images/configuring-samples-operator.adoc#configuring-samples-operator[Samples Operator] +to control which example image streams and templates are installed on the cluster. + +|=== + + +[id="additional-configuration-resources_{context}"] +== Additional configuration resources + +These configuration resources represent a single instance of a particular component. In some cases, you can request multiple +instances by creating multiple instances of the resource. In other cases, the Operator can use only a specific +resource instance name in a specific namespace. Reference the component-specific +documentation for details on how and when you can create additional resource instances. + +[cols="2a,2a,2a,8a",options="header"] +|=== +|Resource name +|Instance name +|Namespace +|Description + +|`alertmanager.monitoring.coreos.com` +|`main` +|`openshift-monitoring` +|Controls the xref:../../monitoring/managing-alerts.adoc#managing-alerts[Alertmanager] deployment parameters. + +|`ingresscontroller.operator.openshift.io` +|`default` +|`openshift-ingress-operator` +|Configures xref:../../networking/ingress-operator.adoc#configuring-ingress[Ingress Operator] behavior such as domain, number of replicas, certificates, and controller placement. + +|=== + + +[id="informational-resources_{context}"] +== Informational Resources + +You use these resources to retrieve information about the cluster. Do not edit these resources directly. + +[cols="2a,2a,8a",options="header"] +|=== +|Resource name|Instance name|Description + +|`clusterversion.config.openshift.io` +|`version` +|In {product-title} {product-version}, you must not customize the `ClusterVersion` +resource for production clusters. Instead, follow the process to +xref:../../updating/updating-cluster.adoc#updating-cluster[update a cluster]. + +|`dns.config.openshift.io` +|`cluster` +|You cannot modify the DNS settings for your cluster. You can +xref:../../networking/dns-operator.adoc#dns-operator[view the DNS Operator status]. + +|`infrastructure.config.openshift.io` +|`cluster` +|Configuration details allowing the cluster to interact with its cloud provider. + +|`network.config.openshift.io` +|`cluster` +|You cannot modify your cluster networking after installation. To customize your network, follow the process to +xref:../../installing/installing_aws/installing-aws-network-customizations.adoc#installing-aws-network-customizations[customize networking during installation]. + +|=== + +include::modules/images-update-global-pull-secret.adoc[leveloffset=+1] + +//// +[id="default-crds_{context}"] +== Custom resources + +A number of Custom Resource Definitions (CRDs) are available for you to use to +further tune your {product-title} deployment. You can deploy Custom Resources +that are based on many of these CRDs to add more functionality to your +{product-title} cluster. + +.Default CRDs +[cols="2a,2a,8a,2a,2a",options="header"] +|=== +|Name +|Group +|Description +|Namespaced +|Can deploy CR + + +|Alertmanager +|monitoring.coreos.com +| +|Namespaced +| + +|Authentication +|config.openshift.io +| +|Global +| + +|Build +|config.openshift.io +| +|Global +| + +|CatalogSourceConfig +|operators.coreos.com +| +|Namespaced +| + +|CatalogSource +|operators.coreos.com +| +|Namespaced +| + +|ClusterAutoscaler +|autoscaling.openshift.io +| +|Global +|Yes + +|ClusterDNS +|dns.openshift.io +| +|Global +| + +|IngressController +|operator.openshift.io +| +|Namespaced +| + +|ClusterNetwork +|network.openshift.io +| +|Global +| + +|ClusterOperator +|config.openshift.io +| +|Global +| + +|ClusterOperator +|operatorstatus.openshift.io +| +|Namespaced +| + +|Cluster +|machine.openshift.io +| +|Namespaced +| + +|ClusterServiceVersion +|operators.coreos.com +| +|Namespaced +| + +|ClusterVersion +|config.openshift.io +| +|Global +| + +|Config +|imageregistry.operator.openshift.io +| +|Global +| + +|Config +|samples.operator.openshift.io +| +|Global +| + +|Console +|console.config.openshift.io +|The top-level configuration for the web console. +|Namespaced +|The console CR is created by default with more or less empty values. It honors +new values. If it is deleted, it recreates automatically. + +|ControllerConfig +|machineconfiguration.openshift.io +| +|Global +| + +|CredentialsRequest +|cloudcredential.openshift.io +| +|Namespaced +| + +|DNS +|config.openshift.io +| +|Global +| + +|EgressNetworkPolicy +|network.openshift.io +| +|Namespaced +| + +|HostSubnet +|network.openshift.io +| +|Global +| + +|Image +|config.openshift.io +| +|Global +| + +|Infrastructure +|config.openshift.io +| +|Global +| + +|Ingress +|config.openshift.io +| +|Global +| + +|InstallPlan +|operators.coreos.com +| +|Namespaced +| + +|KubeControllerManager +|operator.openshift.io +| +|Global +| + +|KubeletConfig +|machineconfiguration.openshift.io +| +|Global +| + +|MachineAutoscaler +|autoscaling.openshift.io +| +|Namespaced +|Yes + +|MachineClass +|machine.openshift.io +| +|Namespaced +| + +|MachineConfigPool +|machineconfiguration.openshift.io +| +|Global +| + +|MachineConfig +|machineconfiguration.openshift.io +| +|Global +| + +|MachineDeployment +|machine.openshift.io +| +|Namespaced +| + +|MachineHealthCheck +|healthchecking.openshift.io +| +|Namespaced +| + +|Machine +|machine.openshift.io +| +|Namespaced +| + +|MachineSet +|machine.openshift.io +| +|Namespaced +| + +|MCOConfig +|machineconfiguration.openshift.io +| +|Global +| + +|NetNamespace +|network.openshift.io +| +|Global +| + +|NetworkAttachmentDefinition +|k8s.cni.cncf.io +| +|Namespaced +| + +|NetworkConfig +|networkoperator.openshift.io +| +|Global +| + +|Network +|config.openshift.io +| +|Global +| + +|OAuth +|config.openshift.io +| +|Global +| + +|OpenShiftAPIServer +|operator.openshift.io +| +|Global +| + +|OpenShiftControllerManagerOperatorConfig +|openshiftcontrollermanager.operator.openshift.io +| +|Global +| + +|OperatorGroup +|operators.coreos.com +| +|Namespaced +| + +|Project +|config.openshift.io +| +|Global +| + +|Prometheus +|monitoring.coreos.com +| +|Namespaced +| + +|PrometheusRule +|monitoring.coreos.com +| +|Namespaced +| + +|ServiceCertSignerOperatorConfig +|servicecertsigner.config.openshift.io +| +|Global +| + +|ServiceMonitor +|monitoring.coreos.com +| +|Namespaced +| + +|Subscription +|operators.coreos.com +| +|Namespaced +| + +|=== +//// diff --git a/installing/install_config/installation-types.adoc b/installing/install_config/installation-types.adoc new file mode 100644 index 0000000000..d0dd7b072d --- /dev/null +++ b/installing/install_config/installation-types.adoc @@ -0,0 +1,144 @@ +[id="installation-types"] += Supported installation methods for different platforms +include::modules/common-attributes.adoc[] +:context: installation-types +toc::[] + +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. +==== + +.Installer-provisioned infrastructure options +|=== +||AWS |Azure |GCP |OpenStack | RHV |Bare metal |vSphere |IBM Z |IBM Power + +|Default +|xref:../../installing/installing_aws/installing-aws-default.adoc#installing-aws-default[X] +|xref:../../installing/installing_azure/installing-azure-default.adoc#installing-azure-default[X] +|xref:../../installing/installing_gcp/installing-gcp-default.adoc#installing-gcp-default[X] +| +|xref:../../installing/installing_rhv/installing-rhv-default.adoc#installing-rhv-default[X] +|xref:../../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install-overview[X] +|xref:../../installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc#installing-vsphere-installer-provisioned[X] +| +| + +|Custom +|xref:../../installing/installing_aws/installing-aws-customizations.adoc#installing-aws-customizations[X] +|xref:../../installing/installing_azure/installing-azure-customizations.adoc#installing-azure-customizations[X] +|xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[X] +|xref:../../installing/installing_openstack/installing-openstack-installer-custom.adoc#installing-openstack-installer-custom[X] +|xref:../../installing/installing_rhv/installing-rhv-customizations.adoc#installing-rhv-customizations[X] +| +|xref:../../installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc#installing-vsphere-installer-provisioned-customizations[X] +| +| + +|Network Operator +|xref:../../installing/installing_aws/installing-aws-network-customizations.adoc#installing-aws-network-customizations[X] +|xref:../../installing/installing_azure/installing-azure-network-customizations.adoc#installing-azure-network-customizations[X] +|xref:../../installing/installing_gcp/installing-gcp-network-customizations.adoc#installing-gcp-network-customizations[X] +| +| +| +| +| +| + +|Restricted network +| +| +| +|xref:../../installing/installing_openstack/installing-openstack-installer-restricted.adoc#installing-openstack-installer-restricted[X] +| +| +| +| +| + +|Private clusters +|xref:../../installing/installing_aws/installing-aws-private.adoc#installing-aws-private[X] +|xref:../../installing/installing_azure/installing-azure-private.adoc#installing-azure-private[X] +|xref:../../installing/installing_gcp/installing-gcp-private.adoc#installing-gcp-private[X] +| +| +| +| +| +| + +|Existing virtual private networks +|xref:../../installing/installing_aws/installing-aws-vpc.adoc#installing-aws-vpc[X] +|xref:../../installing/installing_azure/installing-azure-vnet.adoc#installing-azure-vnet[X] +|xref:../../installing/installing_gcp/installing-gcp-vpc.adoc#installing-gcp-vpc[X] +| +| +| +| +| +| + +|Government regions +|xref:../../installing/installing_aws/installing-aws-government-region.adoc#installing-aws-government-region[X] +|xref:../../installing/installing_azure/installing-azure-government-region.adoc#installing-azure-government-region[X] +| +| +| +| +| +| +| + +|=== + +.User-provisioned infrastructure options +|=== +||AWS |Azure |GCP |OpenStack | RHV |Bare metal |vSphere |IBM Z |IBM Power + +|Custom +|xref:../../installing/installing_aws/installing-aws-user-infra.adoc#installing-aws-user-infra[X] +|xref:../../installing/installing_azure/installing-azure-user-infra.adoc#installing-azure-user-infra[X] +|xref:../../installing/installing_gcp/installing-gcp-user-infra.adoc#installing-gcp-user-infra[X] +|xref:../../installing/installing_openstack/installing-openstack-user.adoc#installing-openstack-user[X] +|xref:../../installing/installing_rhv/installing-rhv-user-infra.adoc#installing-rhv-user-infra[X] +|xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[X] +|xref:../../installing/installing_vsphere/installing-vsphere.adoc#installing-vsphere[X] +|xref:../../installing/installing_ibm_z/installing-ibm-z.adoc#installing-ibm-z[X] +|xref:../../installing/installing_ibm_power/installing-ibm-power.adoc#installing-ibm-power[X] + +// Add RHV UPI link when docs are available: https://github.com/openshift/openshift-docs/pull/26484 + +|Network Operator +| +| +| +| +| +|xref:../../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installing-bare-metal-network-customizations[X] +|xref:../../installing/installing_vsphere/installing-vsphere-network-customizations.adoc#installing-vsphere-network-customizations[X] +| +| + +|Restricted network +|xref:../../installing/installing_aws/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[X] +| +|xref:../../installing/installing_gcp/installing-restricted-networks-gcp.adoc#installing-restricted-networks-gcp[X] +| +| +|xref:../../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[X] +|xref:../../installing/installing_vsphere/installing-restricted-networks-vsphere.adoc#installing-restricted-networks-vsphere[X] +|xref:../../installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc#installing-restricted-networks-ibm-z[X] +|xref:../../installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc#installing-restricted-networks-ibm-power[X] + +|=== + +//// +*If IBM Z is added to 4.5, replace the following in place of the | before Network Operator. Remove spaces after xref. +ifndef::openshift-origin[] +|xref: ../../installing/installing_ibm_z/installing-ibm-z.adoc#installing-ibm-z[X] +endif::[] +//// + diff --git a/installing/installing-preparing.adoc b/installing/installing-preparing.adoc index 8faa07a3e1..ff2707f41d 100644 --- a/installing/installing-preparing.adoc +++ b/installing/installing-preparing.adoc @@ -70,7 +70,7 @@ You can also configure the cluster machines to use xref:../installing/installing [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. +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:../installing/install_config/customizations.adoc#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 post-installation activities. For a production cluster, you must configure the following integrations: @@ -83,147 +83,3 @@ For a production cluster, you must configure the following integrations: == 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/cnf-performance-addon-operator-for-low-latency-nodes.adoc#cnf-performance-addon-operator-for-low-latency-nodes[low-latency] workloads or to xref:../nodes/pods/nodes-pods-secrets.adoc#nodes-pods-secrets[protect sensitive workloads]. You can also configure xref:../monitoring/enabling-monitoring-for-user-defined-projects.adoc#enabling-monitoring-for-user-defined-projects[monitoring] for application workloads. - -[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. -==== - -.Installer-provisioned infrastructure options -|=== -ifndef::openshift-origin[] -||AWS |Azure |GCP |OpenStack |RHV |Bare metal |vSphere |IBM Z |IBM Power -endif::openshift-origin[] -ifdef::openshift-origin[] -||AWS |Azure |GCP |OpenStack |oVirt |Bare metal |vSphere |IBM Z |IBM Power -endif::openshift-origin[] - -|Default -|xref:../installing/installing_aws/installing-aws-default.adoc#installing-aws-default[X] -|xref:../installing/installing_azure/installing-azure-default.adoc#installing-azure-default[X] -|xref:../installing/installing_gcp/installing-gcp-default.adoc#installing-gcp-default[X] -| -|xref:../installing/installing_rhv/installing-rhv-default.adoc#installing-rhv-default[X] -|xref:../installing/installing_bare_metal_ipi/ipi-install-overview.adoc#ipi-install-overview[X] -|xref:../installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc#installing-vsphere-installer-provisioned[X] -| -| - -|Custom -|xref:../installing/installing_aws/installing-aws-customizations.adoc#installing-aws-customizations[X] -|xref:../installing/installing_azure/installing-azure-customizations.adoc#installing-azure-customizations[X] -|xref:../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[X] -|xref:../installing/installing_openstack/installing-openstack-installer-custom.adoc#installing-openstack-installer-custom[X] -|xref:../installing/installing_rhv/installing-rhv-customizations.adoc#installing-rhv-customizations[X] -| -|xref:../installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc#installing-vsphere-installer-provisioned-customizations[X] -| -| - -|Network Operator -|xref:../installing/installing_aws/installing-aws-network-customizations.adoc#installing-aws-network-customizations[X] -|xref:../installing/installing_azure/installing-azure-network-customizations.adoc#installing-azure-network-customizations[X] -|xref:../installing/installing_gcp/installing-gcp-network-customizations.adoc#installing-gcp-network-customizations[X] -| -| -| -| -| -| - -|Restricted network -| -| -| -|xref:../installing/installing_openstack/installing-openstack-installer-restricted.adoc#installing-openstack-installer-restricted[X] -| -| -| -| -| - -|Private clusters -|xref:../installing/installing_aws/installing-aws-private.adoc#installing-aws-private[X] -|xref:../installing/installing_azure/installing-azure-private.adoc#installing-azure-private[X] -|xref:../installing/installing_gcp/installing-gcp-private.adoc#installing-gcp-private[X] -| -| -| -| -| -| - -|Existing virtual private networks -|xref:../installing/installing_aws/installing-aws-vpc.adoc#installing-aws-vpc[X] -|xref:../installing/installing_azure/installing-azure-vnet.adoc#installing-azure-vnet[X] -|xref:../installing/installing_gcp/installing-gcp-vpc.adoc#installing-gcp-vpc[X] -| -| -| -| -| -| - -|Government regions -|xref:../installing/installing_aws/installing-aws-government-region.adoc#installing-aws-government-region[X] -|xref:../installing/installing_azure/installing-azure-government-region.adoc#installing-azure-government-region[X] -| -| -| -| -| -| -| - -|=== - -.User-provisioned infrastructure options -|=== -ifndef::openshift-origin[] -||AWS |Azure |GCP |OpenStack |RHV |Bare metal |vSphere |IBM Z |IBM Power -endif::openshift-origin[] -ifdef::openshift-origin[] -||AWS |Azure |GCP |OpenStack |oVirt |Bare metal |vSphere |IBM Z |IBM Power -endif::openshift-origin[] - -|Custom -|xref:../installing/installing_aws/installing-aws-user-infra.adoc#installing-aws-user-infra[X] -|xref:../installing/installing_azure/installing-azure-user-infra.adoc#installing-azure-user-infra[X] -|xref:../installing/installing_gcp/installing-gcp-user-infra.adoc#installing-gcp-user-infra[X] -|xref:../installing/installing_openstack/installing-openstack-user.adoc#installing-openstack-user[X] -|xref:../installing/installing_rhv/installing-rhv-user-infra.adoc#installing-rhv-user-infra[X] -|xref:../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[X] -|xref:../installing/installing_vsphere/installing-vsphere.adoc#installing-vsphere[X] -|xref:../installing/installing_ibm_z/installing-ibm-z.adoc#installing-ibm-z[X] -|xref:../installing/installing_ibm_power/installing-ibm-power.adoc#installing-ibm-power[X] - -// Add RHV UPI link when docs are available: https://github.com/openshift/openshift-docs/pull/26484 - -|Network Operator -| -| -| -| -| -|xref:../installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc#installing-bare-metal-network-customizations[X] -|xref:../installing/installing_vsphere/installing-vsphere-network-customizations.adoc#installing-vsphere-network-customizations[X] -| -| - -|Restricted network -|xref:../installing/installing_aws/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[X] -| -|xref:../installing/installing_gcp/installing-restricted-networks-gcp.adoc#installing-restricted-networks-gcp[X] -| -| -|xref:../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[X] -|xref:../installing/installing_vsphere/installing-restricted-networks-vsphere.adoc#installing-restricted-networks-vsphere[X] -|xref:../installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc#installing-restricted-networks-ibm-z[X] -|xref:../installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc#installing-restricted-networks-ibm-power[X] - -|=== diff --git a/installing/installing_aws/installing-aws-customizations.adoc b/installing/installing_aws/installing-aws-customizations.adoc index 04814dc88e..65d7f3c237 100644 --- a/installing/installing_aws/installing-aws-customizations.adoc +++ b/installing/installing_aws/installing-aws-customizations.adoc @@ -10,11 +10,6 @@ cluster on infrastructure that the installation program provisions on Amazon Web Services (AWS). To customize the installation, you modify parameters in the `install-config.yaml` file before you install the cluster. -[NOTE] -==== -The scope of the {product-title} installation configurations is intentionally narrow. It is designed for simplicity and ensured success. You can complete many more {product-title} configuration tasks after an installation completes. -==== - == Prerequisites * Review details about the @@ -76,5 +71,6 @@ 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:../../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]. +* xref:../../installing/install_config/customizations.adoc#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_aws/installing-aws-default.adoc b/installing/installing_aws/installing-aws-default.adoc index 6cb5c63712..fcb2b69bc5 100644 --- a/installing/installing_aws/installing-aws-default.adoc +++ b/installing/installing_aws/installing-aws-default.adoc @@ -64,5 +64,6 @@ 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:../../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]. +* xref:../../installing/install_config/customizations.adoc#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_aws/installing-aws-government-region.adoc b/installing/installing_aws/installing-aws-government-region.adoc index 6596b7009f..beef2fa237 100644 --- a/installing/installing_aws/installing-aws-government-region.adoc +++ b/installing/installing_aws/installing-aws-government-region.adoc @@ -76,5 +76,6 @@ 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:../../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]. +* xref:../../installing/install_config/customizations.adoc#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_aws/installing-aws-network-customizations.adoc b/installing/installing_aws/installing-aws-network-customizations.adoc index 15446fdb5e..3c3799e7ef 100644 --- a/installing/installing_aws/installing-aws-network-customizations.adoc +++ b/installing/installing_aws/installing-aws-network-customizations.adoc @@ -99,5 +99,6 @@ 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:../../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]. +* xref:../../installing/install_config/customizations.adoc#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_aws/installing-aws-private.adoc b/installing/installing_aws/installing-aws-private.adoc index 9fd6a24c11..40c87841a8 100644 --- a/installing/installing_aws/installing-aws-private.adoc +++ b/installing/installing_aws/installing-aws-private.adoc @@ -74,5 +74,6 @@ 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:../../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]. +* xref:../../installing/install_config/customizations.adoc#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_aws/installing-aws-user-infra.adoc b/installing/installing_aws/installing-aws-user-infra.adoc index 897eb98ddb..85a0ddb646 100644 --- a/installing/installing_aws/installing-aws-user-infra.adoc +++ b/installing/installing_aws/installing-aws-user-infra.adoc @@ -179,5 +179,5 @@ 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:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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_aws/installing-aws-vpc.adoc b/installing/installing_aws/installing-aws-vpc.adoc index 524e106f81..fb824f2906 100644 --- a/installing/installing_aws/installing-aws-vpc.adoc +++ b/installing/installing_aws/installing-aws-vpc.adoc @@ -70,5 +70,6 @@ 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:../../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]. +* xref:../../installing/install_config/customizations.adoc#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_aws/installing-restricted-networks-aws.adoc b/installing/installing_aws/installing-restricted-networks-aws.adoc index b186d4dcc3..3c7e528e44 100644 --- a/installing/installing_aws/installing-restricted-networks-aws.adoc +++ b/installing/installing_aws/installing-restricted-networks-aws.adoc @@ -167,6 +167,6 @@ include::modules/logging-in-by-using-the-web-console.adoc[leveloffset=+1] == Next steps * xref:../../installing/validating-an-installation.adoc#validating-an-installation[Validate an installation]. -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster]. * If the mirror registry that you used to install your cluster has a trusted CA, add it to the cluster by xref:../../openshift_images/image-configuration.adoc#images-configuration-cas_image-configuration[configuring additional trust stores]. * If necessary, you can 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_azure/installing-azure-customizations.adoc b/installing/installing_azure/installing-azure-customizations.adoc index cb3caad619..cbb04b85a8 100644 --- a/installing/installing_azure/installing-azure-customizations.adoc +++ b/installing/installing_azure/installing-azure-customizations.adoc @@ -47,6 +47,6 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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_azure/installing-azure-default.adoc b/installing/installing_azure/installing-azure-default.adoc index 12a189eb88..ad83434136 100644 --- a/installing/installing_azure/installing-azure-default.adoc +++ b/installing/installing_azure/installing-azure-default.adoc @@ -36,6 +36,6 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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_azure/installing-azure-government-region.adoc b/installing/installing_azure/installing-azure-government-region.adoc index 2677dca20a..aeab318ae8 100644 --- a/installing/installing_azure/installing-azure-government-region.adoc +++ b/installing/installing_azure/installing-azure-government-region.adoc @@ -56,6 +56,6 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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_azure/installing-azure-network-customizations.adoc b/installing/installing_azure/installing-azure-network-customizations.adoc index 3d1c7e8a72..3cddf63d91 100644 --- a/installing/installing_azure/installing-azure-network-customizations.adoc +++ b/installing/installing_azure/installing-azure-network-customizations.adoc @@ -64,6 +64,6 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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_azure/installing-azure-private.adoc b/installing/installing_azure/installing-azure-private.adoc index 9744b397c0..c370a27d1f 100644 --- a/installing/installing_azure/installing-azure-private.adoc +++ b/installing/installing_azure/installing-azure-private.adoc @@ -51,6 +51,6 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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_azure/installing-azure-vnet.adoc b/installing/installing_azure/installing-azure-vnet.adoc index 11c13f8789..7ad2ad5247 100644 --- a/installing/installing_azure/installing-azure-vnet.adoc +++ b/installing/installing_azure/installing-azure-vnet.adoc @@ -45,6 +45,6 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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-network-customizations.adoc b/installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc index 19978a19ad..3a54dcb0a4 100644 --- a/installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc +++ b/installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc @@ -118,7 +118,7 @@ include::modules/installation-complete-user-infra.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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]. * xref:../../registry/configuring_registry_storage/configuring-registry-storage-baremetal.adoc#configuring-registry-storage-baremetal[Set up your registry and configure registry storage]. diff --git a/installing/installing_bare_metal/installing-bare-metal.adoc b/installing/installing_bare_metal/installing-bare-metal.adoc index c907692f35..6c337ee3de 100644 --- a/installing/installing_bare_metal/installing-bare-metal.adoc +++ b/installing/installing_bare_metal/installing-bare-metal.adoc @@ -133,7 +133,7 @@ include::modules/installation-complete-user-infra.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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]. * xref:../../registry/configuring_registry_storage/configuring-registry-storage-baremetal.adoc#configuring-registry-storage-baremetal[Set up your registry and configure registry storage]. diff --git a/installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc b/installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc index 4b8b73d9bd..7a155c30dd 100644 --- a/installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc +++ b/installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc @@ -139,7 +139,7 @@ include::modules/installation-complete-user-infra.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster]. * If the mirror registry that you used to install your cluster has a trusted CA, add it to the cluster by xref:../../openshift_images/image-configuration.adoc#images-configuration-cas_image-configuration[configuring additional trust stores]. * If necessary, you can 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_gcp/installing-gcp-customizations.adoc b/installing/installing_gcp/installing-gcp-customizations.adoc index 6f3fecd6cc..0f9d152fe2 100644 --- a/installing/installing_gcp/installing-gcp-customizations.adoc +++ b/installing/installing_gcp/installing-gcp-customizations.adoc @@ -52,6 +52,6 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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_gcp/installing-gcp-default.adoc b/installing/installing_gcp/installing-gcp-default.adoc index 91a9560f4a..b9be5d80e6 100644 --- a/installing/installing_gcp/installing-gcp-default.adoc +++ b/installing/installing_gcp/installing-gcp-default.adoc @@ -38,6 +38,6 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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_gcp/installing-gcp-network-customizations.adoc b/installing/installing_gcp/installing-gcp-network-customizations.adoc index 4d7c535e3a..bd05adcb6c 100644 --- a/installing/installing_gcp/installing-gcp-network-customizations.adoc +++ b/installing/installing_gcp/installing-gcp-network-customizations.adoc @@ -65,6 +65,6 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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_gcp/installing-gcp-private.adoc b/installing/installing_gcp/installing-gcp-private.adoc index ab7215449c..5d2936b794 100644 --- a/installing/installing_gcp/installing-gcp-private.adoc +++ b/installing/installing_gcp/installing-gcp-private.adoc @@ -55,6 +55,6 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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_gcp/installing-gcp-user-infra-vpc.adoc b/installing/installing_gcp/installing-gcp-user-infra-vpc.adoc index 6e12b532c2..dc6012f28d 100644 --- a/installing/installing_gcp/installing-gcp-user-infra-vpc.adoc +++ b/installing/installing_gcp/installing-gcp-user-infra-vpc.adoc @@ -139,6 +139,6 @@ include::modules/installation-gcp-user-infra-completing.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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_gcp/installing-gcp-user-infra.adoc b/installing/installing_gcp/installing-gcp-user-infra.adoc index ebe6ec5052..145cff02f4 100644 --- a/installing/installing_gcp/installing-gcp-user-infra.adoc +++ b/installing/installing_gcp/installing-gcp-user-infra.adoc @@ -90,5 +90,5 @@ include::modules/installation-gcp-user-infra-completing.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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_gcp/installing-gcp-vpc.adoc b/installing/installing_gcp/installing-gcp-vpc.adoc index aa8a587a1d..c753484fd2 100644 --- a/installing/installing_gcp/installing-gcp-vpc.adoc +++ b/installing/installing_gcp/installing-gcp-vpc.adoc @@ -49,6 +49,6 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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_gcp/installing-restricted-networks-gcp.adoc b/installing/installing_gcp/installing-restricted-networks-gcp.adoc index 395a52954e..7029dc972a 100644 --- a/installing/installing_gcp/installing-restricted-networks-gcp.adoc +++ b/installing/installing_gcp/installing-restricted-networks-gcp.adoc @@ -89,6 +89,6 @@ include::modules/installation-gcp-user-infra-completing.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster]. * If the mirror registry that you used to install your cluster has a trusted CA, add it to the cluster by xref:../../openshift_images/image-configuration.adoc#images-configuration-cas_image-configuration[configuring additional trust stores]. * If necessary, you can 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_ibm_power/installing-ibm-power.adoc b/installing/installing_ibm_power/installing-ibm-power.adoc index a4f385487a..0cf4117257 100644 --- a/installing/installing_ibm_power/installing-ibm-power.adoc +++ b/installing/installing_ibm_power/installing-ibm-power.adoc @@ -87,6 +87,6 @@ include::modules/installation-complete-user-infra.adoc[leveloffset=+1] .Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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_ibm_power/installing-restricted-networks-ibm-power.adoc b/installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc index 3a5021baaf..9ba06f0e0f 100644 --- a/installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc +++ b/installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc @@ -97,5 +97,5 @@ include::modules/installation-complete-user-infra.adoc[leveloffset=+1] .Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster]. * If the mirror registry that you used to install your cluster has a trusted CA, add it to the cluster by xref:../../openshift_images/image-configuration.adoc#images-configuration-cas_image-configuration[configuring additional trust stores]. diff --git a/installing/installing_ibm_z/installing-ibm-z-kvm.adoc b/installing/installing_ibm_z/installing-ibm-z-kvm.adoc index b29c68edfe..58533a9dac 100644 --- a/installing/installing_ibm_z/installing-ibm-z-kvm.adoc +++ b/installing/installing_ibm_z/installing-ibm-z-kvm.adoc @@ -89,7 +89,7 @@ include::modules/installation-ibm-z-troubleshooting-and-debugging.adoc[leveloffs == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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_ibm_z/installing-ibm-z.adoc b/installing/installing_ibm_z/installing-ibm-z.adoc index 55b81abdc7..8879b15864 100644 --- a/installing/installing_ibm_z/installing-ibm-z.adoc +++ b/installing/installing_ibm_z/installing-ibm-z.adoc @@ -94,7 +94,7 @@ include::modules/installation-ibm-z-troubleshooting-and-debugging.adoc[leveloffs == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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_ibm_z/installing-restricted-networks-ibm-z.adoc b/installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc index 48b8b6eb9e..d755fee06d 100644 --- a/installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc +++ b/installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc @@ -98,5 +98,5 @@ include::modules/installation-ibm-z-troubleshooting-and-debugging.adoc[leveloffs .Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster]. * If the mirror registry that you used to install your cluster has a trusted CA, add it to the cluster by xref:../../openshift_images/image-configuration.adoc#images-configuration-cas_image-configuration[configuring additional trust stores]. diff --git a/installing/installing_openstack/installing-openstack-installer-custom.adoc b/installing/installing_openstack/installing-openstack-installer-custom.adoc index 41fc9f8328..7b51b62250 100644 --- a/installing/installing_openstack/installing-openstack-installer-custom.adoc +++ b/installing/installing_openstack/installing-openstack-installer-custom.adoc @@ -44,7 +44,7 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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 you need to enable external access to node ports, xref:../../networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-nodeport.adoc#nw-using-nodeport_configuring-ingress-cluster-traffic-nodeport[configure ingress cluster traffic by using a node port]. diff --git a/installing/installing_openstack/installing-openstack-installer-kuryr.adoc b/installing/installing_openstack/installing-openstack-installer-kuryr.adoc index 3e7263c8f8..00d576a77e 100644 --- a/installing/installing_openstack/installing-openstack-installer-kuryr.adoc +++ b/installing/installing_openstack/installing-openstack-installer-kuryr.adoc @@ -49,7 +49,7 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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 you need to enable external access to node ports, xref:../../networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-nodeport.adoc#nw-using-nodeport_configuring-ingress-cluster-traffic-nodeport[configure ingress cluster traffic by using a node port]. diff --git a/installing/installing_openstack/installing-openstack-installer-restricted.adoc b/installing/installing_openstack/installing-openstack-installer-restricted.adoc index dd1076c3f1..1ffe1320c7 100644 --- a/installing/installing_openstack/installing-openstack-installer-restricted.adoc +++ b/installing/installing_openstack/installing-openstack-installer-restricted.adoc @@ -21,7 +21,7 @@ to complete all installation steps. * Review details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update processes]. -** Verify that {product-title} {product-version} is compatible with your {rh-openstack} version by consulting the architecture documentation's xref:../../architecture/architecture-installation.adoc#supported-platforms-for-openshift-clusters_architecture-installation[list of available platforms]. 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]. +** Verify that {product-title} {product-version} is compatible with your {rh-openstack} version by consulting the architecture documentation's xref:../../architecture/architecture-installation.html#available-platforms_architecture-installation[list of available platforms]. 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]. * Verify that your network configuration does not rely on a provider network. Provider networks are not supported. @@ -48,9 +48,9 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] .Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster]. * If the mirror registry that you used to install your cluster has a trusted CA, add it to the cluster by xref:../../openshift_images/image-configuration.adoc#images-configuration-cas_image-configuration[configuring additional trust stores]. * If necessary, you can 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]. -* Learn how to xref:../../operators/admin/olm-restricted-networks.adoc#olm-understanding-operator-catalog-images_olm-restricted-networks[use Operator Lifecycle Manager (OLM) on restricted networks]. +* Learn how to xref:../../operators/admin/olm-restricted-networks.html#olm-understanding-operator-catalog-images_olm-restricted-networks[use Operator Lifecycle Manager (OLM) on restricted networks]. * If you did not configure {rh-openstack} to accept application traffic over floating IP addresses, xref:../../post_installation_configuration/network-configuration.adoc#installation-osp-configuring-api-floating-ip_post-install-network-configuration[configure {rh-openstack} access with floating IP addresses]. diff --git a/installing/installing_openstack/installing-openstack-installer.adoc b/installing/installing_openstack/installing-openstack-installer.adoc index 83727707d5..673839abb5 100644 --- a/installing/installing_openstack/installing-openstack-installer.adoc +++ b/installing/installing_openstack/installing-openstack-installer.adoc @@ -38,6 +38,6 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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_openstack/installing-openstack-user-kuryr.adoc b/installing/installing_openstack/installing-openstack-user-kuryr.adoc index d9cfb1c413..44aea42c9d 100644 --- a/installing/installing_openstack/installing-openstack-user-kuryr.adoc +++ b/installing/installing_openstack/installing-openstack-user-kuryr.adoc @@ -65,7 +65,7 @@ include::modules/installation-osp-verifying-installation.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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 you need to enable external access to node ports, xref:../../networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-nodeport.adoc#nw-using-nodeport_configuring-ingress-cluster-traffic-nodeport[configure ingress cluster traffic by using a node port]. diff --git a/installing/installing_openstack/installing-openstack-user.adoc b/installing/installing_openstack/installing-openstack-user.adoc index bb1b0dcacf..e411d31472 100644 --- a/installing/installing_openstack/installing-openstack-user.adoc +++ b/installing/installing_openstack/installing-openstack-user.adoc @@ -63,7 +63,7 @@ include::modules/installation-osp-verifying-installation.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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 you need to enable external access to node ports, xref:../../networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-nodeport.adoc#nw-using-nodeport_configuring-ingress-cluster-traffic-nodeport[configure ingress cluster traffic by using a node port]. diff --git a/installing/installing_rhv/installing-rhv-customizations.adoc b/installing/installing_rhv/installing-rhv-customizations.adoc index 012ba21c98..6ed515119e 100644 --- a/installing/installing_rhv/installing-rhv-customizations.adoc +++ b/installing/installing_rhv/installing-rhv-customizations.adoc @@ -89,6 +89,6 @@ After the {product-title} cluster initializes, you can perform the following tas == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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_vsphere/installing-restricted-networks-vsphere.adoc b/installing/installing_vsphere/installing-restricted-networks-vsphere.adoc index 006c3ef849..1733a15748 100644 --- a/installing/installing_vsphere/installing-restricted-networks-vsphere.adoc +++ b/installing/installing_vsphere/installing-restricted-networks-vsphere.adoc @@ -98,7 +98,7 @@ include::modules/persistent-storage-vsphere-backup.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster]. * If the mirror registry that you used to install your cluster has a trusted CA, add it to the cluster by xref:../../openshift_images/image-configuration.adoc#images-configuration-cas_image-configuration[configuring additional trust stores]. * If necessary, you can 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_vsphere/installing-vsphere-installer-provisioned-customizations.adoc b/installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc index e725cf2c01..31c348ff46 100644 --- a/installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc +++ b/installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc @@ -68,7 +68,7 @@ include::modules/persistent-storage-vsphere-backup.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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]. * xref:../../registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc#configuring-registry-storage-vsphere[Set up your registry and configure registry storage]. diff --git a/installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc b/installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc index 07917c3229..3467978bdf 100644 --- a/installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc +++ b/installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc @@ -78,7 +78,7 @@ include::modules/persistent-storage-vsphere-backup.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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]. * xref:../../registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc#configuring-registry-storage-vsphere[Set up your registry and configure registry storage]. diff --git a/installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc b/installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc index 7639b1c3af..28eb5b4771 100644 --- a/installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc +++ b/installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc @@ -62,7 +62,7 @@ include::modules/persistent-storage-vsphere-backup.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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]. * xref:../../registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc#configuring-registry-storage-vsphere[Set up your registry and configure registry storage]. diff --git a/installing/installing_vsphere/installing-vsphere-network-customizations.adoc b/installing/installing_vsphere/installing-vsphere-network-customizations.adoc index 33c31c756f..73fa9e744a 100644 --- a/installing/installing_vsphere/installing-vsphere-network-customizations.adoc +++ b/installing/installing_vsphere/installing-vsphere-network-customizations.adoc @@ -87,7 +87,7 @@ include::modules/persistent-storage-vsphere-backup.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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]. * xref:../../registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc#configuring-registry-storage-vsphere[Set up your registry and configure registry storage]. diff --git a/installing/installing_vsphere/installing-vsphere.adoc b/installing/installing_vsphere/installing-vsphere.adoc index 567da52c62..d6d3d59fb4 100644 --- a/installing/installing_vsphere/installing-vsphere.adoc +++ b/installing/installing_vsphere/installing-vsphere.adoc @@ -91,7 +91,7 @@ include::modules/persistent-storage-vsphere-backup.adoc[leveloffset=+1] == Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. +* xref:../../installing/install_config/customizations.adoc#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]. * xref:../../registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc#configuring-registry-storage-vsphere[Set up your registry and configure registry storage]. diff --git a/modules/images-update-global-pull-secret.adoc b/modules/images-update-global-pull-secret.adoc index fb32b3934e..e10059d5e4 100644 --- a/modules/images-update-global-pull-secret.adoc +++ b/modules/images-update-global-pull-secret.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // * openshift_images/managing_images/using-image-pull-secrets.adoc -// * post_installation_configuration/cluster-tasks.adoc -// * support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc +// * installing/install_config/customizations.adoc // // Not included, but linked to from: // * operators/admin/olm-managing-custom-catalogs.adoc diff --git a/modules/installation-initializing.adoc b/modules/installation-initializing.adoc index c55cd79c59..0e2020ce7b 100644 --- a/modules/installation-initializing.adoc +++ b/modules/installation-initializing.adoc @@ -2,22 +2,24 @@ // // * installing/installing_aws/installing-aws-customizations.adoc // * installing/installing_aws/installing-aws-network-customizations.adoc +// * installing/installing_aws/installing-aws-private.adoc // * installing/installing_aws/installing-aws-vpc.adoc // * installing/installing_azure/installing-azure-customizations.adoc // * installing/installing_azure/installing-azure-network-customizations +// * installing/installing_azure/installing-azure-private.adoc // * installing/installing_azure/installing-azure-vnet.adoc // * installing/installing_azure/installing-azure-user-infra.adoc // * installing/installing_gcp/installing-gcp-customizations.adoc +// * installing/installing_gcp/installing-gcp-private.adoc // * installing/installing_gcp/installing-gcp-network-customizations.adoc // * installing/installing_gcp/installing-gcp-vpc.adoc // * installing/installing_gcp/installing-gcp-user-infra.adoc // * installing/installing_gcp/installing-restricted-networks-gcp.adoc // * installing/installing_openstack/installing-openstack-installer-custom.adoc // * installing/installing_openstack/installing-openstack-installer-kuryr.adoc -// * installing/installing_openstack/installing-openstack-installer-restricted.adoc -// * installing/installing_openstack/installing-openstack-user-kuryr.adoc -// * installing/installing_openstack/installing-openstack-user.adoc +// * installing/installing_openstack/installing-openstack-installer-user.adoc // * installing/installing_rhv/installing-rhv-customizations.adoc +// * installing/installing_rhv/installing-rhv-default.adoc // * installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc // * installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc diff --git a/modules/installation-overview.adoc b/modules/installation-overview.adoc index 292786563d..d11cf72180 100644 --- a/modules/installation-overview.adoc +++ b/modules/installation-overview.adoc @@ -1,6 +1,5 @@ // Module included in the following assemblies: // -// * installing/index.adoc // * architecture/architecture-installation.adoc [id="installation-overview_{context}"] @@ -8,11 +7,14 @@ The {product-title} installation program offers you flexibility. You can use the installation program to deploy a cluster on infrastructure that the installation program provisions and the cluster maintains or deploy a cluster on infrastructure that you prepare and maintain. -These two basic types of {product-title} clusters are frequently called installer-provisioned infrastructure clusters and user-provisioned infrastructure clusters. +These two basic types of {product-title} clusters are frequently called +installer-provisioned infrastructure clusters and user-provisioned +infrastructure clusters. Both types of clusters have the following characteristics: -* Highly available infrastructure with no single points of failure is available by default +* Highly available infrastructure with no single points of failure is available +by default * Administrators maintain control over what updates are applied and when You use the same installation program to deploy both types of clusters. The main assets generated by the installation program are the Ignition config files for the bootstrap, master, and worker machines. With these three configurations and correctly configured infrastructure, you can start an {product-title} cluster. @@ -26,6 +28,230 @@ image::targets-and-dependencies.png[{product-title} installation targets and dep After installation, each cluster machine uses {op-system-first} as the operating system. {op-system} is the immutable container host version of {op-system-base-full} and features a {op-system-base} kernel with SELinux enabled by default. It includes the `kubelet`, which is the Kubernetes node agent, and the CRI-O container runtime, which is optimized for Kubernetes. -Every control plane machine in an {product-title} {product-version} cluster must use {op-system}, which includes a critical first-boot provisioning tool called Ignition. This tool enables the cluster to configure the machines. Operating system updates are delivered as an Atomic OSTree repository that is embedded in a container image that is rolled out across the cluster by an Operator. Actual operating system changes are made in-place on each machine as an atomic operation by using rpm-ostree. Together, these technologies enable {product-title} to manage the operating system like it manages any other application on the cluster, via in-place upgrades that keep the entire platform up-to-date. These in-place updates can reduce the burden on operations teams. +Every control plane machine in an {product-title} {product-version} cluster must +use {op-system}, which includes a critical first-boot provisioning tool called +Ignition. This tool enables the cluster to configure the machines. +Operating system updates are delivered as an Atomic OSTree repository that is +embedded in a container image that is rolled out across the cluster by an +Operator. Actual operating system changes are made in-place on each machine as +an atomic operation by using rpm-ostree. Together, these technologies enable +{product-title} to manage the operating system like it manages any other +application on the cluster, via in-place upgrades that keep the entire platform +up-to-date. These in-place updates can reduce the burden on operations teams. -If you use {op-system} as the operating system for all cluster machines, the cluster manages all aspects of its components and machines, including the operating system. Because of this, only the installation program and the Machine Config Operator can change machines. The installation program uses Ignition config files to set the exact state of each machine, and the Machine Config Operator completes more changes to the machines, such as the application of new certificates or keys, after installation. +If you use {op-system} as the operating system for all cluster machines, the +cluster manages all aspects of its components and machines, including the +operating system. Because of this, only the installation program and the +Machine Config Operator can change machines. The installation program uses +Ignition config files to set the exact state of each machine, and the Machine +Config Operator completes more changes to the machines, such as the application +of new certificates or keys, after installation. + +[id="available-platforms_{context}"] +== Available platforms + +In {product-title} {product-version}, you can install a cluster that uses +installer-provisioned infrastructure on the following platforms: + +* Amazon Web Services (AWS) +* Google Cloud Platform (GCP) +* Microsoft Azure +* {rh-openstack-first} version 13 and 16 +** The latest {product-title} release supports both the latest {rh-openstack} long-life release and intermediate release. For complete {rh-openstack} release compatibility, see the link:https://access.redhat.com/articles/4679401[{product-title} on {rh-openstack} support matrix]. +* {rh-virtualization-first} +* VMware vSphere + +For these clusters, all machines, including the computer that you run the installation process on, must have direct internet access to pull images for platform containers and provide telemetry data to Red Hat. + +[IMPORTANT] +==== +After installation, the following changes are not supported: + +* Mixing cloud provider platforms +* Mixing cloud provider components, such as using a persistent storage framework from a differing platform than what the cluster is installed on +==== + +In {product-title} {product-version}, you can install a cluster that uses +user-provisioned infrastructure on the following platforms: + +* AWS +* Azure +* GCP +* {rh-openstack} +* {rh-virtualization} +* VMware vSphere +* Bare metal +* IBM Z or LinuxONE +* IBM Power Systems + +With installations on user-provisioned infrastructure, each machine can have full internet access, you can place your cluster behind a proxy, or you can perform a _restricted network installation_. In a restricted network installation, you can download the images that are required to install a cluster, place them in a mirror registry, and use that data to install your cluster. While you require internet access to pull images for platform containers, with a restricted network installation on vSphere or bare metal infrastructure, your cluster machines do not require direct internet access. + +The link:https://access.redhat.com/articles/4128421[OpenShift Container Platform 4.x Tested Integrations] +page contains details about integration testing for different platforms. + +[id="installation-process_{context}"] +== Installation process + +When you install an {product-title} cluster, you download the +installation program from +ifndef::openshift-origin[] +the appropriate +link:https://cloud.redhat.com/openshift/install[Infrastructure Provider] +page on the {cloud-redhat-com} site. This site manages: + +* REST API for accounts +* Registry tokens, which are the pull secrets that you use to obtain the required +components +* Cluster registration, which associates the cluster identity to your Red Hat +account to facilitate the gathering of usage metrics +endif::[] +ifdef::openshift-origin[] +https://github.com/openshift/okd/releases +endif::[] + +In {product-title} {product-version}, the installation program is a Go binary file that performs a +series of file transformations on a set of assets. The way you interact with the +installation program differs depending on your installation type. + +* For clusters with installer-provisioned infrastructure, you delegate the +infrastructure bootstrapping and provisioning to the installation program +instead of doing it yourself. The installation program creates all of the +networking, machines, and operating systems that are required to support the +cluster. + +* If you provision and manage the infrastructure for your cluster, you must +provide all of the cluster infrastructure and resources, including the +bootstrap machine, networking, load balancing, storage, and individual cluster +machines. + +You use three sets of files during installation: an installation configuration +file that is named `install-config.yaml`, Kubernetes manifests, and Ignition +config files for your machine types. + +[IMPORTANT] +==== +It is possible to modify Kubernetes and the Ignition config files that control +the underlying {op-system} operating system during installation. However, +no validation is available to confirm the suitability of any modifications that +you make to these objects. If you modify these objects, you might render +your cluster non-functional. Because of this risk, modifying Kubernetes and +Ignition config files is not supported unless you are following documented procedures +or are instructed to do so by Red Hat support. +==== + +The installation configuration file is transformed into Kubernetes manifests, and +then the manifests are wrapped into Ignition config files. The installation program uses +these Ignition config files to create the cluster. + +The installation configuration files are all pruned when you run the installation program, +so be sure to back up all configuration files that you want to use again. + +[IMPORTANT] +==== +You cannot modify the parameters that you set during installation, but you can +modify many cluster attributes after installation. +==== + +[discrete] +=== The installation process with installer-provisioned infrastructure + +The default installation type uses installer-provisioned infrastructure. By default, the installation +program acts as an installation wizard, prompting you +for values that it cannot determine on its own and providing reasonable default +values for the remaining parameters. You can also customize the installation +process to support advanced infrastructure scenarios. The installation program provisions +the underlying infrastructure for the cluster. + +You can install either a standard cluster or a customized cluster. With a +standard cluster, you provide minimum details that are required to install the +cluster. With a customized cluster, you can specify more details about the +platform, such as the number of machines that the control plane uses, the type +of virtual machine that the cluster deploys, or the CIDR range for the +Kubernetes service network. + +If possible, use this feature to avoid +having to provision and maintain the cluster infrastructure. In all other +environments, you use the installation program to generate the assets that you require to +provision your cluster infrastructure. + +With installer-provisioned infrastructure clusters, {product-title} manages all aspects of +the cluster, including the operating system itself. Each machine boots with a +configuration that references resources hosted in the cluster that it joins. +This configuration allows the cluster to manage itself as updates are applied. + +[discrete] +=== The installation process with user-provisioned infrastructure + +You can also install {product-title} on infrastructure that you provide. You use the +installation program to generate the assets that you require to provision the +cluster infrastructure, create the cluster infrastructure, and then deploy +the cluster to the infrastructure that you provided. + +If you do not use infrastructure that the installation program provisioned, you must manage +and maintain the cluster resources yourself, including: + +* The underlying infrastructure for the control plane and compute machines that make up the cluster +* Load balancers +* Cluster networking, including the DNS records and required subnets +* Storage for the cluster infrastructure and applications + +If your cluster uses user-provisioned infrastructure, you have the option of +adding RHEL worker machines to your cluster. + +[discrete] +=== Installation process details + +Because each machine in the cluster requires information about the cluster when +it is provisioned, {product-title} uses a temporary _bootstrap_ machine during +initial configuration to provide the required information to the permanent +control plane. It boots by using an Ignition config file that describes how to +create the cluster. The bootstrap machine creates the master machines that +make up the control plane. The control plane machines then create the compute machines, which are also known as worker machines. The following figure illustrates this process: + +.Creating the bootstrap, master, and worker machines +image::create-nodes.png[Creating bootstrap, master, and worker machines] + +After the cluster machines initialize, the bootstrap machine is destroyed. +All clusters use the bootstrap process to initialize the +cluster, but if you provision the infrastructure for your cluster, you must +complete many of the steps manually. + +[IMPORTANT] +==== +The Ignition config files that the installation program generates contain certificates that expire after 24 hours, which are then renewed at that time. If the cluster is shut down before renewing the certificates and the cluster is later restarted after the 24 hours have elapsed, the cluster automatically recovers the expired certificates. The exception is that you must manually approve the pending `node-bootstrapper` certificate signing requests (CSRs) to recover kubelet certificates. See the documentation for _Recovering from expired control plane certificates_ for more information. +==== + +Bootstrapping a cluster involves the following steps: + +. The bootstrap machine boots and starts hosting the remote resources required +for the master machines to boot. (Requires manual intervention if you provision + the infrastructure) +. The master machines fetch the remote resources from the bootstrap machine +and finish booting. (Requires manual intervention if you provision the + infrastructure) +. The master machines use the bootstrap machine to form an etcd cluster. +. The bootstrap machine starts a temporary Kubernetes control plane using the +new etcd cluster. +. The temporary control plane schedules the production control plane to the +master machines. +. The temporary control plane shuts down and passes control to the production +control plane. +. The bootstrap machine injects {product-title} components into the production +control plane. +. The installation program shuts down the bootstrap machine. +(Requires manual intervention if you provision the infrastructure) +. The control plane sets up the worker nodes. +. The control plane installs additional services in the form of a set +of Operators. + +The result of this bootstrapping process is a fully running {product-title} +cluster. The cluster then downloads and configures remaining components +needed for the day-to-day operation, including the creation of worker machines +in supported environments. + +[discrete] +== Installation scope + +The scope of the {product-title} installation program is intentionally narrow. +It is designed for simplicity and ensured success. You can complete many +more configuration tasks after installation completes. diff --git a/modules/installation-process.adoc b/modules/installation-process.adoc deleted file mode 100644 index ffaede947e..0000000000 --- a/modules/installation-process.adoc +++ /dev/null @@ -1,96 +0,0 @@ -// Module included in the following assemblies: -// -// * installing/index.adoc -// * architecture/architecture-installation.adoc - -[id="installation-process_{context}"] -= Installation process - -When you install an {product-title} cluster, you download the installation program from -ifndef::openshift-origin[] -the appropriate link:https://cloud.redhat.com/openshift/install[Infrastructure Provider] page on the {cloud-redhat-com} site. This site manages: - -* REST API for accounts -* Registry tokens, which are the pull secrets that you use to obtain the required components -* Cluster registration, which associates the cluster identity to your Red Hat account to facilitate the gathering of usage metrics -endif::[] -ifdef::openshift-origin[] -https://github.com/openshift/okd/releases. -endif::[] - -In {product-title} {product-version}, the installation program is a Go binary file that performs a series of file transformations on a set of assets. The way you interact with the installation program differs depending on your installation type. - -* For clusters with installer-provisioned infrastructure, you delegate the infrastructure bootstrapping and provisioning to the installation program instead of doing it yourself. The installation program creates all of the networking, machines, and operating systems that are required to support the cluster. - -* If you provision and manage the infrastructure for your cluster, you must provide all of the cluster infrastructure and resources, including the bootstrap machine, networking, load balancing, storage, and individual cluster machines. - -You use three sets of files during installation: an installation configuration file that is named `install-config.yaml`, Kubernetes manifests, and Ignition config files for your machine types. - -[IMPORTANT] -==== -It is possible to modify Kubernetes and the Ignition config files that control the underlying {op-system} operating system during installation. However, no validation is available to confirm the suitability of any modifications that you make to these objects. If you modify these objects, you might render your cluster non-functional. Because of this risk, modifying Kubernetes and Ignition config files is not supported unless you are following documented procedures or are instructed to do so by Red Hat support. -==== - -The installation configuration file is transformed into Kubernetes manifests, and then the manifests are wrapped into Ignition config files. The installation program uses these Ignition config files to create the cluster. - -The installation configuration files are all pruned when you run the installation program, so be sure to back up all configuration files that you want to use again. - -[IMPORTANT] -==== -You cannot modify the parameters that you set during installation, but you can modify many cluster attributes after installation. -==== - -[discrete] -== The installation process with installer-provisioned infrastructure - -The default installation type uses installer-provisioned infrastructure. By default, the installation program acts as an installation wizard, prompting you for values that it cannot determine on its own and providing reasonable default values for the remaining parameters. You can also customize the installation process to support advanced infrastructure scenarios. The installation program provisions the underlying infrastructure for the cluster. - -You can install either a standard cluster or a customized cluster. With a standard cluster, you provide minimum details that are required to install the cluster. With a customized cluster, you can specify more details about the platform, such as the number of machines that the control plane uses, the type of virtual machine that the cluster deploys, or the CIDR range for the Kubernetes service network. - -If possible, use this feature to avoid having to provision and maintain the cluster infrastructure. In all other environments, you use the installation program to generate the assets that you require to provision your cluster infrastructure. - -With installer-provisioned infrastructure clusters, {product-title} manages all aspects of the cluster, including the operating system itself. Each machine boots with a configuration that references resources hosted in the cluster that it joins. This configuration allows the cluster to manage itself as updates are applied. - -[discrete] -== The installation process with user-provisioned infrastructure - -You can also install {product-title} on infrastructure that you provide. You use the installation program to generate the assets that you require to provision the cluster infrastructure, create the cluster infrastructure, and then deploy the cluster to the infrastructure that you provided. - -If you do not use infrastructure that the installation program provisioned, you must manage and maintain the cluster resources yourself, including: - -* The underlying infrastructure for the control plane and compute machines that make up the cluster -* Load balancers -* Cluster networking, including the DNS records and required subnets -* Storage for the cluster infrastructure and applications - -If your cluster uses user-provisioned infrastructure, you have the option of adding RHEL worker machines to your cluster. - -[discrete] -== Installation process details - -Because each machine in the cluster requires information about the cluster when it is provisioned, {product-title} uses a temporary _bootstrap_ machine during initial configuration to provide the required information to the permanent control plane. It boots by using an Ignition config file that describes how to create the cluster. The bootstrap machine creates the master machines that make up the control plane. The control plane machines then create the compute machines, which are also known as worker machines. The following figure illustrates this process: - -.Creating the bootstrap, master, and worker machines -image::create-nodes.png[Creating bootstrap, master, and worker machines] - -After the cluster machines initialize, the bootstrap machine is destroyed. All clusters use the bootstrap process to initialize the cluster, but if you provision the infrastructure for your cluster, you must complete many of the steps manually. - -[IMPORTANT] -==== -The Ignition config files that the installation program generates contain certificates that expire after 24 hours, which are then renewed at that time. If the cluster is shut down before renewing the certificates and the cluster is later restarted after the 24 hours have elapsed, the cluster automatically recovers the expired certificates. The exception is that you must manually approve the pending `node-bootstrapper` certificate signing requests (CSRs) to recover kubelet certificates. See the documentation for _Recovering from expired control plane certificates_ for more information. -==== - -Bootstrapping a cluster involves the following steps: - -. The bootstrap machine boots and starts hosting the remote resources required for the master machines to boot. (Requires manual intervention if you provision the infrastructure) -. The master machines fetch the remote resources from the bootstrap machine and finish booting. (Requires manual intervention if you provision the infrastructure) -. The master machines use the bootstrap machine to form an etcd cluster. -. The bootstrap machine starts a temporary Kubernetes control plane using the new etcd cluster. -. The temporary control plane schedules the production control plane to the master machines. -. The temporary control plane shuts down and passes control to the production control plane. -. The bootstrap machine injects {product-title} components into the production control plane. -. The installation program shuts down the bootstrap machine. (Requires manual intervention if you provision the infrastructure) -. The control plane sets up the worker nodes. -. The control plane installs additional services in the form of a set of Operators. - -The result of this bootstrapping process is a fully running {product-title} cluster. The cluster then downloads and configures remaining components needed for the day-to-day operation, including the creation of worker machines in supported environments. diff --git a/modules/nw-aws-nlb-new-cluster.adoc b/modules/nw-aws-nlb-new-cluster.adoc index eeaebd6484..b16c02d33a 100644 --- a/modules/nw-aws-nlb-new-cluster.adoc +++ b/modules/nw-aws-nlb-new-cluster.adoc @@ -1,6 +1,5 @@ // Module included in the following assemblies: // -// * installing/installing_aws/installing-aws-network-customizations.adoc // * networking/configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-aws-network-load-balancer.adoc [id="nw-aws-nlb-new-cluster_{context}"] @@ -48,7 +47,7 @@ $ ls /manifests/cluster-ingress-default-ingresscontrolle cluster-ingress-default-ingresscontroller.yaml ---- -. Open the `cluster-ingress-default-ingresscontroller.yaml` file in an editor and enter a custom resource (CR) that describes the Operator configuration you want: +. Open the `cluster-ingress-default-ingresscontroller.yaml` file in an editor and enter a CR that describes the Operator configuration you want: + [source,yaml] ---- diff --git a/modules/nw-modifying-operator-install-config.adoc b/modules/nw-modifying-operator-install-config.adoc index a40b04c83d..0d437bdfab 100644 --- a/modules/nw-modifying-operator-install-config.adoc +++ b/modules/nw-modifying-operator-install-config.adoc @@ -75,7 +75,7 @@ cluster-network-02-config.yml cluster-network-03-config.yml ---- -. Open the `cluster-network-03-config.yml` file in an editor and enter a custom resource (CR) that +. Open the `cluster-network-03-config.yml` file in an editor and enter a CR that describes the Operator configuration you want: + [source,yaml] diff --git a/modules/nw-operator-cr.adoc b/modules/nw-operator-cr.adoc index 8086b50959..bb97388330 100644 --- a/modules/nw-operator-cr.adoc +++ b/modules/nw-operator-cr.adoc @@ -5,7 +5,6 @@ // * installing/installing_azure/installing-azure-network-customizations.adoc // * installing/installing_bare_metal/installing-bare-metal-network-customizations.adoc // * installing/installing_vsphere/installing-vsphere-network-customizations.adoc -// * installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc // * installing/installing_gcp/installing-gcp-network-customizations.adoc // * post_installation_configuration/network-configuration.adoc @@ -17,11 +16,11 @@ endif::[] [id="nw-operator-cr_{context}"] = Cluster Network Operator configuration -The configuration for the cluster network is specified as part of the Cluster Network Operator (CNO) configuration and stored in a custom resource (CR) object that is named `cluster`. The CR specifies the parameters for the `Network` API in the `operator.openshift.io` API group. +The configuration for the cluster network is specified as part of the Cluster Network Operator (CNO) configuration and stored in a CR object that is named `cluster`. The CR specifies the parameters for the `Network` API in the `operator.openshift.io` API group. You can specify the cluster network configuration for your {product-title} cluster by setting the parameter values for the `defaultNetwork` parameter in the CNO CR. The following CR displays the default configuration for the CNO and explains both the parameters you can configure and the valid parameter values: -.Cluster Network Operator custom resource +.Cluster Network Operator CR [source,yaml] ifndef::operator[] ---- diff --git a/modules/private-clusters-about.adoc b/modules/private-clusters-about.adoc index 31e9ebdee7..d3f2ee0ed0 100644 --- a/modules/private-clusters-about.adoc +++ b/modules/private-clusters-about.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * post_installation_configuration/configuring-private-cluster.adoc +// * installing/install_config/configuring-private-cluster.adoc [id="private-clusters-about_{context}"] = About private clusters diff --git a/modules/private-clusters-setting-api-private.adoc b/modules/private-clusters-setting-api-private.adoc index b96a3a3cfe..432262a39f 100644 --- a/modules/private-clusters-setting-api-private.adoc +++ b/modules/private-clusters-setting-api-private.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * post_installation_configuration/configuring-private-cluster.adoc +// * installing/install_config/configuring-private-cluster.adoc [id="private-clusters-setting-api-private_{context}"] = Restricting the API server to private diff --git a/modules/private-clusters-setting-dns-private.adoc b/modules/private-clusters-setting-dns-private.adoc index d2a72aa216..a1c2143d0a 100644 --- a/modules/private-clusters-setting-dns-private.adoc +++ b/modules/private-clusters-setting-dns-private.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * post_installation_configuration/configuring-private-cluster.adoc +// * installing/install_config/configuring-private-cluster.adoc // * post_installation_configuration/network-configuration.adoc [id="private-clusters-setting-dns-private_{context}"] diff --git a/modules/private-clusters-setting-ingress-private.adoc b/modules/private-clusters-setting-ingress-private.adoc index 5f76bfd065..38f3fd1291 100644 --- a/modules/private-clusters-setting-ingress-private.adoc +++ b/modules/private-clusters-setting-ingress-private.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * post_installation_configuration/configuring-private-cluster.adoc +// * installing/install_config/configuring-private-cluster.adoc [id="private-clusters-setting-ingress-private_{context}"] = Setting the Ingress Controller to private diff --git a/modules/supported-platforms-for-openshift-clusters.adoc b/modules/supported-platforms-for-openshift-clusters.adoc deleted file mode 100644 index 13365fa130..0000000000 --- a/modules/supported-platforms-for-openshift-clusters.adoc +++ /dev/null @@ -1,43 +0,0 @@ -// Module included in the following assemblies: -// -// * architecture/architecture-installation.adoc -// * installing/index.adoc - -[id="supported-platforms-for-openshift-clusters_{context}"] -= Supported platforms for OpenShift clusters - -In {product-title} {product-version}, you can install a cluster that uses installer-provisioned infrastructure on the following platforms: - -* Amazon Web Services (AWS) -* Google Cloud Platform (GCP) -* Microsoft Azure -* {rh-openstack-first} version 13 and 16 -** The latest {product-title} release supports both the latest {rh-openstack} long-life release and intermediate release. For complete {rh-openstack} release compatibility, see the link:https://access.redhat.com/articles/4679401[{product-title} on {rh-openstack} support matrix]. -* {rh-virtualization-first} -* VMware vSphere - -For these clusters, all machines, including the computer that you run the installation process on, must have direct internet access to pull images for platform containers and provide telemetry data to Red Hat. - -[IMPORTANT] -==== -After installation, the following changes are not supported: - -* Mixing cloud provider platforms -* Mixing cloud provider components, such as using a persistent storage framework from a differing platform than what the cluster is installed on -==== - -In {product-title} {product-version}, you can install a cluster that uses user-provisioned infrastructure on the following platforms: - -* AWS -* Azure -* GCP -* {rh-openstack} -* {rh-virtualization} -* VMware vSphere -* Bare metal -* IBM Z or LinuxONE -* IBM Power Systems - -With installations on user-provisioned infrastructure, each machine can have full internet access, you can place your cluster behind a proxy, or you can perform a _restricted network installation_. In a restricted network installation, you can download the images that are required to install a cluster, place them in a mirror registry, and use that data to install your cluster. While you require internet access to pull images for platform containers, with a restricted network installation on vSphere or bare metal infrastructure, your cluster machines do not require direct internet access. - -The link:https://access.redhat.com/articles/4128421[OpenShift Container Platform 4.x Tested Integrations] page contains details about integration testing for different platforms. diff --git a/post_installation_configuration/cluster-tasks.adoc b/post_installation_configuration/cluster-tasks.adoc index 29aef14c6d..24d5f7c460 100644 --- a/post_installation_configuration/cluster-tasks.adoc +++ b/post_installation_configuration/cluster-tasks.adoc @@ -6,489 +6,6 @@ toc::[] After installing {product-title}, you can further expand and customize your cluster to your requirements. -[id="available_cluster_customizations"] -== Available cluster customizations - -You complete most of the cluster configuration and customization after you deploy your {product-title} cluster. A number of _configuration resources_ are available. - -[NOTE] -==== -If you install your cluster on IBM Z, not all features and functions are available. -==== - -You modify the configuration resources to configure the major features of the -cluster, such as the image registry, networking configuration, image build -behavior, and the identity provider. - -For current documentation of the settings that you control by using these resources, use -the `oc explain` command, for example `oc explain builds --api-version=config.openshift.io/v1` - -[id="configuration-resources_{context}"] -=== Cluster configuration resources - -All cluster configuration resources are globally scoped (not namespaced) and named `cluster`. -//// -Config changes should not require coordinated changes between config resources, if you find -yourself struggling to update these docs to explain coordinated changes, please reach out -to @api-approvers (github) or #forum-api-review (slack). -//// - -[cols="2a,8a",options="header"] -|=== -|Resource name -|Description - -|`apiserver.config.openshift.io` -|Provides API server configuration such as xref:../security/certificates/api-server.adoc#api-server-certificates[certificates and certificate authorities]. - -|`authentication.config.openshift.io` -|Controls the xref:../authentication/understanding-identity-provider.adoc#understanding-identity-provider[identity provider] and authentication configuration for the cluster. - -|`build.config.openshift.io` -|Controls default and enforced xref:../cicd/builds/build-configuration.adoc#build-configuration[configuration] for all builds on the cluster. - -|`console.config.openshift.io` -|Configures the behavior of the web console interface, including the xref:../web_console/configuring-web-console.adoc#configuring-web-console[logout behavior]. - -|`featuregate.config.openshift.io` -|Enables xref:../nodes/clusters/nodes-cluster-enabling-features.adoc#nodes-cluster-enabling[FeatureGates] -so that you can use Tech Preview features. - -|`image.config.openshift.io` -|Configures how specific xref:../openshift_images/image-configuration.adoc#image-configuration[image registries] should be treated (allowed, disallowed, insecure, CA details). - -|`ingress.config.openshift.io` -|Configuration details related to xref:../networking/ingress-operator.adoc#nw-installation-ingress-config-asset_configuring-ingress[routing] such as the default domain for routes. - -|`oauth.config.openshift.io` -|Configures identity providers and other behavior related to xref:../authentication/configuring-internal-oauth.adoc#configuring-internal-oauth[internal OAuth server] flows. - -|`project.config.openshift.io` -|Configures xref:../applications/projects/configuring-project-creation.adoc#configuring-project-creation[how projects are created] including the project template. - -|`proxy.config.openshift.io` -|Defines proxies to be used by components needing external network access. Note: not all components currently consume this value. - -|`scheduler.config.openshift.io` -|Configures xref:../nodes/scheduling/nodes-scheduler-default.adoc#nodes-scheduler-default[scheduler] behavior such as policies and default node selectors. - -|=== - -[id="operator-configuration-resources_{context}"] -=== Operator configuration resources - -These configuration resources are cluster-scoped instances, named `cluster`, which control the behavior of a specific component as -owned by a particular Operator. - -[cols="2a,8a",options="header"] -|=== -|Resource name -|Description - -|`consoles.operator.openshift.io` -|Controls console appearance such as branding customizations - -|`config.imageregistry.operator.openshift.io` -|Configures xref:../registry/configuring-registry-operator.adoc#registry-operator-configuration-resource-overview_configuring-registry-operator[internal image registry settings] such as public routing, log levels, proxy settings, resource constraints, replica counts, and storage type. - -|`config.samples.operator.openshift.io` -|Configures the -xref:../openshift_images/configuring-samples-operator.adoc#configuring-samples-operator[Samples Operator] -to control which example image streams and templates are installed on the cluster. - -|=== - - -[id="additional-configuration-resources_{context}"] -=== Additional configuration resources - -These configuration resources represent a single instance of a particular component. In some cases, you can request multiple -instances by creating multiple instances of the resource. In other cases, the Operator can use only a specific -resource instance name in a specific namespace. Reference the component-specific -documentation for details on how and when you can create additional resource instances. - -[cols="2a,2a,2a,8a",options="header"] -|=== -|Resource name -|Instance name -|Namespace -|Description - -|`alertmanager.monitoring.coreos.com` -|`main` -|`openshift-monitoring` -|Controls the xref:../monitoring/managing-alerts.adoc#managing-alerts[Alertmanager] deployment parameters. - -|`ingresscontroller.operator.openshift.io` -|`default` -|`openshift-ingress-operator` -|Configures xref:../networking/ingress-operator.adoc#configuring-ingress[Ingress Operator] behavior such as domain, number of replicas, certificates, and controller placement. - -|=== - - -[id="informational-resources_{context}"] -=== Informational Resources - -You use these resources to retrieve information about the cluster. Do not edit these resources directly. - -[cols="2a,2a,8a",options="header"] -|=== -|Resource name|Instance name|Description - -|`clusterversion.config.openshift.io` -|`version` -|In {product-title} {product-version}, you must not customize the `ClusterVersion` -resource for production clusters. Instead, follow the process to -xref:../updating/updating-cluster.adoc#updating-cluster[update a cluster]. - -|`dns.config.openshift.io` -|`cluster` -|You cannot modify the DNS settings for your cluster. You can -xref:../networking/dns-operator.adoc#dns-operator[view the DNS Operator status]. - -|`infrastructure.config.openshift.io` -|`cluster` -|Configuration details allowing the cluster to interact with its cloud provider. - -|`network.config.openshift.io` -|`cluster` -|You cannot modify your cluster networking after installation. To customize your network, follow the process to -xref:../installing/installing_aws/installing-aws-network-customizations.adoc#installing-aws-network-customizations[customize networking during installation]. - -|=== - -include::modules/images-update-global-pull-secret.adoc[leveloffset=+1] - -//// -[id="default-crds_{context}"] -== Custom resources - -A number of Custom Resource Definitions (CRDs) are available for you to use to -further tune your {product-title} deployment. You can deploy Custom Resources -that are based on many of these CRDs to add more functionality to your -{product-title} cluster. - -.Default CRDs -[cols="2a,2a,8a,2a,2a",options="header"] -|=== -|Name -|Group -|Description -|Namespaced -|Can deploy CR - - -|Alertmanager -|monitoring.coreos.com -| -|Namespaced -| - -|Authentication -|config.openshift.io -| -|Global -| - -|Build -|config.openshift.io -| -|Global -| - -|CatalogSourceConfig -|operators.coreos.com -| -|Namespaced -| - -|CatalogSource -|operators.coreos.com -| -|Namespaced -| - -|ClusterAutoscaler -|autoscaling.openshift.io -| -|Global -|Yes - -|ClusterDNS -|dns.openshift.io -| -|Global -| - -|IngressController -|operator.openshift.io -| -|Namespaced -| - -|ClusterNetwork -|network.openshift.io -| -|Global -| - -|ClusterOperator -|config.openshift.io -| -|Global -| - -|ClusterOperator -|operatorstatus.openshift.io -| -|Namespaced -| - -|Cluster -|machine.openshift.io -| -|Namespaced -| - -|ClusterServiceVersion -|operators.coreos.com -| -|Namespaced -| - -|ClusterVersion -|config.openshift.io -| -|Global -| - -|Config -|imageregistry.operator.openshift.io -| -|Global -| - -|Config -|samples.operator.openshift.io -| -|Global -| - -|Console -|console.config.openshift.io -|The top-level configuration for the web console. -|Namespaced -|The console CR is created by default with more or less empty values. It honors -new values. If it is deleted, it recreates automatically. - -|ControllerConfig -|machineconfiguration.openshift.io -| -|Global -| - -|CredentialsRequest -|cloudcredential.openshift.io -| -|Namespaced -| - -|DNS -|config.openshift.io -| -|Global -| - -|EgressNetworkPolicy -|network.openshift.io -| -|Namespaced -| - -|HostSubnet -|network.openshift.io -| -|Global -| - -|Image -|config.openshift.io -| -|Global -| - -|Infrastructure -|config.openshift.io -| -|Global -| - -|Ingress -|config.openshift.io -| -|Global -| - -|InstallPlan -|operators.coreos.com -| -|Namespaced -| - -|KubeControllerManager -|operator.openshift.io -| -|Global -| - -|KubeletConfig -|machineconfiguration.openshift.io -| -|Global -| - -|MachineAutoscaler -|autoscaling.openshift.io -| -|Namespaced -|Yes - -|MachineClass -|machine.openshift.io -| -|Namespaced -| - -|MachineConfigPool -|machineconfiguration.openshift.io -| -|Global -| - -|MachineConfig -|machineconfiguration.openshift.io -| -|Global -| - -|MachineDeployment -|machine.openshift.io -| -|Namespaced -| - -|MachineHealthCheck -|healthchecking.openshift.io -| -|Namespaced -| - -|Machine -|machine.openshift.io -| -|Namespaced -| - -|MachineSet -|machine.openshift.io -| -|Namespaced -| - -|MCOConfig -|machineconfiguration.openshift.io -| -|Global -| - -|NetNamespace -|network.openshift.io -| -|Global -| - -|NetworkAttachmentDefinition -|k8s.cni.cncf.io -| -|Namespaced -| - -|NetworkConfig -|networkoperator.openshift.io -| -|Global -| - -|Network -|config.openshift.io -| -|Global -| - -|OAuth -|config.openshift.io -| -|Global -| - -|OpenShiftAPIServer -|operator.openshift.io -| -|Global -| - -|OpenShiftControllerManagerOperatorConfig -|openshiftcontrollermanager.operator.openshift.io -| -|Global -| - -|OperatorGroup -|operators.coreos.com -| -|Namespaced -| - -|Project -|config.openshift.io -| -|Global -| - -|Prometheus -|monitoring.coreos.com -| -|Namespaced -| - -|PrometheusRule -|monitoring.coreos.com -| -|Namespaced -| - -|ServiceCertSignerOperatorConfig -|servicecertsigner.config.openshift.io -| -|Global -| - -|ServiceMonitor -|monitoring.coreos.com -| -|Namespaced -| - -|Subscription -|operators.coreos.com -| -|Namespaced -| - -|=== -//// - [id="post-install-adjust-worker-nodes"] == Adjust worker nodes If you incorrectly sized the worker nodes during deployment, adjust them by creating one or more new machine sets, scale them up, then scale the original machine set down before removing them. diff --git a/security/container_security/security-hosts-vms.adoc b/security/container_security/security-hosts-vms.adoc index d9ac27be40..b704bbd190 100644 --- a/security/container_security/security-hosts-vms.adoc +++ b/security/container_security/security-hosts-vms.adoc @@ -17,7 +17,7 @@ include::modules/security-hosts-vms-rhcos.adoc[leveloffset=+1] .Additional resources * xref:../../nodes/nodes/nodes-nodes-resources-configuring.adoc#allocate-node-enforcement_nodes-nodes-resources-configuring[How nodes enforce resource constraints] * xref:../../authentication/managing-security-context-constraints.adoc#managing-pod-security-policies[Managing security context constraints] -* xref:../../architecture/architecture-installation.adoc#supported-platforms-for-openshift-clusters_architecture-installation[Supported platforms for OpenShift clusters] +* xref:../../architecture/architecture-installation.adoc#available-platforms_architecture-installation[Available platforms] * xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installation-requirements-user-infra_installing-bare-metal[Machine requirements for a cluster with user-provisioned infrastructure] * xref:../../architecture/architecture-rhcos.adoc#rhcos-configured_architecture-rhcos[Choosing how to configure {op-system}] * xref:../../architecture/architecture-rhcos.adoc#rhcos-about-ignition_architecture-rhcos[Ignition] diff --git a/service_mesh/v1x/preparing-ossm-installation.adoc b/service_mesh/v1x/preparing-ossm-installation.adoc index 54e84c1039..a0a80a4cd1 100644 --- a/service_mesh/v1x/preparing-ossm-installation.adoc +++ b/service_mesh/v1x/preparing-ossm-installation.adoc @@ -18,7 +18,7 @@ Before you can install {ProductName}, review the installation activities, ensure + [NOTE] ==== -If you are installing {ProductName} 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 {ProductName} on a xref:../../installing/install_config/installation-types.adoc[restricted network], follow the instructions for your chosen {product-title} infrastructure. ==== + * Install the version of the {product-title} command line utility (the `oc` client tool) that matches your {product-title} version and add it to your path. diff --git a/service_mesh/v2x/preparing-ossm-installation.adoc b/service_mesh/v2x/preparing-ossm-installation.adoc index b14a50ce4d..8ca0f949e7 100644 --- a/service_mesh/v2x/preparing-ossm-installation.adoc +++ b/service_mesh/v2x/preparing-ossm-installation.adoc @@ -20,7 +20,7 @@ Before you can install {ProductName}, review the installation activities, ensure + [NOTE] ==== -If you are installing {ProductName} 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 {ProductName} on a xref:../../installing/install_config/installation-types.adoc[restricted network], follow the instructions for your chosen {product-title} infrastructure. ==== + * Install the version of the {product-title} command line utility (the `oc` client tool) that matches your {product-title} version and add it to your path. diff --git a/updating/understanding-the-update-service.adoc b/updating/understanding-the-update-service.adoc deleted file mode 100644 index 9f0420b04e..0000000000 --- a/updating/understanding-the-update-service.adoc +++ /dev/null @@ -1,9 +0,0 @@ -[id="understanding-the-update-service"] -= Understanding the update service -include::modules/common-attributes.adoc[] -:context: understanding-the-update-service -toc::[] - -include::modules/update-service-overview.adoc[leveloffset=+1] - -include::modules/unmanaged-operators.adoc[leveloffset=+1] diff --git a/welcome/index.adoc b/welcome/index.adoc index ef253ecc6a..8ce54d5086 100644 --- a/welcome/index.adoc +++ b/welcome/index.adoc @@ -28,8 +28,6 @@ ifdef::openshift-enterprise,openshift-webscale,openshift-origin[] == Cluster installer activities As someone setting out to install an {product-title} {product-version} cluster, this documentation helps you: -- **xref:../installing/index.adoc#ocp-installation-overview[{product-title} installation overview]**: 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/installing_aws/installing-aws-account.adoc#installing-aws-account[Install a cluster on AWS]**: You have the most installation options when you deploy a cluster on Amazon Web Services (AWS). You can deploy clusters with xref:../installing/installing_aws/installing-aws-default.adoc#installing-aws-default[default settings] or xref:../installing/installing_aws/installing-aws-customizations.adoc#installing-aws-customizations[custom AWS settings]. You can also deploy a cluster on AWS infrastructure that you provisioned yourself. You can modify the provided xref:../installing/installing_aws/installing-aws-user-infra.adoc#installing-aws-user-infra[AWS CloudFormation templates] to meet your needs.