config

Documentation

Index

• type AddonConfig
  • func (ac *AddonConfig) GetAddonDestPath(dest string) (string, error)
  • func (ac *AddonConfig) GetReferenceValueMap(dest string) (map[string]string, error)
• type BuilderVar
• type BuilderVarDefault
• type CreateConfig
• type DraftConfig
  • func (d *DraftConfig) GetNameOverride(path string) string
• type FileNameOverride
• type Reference
• type UserInputs

Types

type AddonConfig

type AddonConfig struct {
	DraftConfig         `yaml:",inline"`
	ReferenceComponents map[string][]referenceResource `yaml:"references"`
	// contains filtered or unexported fields
}

AddonConfig is a struct that extends the base DraftConfig to allow for the Referencing previously generated k8s objects. This allows an addon creator to reference pre-entered data from the deployment files.

func (*AddonConfig) GetAddonDestPath

func (ac *AddonConfig) GetAddonDestPath(dest string) (string, error)

func (*AddonConfig) GetReferenceValueMap

func (ac *AddonConfig) GetReferenceValueMap(dest string) (map[string]string, error)

GetReferenceValueMap extracts k8s object values into a mapping of template strings to k8s object value.

type BuilderVar

type BuilderVar struct {
	Name        string `yaml:"name"`
	Description string `yaml:"description"`
	VarType     string `yaml:"type"`
}

type BuilderVarDefault

type BuilderVarDefault struct {
	Name         string `yaml:"name"`
	Value        string `yaml:"value"`
	ReferenceVar string `yaml:"referenceVar"`
}

type CreateConfig

type CreateConfig struct {
	DeployType        string
	LanguageType      string
	DeployVariables   []UserInputs
	LanguageVariables []UserInputs
}

type DraftConfig

type DraftConfig struct {
	NameOverrides    []FileNameOverride  `yaml:"nameOverrides"`
	Variables        []BuilderVar        `yaml:"variables"`
	VariableDefaults []BuilderVarDefault `yaml:"variableDefaults"`
	// contains filtered or unexported fields
}

TODO: remove Name Overrides since we don't need them anymore

func (*DraftConfig) GetNameOverride

func (d *DraftConfig) GetNameOverride(path string) string

type FileNameOverride

type FileNameOverride struct {
	Path   string `yaml:"path"`
	Prefix string `yaml:"prefix"`
}

type Reference

type Reference interface {
	GetReferenceVariables([]referenceResource) map[string]string
}

type UserInputs

type UserInputs struct {
	Name  string
	Value string
}