common

Documentation

Overview

Package common handles command configuration across all commands

Package common handles command configuration across all commands

Index

• Constants
• Variables
• func CheckVendorOnlyFromArgs() bool
• func CheckVendorOnlyFromPath(cmd *cobra.Command) bool
• func GetViper() *viper.Viper
• func IsVendorCmd(args []string, vendoredCmds []string) bool
• func PrintFindings(ctx context.Context, lintErr *lint.LintError)
• func PrintViperConfigUsed(ctx context.Context) error

Constants

const (
	VArchitecture          = "architecture"
	VZarfCache             = "zarf_cache"
	VTmpDir                = "tmp_dir"
	VInsecure              = "insecure"
	VPlainHTTP             = "plain_http"
	VInsecureSkipTLSVerify = "insecure_skip_tls_verify"

	VLogLevel   = "log_level"
	VLogFormat  = "log_format"
	VNoLogFile  = "no_log_file"
	VNoProgress = "no_progress"
	VNoColor    = "no_color"

	VInitComponents   = "init.components"
	VInitStorageClass = "init.storage_class"

	VInitGitURL      = "init.git.url"
	VInitGitPushUser = "init.git.push_username"
	VInitGitPushPass = "init.git.push_password"
	VInitGitPullUser = "init.git.pull_username"
	VInitGitPullPass = "init.git.pull_password"

	VInitRegistryURL      = "init.registry.url"
	VInitRegistryNodeport = "init.registry.nodeport"
	VInitRegistrySecret   = "init.registry.secret"
	VInitRegistryPushUser = "init.registry.push_username"
	VInitRegistryPushPass = "init.registry.push_password"
	VInitRegistryPullUser = "init.registry.pull_username"
	VInitRegistryPullPass = "init.registry.pull_password"

	VInitArtifactURL       = "init.artifact.url"
	VInitArtifactPushUser  = "init.artifact.push_username"
	VInitArtifactPushToken = "init.artifact.push_token"

	VPkgOCIConcurrency = "package.oci_concurrency"
	VPkgPublicKey      = "package.public_key"

	VPkgCreateSet                = "package.create.set"
	VPkgCreateOutput             = "package.create.output"
	VPkgCreateSbom               = "package.create.sbom"
	VPkgCreateSbomOutput         = "package.create.sbom_output"
	VPkgCreateSkipSbom           = "package.create.skip_sbom"
	VPkgCreateMaxPackageSize     = "package.create.max_package_size"
	VPkgCreateSigningKey         = "package.create.signing_key"
	VPkgCreateSigningKeyPassword = "package.create.signing_key_password"
	VPkgCreateDifferential       = "package.create.differential"
	VPkgCreateRegistryOverride   = "package.create.registry_override"
	VPkgCreateFlavor             = "package.create.flavor"

	VPkgDeploySet        = "package.deploy.set"
	VPkgDeployComponents = "package.deploy.components"
	VPkgDeployShasum     = "package.deploy.shasum"
	VPkgDeploySget       = "package.deploy.sget"
	VPkgDeployTimeout    = "package.deploy.timeout"
	VPkgRetries          = "package.deploy.retries"

	VPkgPublishSigningKey         = "package.publish.signing_key"
	VPkgPublishSigningKeyPassword = "package.publish.signing_key_password"

	VPkgPullOutputDir = "package.pull.output_directory"

	VDevDeployNoYolo = "dev.deploy.no_yolo"
)

Constants for use when loading configurations from viper config files

Variables

var OutputWriter = os.Stdout

OutputWriter provides a writer to stdout for user-focused output

Functions

func CheckVendorOnlyFromArgs

func CheckVendorOnlyFromArgs() bool

CheckVendorOnlyFromArgs checks if the command being run is a vendor-only command

func CheckVendorOnlyFromPath

func CheckVendorOnlyFromPath(cmd *cobra.Command) bool

CheckVendorOnlyFromPath checks if the cobra command is a vendor-only command

func GetViper

func GetViper() *viper.Viper

GetViper returns the viper singleton

func IsVendorCmd

func IsVendorCmd(args []string, vendoredCmds []string) bool

IsVendorCmd checks if the command is a vendor command.

func PrintFindings

func PrintFindings(ctx context.Context, lintErr *lint.LintError)

PrintFindings prints the findings in the LintError as a table.

func PrintViperConfigUsed

func PrintViperConfigUsed(ctx context.Context) error

PrintViperConfigUsed informs users when Zarf has detected a config file.