Documentation
¶
Index ¶
- func BreakingChangeAllowed(left string, right string) (bool, error)
- func CompareVersions(left string, right string) (int, error)
- func FileExists(file string) bool
- func Flatten(items []interface{}) ([]string, error)
- func GetRandomPort() (int, error)
- func GithubGroupsBegin(w io.Writer, title string)
- func GithubGroupsEnd(w io.Writer)
- func PrintDelimiterLineToWriter(w io.Writer, delimiterChar string)
- func RandomString(length int) string
- func SanitizeName(s string, maxLength int) string
- func StringSliceContains(slice []string, s string) bool
- type ChartYaml
- type DirectoryLister
- type Maintainer
- type Utils
- type ZarfChart
- type ZarfChartVariable
- type ZarfComponent
- type ZarfComponentOnly
- type ZarfComponentOnlyCluster
- type ZarfComponentScripts
- type ZarfConstant
- type ZarfContainerTarget
- type ZarfDataInjection
- type ZarfFile
- type ZarfManifest
- type ZarfVariable
- type ZarfYaml
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FileExists ¶
func GetRandomPort ¶
func GithubGroupsBegin ¶
func GithubGroupsEnd ¶
func RandomString ¶
RandomString string creates a random string of numbers and lower-case ascii characters with the specified length.
func SanitizeName ¶
func StringSliceContains ¶
Types ¶
type ChartYaml ¶
type ChartYaml struct {
Name string `yaml:"name"`
Version string `yaml:"version"`
Deprecated bool `yaml:"deprecated"`
Maintainers []Maintainer
}
func ReadChartYaml ¶
ReadChartYaml attempts to parse Chart.yaml within the specified directory and return a newly allocated ChartYaml object. If no Chart.yaml is present or there is an error unmarshaling the file contents, an error will be returned.
func UnmarshalChartYaml ¶
UnmarshalChartYaml parses the yaml encoded data and returns a newly allocated ChartYaml object.
type DirectoryLister ¶
type DirectoryLister struct{}
func (DirectoryLister) ListChildDirs ¶
func (l DirectoryLister) ListChildDirs(parentDir string, test func(dir string) bool) ([]string, error)
ListChildDirs lists subdirectories of parentDir matching the test function.
type Maintainer ¶
type ZarfChart ¶
type ZarfChart struct {
Name string `yaml:"name"`
Version string `yaml:"version,omitempty"`
Url string `yaml:"url,omitempty"`
RepoName string `yaml:"repoName,omitempty"`
GitPath string `yaml:"gitPath,omitempty"`
LocalPath string `yaml:"localPath,omitempty"`
Namespace string `yaml:"namespace,omitempty"`
ReleaseName string `yaml:"releaseName,omitempty"`
NoWait bool `yaml:"noWait,omitempty"`
ValuesFiles []string `yaml:"valuesFiles,omitempty"`
Variables []ZarfChartVariable `yaml:"variables,omitempty"`
}
type ZarfChartVariable ¶
type ZarfComponent ¶
type ZarfComponent struct {
Name string `yaml:"name"`
Description string `yaml:"description,omitempty"`
Default bool `yaml:"default,omitempty"`
Required bool `yaml:"required,omitempty"`
Only ZarfComponentOnly `yaml:"only,omitempty"`
Group string `yaml:"group,omitempty"`
DepsWith []string `yaml:"depsWith,omitempty"`
Files []ZarfFile `yaml:"files,omitempty"`
Charts []ZarfChart `yaml:"charts,omitempty"`
Manifests []ZarfManifest `yaml:"manifests,omitempty"`
Images []string `yaml:"images,omitempty"`
Repos []string `yaml:"repos,omitempty"`
DataInjections []ZarfDataInjection `yaml:"dataInjections,omitempty"`
Scripts ZarfComponentScripts `yaml:"scripts,omitempty"`
}
type ZarfComponentOnly ¶
type ZarfComponentOnly struct {
LocalOS string `yaml:"localOS,omitempty"`
Cluster ZarfComponentOnlyCluster `yaml:"cluster,omitempty"`
}
type ZarfComponentScripts ¶
type ZarfConstant ¶
type ZarfContainerTarget ¶
type ZarfDataInjection ¶
type ZarfDataInjection struct {
Source string `yaml:"source"`
Target ZarfContainerTarget `yaml:"target"`
Compress bool `yaml:"compress,omitempty"`
}
type ZarfManifest ¶
type ZarfVariable ¶
type ZarfYaml ¶
type ZarfYaml struct {
Kind string `yaml:"kind"`
Metadata struct {
Name string `yaml:"name"`
Description string `yaml:"description"`
Version string `yaml:"version"`
Architecture string `yaml:"architecture,omitempty"`
Deprecated bool `yaml:"deprecated,omitempty"`
} `yaml:"metadata"`
Variables []ZarfVariable `yaml:"variables,omitempty"`
Constants []ZarfConstant `yaml:"constants,omitempty"`
Components []ZarfComponent `yaml:"components,omitempty"`
}
func ReadZarfYaml ¶
ReadZarfYaml attempts to parse zarf.yaml within the specified directory and return a newly allocated ZarfYaml object. If no zarf.yaml is present or there is an error unmarshaling the file contents, an error will be returned.
func UnmarshalZarfYaml ¶
UnmarshalZarfYaml parses the yaml encoded data and returns a newly allocated ZarfYaml object.