Skip to content

📖 align ClusterObjectSet concept doc with the single Ready condition - #3021

Open
perdasilva wants to merge 1 commit into
operator-framework:mainfrom
perdasilva:cos-ready-docs
Open

perdasilva wants to merge 1 commit into
operator-framework:mainfrom
perdasilva:cos-ready-docs

Conversation

@perdasilva

@perdasilva perdasilva commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

Description

Align the ClusterObjectSet concept doc with the current single Ready condition model.

The ClusterObjectSet reports only a Ready condition; the Progressing and Succeeded conditions were removed, and rollout completion is tracked by the status.completedAt timestamp. This updates docs/draft/concepts/clusterobjectsets.md accordingly:

  • Drop the stale Progressing and Succeeded condition sections.
  • Add a Completion (status.completedAt) section.
  • Remove the Migrated Ready-reason row (no such reason is emitted).
  • Add the ProgressDeadlineExceeded Ready-reason row, which the controller emits and the API doc-string already documents but the concept table was missing.
  • Reword "reports Succeeded" references in the transition/upgrade flows to "rolled out successfully".

The Ready-reason table now matches the API doc-string's reason set exactly (AllObjectsReady, ObjectsNotReady, Superseded, ObjectCollision, PreconditionsNotMet, InvalidSpecification, ProgressDeadlineExceeded, Archiving, Archived) — reflecting the ValidationFailure → PreconditionsNotMet/InvalidSpecification split (#3017) and the RetryableError removal (#3012), both now in main.

Docs-only change.

Supersedes #3003 (rebased onto main; the original was part of a now-merged stack).

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated cluster object set guidance to allow an old revision to be archived after the new revision rolls out successfully, rather than requiring a Succeeded status.
    • Clarified that rollout completion is recorded separately from readiness: the completion timestamp is set when a revision first becomes ready, does not change, and remains set if the revision later becomes not ready.
    • Revised the documented status conditions and Ready reasons.

The ClusterObjectSet reports only a Ready condition; the Progressing and
Succeeded conditions were removed and rollout completion is tracked by the
status.completedAt timestamp. Align the concept doc accordingly:

- Drop the stale Progressing and Succeeded condition sections.
- Note that completion is recorded in status.completedAt (new "Completion" section).
- Remove the Migrated Ready reason row (no such reason is emitted).
- Add the ProgressDeadlineExceeded Ready reason row, which the controller emits
  and the API doc already documents but the concept table was missing.
- Replace "reports Succeeded" references in the transition/upgrade flows with
  "rolled out successfully".

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: Per G. da Silva <pegoncal@redhat.com>
@openshift-ci
openshift-ci Bot requested review from grokspawn and pedjak October 16, 2026 09:19
@openshift-ci

openshift-ci Bot commented Oct 16, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign grokspawn for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@netlify

netlify Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for olmv1 ready!

Name Link
🔨 Latest commit c2d7203
🔍 Latest deploy log https://app.netlify.com/projects/olmv1/deploys/6ad1ec109a26c26402aa6987
😎 Deploy Preview https://deploy-preview-3021--olmv1.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Enterprise
  • Run ID: 058e52c4-b54a-4c5c-b6e5-8197a931a6b2
📥 Commits

Reviewing files that changed from the base of the PR and between b642483 and c2d7203.

📒 Files selected for processing: 1
  • docs/draft/concepts/clusterobjectsets.md

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.

📝 Walkthrough

The ClusterObjectSet documentation now describes rollout completion through status.completedAt and uses successful rollout as the criterion for archiving an old revision.

Changes: Revision status and archival

Layer / File(s) Summary
Readiness and archival guidance
docs/draft/concepts/clusterobjectsets.md
The documentation describes one Ready condition and the status.completedAt timestamp. It updates the archival criterion to successful rollout and removes the Migrated reason and Succeeded condition descriptions.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: fao89

Merge Risk: ⚪ Minimal · up to c2d72

The updated documentation matches the API and controller behavior, and no concrete merge risk is identified.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title is concise, specific, and accurately describes the documentation change to the single Ready condition model.
Description check Passed The description explains the change, motivation, affected documentation, related issues, and docs-only scope. It follows the repository template sufficiently.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@fgiudici fgiudici left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci Bot added the lgtm Indicates that a PR is ready to be merged. label Oct 16, 2026

This branch has not been deployed

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

Labels

lgtm Indicates that a PR is ready to be merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants