OCPBUGS-78223: add NodePool Rollouts reference documentation - #7923
Conversation
|
Pipeline controller notification For optional jobs, comment This repository is configured in: LGTM mode |
openshift-ci-robot
added
jira/valid-reference
|
@jparrill: This pull request references Jira Issue OCPBUGS-78223, which is invalid:
Comment The bug has been updated to refer to the pull request using the external bug tracker. DetailsIn response to this:
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. |
📝 WalkthroughWalkthroughAdds a new reference document describing NodePool rollouts: categorized rollout triggers (OCP release version, node configuration, HostedCluster global configuration, platform-specific machine templates), non-triggers, three upgrade types (Replace with RollingUpdate, OnDelete, InPlace) with parameters and constraints, rollout lifecycle steps, monitoring conditions/status indicators, version- and platform-specific notes, and a trigger vs. effect summary table. Updates navigation to include the NodePool Rollouts reference and removes the previous detailed rollout/upgrade content from the how-to lifecycle guide, replacing it with a pointer to the new reference. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
/jira refresh |
|
@jparrill: An error was encountered updating to the POST state for bug OCPBUGS-78223 on the Jira server at https://issues.redhat.com. No known errors were detected, please see the full error message for details. Full error message.
Error marking step #39025374 finished: root cause: Tried to update an entity that does not exist.: request failed. Please analyze the request body for more details. Status code: 400:
Please contact an administrator to resolve this issue, then request a bug refresh with DetailsIn response to this:
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-robot
added
jira/valid-bug
|
@jparrill: This pull request references Jira Issue OCPBUGS-78223, which is valid. The bug has been moved to the POST state. 3 validation(s) were run on this bug
No GitHub users were found matching the public email listed for the QA contact in Jira (jiezhao@redhat.com), skipping review request. DetailsIn response to this:
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. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/mkdocs.yml (1)
333-333: Consider placing at top-level Reference instead of under Manifests.The NodePool Rollouts documentation describes behavioral and conceptual information about rollout mechanics, which aligns better with other top-level Reference items like
versioning-support.md,controller-architecture.md, andconcepts-and-personas.md. Placing it under "Manifests" (which contains version-specific IBM Cloud manifests) may reduce discoverability.📝 Suggested placement
- reference/multi-platform-support.md - - 'NodePool Rollouts': reference/nodepool-rollouts.md + - 'NodePool Rollouts': reference/nodepool-rollouts.md # Move this line after multi-platform-support.md but before 'Openshift behaviour deviations' - 'Openshift behaviour deviations':Or alternatively, place it near
versioning-support.mdat the end of the Reference section since they are conceptually related.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/mkdocs.yml` at line 333, Move the "NodePool Rollouts" nav entry out of the Manifests subsection and add it to the top-level Reference list in mkdocs.yml so it appears alongside other reference items; specifically remove the '- 'NodePool Rollouts': reference/nodepool-rollouts.md' line from under the Manifests group and insert the same entry into the Reference group (optionally place it near 'versioning-support.md' or at the end of the Reference section) so the page is discoverable with other conceptual/reference docs.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/content/reference/nodepool-rollouts.md`:
- Line 11: Update the introductory sentence that currently reads "three
independent categories" to correctly say "four independent categories" and
ensure it lists the four triggers: OCP Release Version, Node Configuration,
HostedCluster Global Configuration, and Platform-Specific Machine Template;
locate the string "three independent categories" in the document and change it
to "four independent categories" and verify any nearby headings or summary lines
reference the four categories consistently.
---
Nitpick comments:
In `@docs/mkdocs.yml`:
- Line 333: Move the "NodePool Rollouts" nav entry out of the Manifests
subsection and add it to the top-level Reference list in mkdocs.yml so it
appears alongside other reference items; specifically remove the '- 'NodePool
Rollouts': reference/nodepool-rollouts.md' line from under the Manifests group
and insert the same entry into the Reference group (optionally place it near
'versioning-support.md' or at the end of the Reference section) so the page is
discoverable with other conceptual/reference docs.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Central YAML (inherited)
Review profile: CHILL
Plan: Pro
Run ID: 11001f18-0673-48b3-a6f7-fb0828f17e2b
⛔ Files ignored due to path filters (1)
docs/content/reference/aggregated-docs.mdis excluded by!docs/content/reference/aggregated-docs.md
📒 Files selected for processing (2)
docs/content/reference/nodepool-rollouts.mddocs/mkdocs.yml
|
|
||
| ## What Triggers a Rollout | ||
|
|
||
| There are three independent categories of changes that trigger a rollout. A rollout occurs when any one of them detects a difference between the desired state and the current state. |
There was a problem hiding this comment.
Inconsistent category count.
The text states "three independent categories" but the documentation actually describes four: OCP Release Version, Node Configuration, HostedCluster Global Configuration, and Platform-Specific Machine Template.
📝 Proposed fix
-There are three independent categories of changes that trigger a rollout. A rollout occurs when any one of them detects a difference between the desired state and the current state.
+There are four independent categories of changes that trigger a rollout. A rollout occurs when any one of them detects a difference between the desired state and the current state.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| There are three independent categories of changes that trigger a rollout. A rollout occurs when any one of them detects a difference between the desired state and the current state. | |
| There are four independent categories of changes that trigger a rollout. A rollout occurs when any one of them detects a difference between the desired state and the current state. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/content/reference/nodepool-rollouts.md` at line 11, Update the
introductory sentence that currently reads "three independent categories" to
correctly say "four independent categories" and ensure it lists the four
triggers: OCP Release Version, Node Configuration, HostedCluster Global
Configuration, and Platform-Specific Machine Template; locate the string "three
independent categories" in the document and change it to "four independent
categories" and verify any nearby headings or summary lines reference the four
categories consistently.
openshift-ci
Bot
added
area/documentation
| --- | ||
| title: NodePool Rollouts | ||
| --- | ||
|
|
There was a problem hiding this comment.
Thanks, this is nice! can we please consolidate these two docs together https://hypershift.pages.dev/how-to/automated-machine-management/nodepool-lifecycle/
There was a problem hiding this comment.
What do you prefer for this, keep the page at References tab with more visibility or keep that at nodepool-lifecycle.md?
There was a problem hiding this comment.
I've updated the PR following this pattern I've mentioned above. I think rollout deserves a section in References :)
|
@jparrill: This pull request references Jira Issue OCPBUGS-78223, which is valid. 3 validation(s) were run on this bug
No GitHub users were found matching the public email listed for the QA contact in Jira (jiezhao@redhat.com), skipping review request. DetailsIn response to this:
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. |
|
/verified bypass |
openshift-ci-robot
added
the
verified
|
@jparrill: The DetailsIn response to this:
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. |
|
@mvacula02: changing LGTM is restricted to collaborators DetailsIn response to this:
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. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: jparrill, mvacula02 The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Adds a new reference page documenting what triggers a NodePool rollout, upgrade types (Replace/InPlace), rollout lifecycle, and monitoring. Simplifies the nodepool-lifecycle how-to page by redirecting rollout details to the new reference page and updates the upgrades.md link. Closes: https://issues.redhat.com/browse/OCPBUGS-78223 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Juan Manuel Parrilla Madrid <jparrill@redhat.com>
openshift-ci-robot
removed
the
verified
|
/verified bypass |
openshift-ci-robot
added
the
verified
|
@jparrill: The DetailsIn response to this:
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. |
|
@jparrill: This pull request references Jira Issue OCPBUGS-78223, which is valid. 3 validation(s) were run on this bug
DetailsIn response to this:
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. |
There was a problem hiding this comment.
♻️ Duplicate comments (1)
docs/content/reference/nodepool-rollouts.md (1)
11-11:⚠️ Potential issue | 🟡 MinorInconsistent category count.
The text states "three independent categories" but the documentation describes four: OCP Release Version, Node Configuration, HostedCluster Global Configuration, and Platform-Specific Machine Template.
📝 Proposed fix
-There are three independent categories of changes that trigger a rollout. A rollout occurs when any one of them detects a difference between the desired state and the current state. +There are four independent categories of changes that trigger a rollout. A rollout occurs when any one of them detects a difference between the desired state and the current state.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/content/reference/nodepool-rollouts.md` at line 11, The intro claims "three independent categories" but the doc actually lists four rollout categories (OCP Release Version, Node Configuration, HostedCluster Global Configuration, Platform-Specific Machine Template); update the sentence to say "four independent categories" (or rephrase to avoid a numeric count) so it matches the listed items and prevents inconsistency between the opening line and the categories described.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/content/reference/nodepool-rollouts.md`:
- Line 11: The intro claims "three independent categories" but the doc actually
lists four rollout categories (OCP Release Version, Node Configuration,
HostedCluster Global Configuration, Platform-Specific Machine Template); update
the sentence to say "four independent categories" (or rephrase to avoid a
numeric count) so it matches the listed items and prevents inconsistency between
the opening line and the categories described.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Central YAML (inherited)
Review profile: CHILL
Plan: Pro
Run ID: 68d93fa8-60ba-4efc-87f1-733b88ae119f
⛔ Files ignored due to path filters (1)
docs/content/reference/aggregated-docs.mdis excluded by!docs/content/reference/aggregated-docs.md
📒 Files selected for processing (4)
docs/content/how-to/automated-machine-management/nodepool-lifecycle.mddocs/content/how-to/upgrades.mddocs/content/reference/nodepool-rollouts.mddocs/mkdocs.yml
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/mkdocs.yml
|
/lgtm |
|
Pipeline controller notification No second-stage tests were triggered for this PR. This can happen when:
Use |
|
@jparrill: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions 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. |
|
@jparrill: Jira Issue Verification Checks: Jira Issue OCPBUGS-78223 Jira Issue OCPBUGS-78223 has been moved to the MODIFIED state and will move to the VERIFIED state when the change is available in an accepted nightly payload. 🕓 DetailsIn response to this:
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. |
|
Fix included in accepted release 4.22.0-0.nightly-2026-03-13-065313 |
5 participants
Summary
docs/content/reference/nodepool-rollouts.mddocumenting NodePool rollout behaviordocs/mkdocs.ymlunder the Reference sectionThe documentation covers:
Closes: https://issues.redhat.com/browse/OCPBUGS-78223
Test plan
mkdocs servefrom thedocs/directoryCo-Authored-By: Claude Opus 4.6 noreply@anthropic.com
Summary by CodeRabbit