-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Implement remote chart #9845
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
base: main
Are you sure you want to change the base?
Implement remote chart #9845
Conversation
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
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.
Summary of Changes
Hello @ranjith-ka, 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 significantly enhances Skaffold's Helm deployer capabilities by introducing support for using values files that are bundled directly within remote Helm charts. This allows users to more seamlessly manage and deploy applications where specific configurations are co-located with the chart itself, streamlining the deployment process for remote chart users.
Highlights
- New Feature: Remote Chart Values Files: Skaffold now supports referencing
valuesFiles
directly from within remote Helm charts (e.g., OCI registries or remote repositories), allowing users to use configurations co-located with their charts. :chart:
Prefix Support: Users can specify":chart:filename.yaml"
in theirvaluesFiles
list withinskaffold.yaml
to instruct Skaffold to extract a specific values file from the remote chart.- Automated Chart Pull and Extraction: Skaffold will automatically pull the specified remote chart, extract the designated values file to a temporary location, and use it as an override during deployment, with proper cleanup.
- Documentation Update: The Helm deployer documentation (
docs-v2/content/en/docs/deployers/helm.md
) has been updated to clearly describe the new feature's usage, provide examples, and outline its current limitations.
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 or fill out our survey 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.
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 introduces a valuable feature for Skaffold users by allowing the use of values files directly from remote Helm charts. The implementation is well-contained within a new utility function and integrated cleanly into the existing deployment logic. The accompanying documentation is clear and provides good examples. My review focuses on correctness, maintainability, and code hygiene. Overall, this is a great contribution. Addressing the feedback below will make the new feature more robust and easier to maintain.
return "", nil, err | ||
} | ||
// Chart files are inside a top-level dir, e.g. united/values-prod.yaml | ||
if filepath.Base(hdr.Name) == fileInChart { |
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.
The current logic using filepath.Base(hdr.Name)
is too broad. It will match any file with the given name, regardless of its location within the chart archive. This can lead to unexpected behavior, as the documentation states that "The file must exist in the root of the chart archive". The logic should be more strict to only match files in the top-level directory of the chart (e.g., mychart/values.yaml
).
if filepath.Base(hdr.Name) == fileInChart { | |
pathParts := strings.Split(filepath.ToSlash(hdr.Name), "/") | |
if hdr.Typeflag == tar.TypeReg && len(pathParts) == 2 && pathParts[1] == fileInChart { |
743da84
to
2831800
Compare
2831800
to
25f2d67
Compare
Fixes: #nnn
Related: N/A
Merge before/after: N/A
Description
This PR adds support for using values files that are co-located inside remote Helm charts (such as those from OCI registries or remote repositories) in Skaffold.
:chart:
prefix in thevaluesFiles
list.User facing changes
Before:
values-prod.yaml
) that exist only inside the remote chart.After:
:chart:values-prod.yaml
invaluesFiles
to use a values file from inside the remote chart.Documentation
docs-v2/content/en/docs/deployers/helm.md
) has been updated with usage instructions, an example, and limitations for the new feature.Follow-up Work