spec

Documentation

Index

• type Application
  • func (a *Application) ApplyScope(scope *Scope) error
• type Build
• type Container
• type Cron
  • func (c Cron) Job(k string) Job
• type Deploy
• type Error
  • func (e *Error) Error() string
• type Job
• type JobHealthcheck
• type Package
• type Program
  • func (p *Program) ApplyScope(scope *Scope) error
• type ProgramHealthcheck
• type Reload
• type Scale
• type Scope
  • func (s *Scope) Expand(text string) (string, error)
  • func (s *Scope) Parse(filename string, b []byte) error
  • func (s *Scope) ParseFile(filename string) error
• type Spec
  • func Parse(filename string, b []byte) (*Spec, error)
  • func ParseFile(filename string) (*Spec, error)
  • func (s *Spec) ApplyScope(scope *Scope) error
  • func (s *Spec) ApplyScopeFile(name string) error
• type Unsafe

Types

type Application

type Application struct {
	Name       string
	Identifier string
	Deploy     Deploy

	Programs    map[string]Program
	ProgramKeys []string

	Cron Cron
}

func (*Application) ApplyScope

func (a *Application) ApplyScope(scope *Scope) error

type Build

type Build struct {
	Image  string
	Script []string
}

type Container

type Container struct {
	Dockerfile string
	Image      string
	Entrypoint *string
	WorkingDir *string
}

type Cron

type Cron struct {
	Jobs []Job
}

func (Cron) Job

func (c Cron) Job(k string) Job

type Deploy

type Deploy struct {
	Current string
}

type Error

type Error struct {
	Name string
	Err  error
}

func (*Error) Error

func (e *Error) Error() string

type Job

type Job struct {
	Key         string
	Command     string
	Schedule    string
	Jitter      string
	Healthcheck JobHealthcheck
}

type JobHealthcheck

type JobHealthcheck struct {
	URL string
}

type Package

type Package struct {
	Contents []string
}

type Program

type Program struct {
	Key         string `yaml:"-"`
	Name        string
	Command     string
	User        string
	Container   Container
	Ports       []string
	Volumes     []string
	Healthcheck *ProgramHealthcheck
	Scales      []Scale
	Reload      Reload

	Unsafe Unsafe
}

func (*Program) ApplyScope

func (p *Program) ApplyScope(scope *Scope) error

type ProgramHealthcheck

type ProgramHealthcheck struct {
	Command     string
	Interval    time.Duration
	Timeout     time.Duration
	Retries     int
	StartPeriod time.Duration
}

type Reload

type Reload struct {
	Method     string
	Signal     string
	Command    string
	PreCommand string
}

type Scale

type Scale struct {
	If string
	N  string
}

type Scope

type Scope struct {
	Vars map[string]string
}

func (*Scope) Expand

func (s *Scope) Expand(text string) (string, error)

func (*Scope) Parse

func (s *Scope) Parse(filename string, b []byte) error

func (*Scope) ParseFile

func (s *Scope) ParseFile(filename string) error

type Spec

type Spec struct {
	Application Application
}

func Parse

func Parse(filename string, b []byte) (*Spec, error)

func ParseFile

func ParseFile(filename string) (*Spec, error)

func (*Spec) ApplyScope

func (s *Spec) ApplyScope(scope *Scope) error

func (*Spec) ApplyScopeFile

func (s *Spec) ApplyScopeFile(name string) error

type Unsafe

type Unsafe struct {
	NetworkHost bool
}