scaffold

Documentation

Index

• Constants
• func ApplicationScaffold(client api.Client) error
• func Notes(installation *api.Installation) error
• func Readme(chartSearchRoot string, dryRun bool) error
• type Applications
  • func BuildApplications(root string) *Applications
  • func NewApplications() (*Applications, error)
  • func (apps *Applications) HelmValues(app string) (map[string]interface{}, error)
  • func (apps *Applications) TerraformValues(app string) (map[string]interface{}, error)
• type Build
  • func Default(w *wkspace.Workspace, name string) (b *Build)
  • func Read(path string) (*Build, error)
  • func Scaffolds(wk *wkspace.Workspace) (*Build, error)
  • func (b *Build) Execute(wk *wkspace.Workspace, force bool) error
  • func (b *Build) Flush(root string) error
• type Metadata
• type Scaffold
  • func (s *Scaffold) Execute(wk *wkspace.Workspace, force bool) error

Constants

const (

	// ChartfileName is the default Chart file name.
	ChartfileName = "Chart.yaml"
	// ValuesfileName is the default values file name.
	TemplatesDir = "templates"
	// ChartsDir is the relative directory name for charts dependencies.
	ChartsDir = "charts"
	// IgnorefileName is the name of the Helm ignore file.
	IgnorefileName = ".helmignore"
	// NotesName is the name of the example NOTES.txt file.
	NotesName = TemplatesDir + sep + "NOTES.txt"
	// file to put the default application resource in
	ApplicationName = TemplatesDir + sep + "application.yaml"
	// file to put the license secret in
	LicenseSecretName = TemplatesDir + sep + "secret.yaml"
	// file to put the license crd in
	LicenseCrdName = TemplatesDir + sep + "license.yaml"
)

const (
	TF   = "terraform"
	HELM = "helm"
	CRD  = "crd"
)

Functions

func ApplicationScaffold

func ApplicationScaffold(client api.Client) error

func Notes

func Notes(installation *api.Installation) error

func Readme

func Readme(chartSearchRoot string, dryRun bool) error

Types

type Applications

type Applications struct {
	Root string
}

func BuildApplications

func BuildApplications(root string) *Applications

func NewApplications

func NewApplications() (*Applications, error)

func (*Applications) HelmValues

func (apps *Applications) HelmValues(app string) (map[string]interface{}, error)

func (*Applications) TerraformValues

func (apps *Applications) TerraformValues(app string) (map[string]interface{}, error)

type Build

type Build struct {
	Metadata  *Metadata   `hcl:"metadata"`
	Scaffolds []*Scaffold `hcl:"scaffold"`
}

func Default

func Default(w *wkspace.Workspace, name string) (b *Build)

func Read

func Read(path string) (*Build, error)

func Scaffolds

func Scaffolds(wk *wkspace.Workspace) (*Build, error)

func (*Build) Execute

func (b *Build) Execute(wk *wkspace.Workspace, force bool) error

func (*Build) Flush

func (b *Build) Flush(root string) error

type Metadata

type Metadata struct {
	Name string `hcl:"name"`
}

type Scaffold

type Scaffold struct {
	Name string `hcl:",key"`
	Path string `hcl:"path"`
	Type string `hcl:"type"`
	Root string `hcle:"omit"`

	Preflight []*executor.Step `hcl:"preflight"`
}

func (*Scaffold) Execute

func (s *Scaffold) Execute(wk *wkspace.Workspace, force bool) error