HYPERFLEET-1163 - docs: add v0.2.0 to v1.0.0 upgrade guide#157
Conversation
|
Skipping CI for Draft Pull Request. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Central YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
🔗 Linked repositories identifiedCodeRabbit considers these linked repositories for cross-repo context during reviews:
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughSummary by CodeRabbit
WalkthroughDocumentation-only addition: Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes 🚥 Pre-merge checks | ✅ 11✅ Passed checks (11 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Comment |
kuudori
force-pushed
the
HYPERFLEET-1163-upgrade-guide
branch
5 times, most recently
from
7dba78d to
e12c5f3
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@hyperfleet/docs/release/v0.2.0-to-v1.0.0-upgrade-guide.md`:
- Around line 54-72: The upgrade guide Section 1.2 for Sentinel message_decision
CEL configuration is confusing because it shows inline comments like "# was
Ready" without displaying the actual before/after configuration blocks
side-by-side. This creates a footgun where users with custom configs may copy
the example as-is without realizing they must update condition references from
condition("Ready") to condition("Reconciled"). Replace the current single
example block in lines 60-68 with two clearly labeled YAML blocks: first show
the v0.2.0 custom config that references condition("Ready") and mark it as
broken/wrong for v1.0.0, then show the v1.0.0 corrected config that uses
condition("Reconciled"). Add an explicit warning that old condition("Ready")
references return zero-value conditions and cause silent CEL evaluation
failures.
- Line 277: The adapter status example uses an incorrect JSON field name.
Replace the field name "observed_time" with "last_report_time" to match the
actual AdapterStatus struct definition in the hyperfleet-api package
(pkg/api/adapter_status_types.go). This ensures the documentation example aligns
with the actual API contract. Additionally, verify that the status-guide.md
documentation is also corrected from "last_updated_time" to "last_report_time"
for consistency across all documentation.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Central YAML (base), Organization UI (inherited)
Review profile: CHILL
Plan: Enterprise
Run ID: 8b9f602a-b436-4bef-bc06-9c8583cf912e
📒 Files selected for processing (1)
hyperfleet/docs/release/v0.2.0-to-v1.0.0-upgrade-guide.md
🔗 Linked repositories identified
CodeRabbit considers these linked repositories for cross-repo context during reviews:
openshift-hyperfleet/architecture(manual)openshift-hyperfleet/hyperfleet-api(manual)openshift-hyperfleet/hyperfleet-sentinel(manual)openshift-hyperfleet/hyperfleet-adapter(manual)openshift-hyperfleet/hyperfleet-broker(manual)
kuudori
force-pushed
the
HYPERFLEET-1163-upgrade-guide
branch
3 times, most recently
from
e19cad7 to
6a5372f
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@hyperfleet/docs/release/v0.2.0-to-v1.0.0-upgrade-guide.md`:
- Around line 84-120: The document references adapter CEL expressions that need
updating from condition("Ready") to condition("Reconciled") in line 90, but
provides no configuration section or examples for operators to locate these
expressions. Add a new subsection after the Sentinel message_decision
configuration examples that documents where adapter CEL configuration is
located, provide a before/after example showing custom adapter precondition and
capture CEL expressions using condition("Ready") versus condition("Reconciled"),
and include the same warning about the zero-value failure mode that applies to
adapter expressions. This guidance should parallel the Sentinel CEL section
(lines 94–114) so operators with custom adapter configurations can identify and
update their expressions.
- Line 46: The deployment sequence guidance in the upgrade guide at lines 46 and
54 warns about deploying components together and specifies the deployment order,
but fails to explicitly require that all adapters be upgraded to v1.0.0 before
any DELETE operations, which will cause deletion flows to hang since v0.2.0
adapters cannot report the Finalized condition type. Update the warning at line
46 to emphasize the adapter version requirement, and modify step 7 (referenced
in the deployment order section at line 54) to explicitly state that all
adapters must be upgraded to v1.0.0 in sequence and that v0.2.0 adapters cannot
report the Finalized condition required for deletion completion, with guidance
to stagger adapter upgrades so all are v1.0.0 before the first DELETE call on a
resource.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Central YAML (base), Organization UI (inherited)
Review profile: CHILL
Plan: Enterprise
Run ID: 6225229d-b964-4e39-b0e4-8009da8a335c
📒 Files selected for processing (1)
hyperfleet/docs/release/v0.2.0-to-v1.0.0-upgrade-guide.md
🔗 Linked repositories identified
CodeRabbit considers these linked repositories for cross-repo context during reviews:
openshift-hyperfleet/architecture(manual)openshift-hyperfleet/hyperfleet-api(manual)openshift-hyperfleet/hyperfleet-sentinel(manual)openshift-hyperfleet/hyperfleet-adapter(manual)openshift-hyperfleet/hyperfleet-broker(manual)
Operator-facing migration guide covering all 20 breaking changes
across configuration, API contract, statuses, and operating model.
Structure:
- Breaking Changes Summary table for quick scanning
- 9-step upgrade procedure (export inventory, audit DELETE sites,
confirm auth, deploy, re-register, verify)
- Per-change sections with Action required / If you don't act
- Before/after config examples for every config change
- Post-Upgrade Verification checklist
Key breaking changes documented:
- JWT enabled default flipped to false + OCM SDK removed (auth gap)
- Adapter status POST → PUT (method-only, body unchanged)
- DELETE returns 202 with cascade (was 501 Not Implemented)
- condition("Ready") → condition("Reconciled") (silent zero-value on miss)
- Fresh database required (tear-down-and-redeploy, no data migration)
- Sentinel strict config parsing, mount paths, Helm value restructuring
kuudori
force-pushed
the
HYPERFLEET-1163-upgrade-guide
branch
from
6a5372f to
4fcbb5e
Compare
1 participant
Summary
Jira: HYPERFLEET-1163
Depends on: HYPERFLEET-1177 (breaking-change checklist, in Review)
AC Coverage
Open items
observed_timevslast_updated_timeTest plan