config

package

v0.16.2 Latest Latest Go to latest Published: Mar 22, 2022 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/defenseunicorns/zarf

Links

Open Source Insights

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 GetDataInjections() []types.ZarfData
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)
type SecretMap
type SecretSelector

Constants ¶

View Source

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"
	ZarfRegistryPushUser   = "zarf-push"
	ZarfRegistryPullUser   = "zarf-pull"
	ZarfRegistry           = IPV4Localhost + ":45001"

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

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

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

Variables ¶

View Source

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
)

Functions ¶

func BuildConfig ¶ added in v0.14.0

func BuildConfig(path string) error

func GetArch ¶ added in v0.16.0

func GetArch() string

func GetBuildData ¶ added in v0.13.4

func GetBuildData() types.ZarfBuildData

func GetComponents ¶

func GetComponents() []types.ZarfComponent

func GetCraneOptions ¶ added in v0.16.0

func GetCraneOptions() crane.Option

func GetDataInjections ¶

func GetDataInjections() []types.ZarfData

func GetMetaData ¶

func GetMetaData() types.ZarfMetadata

func GetPackageName ¶

func GetPackageName() string

func GetRegistry ¶ added in v0.15.0

func GetRegistry() string

func GetSecret ¶ added in v0.15.0

func GetSecret(selector SecretSelector) string

func GetSeedImage ¶ added in v0.16.0

func GetSeedImage() string

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

func GetSeedRegistry ¶ added in v0.15.0

func GetSeedRegistry() string

func GetState ¶ added in v0.14.0

func GetState() types.ZarfState

func GetValidPackageExtensions ¶

func GetValidPackageExtensions() [3]string

func InitState ¶ added in v0.15.0

func InitState(tmpState types.ZarfState)

func IsZarfInitConfig ¶

func IsZarfInitConfig() bool

func LoadConfig ¶ added in v0.14.0

func LoadConfig(path string) error

func SetComponents ¶ added in v0.16.0

func SetComponents(components []types.ZarfComponent)

Types ¶

type SecretMap ¶ added in v0.15.0

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

type SecretSelector ¶ added in v0.15.0

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL