[Docs] Add volcano engine startup docs and quick start

[Jeffwan]

Pull Request Description

• Add volcano engine installation guidance and quick start yaml
• Update the artifact path with new registry

Related Issues

Resolves: #[Insert issue number(s)]

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

• PR title includes appropriate prefix(es)
• Changes are clearly explained in the PR description
• New and existing tests pass successfully
• Code adheres to project style and best practices
• Documentation updated to reflect changes (if applicable)
• Thorough testing completed, no regressions introduced

By submitting this PR, you confirm that you've read these guidelines and your changes align with the project's contribution standards.

[gemini-code-assist]

Summary of Changes

Hello @Jeffwan, I'm Gemini Code Assist¹! 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 significantly enhances the AIBrix deployment experience on Volcano Engine Kubernetes Engine (VKE) by introducing comprehensive installation documentation and ready-to-use quick start YAML files. These additions aim to streamline the process for users to set up and run AIBrix, including both standard and disaggregated models, within a VKE environment, facilitating quicker adoption and testing.

Highlights

• Volcano Engine Documentation: New documentation has been added for installing AIBrix on Volcano Engine Kubernetes Engine (VKE), providing step-by-step guidance for deployment.
• Quick Start YAMLs: Introduced quick start YAML configurations for deploying both a base model and a Prefill-Decode (PD) Disaggregation Model on VKE, simplifying the setup process.
• Image Repository and Tag Updates: Updated image repositories in vke.yaml to use aibrix-public-release-cn-beijing.cr.volces.com and bumped various component image tags to v0.5.0-rc.2, ensuring the use of the latest release candidate versions. The Redis image tag was also standardized to 7.4.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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

1. 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. ↩

[gemini-code-assist]

Code Review

This pull request adds documentation and quick start configurations for deploying AIBrix on Volcano Engine. The changes include updating container image repositories and tags to public release versions, and adding new documentation and sample YAML files. My review focuses on improving the correctness and security of the new documentation and sample files. I've identified a critical syntax error in a sample curl command that would cause it to fail. I've also pointed out a missing prerequisite step in the documentation that would prevent the sample application from deploying correctly. Additionally, I've raised concerns about the use of hostPath with a privileged directory in the sample YAMLs, which is a security risk, and suggested improvements for robustness in a script that retrieves a service IP. Finally, a minor suggestion is made to follow best practices in YAML formatting for version tags.

[nurali-techie]

@Jeffwan interesting addition 👍 Can you plz share motivation/reason for adding volcano engine support, Thanks :-)

[googs1025]

@Jeffwan interesting addition 👍 Can you plz share motivation/reason for adding volcano engine support, Thanks :-)

This is a deployment example provided internally by bytendance.

[nurali-techie]

Thanks @googs1025 for info. So I think that this doc will help folks at bytedance to install aibrix on their volcano engine 👍

[Jeffwan]

yes. We use volcano engine for testing. that's the purpose