Skip to content

Commit 346a0a5

Browse files
committed
Reorganizing CCO manual upgrade requirements
1 parent ac8a01b commit 346a0a5

File tree

7 files changed

+37
-18
lines changed

7 files changed

+37
-18
lines changed

installing/installing_aws/manually-creating-iam.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,11 @@ include::modules/alternatives-to-storing-admin-secrets-in-kube-system.adoc[level
2424
2525
include::modules/manually-create-identity-access-management.adoc[leveloffset=+1]
2626

27-
include::modules/admin-credentials-root-secret-formats.adoc[leveloffset=+1]
27+
.Additional references
28+
* xref:../../updating/updating-cluster-within-minor.adoc#manually-maintained-credentials-upgrade_updating-cluster-within-minor[Updating a cluster within a minor version using the web console]
29+
* xref:../../updating/updating-cluster-cli.adoc#manually-maintained-credentials-upgrade_updating-cluster-cli[Updating a cluster within a minor version using the CLI]
2830
29-
include::modules/manually-maintained-credentials-upgrade.adoc[leveloffset=+1]
31+
include::modules/admin-credentials-root-secret-formats.adoc[leveloffset=+1]
3032

3133
include::modules/mint-mode.adoc[leveloffset=+1]
3234

installing/installing_azure/manually-creating-iam-azure.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,11 @@ For a detailed description of all available CCO credential modes and their suppo
1616

1717
include::modules/manually-create-identity-access-management.adoc[leveloffset=+1]
1818

19-
include::modules/admin-credentials-root-secret-formats.adoc[leveloffset=+1]
19+
.Additional references
20+
* xref:../../updating/updating-cluster-within-minor.adoc#manually-maintained-credentials-upgrade_updating-cluster-within-minor[Updating a cluster within a minor version using the web console]
21+
* xref:../../updating/updating-cluster-cli.adoc#manually-maintained-credentials-upgrade_updating-cluster-cli[Updating a cluster within a minor version using the CLI]
2022
21-
include::modules/manually-maintained-credentials-upgrade.adoc[leveloffset=+1]
23+
include::modules/admin-credentials-root-secret-formats.adoc[leveloffset=+1]
2224

2325
[id="manually-creating-iam-azure-next-steps"]
2426
== Next steps

installing/installing_gcp/manually-creating-iam-gcp.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,11 @@ For a detailed description of all available CCO credential modes and their suppo
1818

1919
include::modules/manually-create-identity-access-management.adoc[leveloffset=+1]
2020

21-
include::modules/admin-credentials-root-secret-formats.adoc[leveloffset=+1]
21+
.Additional references
22+
* xref:../../updating/updating-cluster-within-minor.adoc#manually-maintained-credentials-upgrade_updating-cluster-within-minor[Updating a cluster within a minor version using the web console]
23+
* xref:../../updating/updating-cluster-cli.adoc#manually-maintained-credentials-upgrade_updating-cluster-cli[Updating a cluster within a minor version using the CLI]
2224
23-
include::modules/manually-maintained-credentials-upgrade.adoc[leveloffset=+1]
25+
include::modules/admin-credentials-root-secret-formats.adoc[leveloffset=+1]
2426

2527
include::modules/mint-mode.adoc[leveloffset=+1]
2628

modules/manually-create-identity-access-management.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ $ openshift-install create cluster --dir <installation_directory>
173173
+
174174
[IMPORTANT]
175175
====
176-
Before upgrading a cluster that uses manually maintained credentials, you must ensure that the CCO is in an upgradeable state. For details, see the "Upgrading clusters with manually maintained credentials" section of the installation content for your cloud provider.
176+
Before upgrading a cluster that uses manually maintained credentials, you must ensure that the CCO is in an upgradeable state. For details, see the "Upgrading clusters with manually maintained credentials" section of the update procedure you are using.
177177
====
178178
179179
ifeval::["{context}" == "manually-creating-iam-aws"]

modules/manually-maintained-credentials-upgrade.adoc

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
// Module included in the following assemblies:
22
//
3-
// * installing/installing_aws/manually-creating-iam.adoc
4-
// * installing/installing_azure/manually-creating-iam-azure.adoc
5-
// * installing/installing_gcp/manually-creating-iam-gcp.adoc
63
// * authentication/managing_cloud_provider_credentials/cco-mode-manual.adoc
74
// * authentication/managing_cloud_provider_credentials/cco-mode-sts.adoc
5+
// * updating/updating-cluster-within-minor.adoc
6+
// * updating/updating-cluster-cli.adoc
87

98
:_content-type: PROCEDURE
109
[id="manually-maintained-credentials-upgrade_{context}"]
@@ -56,12 +55,12 @@ Where `<version_number>` is the version you are upgrading to, in the format `x.y
5655
+
5756
It may take several minutes after adding the annotation for the upgradeable status to change.
5857

59-
. Verify that the CCO is upgradeable:
58+
.Verification
6059

61-
.. In the *Administrator* perspective of the web console, navigate to *Administration* -> *Cluster Settings*.
60+
. In the *Administrator* perspective of the web console, navigate to *Administration* -> *Cluster Settings*.
6261

63-
.. To view the CCO status details, click *cloud-credential* in the *Cluster Operators* list.
62+
. To view the CCO status details, click *cloud-credential* in the *Cluster Operators* list.
6463

65-
.. If the *Upgradeable* status in the *Conditions* section is *False*, verify that the `upgradeable-to` annotation is free of typographical errors.
64+
. If the *Upgradeable* status in the *Conditions* section is *False*, verify that the `upgradeable-to` annotation is free of typographical errors.
6665

6766
When the *Upgradeable* status in the *Conditions* section is *True*, you can begin the {product-title} upgrade.

updating/updating-cluster-cli.adoc

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ See xref:../authentication/using-rbac.adoc[Using RBAC to define and apply permis
2020
* Have a recent xref:../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backup-etcd[etcd backup] in case your upgrade fails and you must xref:../backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-2-restoring-cluster-state.adoc#dr-restoring-cluster-state[restore your cluster to a previous state].
2121
* Ensure all Operators previously installed through Operator Lifecycle Manager (OLM) are updated to their latest version in their latest channel. Updating the Operators ensures they have a valid upgrade path when the default OperatorHub catalogs switch from the current minor version to the next during a cluster upgrade. See xref:../operators/admin/olm-upgrading-operators.adoc#olm-upgrading-operators[Upgrading installed Operators] for more information.
2222
* Ensure that all machine config pools (MCPs) are running and not paused. Nodes associated with a paused MCP are skipped during the update process. You can pause the MCPs if you are performing a canary rollout update strategy.
23-
* If your cluster uses manually maintained credentials, ensure that the Cloud Credential Operator (CCO) is in an upgradeable state. For more information, see _Upgrading clusters with manually maintained credentials_ for xref:../installing/installing_aws/manually-creating-iam.adoc#manually-maintained-credentials-upgrade_manually-creating-iam-aws[AWS], xref:../installing/installing_azure/manually-creating-iam-azure.adoc#manually-maintained-credentials-upgrade_manually-creating-iam-azure[Azure], or xref:../installing/installing_gcp/manually-creating-iam-gcp.adoc#manually-maintained-credentials-upgrade_manually-creating-iam-gcp[GCP].
24-
* If your cluster uses manually maintained credentials with the AWS Secure Token Service (STS), obtain a copy of the `ccoctl` utility from the release image being upgraded to and use it to process any updated credentials. For more information, see xref:../authentication/managing_cloud_provider_credentials/cco-mode-sts.adoc#sts-mode-upgrading[_Upgrading an OpenShift Container Platform cluster configured for manual mode with STS_].
23+
* If your cluster uses manually maintained credentials, ensure that the Cloud Credential Operator (CCO) is in an upgradeable state. For more information, see xref:../updating/updating-cluster-cli.adoc#manually-maintained-credentials-upgrade_updating-cluster-cli[Upgrading clusters with manually maintained credentials].
24+
* If your cluster uses manually maintained credentials with the AWS Secure Token Service (STS), obtain a copy of the `ccoctl` utility from the release image being upgraded to and use it to process any updated credentials. For more information, see xref:../authentication/managing_cloud_provider_credentials/cco-mode-sts.adoc#sts-mode-upgrading[Upgrading an OpenShift Container Platform cluster configured for manual mode with STS].
2525
* Ensure that you address all `Upgradeable=False` conditions so the cluster allows an upgrade to the next minor version. You can run the `oc adm upgrade` command for an output of all `Upgradeable=False` conditions and the condition reasoning to help you prepare for a minor version upgrade.
2626

2727

@@ -39,6 +39,13 @@ If you are running cluster monitoring with an attached PVC for Prometheus, you m
3939

4040
* xref:../architecture/architecture-installation.adoc#unmanaged-operators_architecture-installation[Support policy for unmanaged Operators]
4141

42+
include::modules/manually-maintained-credentials-upgrade.adoc[leveloffset=+1]
43+
44+
.Additional resources
45+
* xref:../installing/installing_aws/manually-creating-iam.adoc[Manually creating IAM for AWS]
46+
* xref:../installing/installing_azure/manually-creating-iam-azure.adoc[Manually creating IAM for Azure]
47+
* xref:../installing/installing_gcp/manually-creating-iam-gcp.adoc[Manually creating IAM for GCP]
48+
4249
include::modules/machine-health-checks-pausing.adoc[leveloffset=+1]
4350

4451
include::modules/updating-sno.adoc[leveloffset=+1]

updating/updating-cluster-within-minor.adoc

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ See xref:../authentication/using-rbac.adoc[Using RBAC to define and apply permis
2020
* Have a recent xref:../backup_and_restore/control_plane_backup_and_restore/backing-up-etcd.adoc#backup-etcd[etcd backup] in case your upgrade fails and you must xref:../backup_and_restore/control_plane_backup_and_restore/disaster_recovery/scenario-2-restoring-cluster-state.adoc#dr-restoring-cluster-state[restore your cluster to a previous state].
2121
* Ensure all Operators previously installed through Operator Lifecycle Manager (OLM) are updated to their latest version in their latest channel. Updating the Operators ensures they have a valid upgrade path when the default OperatorHub catalogs switch from the current minor version to the next during a cluster upgrade. See xref:../operators/admin/olm-upgrading-operators.adoc#olm-upgrading-operators[Upgrading installed Operators] for more information.
2222
* Ensure that all machine config pools (MCPs) are running and not paused. Nodes associated with a paused MCP are skipped during the update process. You can pause the MCPs if you are performing a canary rollout update strategy.
23-
* If your cluster uses manually maintained credentials, ensure that the Cloud Credential Operator (CCO) is in an upgradeable state. For more information, see _Upgrading clusters with manually maintained credentials_ for xref:../installing/installing_aws/manually-creating-iam.adoc#manually-maintained-credentials-upgrade_manually-creating-iam-aws[AWS], xref:../installing/installing_azure/manually-creating-iam-azure.adoc#manually-maintained-credentials-upgrade_manually-creating-iam-azure[Azure], or xref:../installing/installing_gcp/manually-creating-iam-gcp.adoc#manually-maintained-credentials-upgrade_manually-creating-iam-gcp[GCP].
24-
* If your cluster uses manually maintained credentials with the AWS Secure Token Service (STS), obtain a copy of the `ccoctl` utility from the release image being upgraded to and use it to process any updated credentials. For more information, see xref:../authentication/managing_cloud_provider_credentials/cco-mode-sts.adoc#sts-mode-upgrading[_Upgrading an OpenShift Container Platform cluster configured for manual mode with STS_].
23+
* If your cluster uses manually maintained credentials, ensure that the Cloud Credential Operator (CCO) is in an upgradeable state. For more information, see xref:../updating/updating-cluster-within-minor.adoc#manually-maintained-credentials-upgrade_updating-cluster-within-minor[Upgrading clusters with manually maintained credentials].
24+
* If your cluster uses manually maintained credentials with the AWS Secure Token Service (STS), obtain a copy of the `ccoctl` utility from the release image being upgraded to and use it to process any updated credentials. For more information, see xref:../authentication/managing_cloud_provider_credentials/cco-mode-sts.adoc#sts-mode-upgrading[Upgrading an OpenShift Container Platform cluster configured for manual mode with STS].
2525

2626
[IMPORTANT]
2727
====
@@ -41,6 +41,13 @@ include::modules/update-using-custom-machine-config-pools-canary.adoc[leveloffse
4141

4242
If you want to use the canary rollout update process, see xref:../updating/update-using-custom-machine-config-pools.adoc#update-using-custom-machine-config-pools[Performing a canary rollout update].
4343

44+
include::modules/manually-maintained-credentials-upgrade.adoc[leveloffset=+1]
45+
46+
.Additional resources
47+
* xref:../installing/installing_aws/manually-creating-iam.adoc[Manually creating IAM for AWS]
48+
* xref:../installing/installing_azure/manually-creating-iam-azure.adoc[Manually creating IAM for Azure]
49+
* xref:../installing/installing_gcp/manually-creating-iam-gcp.adoc[Manually creating IAM for GCP]
50+
4451
include::modules/machine-health-checks-pausing.adoc[leveloffset=+1]
4552

4653
include::modules/updating-sno.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)