module

Documentation

Index

• Constants
• func DefaultPaths() []string
• type Instance
• type Kind
• type Runner
  • func (mr *Runner) GetSpecHeader(moduleYamlPath string) (*SpecHeader, error)
  • func (mr *Runner) InfoByName(name string) ([]..., error)
  • func (mr *Runner) NewInstance(name string, specFilename string) (Instance, error)
• type SpecHeader
  • func GetSpecHeader(buf []byte) (*SpecHeader, error)
• type SpecUnstructured

Constants

const DefaultSpecRootName = "modules"

const SpecFilename = "module.yaml"

Functions

func DefaultPaths

func DefaultPaths() []string

Types

type Instance

type Instance interface {
	Run(workDir string, overrides []string) ([]byte, error)
}

type Kind

type Kind interface {
	NewInstance(runner *Runner, path string, specFilename string) (Instance, error)
}

type Runner

type Runner struct {
	Kinds map[string]Kind
	Paths []string // lookup paths
}

func (*Runner) GetSpecHeader

func (mr *Runner) GetSpecHeader(moduleYamlPath string) (*SpecHeader, error)

func (*Runner) InfoByName

func (mr *Runner) InfoByName(name string) ([]*struct {
	Path string
	Kind string
}, error)

func (*Runner) NewInstance

func (mr *Runner) NewInstance(name string, specFilename string) (Instance, error)

just return the first successful

type SpecHeader

type SpecHeader struct {
	ApiVersion string `json:"apiVersion" yaml:"apiVersion"` // some version
	Kind       string // goTemplate, starlark, etc

	Metadata struct {
		Name string // module name
	}
}

func GetSpecHeader

func GetSpecHeader(buf []byte) (*SpecHeader, error)

type SpecUnstructured

type SpecUnstructured struct {
	SpecHeader `yaml:",inline"`
	Spec       *map[string]interface{} `json:",omitempty" yaml:",omitempty"`
}