[docs] update intallation document#130
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @slin1237, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request improves the OME installation documentation by reorganizing the content to clearly differentiate between required and optional components. It also clarifies the different deployment modes, adds a warning about the prerequisites for MultiNode deployments, and provides example installation commands. The goal is to reduce user confusion and prevent runtime errors.
Highlights
- Documentation Restructuring: Reorganized the installation guide to clearly distinguish between required and optional components for OME deployment.
- Deployment Modes Clarification: Clarified deployment mode descriptions, including the addition of the
PDDisaggregatedmode. - Prerequisites Warning: Added clear warnings about installing required CRDs (LeaderWorkerSet) before using MultiNode deployment modes to prevent runtime panics.
- Optional Component Table: Added a comprehensive table showing which optional components are needed for specific deployment modes.
- Installation Examples: Added example installation commands for LeaderWorkerSet.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request significantly improves the installation documentation by clearly separating required and optional components, adding a comprehensive table, and clarifying deployment modes. The changes enhance user understanding and prevent potential issues. My review identified a minor numbering inconsistency in the table of contents and two areas where clarity could be further improved regarding optional component prerequisites and example installation commands to ensure users have all necessary information for a successful setup.
| | **Kueue** | Job scheduling | Kubernetes-native job queueing | | ||
|
|
||
| !!! warning | ||
| **Important**: If you plan to use `MultiNode` or `MultiNodeRayVLLM` deployment modes, you MUST install the corresponding optional components (Ray and/or LWS) BEFORE installing OME. The controller may panic if these CRDs are not available when needed. |
There was a problem hiding this comment.
The warning mentions "Ray and/or LWS" as required optional components for MultiNodeRayVLLM deployment modes. However, the "Optional Components" table (lines 46-53) only lists "LeaderWorkerSet (LWS)" and does not explicitly mention Ray. For clarity and completeness, please add Ray to the "Optional Components" table if it's a distinct prerequisite, or clarify its relationship with LWS for MultiNodeRayVLLM mode.
| Please refer to [LeaderWorkerSet installation guide](https://github.com/kubernetes-sigs/lws). | ||
|
|
||
| Example installation: | ||
| ```shell |
There was a problem hiding this comment.
The example installation command for LeaderWorkerSet only applies the webhook component (lws-webhook.yaml). A complete LWS installation typically involves both the webhook and the controller. To prevent incomplete installations, consider providing the full installation command that includes both components, or explicitly state that this example is only for the webhook and users should refer to the full guide for a complete setup.
| ```shell | |
| kubectl apply --server-side -f https://github.com/kubernetes-sigs/lws/releases/download/v0.3.0/lws-webhook.yaml | |
| kubectl apply --server-side -f https://github.com/kubernetes-sigs/lws/releases/download/v0.3.0/lws-controller.yaml |
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
1 participant
What type of PR is this?
/kind documentation
What this PR does / why we need it:
This PR improves the installation documentation to clearly distinguish between required and optional components for OME deployment.
Changes made:
PDDisaggregatedmodeWhich issue(s) this PR fixes:
Fixes #
Special notes for your reviewer:
Does this PR introduce a user-facing change?