Skip to content

Commit

Permalink
move section to risks
Browse files Browse the repository at this point in the history
  • Loading branch information
Racer159 committed Feb 5, 2025
1 parent 8e8d941 commit 1bc9701
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions 0015-helm-value-style-variable-interfaces/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,12 +148,12 @@ This will require some additional processing of the `zarf-config` files to allow

The `--set` syntax will change somewhat how variables are interpreted on the CLI (i.e. `--set VAR=100` will no longer represent `"100"` and instead will just be `100` internally). For `###` templates this can be mitigated by simply representing the value as a string for backwards compatibility though this will likely need to either be marked as breaking for Helm overrides or have additional flag changes / opt ins for this specific feature.

As we implement these changes tehre are risks around opening a `string` to an `interface{}` and we should strongly look at adopting many of the [Helm helpers](https://github.com/helm/helm/blob/main/pkg/chartutil/values.go#L71) from their `chartutil` package to ensure that potential security and stability issues are minimized. Also called out below we should implement fuzz testing to catch unanticipated issues and provide an additional layer of assurance to the implementation.

## Design Details

This design proposal seeks to keep changes to a minimum to align Zarf Variables with Helm Values with the largest changes being the change from `string` to `interface` and the changes to loading a `zarf-config` file and handling `--set` as described above.

As we implement these changes we should strongly look at adopting many of the [Helm helpers](https://github.com/helm/helm/blob/main/pkg/chartutil/values.go#L71) from their `chartutil` package to ensure that potential security and stability issues are minimized.

This change will also impact other aspects of Zarf variables as described below:

- `default` values would now accept an interface - this would affect packages in the same way as zarf-config values for backwards compatibility
Expand Down

0 comments on commit 1bc9701

Please sign in to comment.