config

Documentation

Index

• Constants
• Variables
• func BuildConfig(path string) error
• func GetArch() string
• func GetBuildData() types.ZarfBuildData
• func GetComponents() []types.ZarfComponent
• func GetCraneOptions() crane.Option
• func GetImageCachePath() string
• func GetMetaData() types.ZarfMetadata
• func GetPackageName() string
• func GetRegistry() string
• func GetSecret(selector SecretSelector) string
• func GetSeedImage() 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 SetComponents(components []types.ZarfComponent)
• func SetImageCachePath(cachePath string)
• type SecretMap
• type SecretSelector

Constants

const (
	IPV4Localhost = "127.0.0.1"

	PackagePrefix = "zarf-package"

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

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

	ZarfManagedByLabel        = "app.kubernetes.io/managed-by"
	ZarfCleanupScriptsPath    = "/opt/zarf"
	ZarfDefaultImageCachePath = ".zarf-image-cache"
)

Variables

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

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

	CliArch string

	ZarfSeedPort string

	// Do not process SBOM data
	SkipSBOM bool
)

Functions

func BuildConfig

func BuildConfig(path string) error

func GetArch

func GetArch() string

func GetBuildData

func GetBuildData() types.ZarfBuildData

func GetComponents

func GetComponents() []types.ZarfComponent

func GetCraneOptions

func GetCraneOptions() crane.Option

func GetImageCachePath

func GetImageCachePath() string

func GetMetaData

func GetMetaData() types.ZarfMetadata

func GetPackageName

func GetPackageName() string

func GetRegistry

func GetRegistry() string

func GetSecret

func GetSecret(selector SecretSelector) string

func GetSeedImage

func GetSeedImage() string

GetSeedImage 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 SetComponents

func SetComponents(components []types.ZarfComponent)

func SetImageCachePath

func SetImageCachePath(cachePath string)

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"
)