[Bugfix] Fix install script path prefix #665
Conversation
Signed-off-by: Nicolas Jourdan <[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 @nicolasj92, 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 addresses a bug in the observability stack's installation script. The core change involves correcting a file path within a Helm command to ensure that a critical configuration file, "kube-prom-stack.yaml", is correctly located relative to the script's execution directory. This fix prevents potential errors during the deployment of the observability stack by ensuring all necessary files are found.
Highlights
- Observability Install Script Fix: Corrected the path for "kube-prom-stack.yaml" in the "helm upgrade" command within "observability/install.sh" by prepending "$SCRIPT_DIR/".
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 correctly fixes a path issue in the install.sh script by prepending $SCRIPT_DIR to the YAML file path, ensuring the script can be run from any directory. My review includes a suggestion to improve the script's robustness by adding error handling.
| --namespace monitoring \ | ||
| --create-namespace \ | ||
| -f kube-prom-stack.yaml --wait | ||
| -f "$SCRIPT_DIR/kube-prom-stack.yaml" --wait |
There was a problem hiding this comment.
To make the script more robust, consider adding error handling. If this helm command fails, the script will continue executing, which might lead to an inconsistent state or confusing errors. Appending || exit 1 will cause the script to exit if this command fails.
For consistency, the same logic should be applied to the other helm command in this script. A more idiomatic way to handle this for the entire script would be to add set -e at the top.
| -f "$SCRIPT_DIR/kube-prom-stack.yaml" --wait | |
| -f "$SCRIPT_DIR/kube-prom-stack.yaml" --wait || exit 1 |
Signed-off-by: Nicolas Jourdan <[email protected]> Co-authored-by: Nicolas Jourdan <[email protected]> Signed-off-by: Ifta Khairul Alam Adil <[email protected]>
Signed-off-by: Nicolas Jourdan <[email protected]> Co-authored-by: Nicolas Jourdan <[email protected]> Signed-off-by: [email protected] <[email protected]>
4 participants
Fixes #658
Adds the missing
$SCRIPT_DIRto the first helm command in the install script of the observability stack.-swhen doinggit commit[Bugfix],[Feat], and[CI].Detailed Checklist (Click to Expand)
Thank you for your contribution to production-stack! Before submitting the pull request, please ensure the PR meets the following criteria. This helps us maintain the code quality and improve the efficiency of the review process.
PR Title and Classification
Please try to classify PRs for easy understanding of the type of changes. The PR title is prefixed appropriately to indicate the type of change. Please use one of the following:
[Bugfix]for bug fixes.[CI/Build]for build or continuous integration improvements.[Doc]for documentation fixes and improvements.[Feat]for new features in the cluster (e.g., autoscaling, disaggregated prefill, etc.).[Router]for changes to thevllm_router(e.g., routing algorithm, router observability, etc.).[Misc]for PRs that do not fit the above categories. Please use this sparingly.Note: If the PR spans more than one category, please include all relevant prefixes.
Code Quality
The PR need to meet the following code quality standards:
pre-committo format your code. SeeREADME.mdfor installation.DCO and Signed-off-by
When contributing changes to this project, you must agree to the DCO. Commits must include a
Signed-off-by:header which certifies agreement with the terms of the DCO.Using
-swithgit commitwill automatically add this header.What to Expect for the Reviews
We aim to address all PRs in a timely manner. If no one reviews your PR within 5 days, please @-mention one of YuhanLiu11
, Shaoting-Feng or ApostaC.