Skip to content

OSDOCS#13971: Update the z-stream RNs for 4.17.24 #91900

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

Merged
merged 1 commit into from
Apr 10, 2025

Conversation

tmalove
Copy link
Contributor

@tmalove tmalove commented Apr 9, 2025

Version(s):
4.17

Issue:
OSDOCS-13971

Link to docs preview:
4.17.24

QE review:

  • QE has approved this change.
    n/a for z-stream relnotes.

Additional information:
The errata URLs will return 404 until the go-live date of 4/9/25.

@openshift-ci openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Apr 9, 2025
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Apr 9, 2025

🤖 Wed Apr 09 22:23:35 - Prow CI generated the docs preview:

https://91900--ocpdocs-pr.netlify.app/openshift-enterprise/latest/release_notes/ocp-4-17-release-notes.html

@tmalove
Copy link
Contributor Author

tmalove commented Apr 9, 2025

/label peer-review-needed

@openshift-ci openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Apr 9, 2025
@max-cx
Copy link
Contributor

max-cx commented Apr 9, 2025

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

@openshift-ci openshift-ci bot added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Apr 9, 2025
Copy link
Contributor

@max-cx max-cx left a comment

Choose a reason for hiding this comment

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

🙂
Enjoyed reading your release notes.
Added some suggestions for you to consider.

@@ -2879,6 +2879,39 @@ This section will continue to be updated over time to provide notes on enhanceme
For any {product-title} release, always review the instructions on xref:../updating/updating_a_cluster/updating-cluster-web-console.adoc#updating-cluster-web-console[updating your cluster] properly.
====

// 4.17.24
[id="ocp-4-17-24_{context}"]
=== RHBA-2025:3565 - {product-title} {product-version}.24 bug fix, and security update advisory
Copy link
Contributor

Choose a reason for hiding this comment

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

I suggest double-checking this comma, which appears likely redundant to me:

Suggested change
=== RHBA-2025:3565 - {product-title} {product-version}.24 bug fix, and security update advisory
=== RHBA-2025:3565 - {product-title} {product-version}.24 bug fix and security update advisory

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 verified changing all of the 4.17 z-stream bug text with the team lead...done. Thx!

[id="ocp-4-17-24-bug-fixes_{context}"]
==== Bug fixes

