[Docs] Update helm installation guidance #1461
Conversation
Signed-off-by: Jiaxin Shan <[email protected]>
![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 @Jeffwan, 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 updates the documentation for AIBrix to streamline and clarify the Helm-based installation process. It standardizes the installation of AIBrix and its dependencies, introduces explicit instructions for upgrading and uninstalling components, and makes the KubeRay operator installation a required step.
Highlights
- Standardized Helm Installation: The documentation now exclusively guides users through Helm for installing AIBrix and its core dependencies, removing previous alternative methods for a more consistent setup experience.
- Mandatory KubeRay Operator Setup: The installation of the KubeRay operator is now a required step, with updated Helm parameters including a specific namespace and image details, ensuring proper integration for RayClusterFleet users.
- Comprehensive Lifecycle Management: New sections have been added to provide clear Helm commands for upgrading and completely uninstalling AIBrix, KubeRay operator, and Envoy Gateway, improving the overall manageability of the deployment.
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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
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 updates the Helm installation documentation, making it the required method. The changes pin dependency versions and add upgrade/uninstall instructions. My review focuses on ensuring the new instructions are correct and clear. I've identified a few issues: a missing step for installing KubeRay CRDs, an incorrect file used in the upgrade command which could lead to installing a nightly build on a stable system, and some unclear wording regarding optional dependencies. Addressing these points will provide a smoother and more reliable installation experience for users.
| # 2. Install KubeRay operator (if you use AIBrix RayClusterFleet, you need to install it): | ||
| helm install kuberay-operator kuberay/kuberay-operator \ |
There was a problem hiding this comment.
The helm install command for the KubeRay operator does not install its required Custom Resource Definitions (CRDs). This will cause failures when using features that depend on KubeRay, such as RayClusterFleet. A step to install the CRDs must be added before installing the operator.
# 2. Install KubeRay operator (if you use AIBrix RayClusterFleet, you need to install it):
kubectl apply -f https://github.com/ray-project/kuberay/releases/download/v1.2.1/ray-operator-crds.yaml
helm install kuberay-operator kuberay/kuberay-operator \
|
|
||
| .. code:: bash | ||
| helm upgrade aibrix dist/chart -f dist/chart/values.yaml -n aibrix-system |
There was a problem hiding this comment.
The upgrade command uses dist/chart/values.yaml, which appears to be for 'nightly' builds based on its content. However, this documentation section is for the 'Stable Version', which is installed using dist/chart/stable.yaml. Using values.yaml for an upgrade would inadvertently switch a stable installation to a nightly one. The upgrade command should use stable.yaml to maintain consistency with the stable installation.
helm upgrade aibrix dist/chart -f dist/chart/stable.yaml -n aibrix-system
| helm install eg oci://docker.io/envoyproxy/gateway-helm --version v1.2.8 -n envoy-gateway-system --create-namespace | ||
| # 2. Optional: Install KubeRay operator (if you use AIBrix RayClusterFleet, you need to insstall it): | ||
| # 2. Install KubeRay operator (if you use AIBrix RayClusterFleet, you need to install it): |
There was a problem hiding this comment.
The instruction for installing the KubeRay operator is unclear about whether it's a mandatory or optional step. The Optional: prefix was removed, but the parenthetical (if you use AIBrix RayClusterFleet, you need to install it) remains. For clarity, if KubeRay is mandatory, the parenthetical should be removed. If it's optional, the instruction should explicitly state that this step can be skipped, for example by re-adding "Optional:".
1 participant
Pull Request Description
Force user to use helm and make it required
Related Issues
Resolves: #1460
Important: Before submitting, please complete the description above and review the checklist below.
Contribution Guidelines (Expand for Details)
We appreciate your contribution to aibrix! To ensure a smooth review process and maintain high code quality, please adhere to the following guidelines:
Pull Request Title Format
Your PR title should start with one of these prefixes to indicate the nature of the change:
[Bug]: Corrections to existing functionality[CI]: Changes to build process or CI pipeline[Docs]: Updates or additions to documentation[API]: Modifications to aibrix's API or interface[CLI]: Changes or additions to the Command Line Interface[Misc]: For changes not covered above (use sparingly)Note: For changes spanning multiple categories, use multiple prefixes in order of importance.
Submission Checklist
By submitting this PR, you confirm that you've read these guidelines and your changes align with the project's contribution standards.