Merge pull request #62571 from skopacz1/OSDOCS-5790

skrthomas · web-flow · commit bf3cecb8cde8 · 2023-07-20T11:27:47.000-04:00
OSDOCS#5790: Create preparing for update subsection
diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml
@@ -567,12 +567,19 @@ Topics:
       Distros: openshift-enterprise
     - Name: Understanding OpenShift update duration
       File: understanding-openshift-update-duration
-- Name: Preparing to update to OpenShift Container Platform 4.13
-  File: updating-cluster-prepare
-  Distros: openshift-enterprise
-- Name: Preparing to update to OKD 4.13
-  File: updating-cluster-prepare
-  Distros: openshift-origin
+- Name: Preparing to update a cluster
+  Dir: preparing_for_updates
+  Topics:
+  - Name: Preparing to update to OpenShift Container Platform 4.13
+    File: updating-cluster-prepare
+    Distros: openshift-enterprise
+  - Name: Preparing to update to OKD 4.13
+    File: updating-cluster-prepare
+    Distros: openshift-origin
+  - Name: Preparing to update a cluster with manually maintained credentials
+    File: preparing-manual-creds-update
+  - Name: Preflight validation for Kernel Module Management (KMM) Modules
+    File: kmm-preflight-validation
 - Name: Performing a cluster update
   Dir: updating_a_cluster
   Topics:
@@ -613,10 +620,6 @@ Topics:
     File: migrating-to-multi-payload
   - Name: Updating hosted control planes
     File: updating-hosted-control-planes
-- Name: Preparing to update a cluster with manually maintained credentials
-  File: preparing-manual-creds-update
-- Name: Preflight validation for Kernel Module Management (KMM) Modules
-  File: kmm-preflight-validation
 # - Name: Troubleshooting an update
 #  File: updating-troubleshooting
 ---
diff --git a/authentication/managing_cloud_provider_credentials/cco-mode-gcp-workload-identity.adoc b/authentication/managing_cloud_provider_credentials/cco-mode-gcp-workload-identity.adoc
@@ -103,7 +103,7 @@ Because the cluster is operating in manual mode when using GCP Workload Identity
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../updating/preparing-manual-creds-update.adoc#cco-ccoctl-configuring_preparing-manual-creds-update[Configuring the Cloud Credential Operator utility for a cluster update]
+* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#cco-ccoctl-configuring_preparing-manual-creds-update[Configuring the Cloud Credential Operator utility for a cluster update]
 
 //Task part 1: Configuring the Cloud Credential Operator utility
 include::modules/cco-ccoctl-configuring.adoc[leveloffset=+2]
@@ -121,4 +121,4 @@ include::modules/sts-mode-installing-verifying.adoc[leveloffset=+2]
 [id="additional-resources_{context}"]
 == Additional resources
 
-* xref:../../updating/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials]
+* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials]
diff --git a/authentication/managing_cloud_provider_credentials/cco-mode-sts.adoc b/authentication/managing_cloud_provider_credentials/cco-mode-sts.adoc
@@ -82,7 +82,7 @@ Because the cluster is operating in manual mode when using STS, it is not able t
 [role="_additional-resources"]
 .Additional resources
 
-* xref:../../updating/preparing-manual-creds-update.adoc#cco-ccoctl-configuring_preparing-manual-creds-update[Configuring the Cloud Credential Operator utility for a cluster update]
+* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#cco-ccoctl-configuring_preparing-manual-creds-update[Configuring the Cloud Credential Operator utility for a cluster update]
 
 //[pre-4.8]Task part 1: Creating AWS resources manually
 //include::modules/sts-mode-installing-manual-config.adoc[leveloffset=+2]
@@ -111,4 +111,4 @@ include::modules/sts-mode-installing-verifying.adoc[leveloffset=+2]
 [id="additional-resources_{context}"]
 == Additional resources
 
-* xref:../../updating/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials]
+* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials]
diff --git a/installing/installing_alibaba/manually-creating-alibaba-ram.adoc b/installing/installing_alibaba/manually-creating-alibaba-ram.adoc
@@ -18,7 +18,7 @@ include::modules/manually-creating-alibaba-ram-user.adoc[leveloffset=+1]
 include::modules/cco-ccoctl-configuring.adoc[leveloffset=+1]
 [role="_additional-resources"]
 .Additional resources
-* xref:../../updating/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials]
+* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials]
 
 //Task part 3: Creating Alibaba resources with a single command
 // modules/cco-ccoctl-creating-at-once.adoc[leveloffset=+1]
diff --git a/installing/installing_aws/manually-creating-iam.adoc b/installing/installing_aws/manually-creating-iam.adoc
@@ -27,7 +27,7 @@ include::modules/manually-create-identity-access-management.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
-* xref:../../updating/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials]
+* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials]
 
 include::modules/mint-mode.adoc[leveloffset=+1]
 
diff --git a/installing/installing_azure/manually-creating-iam-azure.adoc b/installing/installing_azure/manually-creating-iam-azure.adoc
@@ -18,7 +18,7 @@ include::modules/manually-create-identity-access-management.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
-* xref:../../updating/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials]
+* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials]
 
 [id="manually-creating-iam-azure-next-steps"]
 == Next steps
diff --git a/installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc b/installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc
@@ -39,7 +39,7 @@ include::modules/manually-create-identity-access-management.adoc[leveloffset=+1]
 [role="_additional-resources"]
 [id="additional-resources_installing-azure-stack-hub-default-cco"]
 .Additional resources
-* xref:../../updating/preparing-manual-creds-update.adoc#manually-maintained-credentials-upgrade_preparing-manual-creds-update[Updating cloud provider resources with manually maintained credentials]
+* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#manually-maintained-credentials-upgrade_preparing-manual-creds-update[Updating cloud provider resources with manually maintained credentials]
 
 include::modules/azure-stack-hub-internal-ca.adoc[leveloffset=+1]
 
diff --git a/installing/installing_gcp/manually-creating-iam-gcp.adoc b/installing/installing_gcp/manually-creating-iam-gcp.adoc
@@ -22,7 +22,7 @@ include::modules/manually-create-identity-access-management.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
-* xref:../../updating/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials]
+* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials]
 
 include::modules/mint-mode.adoc[leveloffset=+1]
 
diff --git a/installing/installing_ibm_cloud_public/configuring-iam-ibm-cloud.adoc b/installing/installing_ibm_cloud_public/configuring-iam-ibm-cloud.adoc
@@ -30,4 +30,4 @@ include::modules/cco-ccoctl-configuring.adoc[leveloffset=+1]
 [id="additional-resources_{context}"]
 == Additional resources
 
-* xref:../../updating/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials]
+* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials]
diff --git a/installing/installing_nutanix/preparing-to-install-on-nutanix.adoc b/installing/installing_nutanix/preparing-to-install-on-nutanix.adoc
@@ -13,4 +13,4 @@ include::modules/installation-nutanix-installer-infra-reqs.adoc[leveloffset=+1]
 include::modules/cco-ccoctl-configuring.adoc[leveloffset=+1]
 [role="_additional-resources"]
 .Additional resources