* Previously, an update to the {ibm-cloud-name} Cloud Internet Services (CIS) implementation impacted the upstream Terraform plugin. If you attempted to create an external-facing cluster on {ibm-cloud-name}, an error occurred. With this release, you can use the installation program to create an external cluster on {product-title} without the plugin issue. (link:https://issues.redhat.com/browse/OCPBUGS-54357[*OCPBUGS-54357*])
Copy link
Contributor

Choose a reason for hiding this comment

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

As a reader, I find it difficult to understand what this paragraph means by the installation program. It would be helpful to define it as such by using an appositive in one of the preceding sentences or mention the product name or clarify a software category in this sentence.


* Previously, an update to the {ibm-cloud-name} Cloud Internet Services (CIS) implementation impacted the upstream Terraform plugin. If you attempted to create an external-facing cluster on {ibm-cloud-name}, an error occurred. With this release, you can use the installation program to create an external cluster on {product-title} without the plugin issue. (link:https://issues.redhat.com/browse/OCPBUGS-54357[*OCPBUGS-54357*])

* Previously, when you built the agent ISO in a disconnected setup, an error occured. With this release, the setup completes without an error. (link:https://issues.redhat.com/browse/OCPBUGS-53378[*OCPBUGS-53378*])
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if, despite all the guidance that we have been receiving about using you, we should be using you in some contexts such as this sentence. My concern is that if say most of the readers never built the agent ISO in a disconnected setup, they would be confused about being told that they previous experienced some problem that they don't remember ever experiencing.

Suggested change
* Previously, when you built the agent ISO in a disconnected setup, an error occured. With this release, the setup completes without an error. (link:https://issues.redhat.com/browse/OCPBUGS-53378[*OCPBUGS-53378*])
* Previously, when users tried building the agent ISO in a disconnected setup, an error occurred. With this release, the setup completes without an error. (link:https://issues.redhat.com/browse/OCPBUGS-53378[*OCPBUGS-53378*])


* Previously, when you built the agent ISO in a disconnected setup, an error occured. With this release, the setup completes without an error. (link:https://issues.redhat.com/browse/OCPBUGS-53378[*OCPBUGS-53378*])

* Previously, the `ovn-ipsec-host` pod experienced a crash loop on RHEL worker nodes because of a missing shared library during the container execution. With this release, the `ovn-ipsec-host` pod successfully comes up on the worker node without an error. (link:https://issues.redhat.com/browse/OCPBUGS-52951[*OCPBUGS-52951*])
Copy link
Contributor

Choose a reason for hiding this comment

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

If a pod experienced a crash loop, this might or might not be an anthropomorphism, so this word choice might be worth a second thought unless you've already considered this. Also, international audiences might find it a bit difficult to follow what comes up means.

Suggested change
* Previously, the `ovn-ipsec-host` pod experienced a crash loop on RHEL worker nodes because of a missing shared library during the container execution. With this release, the `ovn-ipsec-host` pod successfully comes up on the worker node without an error. (link:https://issues.redhat.com/browse/OCPBUGS-52951[*OCPBUGS-52951*])
* Previously, the `ovn-ipsec-host` pod failed with a crash loop on RHEL worker nodes because of a missing shared library during the container execution. With this release, the `ovn-ipsec-host` pod successfully starts on the worker node without an error. (link:https://issues.redhat.com/browse/OCPBUGS-52951[*OCPBUGS-52951*])


* Previously, the `ovn-ipsec-host` pod experienced a crash loop on RHEL worker nodes because of a missing shared library during the container execution. With this release, the `ovn-ipsec-host` pod successfully comes up on the worker node without an error. (link:https://issues.redhat.com/browse/OCPBUGS-52951[*OCPBUGS-52951*])

* Previously, the {olm-first} CSV annotation contained unexpected JSON, which was successfully parsed, but then resulted in a runtime error when attempting to use the resulting value. With this release, JSON values from OLM annotations are validated before use, errors are logged, and the console does not fail when an unexpected JSON is received in an annotation. (link:https://issues.redhat.com/browse/OCPBUGS-51277[(*OCPBUGS-51277*)])
Copy link
Contributor

Choose a reason for hiding this comment

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

It could be a little more readable if the JSON format were used in a noun phrase here, for example:

Suggested change
* Previously, the {olm-first} CSV annotation contained unexpected JSON, which was successfully parsed, but then resulted in a runtime error when attempting to use the resulting value. With this release, JSON values from OLM annotations are validated before use, errors are logged, and the console does not fail when an unexpected JSON is received in an annotation. (link:https://issues.redhat.com/browse/OCPBUGS-51277[(*OCPBUGS-51277*)])
* Previously, the {olm-first} CSV annotation contained unexpected JSON data, which was successfully parsed, but then resulted in a runtime error when attempting to use the resulting value. With this release, JSON values from OLM annotations are validated before use, errors are logged, and the console does not fail when an unexpected JSON is received in an annotation. (link:https://issues.redhat.com/browse/OCPBUGS-51277[(*OCPBUGS-51277*)])


[id="ocp-4-17-24-updating_{context}"]
==== Updating
To update an {product-title} 4.17 cluster to this latest release, see xref:../updating/updating_a_cluster/updating-cluster-cli.adoc#updating-cluster-cli[Updating a cluster using the CLI].
Copy link
Contributor

Choose a reason for hiding this comment

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

A rewording such as this might help avoid confusion for some readers like me:

Suggested change
To update an {product-title} 4.17 cluster to this latest release, see xref:../updating/updating_a_cluster/updating-cluster-cli.adoc#updating-cluster-cli[Updating a cluster using the CLI].
To update a cluster from an earlier {product-title} version to this version, 4.17.24, see xref:../updating/updating_a_cluster/updating-cluster-cli.adoc#updating-cluster-cli[Updating a cluster using the CLI].

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'll have to run this past my team lead, because it involves a template change for all of the releases. If approved, I will change all of the 4.17 z-stream relnotes. Thank you!

[id="ocp-4-17-24_{context}"]
=== RHBA-2025:3565 - {product-title} {product-version}.24 bug fix, and security update advisory

Issued: 09 April 2025
Copy link
Contributor

@max-cx max-cx Apr 9, 2025

Choose a reason for hiding this comment

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

Depending on whether it is possible or not, I'd recommend dropping the leading zero to make it more human-readable:

Suggested change
Issued: 09 April 2025
Issued: 9 April 2025

@max-cx
Copy link
Contributor

max-cx commented Apr 9, 2025

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

@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 labels Apr 9, 2025
@tmalove
Copy link
Contributor Author

tmalove commented Apr 9, 2025

@max-cx Thanks for all of your input!

@tmalove tmalove force-pushed the OSDOCS-13971 branch 2 times, most recently from d3deca1 to 9fe66e7 Compare April 9, 2025 19:31
@tmalove
Copy link
Contributor Author

tmalove commented Apr 9, 2025

/label merge-review-needed

@openshift-ci openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Apr 9, 2025
@mburke5678 mburke5678 added merge-review-in-progress Signifies that the merge review team is reviewing this PR and removed merge-review-in-progress Signifies that the merge review team is reviewing this PR merge-review-needed Signifies that the merge review team needs to review this PR labels Apr 9, 2025
Comment on lines 2884 to 2888
=== RHBA-2025:3565 - {product-title} {product-version}.24 bug fix and security update advisory

Issued: 9 April 2025

{product-title} release {product-version}.24 is now available. The list of bug fixes that are included in the update is documented in the link:https://access.redhat.com/errata/RHBA-2025:3565[RHBA-2025:3565] advisory. The RPM packages that are included in the update are provided by the link:https://access.redhat.com/errata/RHBA-2025:3567[RHBA-2025:3567] advisory.
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
=== RHBA-2025:3565 - {product-title} {product-version}.24 bug fix and security update advisory
Issued: 9 April 2025
{product-title} release {product-version}.24 is now available. The list of bug fixes that are included in the update is documented in the link:https://access.redhat.com/errata/RHBA-2025:3565[RHBA-2025:3565] advisory. The RPM packages that are included in the update are provided by the link:https://access.redhat.com/errata/RHBA-2025:3567[RHBA-2025:3567] advisory.
=== RHSA-2025:3565 - {product-title} {product-version}.24 bug fix and security update advisory
Issued: 9 April 2025
{product-title} release {product-version}.24 is now available. The list of bug fixes that are included in the update is documented in the link:https://access.redhat.com/errata/RHSA-2025:3565[RHSA-2025:3565] advisory. The RPM packages that are included in the update are provided by the link:https://access.redhat.com/errata/RHBA-2025:3567[RHBA-2025:3567] advisory.

Copy link

openshift-ci bot commented Apr 9, 2025

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

@mburke5678 mburke5678 merged commit 0dc4453 into openshift:enterprise-4.17 Apr 10, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
peer-review-done Signifies that the peer review team has reviewed this PR size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants