OCM-19813 | fix: update design.md per current code

[elveeram]

What type of PR is this?

This PR is documentation fix for design.md.

What this PR does / why we need it?

We need to update the design.md file per the current code and change params to reflect the correct fields and its values.

Which Jira/Github issue(s) this PR fixes?

OCM-19813

Summary by CodeRabbit

• Documentation
  • Enhanced upgrade process documentation with detailed upgrader steps and failure handling policies.
  • Added new fields for tracking upgrade history including version and worker timing data.
  • Updated condition naming conventions for improved clarity.
  • Introduced configurable feature gates section with configuration examples and ready-to-upgrade criteria.

[coderabbitai]

Walkthrough

Documentation update to design.md introducing new upgrade tracking fields (precedingVersion, workerStartTime, workerCompleteTime), renaming upgrade conditions to ClusterHealthyBeforeUpgrade, and significantly expanding coverage of upgrade processes, failure policies, and feature gates.

Changes

Cohort / File(s)

Summary

Upgrade Documentation docs/design.md

Added new top-level history fields for upgrade tracking. Renamed PreHealthCheck to ClusterHealthyBeforeUpgrade. Expanded examples with new fields and condition types. Added 17 OSDS and 14 ARO upgrader steps with detailed mappings. Introduced OSD upgrade failure policy section with timeout-based remediation. Added feature gates configuration section with ConfigMap examples and ready-to-upgrade criteria documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: updating design.md documentation to align with current code implementation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Stable And Deterministic Test Names	✅ Passed	All test files contain only stable and deterministic test names using descriptive static strings with no dynamic content.
Test Structure And Quality	✅ Passed	This check is not applicable to the provided pull request. The PR is exclusively a documentation update that modifies only docs/design.md to align the design document with the current codebase implementation. No test code files were added, modified, or deleted in this PR. Since the custom check specifically evaluates test code quality requirements such as single responsibility, setup/cleanup patterns, timeouts, and assertion messages, and there are no test code changes present, the check cannot be applied and therefore passes by default as not applicable.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: elveeram
Once this PR has been reviewed and has the lgtm label, please assign theautoroboto 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:

• OWNERS

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

[openshift-ci]

@elveeram: all tests passed!

Full PR test history. Your PR dashboard.

Details

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.

[coderabbitai]

🧹 Nitpick comments (1)

docs/design.md (1)

223-225: Minor: inline failure-policy note duplicates the dedicated section below.

Line 225 summarizes the failure policy already fully described in the "OSD Upgrade Failure Policy" section at line 267. Consider replacing the summary with a cross-reference (e.g., "See OSD Upgrade Failure Policy for details.") to avoid future drift between the two descriptions.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/design.md` around lines 223 - 225, The inline summary of the upgrade
failure policy (the sentence mentioning upgradeWindow.timeOut, marking upgrade
as Failed, removing extra scaled nodes and sending a failure notification)
duplicates the full "OSD Upgrade Failure Policy" section; replace that summary
in the UpgradeDelayedCheck/StartedNotificationSent paragraph with a brief
cross-reference such as "See OSD Upgrade Failure Policy for details" (linking to
the "OSD Upgrade Failure Policy" anchor) so the document refers to the single
authoritative section and avoids duplication.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/design.md`:
- Around line 223-225: The inline summary of the upgrade failure policy (the
sentence mentioning upgradeWindow.timeOut, marking upgrade as Failed, removing
extra scaled nodes and sending a failure notification) duplicates the full "OSD
Upgrade Failure Policy" section; replace that summary in the
UpgradeDelayedCheck/StartedNotificationSent paragraph with a brief
cross-reference such as "See OSD Upgrade Failure Policy for details" (linking to
the "OSD Upgrade Failure Policy" anchor) so the document refers to the single
authoritative section and avoids duplication.

---

ℹ️ Review info

Configuration used: Repository: openshift/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Pro

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between defcd68 and d5d81e6.

📒 Files selected for processing (1)

• docs/design.md