config

Documentation

Overview

Package config stores the global configuration and constants

Index

• Constants
• Variables
• func ClearDeployingComponents()
• func GetAbsCachePath() string
• func GetArch(archs ...string) string
• func GetCraneAuthOption(username string, secret string) crane.Option
• func GetCraneOptions(insecure bool) []crane.Option
• func GetDataInjectionMarker() string
• func GetDeployingComponents() []types.DeployedComponent
• func GetRegistry(state types.ZarfState) string
• func GetStartTime() int64
• func GetValidPackageExtensions() [3]string
• func SetDeployingComponents(components []types.DeployedComponent)

Constants

const (
	GithubProject = "defenseunicorns/zarf"
	IPV4Localhost = "127.0.0.1"

	// 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"
	ZarfImagePullSecretName  = "private-registry"
	ZarfGitServerSecretName  = "private-git-server"
	ZarfGeneratedPasswordLen = 24
	ZarfGeneratedSecretLen   = 48

	ZarfAgentHost = "agent-hook.zarf.svc"

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

	ZarfManagedByLabel     = "app.kubernetes.io/managed-by"
	ZarfCleanupScriptsPath = "/opt/zarf"

	ZarfImageCacheDir = "images"
	ZarfGitCacheDir   = "repos"

	ZarfYAML    = "zarf.yaml"
	ZarfSBOMDir = "zarf-sbom"

	ZarfInClusterContainerRegistryURL      = "http://zarf-registry-http.zarf.svc.cluster.local:5000"
	ZarfInClusterContainerRegistryNodePort = 31999

	ZarfInClusterGitServiceURL = "http://zarf-gitea-http.zarf.svc.cluster.local:3000"

	ZarfSeedImage = "registry"
	ZarfSeedTag   = "2.8.1"
)

Variables

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

	// CommonOptions tracks user-defined values that apply across commands.
	CommonOptions types.ZarfCommonOptions

	// CliArch is the computer architecture of the device executing the CLI commands
	CliArch string

	// ZarfSeedPort is the NodePort Zarf uses for the 'seed registry'
	ZarfSeedPort string

	SGetPublicKey string
	UIAssets      embed.FS

	ZarfDefaultCachePath = filepath.Join("~", ".zarf-cache")
)

Functions

func ClearDeployingComponents

func ClearDeployingComponents()

ClearDeployingComponents clears the list of deploying components TODO: (@jeff-mccoy) this should be moved out of config

func GetAbsCachePath

func GetAbsCachePath() string

GetAbsCachePath gets the absolute cache path for images and git repos.

func GetArch

func GetArch(archs ...string) string

GetArch returns the arch based on a priority list with options for overriding

func GetCraneAuthOption

func GetCraneAuthOption(username string, secret string) crane.Option

GetCraneAuthOption returns a crane auth option with the provided credentials

func GetCraneOptions

func GetCraneOptions(insecure bool) []crane.Option

GetCraneOptions returns a cran option object with the correct options & platform

func GetDataInjectionMarker

func GetDataInjectionMarker() string

GetDataInjectionMarker returns the data injection marker based on the current CLI start time

func GetDeployingComponents

func GetDeployingComponents() []types.DeployedComponent

GetDeployedComponents returns the list of deploying components TODO: (@jeff-mccoy) this should be moved out of config

func GetRegistry

func GetRegistry(state types.ZarfState) string

GetRegistry returns the registry URL based on the Zarf state

func GetStartTime

func GetStartTime() int64

Timestamp of when the CLI was started

func GetValidPackageExtensions

func GetValidPackageExtensions() [3]string

GetValidPackageExtension returns the valid package extensions

func SetDeployingComponents

func SetDeployingComponents(components []types.DeployedComponent)

SetDeployingComponents sets the list of deploying components TODO: (@jeff-mccoy) this should be moved out of config