Skip to content

docs: add missing ODH webhook wait command in platform-setup docs#641

Open
mynhardtburger wants to merge 2 commits intomainfrom
fix/odh-empty-webhook-wait-command
Open

docs: add missing ODH webhook wait command in platform-setup docs#641
mynhardtburger wants to merge 2 commits intomainfrom
fix/odh-empty-webhook-wait-command

Conversation

@mynhardtburger
Copy link
Copy Markdown
Contributor

@mynhardtburger mynhardtburger commented Mar 30, 2026

Summary

  • Fixes empty code block in the ODH tab's "Wait for the operator webhook to be ready" step in docs/content/install/platform-setup.md
  • Added the correct kubectl wait command matching the pattern used by the Kuadrant and RHOAI tabs

Resolves: RHOAIENG-55116

Test plan

  • Verify the rendered docs show the correct command in the ODH tab
  • Confirm the kubectl wait command targets the correct deployment name and namespace

Summary by CodeRabbit

  • Documentation
    • Clarified platform setup by adding an explicit readiness check that waits for the operator to become Available before continuing installation.
    • Cleaned up the instructions by removing an empty/placeholder code block so the guidance is concise and actionable.

@openshift-ci
Copy link
Copy Markdown

openshift-ci bot commented Mar 30, 2026

[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

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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 30, 2026

📝 Walkthrough

Walkthrough

The platform setup documentation for OpenDataHub was updated to add an explicit kubectl wait --for=condition=Available --timeout=120s that targets the opendatahub-operator-controller-manager Deployment in the openshift-operators namespace, ensuring the operator webhook is ready before proceeding. A previously empty shell-code block under the ODH instructions was removed and whitespace in that area was cleaned up.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 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: adding a missing ODH webhook wait command to the platform-setup documentation.

✏️ 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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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 | 🟠 Major

Move 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

📥 Commits

Reviewing files that changed from the base of the PR and between de748ab and 997c2de.

📒 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
@mynhardtburger mynhardtburger force-pushed the fix/odh-empty-webhook-wait-command branch from 997c2de to 1f8837a Compare March 30, 2026 15:23
Signed-off-by: Mynhardt Burger <mynhardt@gmail.com>

rh-pre-commit.version: 2.3.2
rh-pre-commit.check-secrets: ENABLED
@mynhardtburger mynhardtburger added the ready-for-review All changes are complete and CI checks have passed. label Mar 30, 2026
@mynhardtburger
Copy link
Copy Markdown
Contributor Author

@coderabbitai The suggestion of #641 (review) is implemented.

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 | 🟠 Major

Move 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

ℹ️ Review info

The suggestion is now implemented.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 30, 2026

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check the current state of the relevant section in the file
grep -n "webhook\|DSCInitialization\|dscinitialization\|opendatahub-operator-controller-manager\|kubectl wait\|subscription/opendatahub-operator" docs/content/install/platform-setup.md | head -60

Length of output: 1839


@mynhardtburger: Confirmed — the webhook readiness wait (deployment/opendatahub-operator-controller-manager) at Line 369 now correctly precedes the DSCInitialization apply step at Line 375, matching the ordering pattern used by the Kuadrant and RHOAI tabs. The fix is properly implemented.


If you found this review helpful, would you consider giving us a shout-out on X?

Thank you for using CodeRabbit!

@mynhardtburger mynhardtburger changed the title fix: add missing ODH webhook wait command in platform-setup docs docs: add missing ODH webhook wait command in platform-setup docs Mar 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved ready-for-review All changes are complete and CI checks have passed.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant