-
Notifications
You must be signed in to change notification settings - Fork 164
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- This feature allows chart deployment overrides. - #2133 Signed-off-by: naveensrinivasan <172697+naveensrinivasan@users.noreply.github.com>
- Loading branch information
1 parent
9277bdc
commit 939f4e6
Showing
5 changed files
with
342 additions
and
18 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,28 @@ | ||
# 23. Simplifying Helm Chart Value Overrides | ||
|
||
Date: 2024-03-25 | ||
|
||
## Status | ||
|
||
Proposed | ||
|
||
|
||
## 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 `###`. 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 the ZarfConfig file. | ||
- 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**: Centralizing overrides in a single, unified file significantly simplifies the management of configuration settings, aligning more closely with standard Helm practices and reducing the reliance on extensive command-line arguments. | ||
|
||
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. |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,215 @@ | ||
// SPDX-License-Identifier: Apache-2.0 | ||
// SPDX-FileCopyrightText: 2021-Present The Zarf Authors | ||
|
||
package packager | ||
|
||
import ( | ||
"reflect" | ||
"testing" | ||
|
||
"github.com/defenseunicorns/zarf/src/types" | ||
) | ||
|
||
func TestGenerateValuesOverrides(t *testing.T) { | ||
t.Parallel() | ||
|
||
tests := []struct { | ||
name string | ||
chartVariables []types.ZarfChartVariable | ||
setVariableMap map[string]*types.ZarfSetVariable | ||
deployOpts types.ZarfDeployOptions | ||
componentName string | ||
chartName string | ||
want map[string]any | ||
}{ | ||
{ | ||
name: "Empty inputs", | ||
chartVariables: []types.ZarfChartVariable{}, | ||
setVariableMap: map[string]*types.ZarfSetVariable{}, | ||
deployOpts: types.ZarfDeployOptions{}, | ||
componentName: "", | ||
chartName: "", | ||
want: map[string]any{}, | ||
}, | ||
{ | ||
name: "Single variable", | ||
chartVariables: []types.ZarfChartVariable{{Name: "testVar", Path: "testVar"}}, | ||
setVariableMap: map[string]*types.ZarfSetVariable{"testVar": {Value: "testValue"}}, | ||
deployOpts: types.ZarfDeployOptions{}, | ||
componentName: "testComponent", | ||
chartName: "testChart", | ||
want: map[string]any{"testVar": "testValue"}, | ||
}, | ||
{ | ||
name: "Non-matching setVariable", | ||
chartVariables: []types.ZarfChartVariable{{Name: "expectedVar", Path: "path.to.expectedVar"}}, | ||
setVariableMap: map[string]*types.ZarfSetVariable{"unexpectedVar": {Value: "unexpectedValue"}}, | ||
deployOpts: types.ZarfDeployOptions{}, | ||
componentName: "testComponent", | ||
chartName: "testChart", | ||
want: map[string]any{}, | ||
}, | ||
{ | ||
name: "Nested 3 level setVariableMap", | ||
chartVariables: []types.ZarfChartVariable{ | ||
{Name: "level1.level2.level3Var", Path: "level1.level2.level3Var"}, | ||
}, | ||
setVariableMap: map[string]*types.ZarfSetVariable{ | ||
"level1.level2.level3Var": {Value: "nestedValue"}, | ||
}, | ||
deployOpts: types.ZarfDeployOptions{}, | ||
componentName: "nestedComponent", | ||
chartName: "nestedChart", | ||
want: map[string]any{ | ||
"level1": map[string]any{ | ||
"level2": map[string]any{ | ||
"level3Var": "nestedValue", | ||
}, | ||
}, | ||
}, | ||
}, | ||
{ | ||
name: "Multiple variables with nested and non-nested paths", | ||
chartVariables: []types.ZarfChartVariable{ | ||
{Name: "nestedVar.level2", Path: "nestedVar.level2"}, | ||
{Name: "simpleVar", Path: "simpleVar"}, | ||
}, | ||
setVariableMap: map[string]*types.ZarfSetVariable{ | ||
"nestedVar.level2": {Value: "nestedValue"}, | ||
"simpleVar": {Value: "simpleValue"}, | ||
}, | ||
deployOpts: types.ZarfDeployOptions{}, | ||
componentName: "mixedComponent", | ||
chartName: "mixedChart", | ||
want: map[string]any{ | ||
"nestedVar": map[string]any{ | ||
"level2": "nestedValue", | ||
}, | ||
"simpleVar": "simpleValue", | ||
}, | ||
}, | ||
{ | ||
name: "Values override test", | ||
chartVariables: []types.ZarfChartVariable{ | ||
{Name: "overrideVar", Path: "path"}, | ||
}, | ||
setVariableMap: map[string]*types.ZarfSetVariable{ | ||
"path": {Value: "overrideValue"}, | ||
}, | ||
deployOpts: types.ZarfDeployOptions{ | ||
ValuesOverridesMap: map[string]map[string]map[string]any{ | ||
"testComponent": { | ||
"testChart": { | ||
"path": "deployOverrideValue", | ||
}, | ||
}, | ||
}, | ||
}, | ||
componentName: "testComponent", | ||
chartName: "testChart", | ||
want: map[string]any{ | ||
"path": "deployOverrideValue", | ||
}, | ||
}, | ||
{ | ||
name: "Missing variable in setVariableMap but present in ValuesOverridesMap", | ||
chartVariables: []types.ZarfChartVariable{ | ||
{Name: "missingVar", Path: "missingVarPath"}, | ||
}, | ||
setVariableMap: map[string]*types.ZarfSetVariable{}, | ||
deployOpts: types.ZarfDeployOptions{ | ||
ValuesOverridesMap: map[string]map[string]map[string]any{ | ||
"testComponent": { | ||
"testChart": { | ||
"missingVarPath": "overrideValue", | ||
}, | ||
}, | ||
}, | ||
}, | ||
componentName: "testComponent", | ||
chartName: "testChart", | ||
want: map[string]any{ | ||
"missingVarPath": "overrideValue", | ||
}, | ||
}, | ||
{ | ||
name: "Non-existent component or chart", | ||
chartVariables: []types.ZarfChartVariable{{Name: "someVar", Path: "someVar"}}, | ||
setVariableMap: map[string]*types.ZarfSetVariable{"someVar": {Value: "value"}}, | ||
deployOpts: types.ZarfDeployOptions{ | ||
ValuesOverridesMap: map[string]map[string]map[string]any{ | ||
"nonExistentComponent": { | ||
"nonExistentChart": { | ||
"someVar": "overrideValue", | ||
}, | ||
}, | ||
}, | ||
}, | ||
componentName: "actualComponent", | ||
chartName: "actualChart", | ||
want: map[string]any{"someVar": "value"}, | ||
}, | ||
{ | ||
name: "Variable in setVariableMap but not in chartVariables", | ||
chartVariables: []types.ZarfChartVariable{}, | ||
setVariableMap: map[string]*types.ZarfSetVariable{ | ||
"orphanVar": {Value: "orphanValue"}, | ||
}, | ||
deployOpts: types.ZarfDeployOptions{}, | ||
componentName: "orphanComponent", | ||
chartName: "orphanChart", | ||
want: map[string]any{}, | ||
}, | ||
{ | ||
name: "Empty ValuesOverridesMap with non-empty setVariableMap and chartVariables", | ||
chartVariables: []types.ZarfChartVariable{ | ||
{Name: "var1", Path: "path.to.var1"}, | ||
{Name: "var2", Path: "path.to.var2"}, | ||
{Name: "var3", Path: "path.to3.var3"}, | ||
}, | ||
setVariableMap: map[string]*types.ZarfSetVariable{ | ||
"var1": {Value: "value1"}, | ||
"var2": {Value: "value2"}, | ||
"var3": {Value: "value3"}, | ||
}, | ||
deployOpts: types.ZarfDeployOptions{ | ||
ValuesOverridesMap: map[string]map[string]map[string]any{}, | ||
}, | ||
componentName: "componentWithVars", | ||
chartName: "chartWithVars", | ||
want: map[string]any{ | ||
"path": map[string]any{ | ||
"to": map[string]any{ | ||
"var1": "value1", | ||
"var2": "value2", | ||
}, | ||
"to3": map[string]any{ | ||
"var3": "value3", | ||
}, | ||
}, | ||
}, | ||
}, | ||
{ | ||
name: "Empty chartVariables and non-empty setVariableMap", | ||
chartVariables: []types.ZarfChartVariable{}, | ||
setVariableMap: map[string]*types.ZarfSetVariable{ | ||
"var1": {Value: "value1"}, | ||
"var2": {Value: "value2"}, | ||
}, | ||
deployOpts: types.ZarfDeployOptions{}, | ||
componentName: "componentWithVars", | ||
chartName: "chartWithVars", | ||
want: map[string]any{}, | ||
}, | ||
} | ||
|
||
for _, tt := range tests { | ||
tt := tt | ||
t.Run(tt.name, func(t *testing.T) { | ||
got, _ := generateValuesOverrides(tt.chartVariables, tt.setVariableMap, tt.deployOpts, tt.componentName, tt.chartName) | ||
if !reflect.DeepEqual(got, tt.want) { | ||
t.Errorf("%s: generateValuesOverrides() got = %v, want %v", tt.name, got, tt.want) | ||
} | ||
}) | ||
} | ||
} |
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