Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a Design Doc guiding the implementation of a new Variables/Templates/Constants scheme #2296

Open
Racer159 opened this issue Feb 9, 2024 · 0 comments
Assignees
Labels
ga Issues tracking toward Zarf 1.0

Comments

@Racer159
Copy link
Contributor

Racer159 commented Feb 9, 2024

Describe what should be investigated or refactored

Within Zarf we have received a lot of feedback that Package Templates vs Variables vs Constants are confusing and are not what people expect from tools in the K8s space (mostly Helm).

We need to reevaluate the way these function to build a healthier way for configuration to be passed through Zarf packages that is simpler, more familiar, and easier to debug.

Things we have discussed are:

  1. Collapsing the concepts of PKG_TMPLs and CONSTs into one
  2. Allowing variables to be linked directly to Helm Values
  3. Allowing overlays of variables files to be specified on deploy.

Links to any relevant code

This PR removes the valuesTemplate object and separates the concepts of State, Templates and Variables which can help provide a technical base for this design discovery.

Additional context

As an experiment we also worked with UDS-CLI to introduce a different Helm Override syntax that has received good feedback and already has roots in Zarf's library code: https://github.com/defenseunicorns/uds-core/blob/main/bundles/k3d-istio/uds-bundle.yaml#L17. We will likely want to copy something like this in our solution as it has been found to be more familiar and easier for people to work with in testing.

@Racer159 Racer159 added this to the (2024.03.05) milestone Feb 9, 2024
@eddiezane eddiezane moved this to In progress in Zarf (old) Mar 4, 2024
@AustinAbro321 AustinAbro321 moved this from In progress to Ready in Zarf (old) Mar 7, 2024
@AustinAbro321 AustinAbro321 added the ga Issues tracking toward Zarf 1.0 label Jul 2, 2024
@salaxander salaxander removed this from the (2024.03.05) milestone Jul 2, 2024
@salaxander salaxander added this to Zarf Jul 22, 2024
@github-project-automation github-project-automation bot moved this to Backlog in Zarf Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ga Issues tracking toward Zarf 1.0
Projects
Status: Backlog
Development

No branches or pull requests

4 participants