Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Feature request: Zarf dev package templating #2631

@zack-is-cool

Description

@zack-is-cool

Is your feature request related to a problem? Please describe.

It would be beneficial if zarf had the ability to template out what would be in a package at create time and also at deploy time with input variables. It is sometimes difficult to determine what will happen with a complex zarf package with component imports, overrides etc.

Describe the solution you'd like

  • Given I'm creating a zarf package
  • When I type zarf dev package template create (or something like this) with --set variables or referencing a zarf.config
  • Then Zarf will
    • template and print the Zarf package with templated ###ZARF_PKG_TMPLs rendered
    • template and print the values.yaml files with ###ZARF_VARs- defaults used if none provided by the user at create time
    • template and print all manifests that the helm charts would create with ###ZARF_VARs - defaults used if none provided by the user at create time
  • When I type zarf dev package template deploy (or something like this) with --set variables or referencing a zarf.config
  • Then Zarf will
    • template and print the Zarf package with templated ###ZARF_PKG_TMPLs rendered
    • template and print the values.yaml files with ###ZARF_VARs- possibly defaults used
    • template and print all manifests that the helm charts would create with ###ZARF_VARs - possibly defaults used if none provided by the user at deploy time

Additional context

I feel like this workflow eases the friction of needing to actually have a kubernetes cluster up and running and allows you to debug zarf package templating logic before applying anything to a cluster - similar to the way helm template works, but with the additional zarf templating on top of it.. This makes the feedback loop smaller when debugging a zarf package that is failing to deploy.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    Status

    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions