-
Notifications
You must be signed in to change notification settings - Fork 149
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: allow chart deploy overrides ALPHA (#2403)
## Description - This feature allows chart deployment overrides. ## Related Issue Relates to #2133 ## Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Other (security config, docs update, etc) ## Checklist before merging - [ ] Test, docs, adr added or updated as needed - [ ] [Contributor Guide Steps](https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md#developer-workflow) followed --------- Signed-off-by: naveensrinivasan <172697+naveensrinivasan@users.noreply.github.com> Co-authored-by: Lucas Rodriguez <lucas.rodriguez9616@gmail.com> Co-authored-by: razzle <harry@razzle.cloud> Co-authored-by: Austin Abro <37223396+AustinAbro321@users.noreply.github.com>
- Loading branch information
4 people
committed
Apr 9, 2024
1 parent
2982c00
commit d4a750e
Showing
7 changed files
with
493 additions
and
34 deletions.
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| # 23. Simplifying Helm Chart Value Overrides | ||
|
|
||
| Date: 2024-03-25 | ||
|
|
||
| ## Status | ||
|
|
||
| Accepted | ||
|
|
||
|
|
||
| ## Context | ||
|
|
||
| The process of deploying applications with Helm charts in Kubernetes environments often necessitates the customization of chart values to align with specific operational or environmental requirements. The current method for customizing these values—either through manual edits or `###ZARF_VAR_XYZ###`. A more streamlined approach would greatly enhance the deployment experience by offering both flexibility and reliability. | ||
|
|
||
| ## Decision | ||
|
|
||
| To address this issue, we propose the introduction of a feature designed to simplify the process of overriding chart values at the time of deployment. This feature would allow users to easily specify overrides for any chart values directly via command-line arguments, eliminating the need to alter the chart's default values file or manage multiple command-line arguments for each override. | ||
|
|
||
| Key aspects of the proposed implementation include: | ||
| - Use existing `--set` flags to specify overrides for chart values. | ||
| - The ability to list all overrides in a structured and easily understandable format within `zarf.yaml`. | ||
| - Ensuring that during deployment, these specified overrides take precedence over the chart's default values, thus facilitating customized deployments without necessitating permanent modifications to the chart. | ||
|
|
||
| ## Consequences | ||
|
|
||
| Adopting this feature would lead to several key improvements: | ||
| - **Streamlined Configuration Process**: Allowing helm values overrides in the zarf package schema simplifies the user experience by reducing the reliance on extensive custom `###ZARF_VAR_XYZ###` templating and aligning more closely with standard Helm practices | ||
|
|
||
| Ultimately, this feature is aimed at enhancing the deployment workflow by offering a straightforward and efficient means of customizing Helm chart deployments via command-line inputs. | ||
|
|
||
| ## Example Configuration | ||
|
|
||
| Below is an example of how the `zarf.yaml` configuration file might be structured to utilize the new override feature for Helm chart values: | ||
|
|
||
| ```yaml | ||
| kind: ZarfPackageConfig | ||
| metadata: | ||
| name: helm-charts | ||
| description: Example showcasing multiple ways to deploy helm charts | ||
| version: 0.0.1 | ||
|
|
||
| components: | ||
| - name: demo-helm-charts | ||
| required: true | ||
| charts: | ||
| - name: podinfo-local | ||
| version: 6.4.0 | ||
| namespace: podinfo-from-local-chart | ||
| localPath: chart | ||
| valuesFiles: | ||
| - values.yaml | ||
| variables: | ||
| - name: REPLICA_COUNT | ||
| description: "Override the number of pod replicas" | ||
| path: replicaCount | ||
| ``` | ||
| This configuration allows for the specification of default values and descriptions for variables that can be overridden at deployment time. The variables section under each chart specifies the variables that can be overridden, along with a path that indicates where in the values file the variable is located. | ||
|
|
||
| ### Command Line Example | ||
|
|
||
| To override the `REPLICA_COUNT` variable at deployment time, the following command can be used: | ||
|
|
||
| ```bash | ||
| zarf package deploy zarf-package-helm-charts-arm64-0.0.1.tar.zst --set REPLICA_COUNT=5 | ||
| ``` | ||
| This command demonstrates how users can easily customize their Helm chart deployments by specifying overrides for chart values directly via command-line arguments, in line with the proposed feature. |
This file contains 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
This file contains 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
This file contains 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
Oops, something went wrong.