Skip to content

Add InferNex-bridge#265

Open
fyuan1316 wants to merge 1 commit into
masterfrom
add-infernex-bridge
Open

Add InferNex-bridge#265
fyuan1316 wants to merge 1 commit into
masterfrom
add-infernex-bridge

Conversation

@fyuan1316

@fyuan1316 fyuan1316 commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Added comprehensive InferNex Bridge documentation suite including an overview page
    • Added detailed installation guide covering prerequisites, CRD configuration, operator setup, and upgrade procedures
    • Added introduction page explaining InferNex Bridge concepts, deployment modes, and supported capabilities

@coderabbitai

coderabbitai Bot commented Jun 15, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

Three new MDX documentation pages are added under docs/en/infernex-bridge/: a section index with weight: 96 and an <Overview /> component, an introduction page describing deployment modes and capabilities, and a full installation/upgrade guide covering prerequisites, CRDs, operator install steps, verification commands, and upgrade flow.

Changes

InferNex Bridge Documentation

Layer / File(s) Summary
Section index and introduction pages
docs/en/infernex-bridge/index.mdx, docs/en/infernex-bridge/intro.mdx
Adds the section landing page (weight: 96, <Overview /> component) and the introduction page covering KServe LLMInferenceService vs. native InferNexService deployment modes, supported capabilities, and external reference links.
Installation guide – prerequisites
docs/en/infernex-bridge/install.mdx
Documents required dependencies table, CRDs installed by the OLM bundle vs. those requiring separate installation, runtime image prerequisites with a warning about unbundled images, the admission webhook note, and optional NATS/kube-prometheus-stack dependencies.
Installation guide – upload, install, verify, and upgrade
docs/en/infernex-bridge/install.mdx
Covers the violet upload command, interactive OperatorHub install steps, kubectl verification commands for controller pods and webhook CRDs, a community examples link, and the full upgrade flow with post-upgrade verification.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 Hippity-hop through the docs we go,
A new Bridge section, watch it grow!
Prerequisites listed, CRDs in a row,
kubectl commands all set to show.
From install to upgrade, the path is clear —
InferNex Bridge docs are finally here! 🌉

🚥 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 'Add InferNex-bridge' clearly summarizes the main change: adding new documentation pages for the InferNex Bridge feature under docs/en/infernex-bridge/.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch add-infernex-bridge

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

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
docs/en/infernex-bridge/install.mdx (1)

40-42: ⚡ Quick win

Clarify what "matching" means for CRD installation guidance.

The phrase "Install the CRD from the matching openFuyao InferNex Bridge release" appears three times but doesn't define what "matching" means. Consider specifying version correspondence (e.g., "same major.minor version" or "compatible release") to help users select the correct CRD version and avoid compatibility issues.

🤖 Prompt for 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.

In `@docs/en/infernex-bridge/install.mdx` around lines 40 - 42, The phrase
"matching openFuyao InferNex Bridge release" is ambiguous and does not clearly
communicate what version correspondence users should follow. Replace the vague
term "matching" with explicit version guidance that specifies the exact
relationship between the CRD version and the InferNex Bridge release (for
example, clarify whether users should install CRDs with the same major.minor
version, the exact same release version, or follow a specific compatibility
matrix). This clarification should be added to all three table rows where this
phrase appears (for resourcescalinggroups.autoscaling.openfuyao.com,
elasticscalers.elasticscaler.io, and tidals.tidal.io) to ensure users understand
how to select the correct CRD version and avoid compatibility issues.
🤖 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.

Nitpick comments:
In `@docs/en/infernex-bridge/install.mdx`:
- Around line 40-42: The phrase "matching openFuyao InferNex Bridge release" is
ambiguous and does not clearly communicate what version correspondence users
should follow. Replace the vague term "matching" with explicit version guidance
that specifies the exact relationship between the CRD version and the InferNex
Bridge release (for example, clarify whether users should install CRDs with the
same major.minor version, the exact same release version, or follow a specific
compatibility matrix). This clarification should be added to all three table
rows where this phrase appears (for
resourcescalinggroups.autoscaling.openfuyao.com,
elasticscalers.elasticscaler.io, and tidals.tidal.io) to ensure users understand
how to select the correct CRD version and avoid compatibility issues.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3d7fd18a-a497-4803-9f58-36b9b849eb03

📥 Commits

Reviewing files that changed from the base of the PR and between a14879f and 0212cac.

📒 Files selected for processing (3)
  • docs/en/infernex-bridge/index.mdx
  • docs/en/infernex-bridge/install.mdx
  • docs/en/infernex-bridge/intro.mdx

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying alauda-ai with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0212cac
Status: ✅  Deploy successful!
Preview URL: https://e6c6f7f0.alauda-ai.pages.dev
Branch Preview URL: https://add-infernex-bridge.alauda-ai.pages.dev

View logs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant