Skip to content

doc: explain dependency handling#3544

Open
ahadas wants to merge 1 commit into
opendatahub-io:mainfrom
ahadas:doc_missing_dependencies
Open

doc: explain dependency handling#3544
ahadas wants to merge 1 commit into
opendatahub-io:mainfrom
ahadas:doc_missing_dependencies

Conversation

@ahadas

@ahadas ahadas commented May 14, 2026

Copy link
Copy Markdown
Contributor

Description

There has been a decision that the ODH/RHOAI operator won't deploy external operators. This PR documents this and suggests a GitOps approach based on https://github.com/opendatahub-io/odh-gitops

Merge criteria

  • You have read the contributors guide.
  • Commit messages are meaningful - have a clear and concise summary and detailed explanation of what was changed and why.
  • Pull Request contains a description of the solution, a link to the JIRA issue, and to any dependent or related Pull Request.
  • Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
  • The developer has manually tested the changes and verified that the changes work
  • The developer has run the integration test pipeline and verified that it passed successfully
  • New RELATED_IMAGE mappings are listed in ODH-Build-Config and RHOAI-Build-Config (CI validates names against build-config repos). Include links to build-config PRs in the description.

E2E test suite update requirement

When bringing new changes to the operator code, such changes are by default required to be accompanied by extending and/or updating the E2E test suite accordingly.

To opt-out of this requirement:

  1. Please inspect the opt-out guidelines, to determine if the nature of the PR changes allows for skipping this requirement
  2. If opt-out is applicable, provide justification in the dedicated E2E update requirement opt-out justification section below
  3. Check the checkbox below:
  • Skip requirement to update E2E test suite for this PR
  1. Submit/save these changes to the PR description. This will automatically trigger the check.

E2E update requirement opt-out justification

Doc change

Summary by CodeRabbit

  • Documentation
    • Clarified operator status reporting to better explain how missing dependencies are communicated at operator and component levels.
    • Documented the GitOps-based deployment approach for improved system understanding.

@openshift-ci

openshift-ci Bot commented May 14, 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 robotmaxtron 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

@openshift-ci openshift-ci Bot requested review from carlkyrillos and kahowell May 14, 2026 07:41
@coderabbitai

coderabbitai Bot commented May 14, 2026

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@ahadas has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 56 minutes and 57 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Enterprise

Run ID: 590249d3-a399-4930-87cc-b1692c1036d0

📥 Commits

Reviewing files that changed from the base of the PR and between 15d09e3 and 1098e69.

📒 Files selected for processing (1)
  • docs/DESIGN.md
📝 Walkthrough

Walkthrough

Updated documentation in docs/DESIGN.md to clarify what operator-level Custom Resource (CR) status reports. Added notes indicating that the operator provides information about missing dependencies and does not deploy other operators by design. Expanded DSCI (DSCInitialization) section to specify that DSCI status indicates missing dependencies not tied to a single component. Extended DSC (DataScienceCluster) section to specify that DSC status indicates missing dependencies for specific components and affected features.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'doc: explain dependency handling' directly relates to the main change of clarifying operator-level CR status reports regarding dependency handling in the design documentation.
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.

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


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

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 `@docs/DESIGN.md`:
- Line 55: The sentence "In its status, the DSCI CR indicates of missing
dependencies that are not specific to a single component." contains a
grammatical error; remove the extraneous "of" so it reads "In its status, the
DSCI CR indicates missing dependencies that are not specific to a single
component." Update that exact sentence in the document (the line containing "In
its status, the DSCI CR indicates of missing dependencies...").
- Line 64: Update the sentence that currently reads "In its status, the DSC CR
indicates of missing dependencies for a specific component, or of
component-specific features that are affects by missing dependencies." by
removing the stray "of" after "indicates" and changing "affects" to "affected"
so it reads: "In its status, the DSC CR indicates missing dependencies for a
specific component, or of component-specific features that are affected by
missing dependencies." Target the sentence containing "DSC CR indicates of
missing dependencies" and edit those two words accordingly.
🪄 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: ae62816e-fda1-4a08-ae84-825ac73393a6

📥 Commits

Reviewing files that changed from the base of the PR and between b24846b and 15d09e3.

📒 Files selected for processing (1)
  • docs/DESIGN.md

Comment thread docs/DESIGN.md Outdated
Comment thread docs/DESIGN.md Outdated
Signed-off-by: Arik Hadas <ahadas@redhat.com>
@ahadas ahadas force-pushed the doc_missing_dependencies branch from 15d09e3 to 1098e69 Compare May 14, 2026 10:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

1 participant