Update the helm chart to use config file by default #419
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-client
property based onreplicaCount
warpConfiguration
when both are defined2. Automatic
warp-client
Injectionwarp-client
property<release-name>-{0...<replicaCount-1>}.<release-name>.<namespace>
3. Job Restart on Upgrade
helm upgrade
job.restartOnUpgrade
setting (default:true
)warp-1
,warp-2
)4. Default Configuration Update
configFile
is now the default configuration methodwarpConfiguration
andwarpJobArgs
are commented out by default5. Enhanced User Experience
NOTES.txt
with immediate log viewing instructionskubectl logs -f
command 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 withconfigFile
as 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
warpConfiguration
will continue to work without changes.Migration Path
Users can migrate from legacy to new configuration by:
warpConfiguration
values to YAML formatconfigFile
value in their values.yamlwarpConfiguration
andwarpJobArgs
sectionsBenefits
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.