Update the helm chart to use config file by default#419
Merged
harshavardhana merged 2 commits intomasterfrom Oct 7, 2025
Merged
Update the helm chart to use config file by default#419harshavardhana merged 2 commits intomasterfrom
harshavardhana merged 2 commits intomasterfrom
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the Warp Helm chart to support complete YAML configuration files, providing access to all Warp features while maintaining backward compatibility with the existing configuration method.
- Introduces
configFileoption for complete YAML configuration support with automatic warp-client injection - Adds job restart capability on helm upgrade with unique naming
- Provides comprehensive documentation and examples for both configuration methods
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| k8s/helm/values.yaml | Main helm values with configFile as default, legacy options commented |
| k8s/helm/values-configfile-example.yaml | Complete example showing advanced YAML configuration options |
| k8s/helm/templates/secret.yaml | Made conditional for legacy configuration only |
| k8s/helm/templates/job.yaml | Enhanced with config file support and restart behavior |
| k8s/helm/templates/configmap.yaml | New template for YAML config management with auto warp-client injection |
| k8s/helm/templates/NOTES.txt | Post-installation instructions with log viewing commands |
| k8s/helm/README.md | Updated with configuration method descriptions |
| k8s/helm/CONFIG.md | Comprehensive configuration guide for both methods |
| k8s/README.md | Enhanced with configuration examples and migration guidance |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| {{- include "warp.labels" . | nindent 4 }} | ||
| data: | ||
| warp-config.yml: | | ||
| {{- $config := .Values.configFile | fromYaml }} |
There was a problem hiding this comment.
The variable $_ is used to discard the return value of set, but this creates an unused variable. Consider using a more explicit approach or add a comment explaining why the return value is discarded.
Suggested change
| {{- $config := .Values.configFile | fromYaml }} | |
| {{- $config := .Values.configFile | fromYaml }} | |
| {{- /* Discarding the return value of set; only the mutation side effect is needed. */ -}} |
792fd15 to
6eaf2a9
Compare
…ters in values.yaml
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
e0f353c to
5bcfaaa
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Helm Chart Enhancement: YAML Configuration File Support
Summary
This PR enhances the Warp Helm chart to support full YAML configuration files, providing users with access to all Warp features while maintaining backward compatibility with the existing configuration method.
Key Changes
1. New Configuration Method (
configFile)warp-clientproperty based onreplicaCountwarpConfigurationwhen both are defined2. Automatic
warp-clientInjectionwarp-clientproperty<release-name>-{0...<replicaCount-1>}.<release-name>.<namespace>3. Job Restart on Upgrade
helm upgradejob.restartOnUpgradesetting (default:true)warp-1,warp-2)4. Default Configuration Update
configFileis now the default configuration methodwarpConfigurationandwarpJobArgsare commented out by default5. Enhanced User Experience
NOTES.txtwith immediate log viewing instructionskubectl logs -fcommand after installationFiles Modified
Templates
templates/configmap.yaml- New template for YAML config managementtemplates/statefulset.yaml- Updated to support config file mountingtemplates/job.yaml- Enhanced with config file support and restart behaviortemplates/secret.yaml- Made conditional for legacy configuration onlytemplates/NOTES.txt- New file with post-installation instructionsConfiguration
values.yaml- Updated withconfigFileas default, legacy options commentedvalues-configfile-example.yaml- New example file demonstrating advanced configurationCONFIG.md- New comprehensive configuration guideDocumentation
k8s/README.md- Updated with new configuration examplesk8s/helm/README.md- Enhanced with configuration method descriptionsBackward Compatibility
✅ Fully backward compatible - Existing deployments using
warpConfigurationwill continue to work without changes.Migration Path
Users can migrate from legacy to new configuration by:
warpConfigurationvalues to YAML formatconfigFilevalue in their values.yamlwarpConfigurationandwarpJobArgssectionsBenefits
Testing
All templates have been validated with:
helm lint- No errors or warningshelm template- Correct rendering for both configuration methodsExample Usage
Quick Start (with defaults)
Advanced Configuration
Breaking Changes
None - All changes are additive or have sensible defaults.