docs: add missing ODH webhook wait command in platform-setup docs#641
docs: add missing ODH webhook wait command in platform-setup docs#641mynhardtburger wants to merge 2 commits intomainfrom
Conversation
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: mynhardtburger 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 |
📝 WalkthroughWalkthroughThe platform setup documentation for OpenDataHub was updated to add an explicit Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✏️ 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. Comment |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/content/install/platform-setup.md (1)
369-392:⚠️ Potential issue | 🟠 MajorMove webhook readiness wait before creating
DSCInitialization.Line 391 is currently too late in the flow. Creating
dscinitialization.opendatahub.io/v2(Lines 371-386) can fail if the operator webhook is not ready yet, so this wait must run before that apply step.Suggested doc fix
Wait for the subscription to install successfully: ```shell kubectl wait --for=jsonpath='{.status.state}'=AtLatestKnown subscription/opendatahub-operator -n openshift-operators --timeout=300s ``` + Wait for the operator webhook to be ready: + + ```shell + kubectl wait --for=condition=Available --timeout=120s deployment/opendatahub-operator-controller-manager -n openshift-operators + ``` + Initialize the ODH platform with DSCInitialization: ```yaml kubectl apply -f - <<EOF apiVersion: dscinitialization.opendatahub.io/v2 @@ - Wait for the operator webhook to be ready: - - ```shell - kubectl wait --for=condition=Available --timeout=120s deployment/opendatahub-operator-controller-manager -n openshift-operators - ```As per coding guidelines, prioritize “Bug-prone patterns and error handling gaps.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/content/install/platform-setup.md` around lines 369 - 392, Move the operator readiness checks to run before applying the DSCInitialization manifest: add a wait for the subscription state (subscription/opendatahub-operator) to reach AtLatestKnown and then wait for the operator webhook deployment (deployment/opendatahub-operator-controller-manager) to be Available, placing both waits immediately before the DSCInitialization apply block (the YAML for kind: DSCInitialization and metadata name: default-dsci) so the apply does not fail due to the webhook not yet being ready.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@docs/content/install/platform-setup.md`:
- Around line 369-392: Move the operator readiness checks to run before applying
the DSCInitialization manifest: add a wait for the subscription state
(subscription/opendatahub-operator) to reach AtLatestKnown and then wait for the
operator webhook deployment (deployment/opendatahub-operator-controller-manager)
to be Available, placing both waits immediately before the DSCInitialization
apply block (the YAML for kind: DSCInitialization and metadata name:
default-dsci) so the apply does not fail due to the webhook not yet being ready.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Central YAML (base), Organization UI (inherited)
Review profile: CHILL
Plan: Pro
Run ID: 58f9298e-c9f1-4fd6-93df-13ff4d83a401
📒 Files selected for processing (1)
docs/content/install/platform-setup.md
The ODH tab's "Wait for the operator webhook to be ready" step had an empty code block, blocking users from completing the installation. Added the correct kubectl wait command matching the pattern used by the Kuadrant and RHOAI tabs. Resolves: RHOAIENG-55116 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Mynhardt Burger <mynhardt@gmail.com> rh-pre-commit.version: 2.3.2 rh-pre-commit.check-secrets: ENABLED
997c2de to
1f8837a
Compare
Signed-off-by: Mynhardt Burger <mynhardt@gmail.com> rh-pre-commit.version: 2.3.2 rh-pre-commit.check-secrets: ENABLED
|
@coderabbitai The suggestion of #641 (review) is implemented.
The suggestion is now implemented. |
|
Tip For best results, initiate chat on the files or code changes. 🧩 Analysis chain🏁 Script executed: Length of output: 1839
If you found this review helpful, would you consider giving us a shout-out on X? Thank you for using CodeRabbit! |
Summary
docs/content/install/platform-setup.mdkubectl waitcommand matching the pattern used by the Kuadrant and RHOAI tabsResolves: RHOAIENG-55116
Test plan
kubectl waitcommand targets the correct deployment name and namespaceSummary by CodeRabbit