Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OCPBUGS#6756: Adds conditional updates in web console and some reorg #63315

Merged
merged 1 commit into from
Nov 21, 2023

Conversation

opayne1
Copy link
Contributor

@opayne1 opayne1 commented Aug 8, 2023

Adds conditional updates in web console and some reorg

Version(s):
main and 4.14

Issue:
https://issues.redhat.com/browse/OCPBUGS-5756

Link to docs preview:
https://63315--docspreview.netlify.app/openshift-enterprise/latest/updating/updating_a_cluster/updating-cluster-web-console

QE review:

  • QE has approved this change.

Additional information:
This PR also includes some reorg to the assembly. It moves prerequisites around as well.

@opayne1 opayne1 added this to the Continuous Release milestone Aug 8, 2023
@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 8, 2023
@openshift-ci openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Aug 8, 2023
@openshift-merge-robot openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 8, 2023
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Aug 8, 2023

🤖 Updated build preview is available at:
https://63315--docspreview.netlify.app

Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/34284

@opayne1 opayne1 force-pushed the OCPBUGS-5756 branch 2 times, most recently from 02f00b4 to dad6c71 Compare August 8, 2023 18:16
Copy link
Contributor

@skopacz1 skopacz1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the long list of comments, but here are my placement and wording suggestions to clean up this assembly-level prereq list. Feel free to disregard if you have other ideas in mind.

modules/before-updating-web-console.adoc Outdated Show resolved Hide resolved
Before updating using the web console, you should:

* Have access to the cluster as a user with `cluster-admin` privileges.
* Have a recent etcd backup in case your update fails and you must restore your cluster to a previous state.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would double check with an SME, but I think this prereq might be moot if there's nothing the user could do to trigger a new backup. If that's true, this is more like "hope that your most recent backup is recent enough to revert to if disaster recovery is necessary."

One idea might be to keep this here but reword it to something like:
"Check to see that your etcd backup is recent enough in case your update fails and you must restore your cluster to a previous state." Plus maybe a sentence about how etcd periodically creates a new backup on its own?

Copy link
Contributor Author

@opayne1 opayne1 Aug 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to your suggestion, but wondering if we should specify what "recent enough" means. Leaving this comment thread open to discuss with SMEs. I read through etcd docs and it wasnt clear to me.

modules/before-updating-web-console.adoc Outdated Show resolved Hide resolved
modules/before-updating-web-console.adoc Outdated Show resolved Hide resolved
modules/before-updating-web-console.adoc Outdated Show resolved Hide resolved
modules/before-updating-web-console.adoc Outdated Show resolved Hide resolved
* 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.
//remove this???^ or maybe just add another bullet that you can break up the update?
* To accommodate the time it takes to update, you are able to do a partial update by updating the worker or custom pool nodes. You can pause and resume within the progress bar of each pool.
* If your cluster uses manually maintained credentials, update the cloud provider resources for the new release.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd move this to prereqs for update modules (and ensure parallel wording with other prereqs)

//remove this???^ or maybe just add another bullet that you can break up the update?
* To accommodate the time it takes to update, you are able to do a partial update by updating the worker or custom pool nodes. You can pause and resume within the progress bar of each pool.
* If your cluster uses manually maintained credentials, update the cloud provider resources for the new release.
* Review the list of APIs that were removed in Kubernetes 1.26, migrate any affected components to use the new API version, and provide the administrator acknowledgment.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd move this to prereqs for update modules (and ensure parallel wording with other prereqs)

I think this one is tricky because it might not be in each version's prereqs, and the K8s version is probably different in each OCP version this appears in.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there is always a list of APIs that are removed each release?? I think we could generalize it and keep it under the considerations module as "check the APIs that were removed" maybe

modules/before-updating-web-console.adoc Outdated Show resolved Hide resolved
@openshift-ci openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 11, 2023
@opayne1
Copy link
Contributor Author

opayne1 commented Aug 21, 2023