-* xref:../../updating/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials]
+* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#preparing-manual-creds-update[Preparing to update a cluster with manually maintained credentials]
diff --git a/updating/preparing-manual-creds-update.adoc b/updating/preparing-manual-creds-update.adoc
diff --git a/updating/preparing_for_updates/_attributes b/updating/preparing_for_updates/_attributes
@@ -0,0 +1 @@
+../../_attributes/
diff --git a/updating/preparing_for_updates/images b/updating/preparing_for_updates/images
@@ -0,0 +1 @@
+../../images/
diff --git a/updating/preparing_for_updates/kmm-preflight-validation.adoc b/updating/preparing_for_updates/kmm-preflight-validation.adoc
diff --git a/updating/preparing_for_updates/modules b/updating/preparing_for_updates/modules
@@ -0,0 +1 @@
+../../modules/
diff --git a/updating/preparing_for_updates/preparing-manual-creds-update.adoc b/updating/preparing_for_updates/preparing-manual-creds-update.adoc
@@ -0,0 +1,66 @@
+:_content-type: ASSEMBLY
+[id="preparing-manual-creds-update"]
+= Preparing to update a cluster with manually maintained credentials
+include::_attributes/common-attributes.adoc[]
+:context: preparing-manual-creds-update
+
+toc::[]
+
+The Cloud Credential Operator (CCO) `Upgradable` status for a cluster with manually maintained credentials is `False` by default.
+
+* For minor releases, for example, from 4.12 to 4.13, this status prevents you from updating until you have addressed any updated permissions and annotated the `CloudCredential` resource to indicate that the permissions are updated as needed for the next version. This annotation changes the `Upgradable` status to `True`.
+
+* For z-stream releases, for example, from 4.13.0 to 4.13.1, no permissions are added or changed, so the update is not blocked.
+
+Before updating a cluster with manually maintained credentials, you must accommodate any new or changed credentials in the release image for the version of {product-title} you are updating to.
+
+//Upgrading clusters with manually maintained credentials
+include::modules/about-manually-maintained-credentials-upgrade.adoc[leveloffset=+1]
+[role="_additional-resources"]
+.Additional resources
+* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#cco-determine-mode-gui_preparing-manual-creds-update[Determining the Cloud Credential Operator mode by using the web console]
+* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#cco-determine-mode-cli_preparing-manual-creds-update[Determining the Cloud Credential Operator mode by using the CLI]
+* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#cco-ccoctl-configuring_preparing-manual-creds-update[Configuring the Cloud Credential Operator utility for a cluster update]
+* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#manually-maintained-credentials-upgrade_preparing-manual-creds-update[Updating cloud provider resources with manually maintained credentials]
+* xref:../../authentication/managing_cloud_provider_credentials/about-cloud-credential-operator.adoc#about-cloud-credential-operator[About the Cloud Credential Operator]
+
+//Determining the Cloud Credential Operator mode by using the web console
+include::modules/cco-determine-mode-gui.adoc[leveloffset=+2]
+[role="_additional-resources"]
+.Additional resources
+* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#cco-ccoctl-configuring_preparing-manual-creds-update[Configuring the Cloud Credential Operator utility for a cluster update]
+* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#manually-maintained-credentials-upgrade_preparing-manual-creds-update[Updating cloud provider resources with manually maintained credentials]
+
+//Determining the Cloud Credential Operator mode by using the CLI
+include::modules/cco-determine-mode-cli.adoc[leveloffset=+2]
+[role="_additional-resources"]
+.Additional resources
+* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#cco-ccoctl-configuring_preparing-manual-creds-update[Configuring the Cloud Credential Operator utility for a cluster update]
+* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#manually-maintained-credentials-upgrade_preparing-manual-creds-update[Updating cloud provider resources with manually maintained credentials]
+
+//Configuring the Cloud Credential Operator utility for a cluster update
+include::modules/cco-ccoctl-configuring.adoc[leveloffset=+1]
+
+//Updating cloud provider resources with the Cloud Credential Operator utility
+include::modules/cco-ccoctl-upgrading.adoc[leveloffset=+1]
+[role="_additional-resources"]
+.Additional resources
+* xref:../../installing/installing_alibaba/installing-alibaba-default.adoc#cco-ccoctl-creating-at-once_installing-alibaba-default[Creating {alibaba} credentials for {product-title} components with the `ccoctl` tool]
+* xref:../../authentication/managing_cloud_provider_credentials/cco-mode-sts.adoc#sts-mode-create-aws-resources-ccoctl_cco-mode-sts[Creating AWS resources with the Cloud Credential Operator utility]
+* xref:../../authentication/managing_cloud_provider_credentials/cco-mode-gcp-workload-identity.adoc#cco-ccoctl-creating-at-once_cco-mode-gcp-workload-identity[Creating GCP resources with the Cloud Credential Operator utility]
+* xref:../../installing/installing_ibm_cloud_public/installing-ibm-cloud-customizations.adoc#manually-create-iam-ibm-cloud_installing-ibm-cloud-customizations[Manually creating IAM for IBM Cloud VPC]
+* xref:../../installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc#manually-create-iam-nutanix_installing-nutanix-installer-provisioned[Configuring IAM for Nutanix]
+* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#cco-manual-upgrade-annotation_preparing-manual-creds-update[Indicating that the cluster is ready to upgrade]
+
+//Updating cloud provider resources with manually maintained credentials
+include::modules/manually-maintained-credentials-upgrade.adoc[leveloffset=+1]
+[role="_additional-resources"]
+.Additional resources
+* xref:../../installing/installing_aws/manually-creating-iam.adoc#manually-create-iam_manually-creating-iam-aws[Manually creating IAM for AWS]
+* xref:../../installing/installing_azure/manually-creating-iam-azure.adoc#manually-create-iam_manually-creating-iam-azure[Manually creating IAM for Azure]
+* xref:../../installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc#manually-create-iam_installing-azure-stack-hub-default[Manually creating IAM for Azure Stack Hub]
+* xref:../../installing/installing_gcp/manually-creating-iam-gcp.adoc#manually-create-iam_manually-creating-iam-gcp[Manually creating IAM for GCP]
+* xref:../../updating/preparing_for_updates/preparing-manual-creds-update.adoc#cco-manual-upgrade-annotation_preparing-manual-creds-update[Indicating that the cluster is ready to upgrade]
+
+//Indicating that the cluster is ready to upgrade
+include::modules/cco-manual-upgrade-annotation.adoc[leveloffset=+1]
diff --git a/updating/preparing_for_updates/snippets b/updating/preparing_for_updates/snippets
@@ -0,0 +1 @@
+../../snippets/
diff --git a/updating/preparing_for_updates/updating-cluster-prepare.adoc b/updating/preparing_for_updates/updating-cluster-prepare.adoc
diff --git a/updating/updating_a_cluster/updating-cluster-cli.adoc b/updating/updating_a_cluster/updating-cluster-cli.adoc
diff --git a/updating/updating_a_cluster/updating-cluster-rhel-compute.adoc b/updating/updating_a_cluster/updating-cluster-rhel-compute.adoc
diff --git a/updating/updating_a_cluster/updating-cluster-web-console.adoc b/updating/updating_a_cluster/updating-cluster-web-console.adoc
diff --git a/updating/updating_a_cluster/updating_disconnected_cluster/disconnected-update.adoc b/updating/updating_a_cluster/updating_disconnected_cluster/disconnected-update.adoc
