Skip to content

ROX-20769: Add changelog entry about major version upgrade #93434

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: rhacs-docs-main
Choose a base branch
from
Open

ROX-20769: Add changelog entry about major version upgrade #93434

wants to merge 1 commit into from

Conversation

erthalion
Copy link

@erthalion erthalion commented May 15, 2025 •
edited by kcarmichael08
Loading

Version(s): 4.8

Issue: ROX-20769

Link to docs preview:

https://93434--ocpdocs-pr.netlify.app/openshift-acs/latest/release_notes/48-release-notes.html

QE review:

  • QE has approved this change.

Additional information:

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label May 15, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented May 15, 2025 •
edited by openshift-ci bot
Loading

@erthalion: This pull request references ROX-20769 which is a valid jira issue.

In response to this:

Version(s): 4.8

Issue: ROX-20769

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label May 15, 2025
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented May 15, 2025 •
edited
Loading

🤖 Fri May 16 14:04:45 - Prow CI generated the docs preview:

https://93434--ocpdocs-pr.netlify.app/openshift-acs/latest/release_notes/48-release-notes.html

@openshift-ci-robot
Copy link

openshift-ci-robot commented May 15, 2025 •
edited by openshift-ci bot
Loading

@erthalion: This pull request references ROX-20769 which is a valid jira issue.

In response to this:

Version(s): 4.8

Issue: ROX-20769

Link to docs preview:

https://93434--ocpdocs-pr.netlify.app/openshift-acs/latest/release_notes/48-release-notes.html

QE review:

  • QE has approved this change.

Additional information:

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 openshift-eng/jira-lifecycle-plugin repository.

kcarmichael08
kcarmichael08 reviewed May 15, 2025
View reviewed changes
Copy link
Contributor

@kcarmichael08 kcarmichael08 left a comment

Choose a reason for hiding this comment

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

TY for submitting the RN! I have made some suggestions based on our style guides (IBM Style and Red Hat SSG).

release_notes/48-release-notes.adoc Outdated

[NOTE]
====
To make the database upgrade process smooth, we recommend:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
To make the database upgrade process smooth, we recommend:
To ensure that the database upgrade is successful, follow these suggestions:

There is specific style guide guidance about not using "recommend" or we recommend, so I've suggested a change here.

Copy link
Author

Choose a reason for hiding this comment

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

This one is tricky, because "do this to make the upgrade successful" is a too strong statement. The point is that the migration will be successful for almost everyone, we've put lots of efforts into this. Those recommendations are more about avoiding corner cases, where things are getting complicated.

That being said, how about this?

When preparing the upgrade to RHACS 4.8, follow these suggestions:

release_notes/48-release-notes.adoc Outdated
existing cluster to {product-title-short} 4.8, Central DB will do an in-place
upgrade of the data collected so far.

[NOTE]
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 not have these bullets as a note (multiple lines in notes does not look the best) and have it be a sentence with bullets instead. Maybe move the part about not upgrading the database to here, right before you say "To ensure..." and make that an "important" note:

[IMPORTANT]
====
text
====

Copy link
Author

Choose a reason for hiding this comment

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

Not quite follow what do you mean by "move the part about not upgrading the database to here"? Which part are you referring to?

release_notes/48-release-notes.adoc Outdated
`rox_central_postgres_total_size_bytes`. If that is not the case, extend the
database PVC.

* Do not interrupt the upgrade procedure. If that happens, a manual
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 remove this as a bullet and put it as an "important" note at the beginning of the paragraph as in previous comment.

Copy link
Contributor

Choose a reason for hiding this comment

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

replied below, you can ignore this :)

@kcarmichael08 kcarmichael08 added peer-review-done Signifies that the peer review team has reviewed this PR RHACS Label for RHACS related PRs that go in the rhacs-docs branch rhacs-docs-4.8 labels May 15, 2025
@erthalion erthalion force-pushed the ROX-20769-postgresql-15 branch from c9f537e to c3baf81 Compare May 16, 2025 13:50
@openshift-ci openshift-ci bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 16, 2025
kcarmichael08
kcarmichael08 reviewed May 16, 2025
View reviewed changes
Copy link
Contributor

@kcarmichael08 kcarmichael08 left a comment

Choose a reason for hiding this comment

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

I was going to suggest only making the part about backing up be formatted with "important," and have the rest just be normal formatting, but this is fine the way it is, never mind. :)

release_notes/48-release-notes.adoc
When preparing the upgrade to {product-title-short} 4.8, follow these
suggestions:

* Back up the database before upgrading to {product-title-short} 4.8
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* Back up the database before upgrading to {product-title-short} 4.8
* Back up the database before upgrading to {product-title-short} 4.8.

@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented May 16, 2025

@erthalion: 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kcarmichael08 kcarmichael08 kcarmichael08 left review comments

@dashrews78 dashrews78 dashrews78 approved these changes

Assignees
No one assigned
Labels
jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. peer-review-done Signifies that the peer review team has reviewed this PR RHACS Label for RHACS related PRs that go in the rhacs-docs branch rhacs-docs-4.8 size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@erthalion @openshift-ci-robot @ocpdocs-previewbot @kcarmichael08 @dashrews78