Hi @wking! Could you take a look at this PR when you have a chance? I am doing this one before I start the PRs to backport the change. Thank you!

modules/before-updating-web-console.adoc Outdated Show resolved Hide resolved
modules/before-updating-web-console.adoc Outdated Show resolved Hide resolved
@kalexand-rh
Copy link
Contributor

The branch/enterprise-4.15 label has been added to this PR.

This is because your PR targets the main branch and is labeled for enterprise-4.14. And any PR going into main must also target the latest version branch (enterprise-4.15).

If the update in your PR does NOT apply to version 4.15 onward, please re-target this PR to go directly into the appropriate version branch or branches (enterprise-4.x) instead of main

@opayne1 opayne1 force-pushed the OCPBUGS-5756 branch 2 times, most recently from 192e816 to 20942c3 Compare November 1, 2023 20:38
modules/update-conditional-web-console.adoc Outdated Show resolved Hide resolved
modules/update-conditional-web-console.adoc Outdated Show resolved Hide resolved
modules/update-conditional-web-console.adoc Outdated Show resolved Hide resolved
modules/before-updating-ocp.adoc Outdated Show resolved Hide resolved
@LalatenduMohanty
Copy link
Member

Apart from #63315 (comment) , everything looks good to me.

@opayne1 opayne1 added the peer-review-needed Signifies that the peer review team needs to review this PR label Nov 7, 2023
@opayne1
Copy link
Contributor Author

opayne1 commented Nov 7, 2023

@shellyyang1989 Could you help with a QE review of this PR? Thank you!

@abhatt-rh
Copy link
Contributor

/label peer-review-in-progress

@openshift-ci openshift-ci bot added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Nov 7, 2023
Copy link
Contributor

@abhatt-rh abhatt-rh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work, @opayne1
I added a couple of comments for your consideration.

/remove-label peer-review-in-progress
/remove-label peer-review-needed
/label peer-review-done

modules/before-updating-ocp.adoc Outdated Show resolved Hide resolved
modules/before-updating-ocp.adoc Outdated Show resolved Hide resolved
modules/before-updating-ocp.adoc Outdated Show resolved Hide resolved
modules/update-changing-update-server-web.adoc Outdated Show resolved Hide resolved
modules/update-conditional-web-console.adoc Outdated Show resolved Hide resolved
modules/update-conditional-web-console.adoc Outdated Show resolved Hide resolved
modules/update-upgrading-web.adoc Outdated Show resolved Hide resolved
modules/update-upgrading-web.adoc Outdated Show resolved Hide resolved
modules/update-conditional-web-console.adoc Show resolved Hide resolved
@openshift-ci openshift-ci bot added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR peer-review-needed Signifies that the peer review team needs to review this PR labels Nov 7, 2023
@shellyyang1989
Copy link

@yanpzhan Could you please help review from UI side? Thank you.

@XiyunZhao
Copy link

The changes look good for me
/label qe-approved

@openshift-ci openshift-ci bot added the qe-approved Signifies that QE has signed off on this PR label Nov 10, 2023
@yanpzhan
Copy link

Thanks @XiyunZhao for reviewing the pr, the update looks good from UI side.

@skopacz1
Copy link
Contributor

LGTM! Thanks again for the help with update docs!

@opayne1 opayne1 merged commit 159391b into openshift:main Nov 21, 2023
1 check passed
@opayne1
Copy link
Contributor Author

opayne1 commented Nov 21, 2023

/cherrypick enterprise-4.14

@opayne1
Copy link
Contributor Author

opayne1 commented Nov 21, 2023

/cherrypick enterprise-4.15

@openshift-cherrypick-robot

@opayne1: new pull request created: #68298

In response to this:

/cherrypick enterprise-4.14

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-cherrypick-robot

@opayne1: new pull request created: #68299

In response to this:

/cherrypick enterprise-4.15

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
branch/enterprise-4.14 branch/enterprise-4.15 peer-review-done Signifies that the peer review team has reviewed this PR qe-approved Signifies that QE has signed off on this PR size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet