core

Documentation

Index

• func Template(name string, input map[string]string, k8s *kube.K8s) ([]byte, error)
• type Depends
  • func (d Depends) Complete(stages ...string)
  • func (d Depends) Wait(stages ...string)
• type Jobs
• type Resource
• type Stage
  • func (stg *Stage) Backward(key string, global util.Values, deps *Depends, force, verbose bool) error
  • func (stg *Stage) Forward(key string, global util.Values, deps *Depends, force, verbose bool) error
  • func (stg *Stage) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Stages
  • func (stg *Stages) BuildDepends(reverse bool) *Depends
  • func (stg *Stages) Connect(k8s *kube.K8s, input util.Values, tillerName, tillerPort string) (func(), error)
  • func (stg *Stages) Destroy(input util.Values, force, verbose bool)
  • func (stg *Stages) Lint(in util.Values) (err error)
  • func (stg *Stages) Run(input util.Values, force, verbose bool)
  • func (stg *Stages) Until(input util.Values, force, verbose bool, target string)

Functions

func Template

func Template(name string, input map[string]string, k8s *kube.K8s) ([]byte, error)

Template reads a file and renders it according to the provided functions

Types

type Depends

type Depends map[string]*sync.WaitGroup

Depends implements a mapped waitgroup for dependencies

func (Depends) Complete

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

Complete given waitgroups

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 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
	Input    string      `yaml:"input"`    // template file
	Jobs     Jobs        `yaml:"jobs"`     // bash jobs
	Kind     string      `yaml:"kind"`     // type of deploy
	Remove   bool        `yaml:"remove"`   // delete instead
	Requires util.Values `yaml:"requires"` // env requirements
	Resource
}

Stage represents a single part of the deployment pipeline

func (*Stage) Backward

func (stg *Stage) Backward(key string, global util.Values, deps *Depends, force, verbose bool) error

Backward pass over the graph

func (*Stage) Forward

func (stg *Stage) Forward(key string, global util.Values, deps *Depends, force, verbose bool) error

Forward pass over the graph

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) BuildDepends

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

BuildDepends generates a dependency map

func (*Stages) Connect

func (stg *Stages) Connect(k8s *kube.K8s, input util.Values, tillerName, tillerPort string) (func(), error)

Connect links all of our stages to their required resources

func (*Stages) Destroy

func (stg *Stages) Destroy(input util.Values, force, verbose 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) Run

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

Run processes each stage in the pipeline

func (*Stages) Until

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

Until creates single resource and dependencies