config

Documentation

Overview

Package config contains configuration strings for UDS-CLI

Index

• Constants
• Variables
• func GetArch(archs ...string) string

Constants

const (
	// ZarfYAML is the string for zarf.yaml
	ZarfYAML = "zarf.yaml"

	// BlobsDir is the string for the blobs/sha256 dir in an OCI artifact
	BlobsDir = "blobs/sha256"

	// BundleYAML is the string for uds-bundle.yaml
	BundleYAML = "uds-bundle.yaml"

	// BundlePrefix is the prefix for compiled uds bundles
	BundlePrefix = "uds-bundle-"

	// SBOMsTar is the sboms.tar file in a Zarf pkg
	SBOMsTar = "sboms.tar"

	// BundleSBOMTar is the name of the tarball containing the bundle's SBOM
	BundleSBOMTar = "bundle-sboms.tar"

	// BundleSBOM is the name of the untarred folder containing the bundle's SBOM
	BundleSBOM = "bundle-sboms"

	// BundleYAMLSignature is the name of the bundle's metadata signature file
	BundleYAMLSignature = "uds-bundle.yaml.sig"

	// PublicKeyFile is the name of the public key file
	PublicKeyFile = "public.key"

	// ChecksumsTxt is the name of the checksums.txt file in a Zarf pkg
	ChecksumsTxt = "checksums.txt"

	// UDSCache is the directory containing cached bundle layers
	UDSCache = ".uds-cache"

	// UDSCacheLayers is the directory in the cache containing cached bundle layers
	UDSCacheLayers = "layers"

	// EnvVarPrefix is the prefix for environment variables to override bundle helm variables
	EnvVarPrefix = "UDS_"

	// ZarfPackageNameAnnotation is the annotation key for the value that specifies the zarf package name
	ZarfPackageNameAnnotation = "zarf.package.name"

	// UDSPackageNameAnnotation is the annotation key for the value that specifies the name given to a zarf package in the uds-bundle.yaml
	UDSPackageNameAnnotation = "uds.package.name"

	// CachedLogs is a file containing cached logs
	CachedLogs = "recent-logs"
)

Variables

var (
	// CommonOptions tracks user-defined values that apply across commands.
	CommonOptions types.BundleCommonOptions

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

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

	// SkipLogFile is a flag to skip logging to a file
	SkipLogFile bool

	// ListTasks is a flag to print available tasks in a TaskFileLocation
	ListTasks bool

	// LogFileName is the name of the UDS log file
	LogFileName string

	// HelmTimeout is the default timeout for helm deploys
	HelmTimeout = 15 * time.Minute
)

var (
	// BundleAlwaysPull is a list of paths that will always be pulled from the remote repository.
	BundleAlwaysPull = []string{BundleYAML, BundleYAMLSignature}
)

var DefaultZarfInitOptions = zarfTypes.ZarfInitOptions{
	GitServer: zarfTypes.GitServerInfo{
		PushUsername: zarfTypes.ZarfGitPushUser,
	},
	RegistryInfo: zarfTypes.RegistryInfo{
		PushUsername: zarfTypes.ZarfRegistryPushUser,
	},
}

DefaultZarfInitOptions set these in the case of deploying a Zarf init pkg typically these are set as part of Zarf's Viper config, which we don't use in UDS could technically remove, but it doesn't hurt anything for now

Functions

func GetArch

func GetArch(archs ...string) string

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