composer

Documentation

Overview

Package composer contains functions for composing components within Zarf packages.

Package composer contains functions for composing components within Zarf packages.

Package composer contains functions for composing components within Zarf packages.

Package composer contains functions for composing components within Zarf packages.

Index

• func CompatibleComponent(c types.ZarfComponent, arch, flavor string) bool
• type ImportChain
  • func NewImportChain(ctx context.Context, head types.ZarfComponent, index int, ...) (*ImportChain, error)
  • func (ic *ImportChain) Compose(ctx context.Context) (composed *types.ZarfComponent, err error)
  • func (ic *ImportChain) ContainsOCIImport() bool
  • func (ic *ImportChain) Head() *Node
  • func (ic *ImportChain) MergeConstants(existing []variables.Constant) (merged []variables.Constant)
  • func (ic *ImportChain) MergeVariables(existing []variables.InteractiveVariable) (merged []variables.InteractiveVariable)
  • func (ic *ImportChain) Migrate(build types.ZarfBuildData) (warnings []string)
  • func (ic *ImportChain) String() string
  • func (ic *ImportChain) Tail() *Node
• type Node
  • func (n *Node) ImportLocation() string
  • func (n *Node) ImportName() string
  • func (n *Node) Index() int
  • func (n *Node) Next() *Node
  • func (n *Node) OriginalPackageName() string
  • func (n *Node) Prev() *Node

Functions

func CompatibleComponent

func CompatibleComponent(c types.ZarfComponent, arch, flavor string) bool

CompatibleComponent determines if this component is compatible with the given create options

Types

type ImportChain

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

ImportChain is a doubly linked list of component import definitions

func NewImportChain

func NewImportChain(ctx context.Context, head types.ZarfComponent, index int, originalPackageName, arch, flavor string) (*ImportChain, error)

NewImportChain creates a new import chain from a component Returning the chain on error so we can have additional information to use during lint

func (*ImportChain) Compose

func (ic *ImportChain) Compose(ctx context.Context) (composed *types.ZarfComponent, err error)

Compose merges the import chain into a single component fixing paths, overriding metadata, etc

func (*ImportChain) ContainsOCIImport

func (ic *ImportChain) ContainsOCIImport() bool

ContainsOCIImport returns true if the import chain contains a remote import

func (*ImportChain) Head

func (ic *ImportChain) Head() *Node

Head returns the first node in the import chain

func (*ImportChain) MergeConstants

func (ic *ImportChain) MergeConstants(existing []variables.Constant) (merged []variables.Constant)

MergeConstants merges constants from the import chain

func (*ImportChain) MergeVariables

func (ic *ImportChain) MergeVariables(existing []variables.InteractiveVariable) (merged []variables.InteractiveVariable)

MergeVariables merges variables from the import chain

func (*ImportChain) Migrate

func (ic *ImportChain) Migrate(build types.ZarfBuildData) (warnings []string)

Migrate performs migrations on the import chain

func (*ImportChain) String

func (ic *ImportChain) String() string

String returns a string representation of the import chain

func (*ImportChain) Tail

func (ic *ImportChain) Tail() *Node

Tail returns the last node in the import chain

type Node

type Node struct {
	types.ZarfComponent
	// contains filtered or unexported fields
}

Node is a node in the import chain

func (*Node) ImportLocation

func (n *Node) ImportLocation() string

ImportLocation gets the path from the base `zarf.yaml` to the imported `zarf.yaml`

func (*Node) ImportName

func (n *Node) ImportName() string

ImportName returns the name of the component to import If the component import has a ComponentName defined, that will be used otherwise the name of the component will be used

func (*Node) Index

func (n *Node) Index() int

Index returns the .components index location for this node's source `zarf.yaml`

func (*Node) Next

func (n *Node) Next() *Node

Next returns next node in the chain

func (*Node) OriginalPackageName

func (n *Node) OriginalPackageName() string

OriginalPackageName returns the .metadata.name for this node's source `zarf.yaml`

func (*Node) Prev

func (n *Node) Prev() *Node

Prev returns previous node in the chain