Skip to content

Add the ability to just inspect the available variables on a package #5285

Description

@GemmaClements

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

There are times when it would be useful to view all the possible variables in a Zarf Package that could be overridden such that these can be automated into documentation.

Whilst zarf package inspect definition will offer the full definition there are some occasions where just listing the variables could also be beneficial and more concise to read.

Describe the behaviour you'd like

  • Given you run zarf package inspect variables
  • When command succeeds
  • Then it should display all the possible variables and descriptions so and end user could select overrides that maybe required in their configuration at deployment point if required

Describe alternatives you've considered

We have previously tried zarf package inspect definition and then reading the yaml and extracting these into markdown tables but this becomes quite challenging if some variables are matched directly to paths for values.

Additional context

Add any other context or screenshots about the feature request here.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    • Status
      Triage

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions