schema

Documentation

Index

• type Actions
• type Image
• type Jobs
• type Resource
• type Stage
  • func (stg *Stage) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Workflow
  • func NewWorkflow() *Workflow

Types

type Actions

type Actions struct {
	Depends  []string    `yaml:"depends"`  // dependencies
	Forget   bool        `yaml:"forget"`   // install only
	Template string      `yaml:"template"` // template file
	Jobs     Jobs        `yaml:"jobs"`     // bash jobs
	Kind     string      `yaml:"kind"`     // type of deploy
	Requires util.Values `yaml:"requires"` // env requirements
}

type Image

type Image struct {
	Name      string             `yaml:"name"`
	Context   string             `yaml:"context"`
	Reference string             `yaml:"reference"`
	Args      map[string]*string `yaml:"args"`
}

type Jobs

type Jobs struct {
	Before []string `yaml:"before"`
	After  []string `yaml:"after"`
}

Jobs represent any shell scripts

type Resource

type Resource interface {
	Lint(string, *util.Values) error
	Status() (bool, error)
	InstallOrUpgrade() error
	Delete() error
	Connect(interface{})
	SetInput([]byte)
	GetInput() []byte
}

Resource is the thing to be created / destroyed

type Stage

type Stage struct {
	Actions `yaml:",inline"`
	Resource
}

Stage represents a single part of the deployment pipeline

func (*Stage) UnmarshalYAML

func (stg *Stage) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML allows us to determine the type of our resource

type Workflow

type Workflow struct {
	Build  []Image           `yaml:"build"`
	Tag    []Image           `yaml:"tag"`
	Stages map[string]*Stage `yaml:"stages"`
	Values util.Values       `yaml:"values"`
}

Workflow represents the complete pipeline

func NewWorkflow

func NewWorkflow() *Workflow