openshift-docs icon indicating copy to clipboard operation
openshift-docs copied to clipboard

Updates to upgrade procedures

Open kcarmichael08 opened this issue 2 years ago • 11 comments
trafficstars

Version(s):

  • Merge to rhacs-docs-main
  • Cherry pick to rhacs-docs-4.3, rhacs-docs-4.4, and rhacs-docs-4.5 (but 4.5 will have further updates - see https://issues.redhat.com/browse/ROX-24162)

Issues:

  • https://issues.redhat.com/browse/ROX-18594
  • https://issues.redhat.com/browse/ROX-18976
  • https://issues.redhat.com/browse/ROX-22204

Link to docs previews:

QE review: ACS has no QE, approved by SMEs

  • [x] QE has approved this change.

Additional information:

Replaces #63482 and #63530

See also #65656

kcarmichael08 avatar Sep 28 '23 13:09 kcarmichael08

🤖 Mon May 13 19:52:16 - Prow CI generated the docs preview:

https://65388--ocpdocs-pr.netlify.app/openshift-acs/latest/cloud_service/installing_cloud_ocp/cloud-install-operator.html https://65388--ocpdocs-pr.netlify.app/openshift-acs/latest/cloud_service/rhacs-cloud-service-service-description.html https://65388--ocpdocs-pr.netlify.app/openshift-acs/latest/upgrading/upgrade-helm.html https://65388--ocpdocs-pr.netlify.app/openshift-acs/latest/upgrading/upgrade-operator.html https://65388--ocpdocs-pr.netlify.app/openshift-acs/latest/upgrading/upgrade-roxctl.html

ocpdocs-previewbot avatar Sep 28 '23 14:09 ocpdocs-previewbot

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close. Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

openshift-bot avatar Jan 03 '24 09:01 openshift-bot

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity. Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten /remove-lifecycle stale

openshift-bot avatar Feb 03 '24 00:02 openshift-bot

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen. Mark the issue as fresh by commenting /remove-lifecycle rotten. Exclude this issue from closing again by commenting /lifecycle frozen.

/close

openshift-bot avatar Mar 04 '24 08:03 openshift-bot

@openshift-bot: Closed this PR.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen. Mark the issue as fresh by commenting /remove-lifecycle rotten. Exclude this issue from closing again by commenting /lifecycle frozen.

/close

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-ci[bot] avatar Mar 04 '24 08:03 openshift-ci[bot]

/reopen

kcarmichael08 avatar Mar 25 '24 18:03 kcarmichael08

@kcarmichael08: Reopened this PR.

In response to this:

/reopen

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-ci[bot] avatar Mar 25 '24 18:03 openshift-ci[bot]

I think, after addressing these points we'll just get the first approximation of what's required to to make the upgrade instructions straightforward for users.

There's a lot more to the structure that I see needs a rework although I'm afraid to pull this in because this PR already has a prior history from the August 2023. My suggestion would be to deal with this PR in the current scope and do a pair programming session (over Google Meet) on the upgrade instructions so that we can interactively define a direction of improvement.

msugakov avatar Apr 25 '24 17:04 msugakov

I think, after addressing these points we'll just get the first approximation of what's required to to make the upgrade instructions straightforward for users.

There's a lot more to the structure that I see needs a rework although I'm afraid to pull this in because this PR already has a prior history from the August 2023. My suggestion would be to deal with this PR in the current scope and do a pair programming session (over Google Meet) on the upgrade instructions so that we can interactively define a direction of improvement.

IMO after struggling with this PR and its many comments previously, and then trying to take it back up again so that it can be closed out, it's difficult to make the instructions straightforward because the process itself isn't straightforward. I'm happy to work on another iteration after this PR is done, but I also have to start work on 4.5 documentation. Maybe after I push the changes after your latest comments, we can do a google meet session and go over the doc line by line. Or, alternatively, you can pull the PR and propose changes yourself, if you think that would work better.

kcarmichael08 avatar Apr 25 '24 20:04 kcarmichael08

I think I have everyone's suggestions incorporated, except for a 4.5 version (which I will wait to create until after we get this one completed).

kcarmichael08 avatar Apr 26 '24 17:04 kcarmichael08

@kcarmichael08: all tests passed!

Full PR test history. Your PR dashboard.

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-sigs/prow repository. I understand the commands that are listed here.

openshift-ci[bot] avatar May 13 '24 19:05 openshift-ci[bot]

/cherrypick rhacs-docs-4.3

kcarmichael08 avatar May 14 '24 14:05 kcarmichael08

/cherrypick rhacs-docs-4.4

kcarmichael08 avatar May 14 '24 14:05 kcarmichael08

/cherrypick rhacs-docs-4.5

kcarmichael08 avatar May 14 '24 14:05 kcarmichael08

@kcarmichael08: #65388 failed to apply on top of branch "rhacs-docs-4.3":

Applying: Updates to upgrade procedures
Using index info to reconstruct a base tree...
M	modules/install-acs-operator-cloud.adoc
M	modules/prepare-operator-upgrades.adoc
M	modules/updates-and-upgrades.adoc
M	upgrading/upgrade-operator.adoc
M	upgrading/upgrade-roxctl.adoc
Falling back to patching base and 3-way merge...
Auto-merging upgrading/upgrade-roxctl.adoc
Auto-merging upgrading/upgrade-operator.adoc
Auto-merging modules/updates-and-upgrades.adoc
Auto-merging modules/prepare-operator-upgrades.adoc
CONFLICT (content): Merge conflict in modules/prepare-operator-upgrades.adoc
Auto-merging modules/install-acs-operator-cloud.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Updates to upgrade procedures
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherrypick rhacs-docs-4.3

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-sigs/prow repository.

@kcarmichael08: new pull request created: #75921

In response to this:

/cherrypick rhacs-docs-4.4

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-sigs/prow repository.

@kcarmichael08: new pull request created: #75922

In response to this:

/cherrypick rhacs-docs-4.5

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-sigs/prow repository.