diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 457eb60a7f3..8fad5b262e5 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -369,6 +369,8 @@ Topics: File: installing-ibm-cloud-private - Name: Installing a cluster on IBM Cloud in a disconnected environment File: installing-ibm-cloud-restricted + - Name: Postinstallation configuration for a disconnected IBM Cloud cluster + File: installing-ibm-cloud-restricted-postinstallation-configuration - Name: Installation configuration parameters for IBM Cloud File: installation-config-parameters-ibm-cloud-vpc - Name: Uninstalling a cluster on IBM Cloud diff --git a/installing/installing_ibm_cloud/installing-ibm-cloud-account.adoc b/installing/installing_ibm_cloud/installing-ibm-cloud-account.adoc index 356decd8979..38fc0906c49 100644 --- a/installing/installing_ibm_cloud/installing-ibm-cloud-account.adoc +++ b/installing/installing_ibm_cloud/installing-ibm-cloud-account.adoc @@ -7,9 +7,9 @@ include::_attributes/common-attributes.adoc[] toc::[] [role="_abstract"] -Before you can install {product-title}, you must configure an {ibm-cloud-name} account. +Before you can install {product-title} on {ibm-cloud-name}, you must configure your account by setting up DNS, IAM policies, and an API key. -You must have an account with a subscription. You cannot install {product-title} on a free or trial {ibm-cloud-name} account. +You must have a subscription account; free or trial accounts are not supported. include::modules/quotas-and-limits-ibm-cloud.adoc[leveloffset=+1] @@ -17,8 +17,22 @@ include::modules/installation-ibm-cloud-dns-resolution-concept.adoc[leveloffset= include::modules/installation-cis-ibm-cloud.adoc[leveloffset=+2] +[role="_additional-resources"] +[id="additional-resources_installing-ibm-cloud-account-cis"] +.Additional resources +* link:https://www.ibm.com/cloud/cli[{ibm-cloud-name} CLI ({ibm-cloud-name} documentation)] +* link:https://cloud.ibm.com/docs/dns?topic=dns-getting-started[{ibm-name} DNS documentation] +* link:https://cloud.ibm.com/catalog/services/internet-services[CIS web console ({ibm-cloud-name} documentation)] +* link:https://cloud.ibm.com/docs/cis?topic=cis-getting-started#configure-your-name-servers-with-the-registrar-or-existing-dns-provider[{ibm-cloud-name} documentation for configuring name servers] + include::modules/installation-dns-ibm-cloud.adoc[leveloffset=+2] +[role="_additional-resources"] +[id="additional-resources_installing-ibm-cloud-account-dns"] +.Additional resources +* link:https://www.ibm.com/cloud/cli[{ibm-cloud-name} CLI ({ibm-cloud-name} documentation)] +* link:https://cloud.ibm.com/docs/dns?topic=dns-getting-started[{ibm-name} DNS documentation] + include::modules/installation-ibm-cloud-iam-policies-api-key.adoc[leveloffset=+1] include::modules/installation-ibm-cloud-creating-api-key.adoc[leveloffset=+2] diff --git a/installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc b/installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc index 5f8bb953517..9ae58e53b2c 100644 --- a/installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc +++ b/installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc @@ -6,21 +6,22 @@ include::_attributes/common-attributes.adoc[] toc::[] -In {product-title} version {product-version}, you can install a customized cluster -on {ibm-cloud-name} by using installer-provisioned infrastructure with customizations, including network configuration options. In each, you modify parameters in the `install-config.yaml` file before you install the cluster. +[role="_abstract"] +In {product-title} version {product-version}, you can install a customized cluster on {ibm-cloud-name} by using installer-provisioned infrastructure. Change parameters in the `install-config.yaml` file before you install the cluster. By customizing your network configuration, your cluster can coexist with existing IP address allocations in your environment and integrate with existing MTU and VXLAN configurations. -You must set most of the network configuration parameters during installation, and you can modify only `kubeProxy` configuration parameters in a running cluster. +You must set most of the network configuration parameters during installation, and you can change only `kubeProxy` configuration parameters in a running cluster. -[id="prerequisites_installing-ibm-cloud-customizations"] -== Prerequisites +include::modules/prereqs-ibm-cloud-installer-provisioned.adoc[leveloffset=+1] -* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. -* You xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-account.adoc#installing-ibm-cloud-account[configured an {ibm-cloud-name} account] to host the cluster. -* If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall-module_configuring-firewall[configured it to allow the sites] that your cluster requires access to. -* You configured the `ccoctl` utility before you installed the cluster. For more information, see xref:../../installing/installing_ibm_cloud/configuring-iam-ibm-cloud.adoc#configuring-iam-ibm-cloud[Configuring IAM for {ibm-cloud-name}]. +[role="_additional-resources"] +.Additional resources +* xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] +* xref:../../installing/overview/installing-preparing.adoc#installing-preparing[Selecting a cluster installation method and preparing it for users] +* xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-account.adoc#installing-ibm-cloud-account[Configuring an {ibm-cloud-name} account] +* xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall-module_configuring-firewall[Configuring your firewall] +* xref:../../installing/installing_ibm_cloud/configuring-iam-ibm-cloud.adoc#configuring-iam-ibm-cloud[Configuring IAM for {ibm-cloud-name}] include::modules/cluster-entitlements.adoc[leveloffset=+1] @@ -83,12 +84,7 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] include::modules/cluster-telemetry.adoc[leveloffset=+1] [role="_additional-resources"] -[id="additional-resources_installing-ibm-cloud-customizations-telemetry"] -.Additional resources +[id="additional-resources_installing-ibm-cloud-customizations"] +== Additional resources +* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster] * xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] - -[id="next-steps_installing-ibm-cloud-customizations"] -== Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. -* If necessary, you can -xref:../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting]. diff --git a/installing/installing_ibm_cloud/installing-ibm-cloud-network-customizations.adoc b/installing/installing_ibm_cloud/installing-ibm-cloud-network-customizations.adoc deleted file mode 100644 index 64affad5e9a..00000000000 --- a/installing/installing_ibm_cloud/installing-ibm-cloud-network-customizations.adoc +++ /dev/null @@ -1,93 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -include::_attributes/common-attributes.adoc[] -[id="installing-ibm-cloud-network-customizations"] -= Installing a cluster on {ibm-cloud-title} with network customizations -:context: installing-ibm-cloud-network-customizations - -toc::[] - -In {product-title} version {product-version}, you can install a cluster with a -customized network configuration on infrastructure that the installation program provisions on {ibm-cloud-name}. By customizing your network configuration, your cluster can coexist with existing IP address allocations in your environment and integrate with existing MTU and VXLAN configurations. To customize the installation, you modify parameters in the `install-config.yaml` file before you install the cluster. - -You must set most of the network configuration parameters during installation, and you can modify only `kubeProxy` configuration parameters in a running cluster. - -[id="prerequisites_installing-ibm-cloud-customizations"] -== Prerequisites - -* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. -* You xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-account.adoc#installing-ibm-cloud-account[configured an {ibm-cloud-name} account] to host the cluster. -* If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall-module_configuring-firewall[configured it to allow the sites] that your cluster requires access to. -* You configured the `ccoctl` utility before you installed the cluster. For more information, see xref:../../installing/installing_ibm_cloud/configuring-iam-ibm-cloud.adoc#configuring-iam-ibm-cloud[Configuring IAM for {ibm-cloud-name}]. - -include::modules/cluster-entitlements.adoc[leveloffset=+1] - -include::modules/ssh-agent-using.adoc[leveloffset=+1] - -include::modules/installation-obtaining-installer.adoc[leveloffset=+1] - -include::modules/installation-ibm-cloud-export-variables.adoc[leveloffset=+1] - -include::modules/installation-initializing.adoc[leveloffset=+1] - -[role="_additional-resources"] -.Additional resources -* xref:../../installing/installing_ibm_cloud/installation-config-parameters-ibm-cloud-vpc.adoc#installation-config-parameters-ibm-cloud-vpc[Installation configuration parameters for {ibm-cloud-name}] - -include::modules/installation-minimum-resource-requirements.adoc[leveloffset=+2] - -include::modules/installation-ibm-cloud-tested-machine-types.adoc[leveloffset=+2] - -[role="_additional-resources"] -.Additional resources - -* xref:../../scalability_and_performance/optimization/optimizing-storage.adoc#optimizing-storage[Optimizing storage] - -include::modules/installation-ibm-cloud-config-yaml.adoc[leveloffset=+2] - -//.Additional resources - -//* ../../machine_management/creating_machinesets/creating-machineset-ibm-cloud.adoc#machineset-enabling-customer-managed-encryption_creating-machineset-ibm-cloud[Enabling customer-managed encryption keys for a compute machine set] - -include::modules/installation-configure-proxy.adoc[leveloffset=+2] - -include::modules/manually-create-iam-ibm-cloud.adoc[leveloffset=+1] - -// Network Operator specific configuration -include::modules/nw-network-config.adoc[leveloffset=+1] - -include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1] - -include::modules/nw-operator-cr.adoc[leveloffset=+1] - -include::modules/installation-launching-installer.adoc[leveloffset=+1] - -// Installing the OpenShift CLI on Linux -include::modules/cli-installing-cli-linux.adoc[leveloffset=+1] - -// Installing the OpenShift CLI on Windows -include::modules/cli-installing-cli-windows.adoc[leveloffset=+1] - -// Installing the OpenShift CLI on macOS -include::modules/cli-installing-cli-macos.adoc[leveloffset=+1] - -include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] - -[role="_additional-resources"] -[id="additional-resources_installing-ibm-cloud-customizations-console"] -.Additional resources -* xref:../../web_console/web-console.adoc#web-console[Accessing the web console] - -include::modules/cluster-telemetry.adoc[leveloffset=+1] - -[role="_additional-resources"] -[id="additional-resources_installing-ibm-cloud-customizations-telemetry"] -.Additional resources -* xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] - -[id="next-steps_installing-ibm-cloud-customizations"] -== Next steps - -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. -* If necessary, you can -xref:../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting]. diff --git a/installing/installing_ibm_cloud/installing-ibm-cloud-private.adoc b/installing/installing_ibm_cloud/installing-ibm-cloud-private.adoc index 3a5c0471f34..18f2e1b8c62 100644 --- a/installing/installing_ibm_cloud/installing-ibm-cloud-private.adoc +++ b/installing/installing_ibm_cloud/installing-ibm-cloud-private.adoc @@ -6,16 +6,18 @@ include::_attributes/common-attributes.adoc[] toc::[] -In {product-title} version {product-version}, you can install a private cluster into an existing VPC. The installation program provisions the rest of the required infrastructure, which you can further customize. To customize the installation, you modify parameters in the `install-config.yaml` file before you install the cluster. +[role="_abstract"] +In {product-title} version {product-version}, you can install a private cluster into an existing Virtual Private Cloud (VPC) on {ibm-cloud-name}. The installation program provisions the rest of the required infrastructure, which you can further customize. -[id="prerequisites_installing-ibm-cloud-private"] -== Prerequisites +include::modules/prereqs-ibm-cloud-installer-provisioned.adoc[leveloffset=+1] -* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. -* You xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-account.adoc#installing-ibm-cloud-account[configured an {ibm-cloud-name} account] to host the cluster. -* If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall-module_configuring-firewall[configured it to allow the sites] that your cluster requires access to. -* You configured the `ccoctl` utility before you installed the cluster. For more information, see xref:../../installing/installing_ibm_cloud/configuring-iam-ibm-cloud.adoc#configuring-iam-ibm-cloud[Configuring IAM for {ibm-cloud-name}]. +[role="_additional-resources"] +.Additional resources +* xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] +* xref:../../installing/overview/installing-preparing.adoc#installing-preparing[Selecting a cluster installation method and preparing it for users] +* xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-account.adoc#installing-ibm-cloud-account[Configuring an {ibm-cloud-name} account] +* xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall-module_configuring-firewall[Configuring your firewall] +* xref:../../installing/installing_ibm_cloud/configuring-iam-ibm-cloud.adoc#configuring-iam-ibm-cloud[Configuring IAM for {ibm-cloud-name}] include::modules/private-clusters-default.adoc[leveloffset=+1] @@ -73,11 +75,7 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] include::modules/cluster-telemetry.adoc[leveloffset=+1] [role="_additional-resources"] -[id="additional-resources_installing-ibm-cloud-private-telemetry"] -.Additional resources +[id="additional-resources_installing-ibm-cloud-private"] +== Additional resources +* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster] * xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] - -[id="next-steps_installing-ibm-cloud-private"] -== Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. -* If necessary, you can xref:../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting]. diff --git a/installing/installing_ibm_cloud/installing-ibm-cloud-restricted-postinstallation-configuration.adoc b/installing/installing_ibm_cloud/installing-ibm-cloud-restricted-postinstallation-configuration.adoc new file mode 100644 index 00000000000..f967b64ba53 --- /dev/null +++ b/installing/installing_ibm_cloud/installing-ibm-cloud-restricted-postinstallation-configuration.adoc @@ -0,0 +1,23 @@ +:_mod-docs-content-type: ASSEMBLY +include::_attributes/common-attributes.adoc[] +[id="installing-ibm-cloud-restricted-postinstallation-configuration"] += Postinstallation configuration for a disconnected {ibm-cloud-title} cluster +:context: installing-ibm-cloud-restricted-postinstallation-configuration + +toc::[] + +[role="_abstract"] +After you install a cluster on {ibm-cloud-name} in a disconnected environment, you must complete the postinstallation configuration steps to prepare the cluster for use. + +include::modules/olm-restricted-networks-configuring-operatorhub.adoc[leveloffset=+1] + +include::modules/oc-mirror-updating-restricted-cluster-manifests.adoc[leveloffset=+1] + +include::modules/cluster-telemetry.adoc[leveloffset=+1] + +[role="_additional-resources"] +[id="additional-resources_installing-ibm-cloud-restricted-postinstallation"] +== Additional resources + +* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster] +* xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] diff --git a/installing/installing_ibm_cloud/installing-ibm-cloud-restricted.adoc b/installing/installing_ibm_cloud/installing-ibm-cloud-restricted.adoc index 734c4817b1f..ea05fafdf81 100644 --- a/installing/installing_ibm_cloud/installing-ibm-cloud-restricted.adoc +++ b/installing/installing_ibm_cloud/installing-ibm-cloud-restricted.adoc @@ -6,25 +6,20 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] In {product-title} {product-version}, you can install a cluster in a restricted network by creating an internal mirror of the installation release content that is accessible to an existing Virtual Private Cloud (VPC) on {ibm-cloud-name}. -[id="prerequisites_installing-ibm-cloud-restricted"] -== Prerequisites +include::modules/prereqs-ibm-cloud-restricted.adoc[leveloffset=+1] -* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-account.adoc#installing-ibm-cloud-account[configured an {ibm-cloud-title} account] to host the cluster. -* You have a container image registry that is accessible to the internet and your restricted network. The container image registry should mirror the contents of the {product-registry} and contain the installation media. For more information, see xref:../../disconnected/about-installing-oc-mirror-v2.adoc#about-installing-oc-mirror-v2[Mirroring images for a disconnected installation by using the oc-mirror plugin v2]. -* You have an existing VPC on {ibm-cloud-name} that meets the following requirements: -** The VPC contains the mirror registry or has firewall rules or a peering connection to access the mirror registry that is hosted elsewhere. -** The VPC can access {ibm-cloud-name} service endpoints using a public endpoint. If network restrictions limit access to public service endpoints, evaluate those services for alternate endpoints that might be available. For more information see xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-restricted.adoc#access-to-ibm-service-endpoints_installing-ibm-cloud-restricted[Access to IBM service endpoints]. - -+ -You cannot use the VPC that the installation program provisions by default. -* If you plan on configuring endpoint gateways to use {ibm-cloud-name} Virtual Private Endpoints, consider the following requirements: -** Endpoint gateway support is currently limited to the `us-east` and `us-south` regions. -** The VPC must allow traffic to and from the endpoint gateways. You can use the VPC’s default security group, or a new security group, to allow traffic on port 443. For more information, see xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-restricted.adoc#installation-ibm-cloud-configure-vpc-for-endpoint-gateways_installing-ibm-cloud-restricted[Allowing endpoint gateway traffic]. -* If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall-module_configuring-firewall[configured it to allow the sites] that your cluster requires access to. -* You configured the `ccoctl` utility before you installed the cluster. For more information, see xref:../../installing/installing_ibm_cloud/configuring-iam-ibm-cloud.adoc#configuring-iam-ibm-cloud[Configuring IAM for {ibm-cloud-title}]. +[role="_additional-resources"] +.Additional resources +* xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] +* xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-account.adoc#installing-ibm-cloud-account[Configuring an {ibm-cloud-name} account] +* xref:../../disconnected/about-installing-oc-mirror-v2.adoc#about-installing-oc-mirror-v2[Mirroring images for a disconnected installation by using the oc-mirror plugin v2] +* xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-restricted.adoc#access-to-ibm-service-endpoints_installing-ibm-cloud-restricted[Access to IBM service endpoints] +* xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-restricted.adoc#installation-ibm-cloud-configure-vpc-for-endpoint-gateways_installing-ibm-cloud-restricted[Allowing endpoint gateway traffic] +* xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall-module_configuring-firewall[Configuring your firewall] +* xref:../../installing/installing_ibm_cloud/configuring-iam-ibm-cloud.adoc#configuring-iam-ibm-cloud[Configuring IAM for {ibm-cloud-name}] include::modules/installation-about-restricted-network.adoc[leveloffset=+1] @@ -73,25 +68,7 @@ include::modules/installation-launching-installer.adoc[leveloffset=+1] include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] [role="_additional-resources"] -[id="additional-resources_installing-ibm-cloud-restricted-console"] -.Additional resources +[id="additional-resources_installing-ibm-cloud-restricted"] +== Additional resources * xref:../../web_console/web-console.adoc#web-console[Accessing the web console] - -== Post installation -Complete the following steps to complete the configuration of your cluster. - -include::modules/olm-restricted-networks-configuring-operatorhub.adoc[leveloffset=+2] - -include::modules/oc-mirror-updating-restricted-cluster-manifests.adoc[leveloffset=+2] - -include::modules/cluster-telemetry.adoc[leveloffset=+1] - -[role="_additional-resources"] -[id="additional-resources_installing-ibm-cloud-restricted-telemetry"] -.Additional resources -* xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] - -[id="next-steps_installing-ibm-cloud-restricted"] -== Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. -* Optional: xref:../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting]. +* xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-restricted-postinstallation-configuration.adoc#installing-ibm-cloud-restricted-postinstallation-configuration[Postinstallation configuration for a disconnected {ibm-cloud-title} cluster] diff --git a/installing/installing_ibm_cloud/installing-ibm-cloud-vpc.adoc b/installing/installing_ibm_cloud/installing-ibm-cloud-vpc.adoc index 203f08168e2..d29e81cdaa9 100644 --- a/installing/installing_ibm_cloud/installing-ibm-cloud-vpc.adoc +++ b/installing/installing_ibm_cloud/installing-ibm-cloud-vpc.adoc @@ -6,16 +6,18 @@ include::_attributes/common-attributes.adoc[] toc::[] -In {product-title} version {product-version}, you can install a cluster into an existing Virtual Private Cloud (VPC) on {ibm-cloud-name}. The installation program provisions the rest of the required infrastructure, which you can then further customize. To customize the installation, you modify parameters in the `install-config.yaml` file before you install the cluster. +[role="_abstract"] +In {product-title} version {product-version}, you can install a cluster into an existing Virtual Private Cloud (VPC) on {ibm-cloud-name}. The installation program provisions the rest of the required infrastructure, which you can further customize. -[id="prerequisites_installing-ibm-cloud-vpc"] -== Prerequisites +include::modules/prereqs-ibm-cloud-installer-provisioned.adoc[leveloffset=+1] -* You reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes. -* You read the documentation on xref:../../installing/overview/installing-preparing.adoc#installing-preparing[selecting a cluster installation method and preparing it for users]. -* You xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-account.adoc#installing-ibm-cloud-account[configured an {ibm-cloud-name} account] to host the cluster. -* If you use a firewall, you xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall-module_configuring-firewall[configured it to allow the sites] that your cluster requires access to. -* You configured the `ccoctl` utility before you installed the cluster. For more information, see xref:../../installing/installing_ibm_cloud/configuring-iam-ibm-cloud.adoc#configuring-iam-ibm-cloud[Configuring IAM for {ibm-cloud-name}]. +[role="_additional-resources"] +.Additional resources +* xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] +* xref:../../installing/overview/installing-preparing.adoc#installing-preparing[Selecting a cluster installation method and preparing it for users] +* xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-account.adoc#installing-ibm-cloud-account[Configuring an {ibm-cloud-name} account] +* xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall-module_configuring-firewall[Configuring your firewall] +* xref:../../installing/installing_ibm_cloud/configuring-iam-ibm-cloud.adoc#configuring-iam-ibm-cloud[Configuring IAM for {ibm-cloud-name}] include::modules/installation-custom-ibm-cloud-vpc.adoc[leveloffset=+1] @@ -69,11 +71,7 @@ include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] include::modules/cluster-telemetry.adoc[leveloffset=+1] [role="_additional-resources"] -[id="additional-resources_installing-ibm-cloud-vpc-telemetry"] -.Additional resources +[id="additional-resources_installing-ibm-cloud-vpc"] +== Additional resources +* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster] * xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring] - -[id="next-steps_installing-ibm-cloud-vpc"] -== Next steps -* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]. -* Optional: xref:../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting]. diff --git a/installing/installing_ibm_cloud/preparing-to-install-on-ibm-cloud.adoc b/installing/installing_ibm_cloud/preparing-to-install-on-ibm-cloud.adoc index bd643c64dd1..2be7ae40a07 100644 --- a/installing/installing_ibm_cloud/preparing-to-install-on-ibm-cloud.adoc +++ b/installing/installing_ibm_cloud/preparing-to-install-on-ibm-cloud.adoc @@ -6,25 +6,35 @@ include::_attributes/common-attributes.adoc[] toc::[] -You can install {product-title} on {ibm-cloud-name} using installer-provisioned infrastructure. This process involves using an installation program to provision the underlying infrastructure for your cluster. Installing {product-title} on {ibm-cloud-name} using user-provisioned infrastructure is not supported at this time. +[role="_abstract"] +You can install {product-title} on {ibm-cloud-name} by using installer-provisioned infrastructure. Choose an installation method based on your network connectivity, VPC configuration, and customization requirements. -See xref:../../architecture/architecture-installation.adoc#installation-process_architecture-installation[Installation process] for more information about installer-provisioned installation processes. +Installing {product-title} on {ibm-cloud-name} by using user-provisioned infrastructure is not supported at this time. [id="choosing-an-method-to-install-ocp-on-ibm-cloud-installer-provisioned"] == Installing a cluster on installer-provisioned infrastructure You can install a cluster on {ibm-cloud-name} infrastructure that is provisioned by the {product-title} installation program by using one of the following methods: -* **xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[Installing a customized cluster on {ibm-cloud-name}]**: You can install a customized cluster on {ibm-cloud-name} infrastructure that the installation program provisions. The installation program allows for some customization to be applied at the installation stage. Many other customization options are available xref:../../post_installation_configuration/cluster-tasks.adoc#post-install-cluster-tasks[post-installation]. +* Installing a customized cluster on {ibm-cloud-name}: You can install a customized cluster on {ibm-cloud-name} infrastructure that the installation program provisions. The installation program allows for some customization to be applied at the installation stage. Many other customization options are available post-installation. -* **xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[Installing a cluster on {ibm-cloud-name} with network customizations]**: You can customize your {product-title} network configuration during installation, so that your cluster can coexist with your existing IP address allocations and adhere to your network requirements. +* Installing a cluster on {ibm-cloud-name} with network customizations: You can customize your {product-title} network configuration during installation, so that your cluster can coexist with your existing IP address allocations and adhere to your network requirements. -* **xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-vpc.adoc#installing-ibm-cloud-vpc[Installing a cluster on {ibm-cloud-name} into an existing VPC]**: You can install {product-title} on an existing {ibm-cloud-name}. You can use this installation method if you have constraints set by the guidelines of your company, such as limits when creating new accounts or infrastructure. +* Installing a cluster on {ibm-cloud-name} into an existing VPC: You can install {product-title} on an existing {ibm-cloud-name} Virtual Private Cloud (VPC). You can use this installation method if you have constraints set by the guidelines of your company, such as limits when creating new accounts or infrastructure. -* **xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-private.adoc#installing-ibm-cloud-private[Installing a private cluster on an existing VPC]**: You can install a private cluster on an existing Virtual Private Cloud (VPC). You can use this method to deploy {product-title} on an internal network that is not visible to the internet. +* Installing a private cluster on an existing VPC: You can install a private cluster on an existing VPC. You can use this method to deploy {product-title} on an internal network that is not visible to the internet. -* **xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-restricted.adoc#installing-ibm-cloud-restricted[Installing a cluster on {ibm-cloud-title} in a restricted network]**: You can install {product-title} on {ibm-cloud-title} on installer-provisioned infrastructure by using an internal mirror of the installation release content. You can use this method to install a cluster that does not require an active internet connection to obtain the software components. +* Installing a cluster on {ibm-cloud-title} in a restricted network: You can install {product-title} on {ibm-cloud-title} on installer-provisioned infrastructure by using an internal mirror of the installation release content. You can use this method to install a cluster that does not require an active internet connection to obtain the software components. -[id="next-steps_preparing-to-install-on-ibm-cloud"] -== Next steps +[role="_additional-resources"] +[id="additional-resources_preparing-to-install-on-ibm-cloud"] +== Additional resources + +* xref:../../architecture/architecture-installation.adoc#installation-process_architecture-installation[Installation process] * xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-account.adoc#installing-ibm-cloud-account[Configuring an {ibm-cloud-name} account] +* xref:../../post_installation_configuration/cluster-tasks.adoc#post-install-cluster-tasks[Postinstallation configuration overview] +* xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[Installing a customized cluster on {ibm-cloud-name}] +* xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[Installing a cluster on {ibm-cloud-name} with network customizations] +* xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-vpc.adoc#installing-ibm-cloud-vpc[Installing a cluster on {ibm-cloud-name} into an existing VPC] +* xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-private.adoc#installing-ibm-cloud-private[Installing a private cluster on an existing VPC] +* xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-restricted.adoc#installing-ibm-cloud-restricted[Installing a cluster on {ibm-cloud-title} in a restricted network] diff --git a/modules/installation-cis-ibm-cloud.adoc b/modules/installation-cis-ibm-cloud.adoc index 884c63092cd..053b6a7a587 100644 --- a/modules/installation-cis-ibm-cloud.adoc +++ b/modules/installation-cis-ibm-cloud.adoc @@ -96,17 +96,10 @@ Replace `` with the fully qualified domain name. You can use either A root domain uses the form `openshiftcorp.com`. A subdomain uses the form `clusters.openshiftcorp.com`. ==== -. Open the CIS web console, navigate to the *Overview* page, and note your CIS name servers. These name servers will be used in the next step. For more information, see "CIS web console". +. Open the CIS web console, navigate to the *Overview* page, and note your CIS name servers. These name servers are used in the next step. For more information, see "CIS web console". . Configure the name servers for your domains or subdomains at the domain's registrar or DNS provider. For more information, see the {ibm-cloud-name} documentation for "Configuring name servers". ifeval::["{context}" == "installing-ibm-cloud-account-power-vs"] :!ibm-power-vs: endif::[] - -[role="_additional-resources"] -.Additional resources -* link:https://www.ibm.com/cloud/cli[{ibm-cloud-name} CLI ({ibm-cloud-name} documentation)] -* link:https://cloud.ibm.com/docs/dns?topic=dns-getting-started[{ibm-name} DNS documentation] -* link:https://cloud.ibm.com/catalog/services/internet-services[CIS web console ({ibm-cloud-name} documentation)] -* link:https://cloud.ibm.com/docs/cis?topic=cis-getting-started#configure-your-name-servers-with-the-registrar-or-existing-dns-provider[{ibm-cloud-name} documentation for configuring name servers] diff --git a/modules/installation-dns-ibm-cloud.adoc b/modules/installation-dns-ibm-cloud.adoc index c6361ac692f..68695efadb6 100644 --- a/modules/installation-dns-ibm-cloud.adoc +++ b/modules/installation-dns-ibm-cloud.adoc @@ -70,8 +70,3 @@ Replace `` with the fully qualified zone name. You can use either the ==== You do not have to manage permitted networks or configure an "A" DNS resource record. As required, the installation program configures these resources automatically. ==== - -[role="_additional-resources"] -.Additional resources -* link:https://www.ibm.com/cloud/cli[{ibm-cloud-name} CLI ({ibm-cloud-name} documentation)] -* link:https://cloud.ibm.com/docs/dns?topic=dns-getting-started[{ibm-name} DNS documentation] diff --git a/modules/manually-create-iam-ibm-cloud.adoc b/modules/manually-create-iam-ibm-cloud.adoc index e248032be95..84ba5956712 100644 --- a/modules/manually-create-iam-ibm-cloud.adoc +++ b/modules/manually-create-iam-ibm-cloud.adoc @@ -1,7 +1,6 @@ // Module included in the following assemblies: // // * installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc -// * installing/installing_ibm_cloud/installing-ibm-cloud-network-customizations.adoc // * installing/installing_ibm_cloud/installing-ibm-cloud-vpc.adoc // * installing/installing_ibm_cloud/installing-ibm-cloud-private.adoc // * installing/installing_ibm_powervs/installing-ibm-power-vs-customizations.adoc @@ -39,7 +38,8 @@ endif::[] [id="manually-create-iam-ibm-cloud_{context}"] = Manually creating IAM -Installing the cluster requires that the Cloud Credential Operator (CCO) operate in manual mode. While the installation program configures the CCO for manual mode, you must specify the identity and access management secrets for you cloud provider. +[role="_abstract"] +To install {product-title}, the Cloud Credential Operator (CCO) must operate in manual mode. While the installation program configures the CCO for manual mode, you must specify the identity and access management secrets for your cloud provider. You can use the Cloud Credential Operator (CCO) utility (`ccoctl`) to create the required {ibm-cloud-name} resources. @@ -76,8 +76,10 @@ compute: hyperthreading: Enabled ---- endif::ibm-power-vs[] ++ +where: -* `credentialsMode`: Set the `credentialsMode` parameter to `Manual`. +`credentialsMode`:: Specifies the CCO credentials mode. Set the value to `Manual`. . To generate the manifests, run the following command from the directory that includes the installation program: + @@ -104,9 +106,12 @@ $ oc adm release extract \ --install-config=/install-config.yaml \ --to= ---- -* `--included`: Includes only the manifests that your specific cluster configuration requires. -* ``: Specify the location of the `install-config.yaml` file. -* ``: Specify the path to the directory where you want to store the `CredentialsRequest` objects. If the specified directory does not exist, this command creates it. ++ +where: + +`--included`:: Specifies that only the manifests that your specific cluster configuration requires are included. +``:: Specifies the location of the `install-config.yaml` file. +``:: Specifies the path to the directory where you want to store the `CredentialsRequest` objects. If the specified directory does not exist, this command creates it. + This command creates a YAML file for each `CredentialsRequest` object. + @@ -155,10 +160,13 @@ $ ccoctl ibmcloud create-service-id \ --output-dir= \ --resource-group-name= ---- -* ``: Specify the directory containing the files for the `CredentialsRequest` objects. -* ``: Specify the name of the {product-title} cluster. -* ``: Optional parameter. Specify the directory in which you want the `ccoctl` utility to create objects. By default, the utility creates objects in the directory in which you run the commands. -* ``: Optional parameter. Specify the name of the resource group used for scoping the access policies. ++ +where: + +``:: Specifies the directory that has the files for the `CredentialsRequest` objects. +``:: Specifies the name of the {product-title} cluster. +``:: Specifies the directory in which you want the `ccoctl` utility to create objects. By default, the utility creates objects in the directory in which you run the commands. This parameter is optional. +``:: Specifies the name of the resource group used for scoping the access policies. This parameter is optional. + -- [NOTE] diff --git a/modules/prereqs-ibm-cloud-installer-provisioned.adoc b/modules/prereqs-ibm-cloud-installer-provisioned.adoc new file mode 100644 index 00000000000..6657ed6f610 --- /dev/null +++ b/modules/prereqs-ibm-cloud-installer-provisioned.adoc @@ -0,0 +1,18 @@ +// Module included in the following assemblies: +// +// * installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc +// * installing/installing_ibm_cloud/installing-ibm-cloud-vpc.adoc +// * installing/installing_ibm_cloud/installing-ibm-cloud-private.adoc + +:_mod-docs-content-type: REFERENCE +[id="prereqs-ibm-cloud-installer-provisioned_{context}"] += Prerequisites for installing a cluster on {ibm-cloud-name} + +[role="_abstract"] +Before installing an {product-title} cluster on {ibm-cloud-name} by using installer-provisioned infrastructure, ensure that you have configured your {ibm-cloud-name} account, firewall, and the `ccoctl` utility. + +* You reviewed details about the {product-title} installation and update processes. +* You read the documentation on selecting a cluster installation method and preparing it for users. +* You configured an {ibm-cloud-name} account to host the cluster. +* If you use a firewall, you configured it to allow the sites that your cluster requires access to. +* You configured the `ccoctl` utility before you installed the cluster. \ No newline at end of file diff --git a/modules/prereqs-ibm-cloud-restricted.adoc b/modules/prereqs-ibm-cloud-restricted.adoc new file mode 100644 index 00000000000..2ebf1f0afd9 --- /dev/null +++ b/modules/prereqs-ibm-cloud-restricted.adoc @@ -0,0 +1,23 @@ +// Module included in the following assemblies: +// +// * installing/installing_ibm_cloud/installing-ibm-cloud-restricted.adoc + +:_mod-docs-content-type: REFERENCE +[id="prereqs-ibm-cloud-restricted_{context}"] += Prerequisites for installing a cluster on {ibm-cloud-name} in a disconnected environment + +[role="_abstract"] +Before installing an {product-title} cluster on {ibm-cloud-name} in a disconnected environment, ensure that you have configured your {ibm-cloud-name} account, a mirror registry, an existing VPC with access to the mirror registry, and the `ccoctl` utility. + +* You reviewed details about the {product-title} installation and update processes. +* You configured an {ibm-cloud-name} account to host the cluster. +* You have a container image registry that is accessible to the internet and your restricted network. The container image registry should mirror the contents of the {product-registry} and contain the installation media. +* You have an existing Virtual Private Cloud (VPC) on {ibm-cloud-name} that meets the following requirements: +** The VPC contains the mirror registry or has firewall rules or a peering connection to access the mirror registry that is hosted elsewhere. +** The VPC can access {ibm-cloud-name} service endpoints using a public endpoint. If network restrictions limit access to public service endpoints, evaluate those services for alternate endpoints that might be available. ++ +You cannot use the VPC that the installation program provisions by default. +* If you plan on configuring endpoint gateways to use {ibm-cloud-name} Virtual Private Endpoints, consider the following requirements: +** Endpoint gateway support is currently limited to the `us-east` and `us-south` regions. +** The VPC must allow traffic to and from the endpoint gateways. You can use the VPC's default security group, or a new security group, to allow traffic on port 443. +* You configured the `ccoctl` utility before you installed the cluster.