-
Notifications
You must be signed in to change notification settings - Fork 360
Update the documentation of the semantic router deployment to use helm #786
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…m charts and helm command Signed-off-by: szedan <szedan@redhat.com>
Summary of ChangesHello @szedan-rh, 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 refines the deployment documentation for the vLLM Semantic Router within a Kubernetes environment. The primary goal is to enhance the clarity and maintainability of the installation process by migrating from imperative Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request updates the documentation for semantic router deployment to use Helm instead of kubectl. The changes are well-structured and improve the clarity of the guides, including adding a helpful cleanup section. My review focuses on enhancing the reproducibility of the instructions by suggesting the use of specific version tags and commit-pinned URLs instead of floating tags like -latest and references to the main branch. This will ensure a more stable and predictable experience for users following the documentation.
| # Deploy vLLM Semantic Router with custom values from GHCR OCI registry | ||
| # (Optional) If you use a registry mirror/proxy, append: --set global.imageRegistry=<your-registry> | ||
| helm install semantic-router oci://ghcr.io/vllm-project/charts/semantic-router \ | ||
| --version v0.0.0-latest \ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using a floating version tag like v0.0.0-latest can cause unexpected issues for users if the chart it points to is updated with breaking changes. For better reproducibility, it is recommended to use a specific, immutable version (e.g., v0.1.0). This ensures that everyone following the guide gets the same setup. This suggestion also applies to the other Helm commands in this document.
| --version v0.0.0-latest \ | ||
| --namespace vllm-semantic-router-system \ | ||
| --create-namespace \ | ||
| -f https://raw.githubusercontent.com/vllm-project/semantic-router/refs/heads/main/deploy/kubernetes/ai-gateway/semantic-router-values/values.yaml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using a URL that points to the main branch for the values file can lead to inconsistencies for users if the file is updated with breaking changes. To ensure the documentation remains accurate and reproducible, it's better to link to a file from a specific Git tag or commit hash. This applies to all raw GitHub content URLs in this file.
For example:
.../semantic-router/@<tag-or-commit>/...
| # Deploy vLLM Semantic Router with custom values from GHCR OCI registry | ||
| # (Optional) If you use a registry mirror/proxy, append: --set global.imageRegistry=<your-registry> | ||
| helm install semantic-router oci://ghcr.io/vllm-project/charts/semantic-router \ | ||
| --version v0.0.0-latest \ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using a floating version tag like v0.0.0-latest can cause unexpected issues for users if the chart it points to is updated with breaking changes. For better reproducibility, it is recommended to use a specific, immutable version (e.g., v0.1.0). This ensures that everyone following the guide gets the same setup. This suggestion also applies to the other Helm commands in this document.
| --version v0.0.0-latest \ | ||
| --namespace vllm-semantic-router-system \ | ||
| --create-namespace \ | ||
| -f https://raw.githubusercontent.com/vllm-project/semantic-router/refs/heads/main/deploy/kubernetes/ai-gateway/semantic-router-values/values.yaml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using a URL that points to the main branch for the values file can lead to inconsistencies for users if the file is updated with breaking changes. To ensure the documentation remains accurate and reproducible, it's better to link to a file from a specific Git tag or commit hash. This applies to all raw GitHub content URLs in this file.
For example:
.../semantic-router/@<tag-or-commit>/...
zerofishnoodles
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Thanks for the contribution!
Update the documentation of the semantic router deployment to use helm