config

Documentation

Index

• Constants
• Variables
• func BuildConfig(path string) error
• func GetBuildData() types.ZarfBuildData
• func GetComponents() []types.ZarfComponent
• func GetDataInjections() []types.ZarfData
• func GetMetaData() types.ZarfMetadata
• func GetPackageName() string
• func GetRegistry() string
• func GetSecret(selector SecretSelector) string
• func GetSeedImages() []string
• func GetSeedRegistry() string
• func GetState() types.ZarfState
• func GetValidPackageExtensions() [3]string
• func InitState(tmpState types.ZarfState)
• func IsZarfInitConfig() bool
• func LoadConfig(path string) error
• func SetAcrch()
• type SecretMap
• type SecretSelector

Constants

const (
	IPV4Localhost = "127.0.0.1"

	PackageInitName = "zarf-init.tar.zst"
	PackagePrefix   = "zarf-package-"

	// ZarfMaxChartNameLength limits helm chart name size to account for K8s/helm limits and zarf prefix
	ZarfMaxChartNameLength = 40
	ZarfGitPushUser        = "zarf-git-user"
	ZarfRegistryPushUser   = "zarf-push"
	ZarfRegistryPullUser   = "zarf-pull"
	ZarfSeedPort           = "45000"
	ZarfRegistry           = IPV4Localhost + ":45001"
	ZarfLocalSeedRegistry  = IPV4Localhost + ":" + ZarfSeedPort

	ZarfSeedTypeCLIInject         = "cli-inject"
	ZarfSeedTypeRuntimeRegistry   = "runtime-registry"
	ZarfSeedTypeInClusterRegistry = "in-cluster-registry"

	ZarfConnectLabelName             = "zarf.dev/connect-name"
	ZarfConnectAnnotationDescription = "zarf.dev/connect-description"
	ZarfConnectAnnotationUrl         = "zarf.dev/connect-url"
)

Variables

var (
	// CLIVersion track the version of the CLI
	CLIVersion = "unset"

	// TLS options used for cert creation
	TLS types.TLSConfig

	// DeployOptions tracks user-defined values for the active deployment
	DeployOptions types.ZarfDeployOptions

	ActiveCranePlatform crane.Option

	CliArch string
)

Functions

func BuildConfig

func BuildConfig(path string) error

func GetBuildData

func GetBuildData() types.ZarfBuildData

func GetComponents

func GetComponents() []types.ZarfComponent

func GetDataInjections

func GetDataInjections() []types.ZarfData

func GetMetaData

func GetMetaData() types.ZarfMetadata

func GetPackageName

func GetPackageName() string

func GetRegistry

func GetRegistry() string

func GetSecret

func GetSecret(selector SecretSelector) string

func GetSeedImages

func GetSeedImages() []string

GetSeedImages returns a list of image strings specified in the package, but only for init packages

func GetSeedRegistry

func GetSeedRegistry() string

func GetState

func GetState() types.ZarfState

func GetValidPackageExtensions

func GetValidPackageExtensions() [3]string

func InitState

func InitState(tmpState types.ZarfState)

func IsZarfInitConfig

func IsZarfInitConfig() bool

func LoadConfig

func LoadConfig(path string) error

func SetAcrch

func SetAcrch()

Types

type SecretMap

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

type SecretSelector

type SecretSelector = string

const (
	StateRegistryPush   SecretSelector = "registry-push"
	StateRegistryPull   SecretSelector = "registry-pull"
	StateRegistrySecret SecretSelector = "registry-secret"
	StateGitPush        SecretSelector = "git-push"
	StateGitPull        SecretSelector = "git-pull"
	StateLogging        SecretSelector = "logging"
)