From d43f27b777cf5c03aa03cd04ac862ba51e282dae Mon Sep 17 00:00:00 2001 From: bmcelvee Date: Tue, 6 Jun 2023 15:49:46 -0400 Subject: [PATCH] OSDOCS-3386: Y-stream manual | Z-stream opt documentation updates --- _topic_maps/_topic_map_rosa.yml | 21 ++++++---- modules/rosa-upgrading-automatic-ocm.adoc | 3 +- modules/rosa-upgrading-cli-tutorial.adoc | 2 +- modules/rosa-upgrading-manual-ocm.adoc | 3 +- upgrading/rosa-hcp-upgrading.adoc | 2 +- .../rosa-updating-cluster-prepare-4-10.adoc | 40 +++++++++++++++++++ .../rosa-updating-cluster-prepare-4-11.adoc | 39 ++++++++++++++++++ .../rosa-updating-cluster-prepare-4-12.adoc | 40 +++++++++++++++++++ .../rosa-updating-cluster-prepare-4-13.adoc | 40 +++++++++++++++++++ upgrading/rosa-upgrading-cluster-prepare.adoc | 2 +- upgrading/rosa-upgrading-sts.adoc | 2 +- upgrading/rosa-upgrading.adoc | 2 +- 12 files changed, 181 insertions(+), 15 deletions(-) create mode 100644 upgrading/rosa-updating-cluster-prepare-4-10.adoc create mode 100644 upgrading/rosa-updating-cluster-prepare-4-11.adoc create mode 100644 upgrading/rosa-updating-cluster-prepare-4-12.adoc create mode 100644 upgrading/rosa-updating-cluster-prepare-4-13.adoc diff --git a/_topic_maps/_topic_map_rosa.yml b/_topic_maps/_topic_map_rosa.yml index cf1802dc1e3c..58f888eec271 100644 --- a/_topic_maps/_topic_map_rosa.yml +++ b/_topic_maps/_topic_map_rosa.yml @@ -246,19 +246,24 @@ Topics: - Name: Managing security context constraints File: managing-security-context-constraints --- -Name: Upgrading +Name: Updating Dir: upgrading Distros: openshift-rosa Topics: -- Name: Preparing to upgrade ROSA to 4.9 - File: rosa-upgrading-cluster-prepare - Distros: openshift-rosa -- Name: Upgrading ROSA with STS +#- Name: Preparing to update ROSA to 4.10 +# File: rosa-updating-cluster-prepare-4-10 +#- Name: Preparing to update ROSA to 4.11 +# File: rosa-updating-cluster-prepare-4-11 +- Name: Preparing to update ROSA to 4.12 + File: rosa-updating-cluster-prepare-4-12 +- Name: Preparing to update ROSA to 4.13 + File: rosa-updating-cluster-prepare-4-13 +- Name: Updating ROSA with HCP + File: rosa-hcp-upgrading +- Name: Updating ROSA classic File: rosa-upgrading-sts -- Name: Upgrading ROSA +- Name: Updating ROSA non-STS File: rosa-upgrading -- Name: Upgrading ROSA with HCP - File: rosa-hcp-upgrading --- Name: CI/CD Dir: cicd diff --git a/modules/rosa-upgrading-automatic-ocm.adoc b/modules/rosa-upgrading-automatic-ocm.adoc index 5763265f1d65..a511cf8429e1 100644 --- a/modules/rosa-upgrading-automatic-ocm.adoc +++ b/modules/rosa-upgrading-automatic-ocm.adoc @@ -18,7 +18,8 @@ You can schedule recurring, automatic upgrades for z-stream patch versions for y . Select a preferred day of the week and start time for the upgrade, when updates are available. . Provide an administrator’s acknowledgment and click *Approve and continue*. {cluster-manager} does not start scheduled y-stream updates for minor versions without receiving an administrator’s acknowledgment. + -For information about administrator acknowledgment, see xref:./../upgrading/rosa-upgrading-cluster-prepare.adoc#upgrade-49-acknowledgement_rosa-updating-cluster-prepare[Administrator acknowledgment when upgrading to OpenShift 4.9]. +For information about administrator acknowledgment, see xref:./../upgrading/rosa-updating-cluster-prepare-4-13.adoc#rosa-updating-cluster-prepare-4-13[Administrator acknowledgment when upgrading to OpenShift 4.13]. + . In the *Node draining* pane, select a grace period interval from the list. The grace period enables the nodes to gracefully drain before forcing the pod eviction. The default is *1 hour*. . In the *Update strategy* pane, click *Save* to apply your update strategy. + diff --git a/modules/rosa-upgrading-cli-tutorial.adoc b/modules/rosa-upgrading-cli-tutorial.adoc index b91c702ede75..6ead8ebe9d10 100644 --- a/modules/rosa-upgrading-cli-tutorial.adoc +++ b/modules/rosa-upgrading-cli-tutorial.adoc @@ -27,7 +27,7 @@ This method schedules the cluster for an immediate upgrade, if a more recent ver * You have installed and configured the latest ROSA CLI on your installation host. ifdef::sts[] -* If you are upgrading your cluster from 4.7 to 4.8, you have upgraded the AWS Identity and Access Management (IAM) account-wide roles and policies to version 4.8. You have also updated the `cloudcredential.openshift.io/upgradeable-to` annotation in the `CloudCredential` custom resource. +* You have updated the AWS Identity and Access Management (IAM) account-wide roles and policies to the latest version. You have also updated the `cloudcredential.openshift.io/upgradeable-to` annotation in the `CloudCredential` custom resource. endif::sts[] .Procedure diff --git a/modules/rosa-upgrading-manual-ocm.adoc b/modules/rosa-upgrading-manual-ocm.adoc index 4f961fcf7b84..2a1ad1df4a8d 100644 --- a/modules/rosa-upgrading-manual-ocm.adoc +++ b/modules/rosa-upgrading-manual-ocm.adoc @@ -32,7 +32,8 @@ endif::sts[] . Select the version you want to upgrade your cluster to. Recommended cluster upgrades appear in the UI. . If you select an update version that requires approval, provide an administrator’s acknowledgment and click *Approve and continue*. + -For information about administrator acknowledgment, see xref:./../upgrading/rosa-upgrading-cluster-prepare.adoc#upgrade-49-acknowledgement_rosa-updating-cluster-prepare[Administrator acknowledgment when upgrading to OpenShift 4.9]. +For information about administrator acknowledgment, see xref:./../upgrading/rosa-updating-cluster-prepare-4-13.adoc#rosa-updating-cluster-prepare-4-13[Administrator acknowledgment when upgrading to OpenShift 4.13]. + . In the *Node draining* pane, select a grace period interval from the list. The grace period enables the nodes to gracefully drain before forcing the pod eviction. The default is *1 hour*. . In the *Update strategy* pane, click *Save* to apply your update strategy. . In the *Update status* pane, review the *Update available* information and click *Update*. diff --git a/upgrading/rosa-hcp-upgrading.adoc b/upgrading/rosa-hcp-upgrading.adoc index c0583c393f6b..bf279e61e25a 100644 --- a/upgrading/rosa-hcp-upgrading.adoc +++ b/upgrading/rosa-hcp-upgrading.adoc @@ -1,6 +1,6 @@ :_content-type: ASSEMBLY [id="rosa-hcp-upgrading"] -= Upgrading {hcp-title} += Updating {hcp-title} include::_attributes/attributes-openshift-dedicated.adoc[] :context: rosa-hcp-upgrading diff --git a/upgrading/rosa-updating-cluster-prepare-4-10.adoc b/upgrading/rosa-updating-cluster-prepare-4-10.adoc new file mode 100644 index 000000000000..fcf3572b884e --- /dev/null +++ b/upgrading/rosa-updating-cluster-prepare-4-10.adoc @@ -0,0 +1,40 @@ +[id="rosa-updating-cluster-prepare-4-10"] += Preparing to update ROSA to 4.10 +include::_attributes/common-attributes.adoc[] +ifdef::openshift-dedicated,openshift-rosa[] +include::_attributes/attributes-openshift-dedicated.adoc[] +endif::[] +:context: rosa-updating-cluster-prepare-4-10 + +toc::[] + +//This content is not available in OCP, so this assembly is a stub. + +{product-title} 4.9 uses Kubernetes 1.22, which removed a significant number of deprecated `v1beta1` APIs. + +{product-title} 4.8.14 introduced a requirement that an administrator must provide a manual acknowledgment before the cluster can be updated from {product-title} 4.8 to 4.9. This is to help prevent issues after upgrading to {product-title} 4.9, where APIs that have been removed are still in use by workloads, tools, or other components running on or interacting with the cluster. Administrators must evaluate their cluster for any APIs in use that will be removed and migrate the affected components to use the appropriate new API version. After this evaluation and migration is complete, the administrator can provide the acknowledgment. + +Before you can update your {product-title} 4.8 cluster to 4.9, you must provide the administrator acknowledgment. + +// Removed Kubernetes APIs +include::modules/update-preparing-list.adoc[leveloffset=+1] + +[id="evaluating-cluster-removed-apis"] +== Evaluating your cluster for removed APIs + +There are several methods to help administrators identify where APIs that will be removed are in use. However, {product-title} cannot identify all instances, especially workloads that are idle or external tools that are used. It is the responsibility of the administrator to properly evaluate all workloads and other integrations for instances of removed APIs. + +// Reviewing alerts to identify uses of removed APIs +include::modules/update-preparing-evaluate-alerts.adoc[leveloffset=+2] + +// Using APIRequestCount to identify uses of removed APIs +include::modules/update-preparing-evaluate-apirequestcount.adoc[leveloffset=+2] + +// Using APIRequestCount to identify which workloads are using the removed APIs +include::modules/update-preparing-evaluate-apirequestcount-workloads.adoc[leveloffset=+2] + +// Migrating instances of removed APIs +include::modules/update-preparing-migrate.adoc[leveloffset=+1] + +// Providing the administrator acknowledgment +include::modules/update-preparing-ack.adoc[leveloffset=+1] \ No newline at end of file diff --git a/upgrading/rosa-updating-cluster-prepare-4-11.adoc b/upgrading/rosa-updating-cluster-prepare-4-11.adoc new file mode 100644 index 000000000000..08ec8fa3190a --- /dev/null +++ b/upgrading/rosa-updating-cluster-prepare-4-11.adoc @@ -0,0 +1,39 @@ +[id="rosa-updating-cluster-prepare-4-11"] += Preparing to update ROSA to 4.11 +include::_attributes/common-attributes.adoc[] +ifdef::openshift-dedicated,openshift-rosa[] +include::_attributes/attributes-openshift-dedicated.adoc[] +endif::[] +:context: rosa-updating-cluster-prepare-4-11 + +toc::[] + +//This content is not available in OCP, so this assembly is a stub. + +Upgrading your {product-title} clusters to OpenShift 4.11 requires you to evaluate and migrate your APIs as the latest version of Kubernetes has removed a significant number of APIs. + +Before you can upgrade your {product-title} clusters, you must update the required tools to the appropriate version. + +include::modules/rosa-upgrading-preparing-4-8-to-4-9.adoc[leveloffset=+1] + +include::modules/upgrade-49-acknowledgement.adoc[leveloffset=+2] + +// Removed Kubernetes APIs +include::modules/osd-update-preparing-list.adoc[leveloffset=+2] + +[id="rosa-evaluating-cluster-removed-apis"] +== Evaluating your cluster for removed APIs + +There are several methods to help administrators identify where APIs that will be removed are in use. However, {product-title} cannot identify all instances, especially workloads that are idle or external tools that are used. It is the responsibility of the administrator to properly evaluate all workloads and other integrations for instances of removed APIs. + +// Reviewing alerts to identify uses of removed APIs +include::modules/osd-update-preparing-evaluate-alerts.adoc[leveloffset=+2] + +// Using APIRequestCount to identify uses of removed APIs +include::modules/osd-update-preparing-evaluate-apirequestcount.adoc[leveloffset=+2] + +// Using APIRequestCount to identify which workloads are using the removed APIs +include::modules/osd-update-preparing-evaluate-apirequestcount-workloads.adoc[leveloffset=+2] + +// Migrating instances of removed APIs +include::modules/osd-update-preparing-migrate.adoc[leveloffset=+1] diff --git a/upgrading/rosa-updating-cluster-prepare-4-12.adoc b/upgrading/rosa-updating-cluster-prepare-4-12.adoc new file mode 100644 index 000000000000..d76b76398b7f --- /dev/null +++ b/upgrading/rosa-updating-cluster-prepare-4-12.adoc @@ -0,0 +1,40 @@ +[id="rosa-updating-cluster-prepare-4-12"] += Preparing to update ROSA to 4.12 +include::_attributes/common-attributes.adoc[] +ifdef::openshift-dedicated,openshift-rosa[] +include::_attributes/attributes-openshift-dedicated.adoc[] +endif::[] +:context: rosa-updating-cluster-prepare-4-12 + +toc::[] + +//This content is a copy of what is provided in the OCP 4.12 documentation. It should not change, but periodically verify for consistency. + +{product-title} 4.12 uses Kubernetes 1.25, which removed several deprecated APIs. + +A cluster administrator must provide a manual acknowledgment before the cluster can be updated from {product-title} 4.11 to 4.12. This is to help prevent issues after upgrading to {product-title} 4.12, where APIs that have been removed are still in use by workloads, tools, or other components running on or interacting with the cluster. Administrators must evaluate their cluster for any APIs in use that will be removed and migrate the affected components to use the appropriate new API version. After this evaluation and migration is complete, the administrator can provide the acknowledgment. + +Before you can update your {product-title} 4.11 cluster to 4.12, you must provide the administrator acknowledgment. + +// Removed Kubernetes APIs +include::modules/update-preparing-list.adoc[leveloffset=+1] + +[id="evaluating-cluster-removed-apis-4-12"] +== Evaluating your cluster for removed APIs + +There are several methods to help administrators identify where APIs that will be removed are in use. However, {product-title} cannot identify all instances, especially workloads that are idle or external tools that are used. It is the responsibility of the administrator to properly evaluate all workloads and other integrations for instances of removed APIs. + +// Reviewing alerts to identify uses of removed APIs +include::modules/update-preparing-evaluate-alerts.adoc[leveloffset=+2] + +// Using APIRequestCount to identify uses of removed APIs +include::modules/update-preparing-evaluate-apirequestcount.adoc[leveloffset=+2] + +// Using APIRequestCount to identify which workloads are using the removed APIs +include::modules/update-preparing-evaluate-apirequestcount-workloads.adoc[leveloffset=+2] + +// Migrating instances of removed APIs +include::modules/update-preparing-migrate.adoc[leveloffset=+1] + +// Providing the administrator acknowledgment +include::modules/update-preparing-ack.adoc[leveloffset=+1] \ No newline at end of file diff --git a/upgrading/rosa-updating-cluster-prepare-4-13.adoc b/upgrading/rosa-updating-cluster-prepare-4-13.adoc new file mode 100644 index 000000000000..787115f9bff6 --- /dev/null +++ b/upgrading/rosa-updating-cluster-prepare-4-13.adoc @@ -0,0 +1,40 @@ +[id="rosa-updating-cluster-prepare-4-13"] += Preparing to update ROSA to 4.13 +include::_attributes/common-attributes.adoc[] +ifdef::openshift-dedicated,openshift-rosa[] +include::_attributes/attributes-openshift-dedicated.adoc[] +endif::[] +:context: rosa-updating-cluster-prepare-4-13 + +toc::[] + +//This content is a copy of what is provided in the OCP 4.13 documentation. It should not change, but periodically verify for consistency. + +{product-title} 4.13 uses Kubernetes 1.26, which removed several deprecated APIs. + +A cluster administrator must provide a manual acknowledgment before the cluster can be updated from {product-title} 4.12 to 4.13. This is to help prevent issues after upgrading to {product-title} 4.13, where APIs that have been removed are still in use by workloads, tools, or other components running on or interacting with the cluster. Administrators must evaluate their cluster for any APIs in use that will be removed and migrate the affected components to use the appropriate new API version. After this evaluation and migration is complete, the administrator can provide the acknowledgment. + +Before you can update your {product-title} 4.12 cluster to 4.13, you must provide the administrator acknowledgment. + +// Removed Kubernetes APIs +include::modules/update-preparing-list.adoc[leveloffset=+1] + +[id="evaluating-cluster-removed-apis-4.13"] +== Evaluating your cluster for removed APIs + +There are several methods to help administrators identify where APIs that will be removed are in use. However, {product-title} cannot identify all instances, especially workloads that are idle or external tools that are used. It is the responsibility of the administrator to properly evaluate all workloads and other integrations for instances of removed APIs. + +// Reviewing alerts to identify uses of removed APIs +include::modules/update-preparing-evaluate-alerts.adoc[leveloffset=+2] + +// Using APIRequestCount to identify uses of removed APIs +include::modules/update-preparing-evaluate-apirequestcount.adoc[leveloffset=+2] + +// Using APIRequestCount to identify which workloads are using the removed APIs +include::modules/update-preparing-evaluate-apirequestcount-workloads.adoc[leveloffset=+2] + +// Migrating instances of removed APIs +include::modules/update-preparing-migrate.adoc[leveloffset=+1] + +// Providing the administrator acknowledgment +include::modules/update-preparing-ack.adoc[leveloffset=+1] \ No newline at end of file diff --git a/upgrading/rosa-upgrading-cluster-prepare.adoc b/upgrading/rosa-upgrading-cluster-prepare.adoc index 28f6094db7a5..d5cb53e3df0f 100644 --- a/upgrading/rosa-upgrading-cluster-prepare.adoc +++ b/upgrading/rosa-upgrading-cluster-prepare.adoc @@ -1,5 +1,5 @@ [id="rosa-updating-cluster-prepare"] -= Preparing to upgrade ROSA to 4.9 += Preparing to update ROSA to 4.9 include::_attributes/common-attributes.adoc[] ifdef::openshift-dedicated,openshift-rosa[] include::_attributes/attributes-openshift-dedicated.adoc[] diff --git a/upgrading/rosa-upgrading-sts.adoc b/upgrading/rosa-upgrading-sts.adoc index 709853d707b3..d6ad5bbe11bc 100644 --- a/upgrading/rosa-upgrading-sts.adoc +++ b/upgrading/rosa-upgrading-sts.adoc @@ -1,6 +1,6 @@ :_content-type: ASSEMBLY [id="rosa-upgrading-sts"] -= Upgrading ROSA clusters with STS += Updating ROSA classic include::_attributes/attributes-openshift-dedicated.adoc[] :context: rosa-upgrading-sts diff --git a/upgrading/rosa-upgrading.adoc b/upgrading/rosa-upgrading.adoc index 0db8d5a1658b..6f7cf873dbc1 100644 --- a/upgrading/rosa-upgrading.adoc +++ b/upgrading/rosa-upgrading.adoc @@ -1,6 +1,6 @@ :_content-type: ASSEMBLY [id="rosa-upgrading"] -= Upgrading ROSA clusters += Upgrading ROSA non-STS clusters include::_attributes/attributes-openshift-dedicated.adoc[] :context: rosa-upgrading