template

Documentation

Overview

Package template provides functions for templating yaml files.

Package template provides functions for templating yaml files.

Index

• func ProcessYamlFilesInPath(path string, component types.ZarfComponent, values Values) ([]string, error)
• type Values
  • func Generate(cfg *types.PackagerConfig) (Values, error)
  • func (values Values) Apply(component types.ZarfComponent, path string, ignoreReady bool) error
  • func (values Values) GetRegistry() string
  • func (values Values) GetVariables(component types.ZarfComponent) (map[string]*utils.TextTemplate, map[string]string)
  • func (values Values) Ready() bool

Functions

func ProcessYamlFilesInPath

func ProcessYamlFilesInPath(path string, component types.ZarfComponent, values Values) ([]string, error)

ProcessYamlFilesInPath iterates over all yaml files in a given path and performs Zarf templating + image swapping.

Types

type Values

type Values struct {
	// contains filtered or unexported fields
}

Values contains the values to be used in the template.

func Generate

func Generate(cfg *types.PackagerConfig) (Values, error)

Generate returns a Values struct with the values to be used in the template.

func (Values) Apply

func (values Values) Apply(component types.ZarfComponent, path string, ignoreReady bool) error

Apply renders the template and writes the result to the given path.

func (Values) GetRegistry

func (values Values) GetRegistry() string

GetRegistry returns the registry address.

func (Values) GetVariables

func (values Values) GetVariables(component types.ZarfComponent) (map[string]*utils.TextTemplate, map[string]string)

GetVariables returns the variables to be used in the template.

func (Values) Ready

func (values Values) Ready() bool

Ready returns true if the Values struct is ready to be used in the template.