From 1492242f484578146e313bbd480bdfd738fd21e7 Mon Sep 17 00:00:00 2001 From: DCChadwick Date: Fri, 10 Jul 2026 14:56:27 -0400 Subject: [PATCH] OSDOCS16999 CQA Installing on IBM Cloud Part 1 --- .../configuring-iam-ibm-cloud.adoc | 6 +-- ...ation-config-parameters-ibm-cloud-vpc.adoc | 5 ++- .../installing-ibm-cloud-account.adoc | 40 ++++++++++++------- .../installing-ibm-cloud-customizations.adoc | 35 ++++++++-------- modules/ssh-agent-using.adoc | 8 ++++ 5 files changed, 58 insertions(+), 36 deletions(-) diff --git a/installing/installing_ibm_cloud/configuring-iam-ibm-cloud.adoc b/installing/installing_ibm_cloud/configuring-iam-ibm-cloud.adoc index d5c3ec0ee6c1..edf2d63cbe8f 100644 --- a/installing/installing_ibm_cloud/configuring-iam-ibm-cloud.adoc +++ b/installing/installing_ibm_cloud/configuring-iam-ibm-cloud.adoc @@ -6,6 +6,7 @@ include::_attributes/common-attributes.adoc[] toc::[] +[role="_abstract"] In environments where the cloud identity and access management (IAM) APIs are not reachable, you must put the Cloud Credential Operator (CCO) into manual mode before you install the cluster. include::modules/alternatives-to-storing-admin-secrets-in-kube-system.adoc[leveloffset=+1] @@ -22,12 +23,9 @@ include::modules/cco-ccoctl-configuring.adoc[leveloffset=+1] .Additional resources * xref:../../post_installation_configuration/changing-cloud-credentials-configuration.adoc#refreshing-service-ids-ibm-cloud_changing-cloud-credentials-configuration[Rotating API keys for {ibm-cloud-name}] -[id="next-steps_configuring-iam-ibm-cloud"] -== Next steps -* xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[Installing a cluster on {ibm-cloud-name} with customizations] - [role="_additional-resources"] [id="additional-resources_{context}"] == Additional resources +* xref:../../installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc#installing-ibm-cloud-customizations[Installing a cluster on {ibm-cloud-name} with customizations] * xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials] \ No newline at end of file diff --git a/installing/installing_ibm_cloud/installation-config-parameters-ibm-cloud-vpc.adoc b/installing/installing_ibm_cloud/installation-config-parameters-ibm-cloud-vpc.adoc index 95296f90e721..0178139c5629 100644 --- a/installing/installing_ibm_cloud/installation-config-parameters-ibm-cloud-vpc.adoc +++ b/installing/installing_ibm_cloud/installation-config-parameters-ibm-cloud-vpc.adoc @@ -7,6 +7,9 @@ include::_attributes/common-attributes.adoc[] toc::[] -Before you deploy an {product-title} cluster on {ibm-cloud-name}, you provide parameters to customize your cluster and the platform that hosts it. When you create the `install-config.yaml` file, you provide values for the required parameters through the command line. You can then modify the `install-config.yaml` file to customize your cluster further. +[role="_abstract"] +Before you deploy an {product-title} cluster on {ibm-cloud-name}, you provide parameters to customize your cluster and the platform that hosts it. + +When you create the `install-config.yaml` file, you provide values for the required parameters through the command line. You can then modify the `install-config.yaml` file to customize your cluster further. include::modules/installation-configuration-parameters.adoc[leveloffset=+1] diff --git a/installing/installing_ibm_cloud/installing-ibm-cloud-account.adoc b/installing/installing_ibm_cloud/installing-ibm-cloud-account.adoc index fd3a6f3e5310..d3417d9d0007 100644 --- a/installing/installing_ibm_cloud/installing-ibm-cloud-account.adoc +++ b/installing/installing_ibm_cloud/installing-ibm-cloud-account.adoc @@ -6,22 +6,17 @@ include::_attributes/common-attributes.adoc[] toc::[] -Before you can install {product-title}, you must configure an {ibm-cloud-name} account. - -[id="prerequisites_installing-ibm-cloud-account"] -== Prerequisites - -* You have an {ibm-cloud-name} account with a subscription. You cannot install {product-title} on a free or trial {ibm-cloud-name} account. +[role="_abstract"] +Before you can install {product-title}, you must configure an {ibm-cloud-name} account. You must have an account with a subscription; you cannot install {product-title} on a free or trial account. include::modules/quotas-and-limits-ibm-cloud.adoc[leveloffset=+1] -[id="configuring-dns-resolution"] -== Configuring DNS resolution - -How you configure DNS resolution depends on the type of {product-title} cluster you are installing: +[role="_additional-resources"] +[id="additional-resources_quotas-and-limits-ibm-cloud"] +.Additional resources +* link:https://cloud.ibm.com/docs/vpc?topic=vpc-profiles[{ibm-cloud-name} docs: x86-64 instance profiles] -* If you are installing a public cluster, you use {ibm-cloud-title} Internet Services (CIS). -* If you are installing a private cluster, you use {ibm-cloud-name} DNS Services (DNS Services) +include::modules/installation-ibm-cloud-dns-resolution-concept.adoc[leveloffset=+1] include::modules/installation-cis-ibm-cloud.adoc[leveloffset=+2] @@ -29,10 +24,25 @@ include::modules/installation-dns-ibm-cloud.adoc[leveloffset=+2] include::modules/installation-ibm-cloud-iam-policies-api-key.adoc[leveloffset=+1] +[role="_additional-resources"] +[id="additional-resources_installation-ibm-cloud-iam-policies-api-key"] +.Additional resources +* link:https://cloud.ibm.com/docs/account?topic=account-iamoverview[{ibm-cloud-name} docs: Getting started with {ibm-cloud-name} IAM] +* link:https://cloud.ibm.com/docs/account?topic=account-rgs[{ibm-cloud-name} docs: Managing resource groups] +* link:https://cloud.ibm.com/docs/account?topic=account-assign-access-resources[{ibm-cloud-name} docs: Managing access to resources] +* link:https://cloud.ibm.com/docs/account?topic=account-groups[{ibm-cloud-name} docs: Streamlined access management with access groups] + include::modules/installation-ibm-cloud-creating-api-key.adoc[leveloffset=+2] include::modules/installation-ibm-cloud-regions.adoc[leveloffset=+1] -[id="next-steps_installing-ibm-cloud-account"] -== Next steps -* xref:../../installing/installing_ibm_cloud/configuring-iam-ibm-cloud.adoc#configuring-iam-ibm-cloud[Configuring IAM for {ibm-cloud-name}] +[role="_additional-resources"] +[id="additional-resources_installation-ibm-cloud-regions"] +.Additional resources +* link:https://cloud.ibm.com/docs/vpc?topic=vpc-quotas[{ibm-cloud-name} docs: Quotas and service limits] + +[role="_additional-resources"] +[id="additional-resources_{context}"] +== Additional resources + +* xref:../../installing/installing_ibm_cloud/configuring-iam-ibm-cloud.adoc#configuring-iam-ibm-cloud[Configuring IAM for {ibm-cloud-name}] \ No newline at end of file diff --git a/installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc b/installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc index 5f8bb953517d..01ad65a59ad6 100644 --- a/installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc +++ b/installing/installing_ibm_cloud/installing-ibm-cloud-customizations.adoc @@ -6,26 +6,26 @@ 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"] +You can install a customized {product-title} cluster on {ibm-cloud-name} by using installer-provisioned infrastructure. To customize your installation, you modify 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. -[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] +[role="_additional-resources"] +[id="additional-resources_ssh-agent-using"] +.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-obtaining-installer.adoc[leveloffset=+1] include::modules/installation-ibm-cloud-export-variables.adoc[leveloffset=+1] @@ -87,8 +87,11 @@ include::modules/cluster-telemetry.adoc[leveloffset=+1] .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]. +[role="_additional-resources"] +[id="additional-resources_{context}"] +== Additional resources +[role="_additional-resources"] +[id="additional-resources_{context}"] +== Additional resources +* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster] +* xref:../../support/remote_health_monitoring/remote-health-reporting.adoc#remote-health-reporting[Remote health reporting] diff --git a/modules/ssh-agent-using.adoc b/modules/ssh-agent-using.adoc index 6f9c76c658fc..19cfc85c3e3a 100644 --- a/modules/ssh-agent-using.adoc +++ b/modules/ssh-agent-using.adoc @@ -141,6 +141,14 @@ As a result, newly provisioned {product-title} nodes are not accessible using SS ==== endif::openshift-origin[] +.Prerequisites + +* 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. For more information, see "Configuring an {ibm-cloud-name} account". +* If you use a firewall, you configured it to allow the sites that your cluster requires access to. For more information, see "Configuring your firewall". +* You configured the `ccoctl` utility before you installed the cluster. For more information, see "Configuring IAM for {ibm-cloud-name}". + .Procedure . If you do not have an existing SSH key pair on your local machine to use for authentication onto your cluster nodes, create one. For example, on a computer that uses a Linux operating system, run the following command: