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.

Package composer contains functions for composing components within Zarf packages.

Index

• func CompatibleComponent(c types.ZarfComponent, arch, flavor string) bool
• type ImportChain
  • func NewImportChain(head types.ZarfComponent, arch, flavor string) (*ImportChain, error)
  • func (ic *ImportChain) Compose() (composed types.ZarfComponent, err error)
  • func (ic *ImportChain) ContainsOCIImport() bool
  • func (ic *ImportChain) MergeConstants(existing []types.ZarfPackageConstant) (merged []types.ZarfPackageConstant)
  • func (ic *ImportChain) MergeVariables(existing []types.ZarfPackageVariable) (merged []types.ZarfPackageVariable)
  • func (ic *ImportChain) Migrate(build types.ZarfBuildData) (warnings []string)
  • func (ic *ImportChain) String() string
• type Node
  • func (n *Node) ImportName() string

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(head types.ZarfComponent, arch, flavor string) (*ImportChain, error)

NewImportChain creates a new import chain from a component

func (*ImportChain) Compose

func (ic *ImportChain) Compose() (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) MergeConstants

func (ic *ImportChain) MergeConstants(existing []types.ZarfPackageConstant) (merged []types.ZarfPackageConstant)

MergeConstants merges constants from the import chain

func (*ImportChain) MergeVariables

func (ic *ImportChain) MergeVariables(existing []types.ZarfPackageVariable) (merged []types.ZarfPackageVariable)

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

type Node

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

Node is a node in the import chain

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