core

Documentation

Index

• func RenderWith(k8s *kube.K8s) template.FuncMap
• type Depends
  • func (d Depends) Complete(stages ...string)
  • func (d Depends) IsCyclic() bool
  • func (d Depends) Wait(stages ...string)
• type Jobs
• type Node
• type Resource
• type Stage
  • func (stg *Stage) Create(logger *log.Entry, key string, global util.Values, force bool) error
  • func (stg *Stage) Destroy(logger *log.Entry, key string, global util.Values, force bool) error
  • func (stg *Stage) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Stages
  • func (stg *Stages) Connect(k8s *kube.K8s, tiller *helm.Tiller, input util.Values) error
  • func (stg *Stages) Destroy(input util.Values, force bool)
  • func (stg *Stages) Lint(in util.Values) (err error)
  • func (stg *Stages) NewDepends(reverse bool) *Depends
  • func (stg *Stages) Run(input util.Values, force bool) error
  • func (stg *Stages) Until(input util.Values, force bool, target string)

Functions

func RenderWith

func RenderWith(k8s *kube.K8s) template.FuncMap

RenderWith returns the supported templating functions

Types

type Depends

type Depends map[string]*Node

Depends implements a mapped waitgroup for dependencies

func (Depends) Complete

func (d Depends) Complete(stages ...string)

Complete given waitgroups

func (Depends) IsCyclic

func (d Depends) IsCyclic() bool

IsCyclic returns true if there is a cycle in the graph

func (Depends) Wait

func (d Depends) Wait(stages ...string)

Wait on given waitgroups

type Jobs

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

Jobs represent any shell scripts

type Node

type Node struct {
	Lock  *sync.WaitGroup
	Edges []string
}

type Resource

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

Resource is the thing to be created / destroyed

type Stage

type Stage 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
	Values   interface{} `yaml:"values"`   // yaml values
	Resource
}

Stage represents a single part of the deployment pipeline

func (*Stage) Create

func (stg *Stage) Create(logger *log.Entry, key string, global util.Values, force bool) error

Create installs / upgrades resource

func (*Stage) Destroy

func (stg *Stage) Destroy(logger *log.Entry, key string, global util.Values, force bool) error

Destroy removes resource

func (*Stage) UnmarshalYAML

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

UnmarshalYAML allows us to determine the type of our resource

type Stages

type Stages map[string]*Stage

Stages represents the complete workflow.

func (*Stages) Connect

func (stg *Stages) Connect(k8s *kube.K8s, tiller *helm.Tiller, input util.Values) error

Connect links all of our stages to their required resources and pre-renders their input

func (*Stages) Destroy

func (stg *Stages) Destroy(input util.Values, force bool)

Destroy deletes each stage in reverse order

func (*Stages) Lint

func (stg *Stages) Lint(in util.Values) (err error)

Lint all the stages in our pipeline

func (*Stages) NewDepends

func (stg *Stages) NewDepends(reverse bool) *Depends

NewDepends generates a dependency map

func (*Stages) Run

func (stg *Stages) Run(input util.Values, force bool) error

Run processes each stage in the pipeline

func (*Stages) Until

func (stg *Stages) Until(input util.Values, force bool, target string)

Until creates single resource and dependencies