drain

Documentation

Index

• type ConcreteScript
  • func NewConcreteScript(fs boshsys.FileSystem, runner boshsys.CmdRunner, ...) ConcreteScript
  • func (s ConcreteScript) Cancel() error
  • func (s ConcreteScript) Exists() bool
  • func (s ConcreteScript) Params() ScriptParams
  • func (s ConcreteScript) Path() string
  • func (s ConcreteScript) Run() error
  • func (s ConcreteScript) Tag() string
• type ScriptParams
  • func NewShutdownParams(oldSpec boshas.V1ApplySpec, newSpec *boshas.V1ApplySpec) ScriptParams
  • func NewUpdateParams(oldSpec, newSpec boshas.V1ApplySpec) ScriptParams

Types

type ConcreteScript

type ConcreteScript struct {
	// contains filtered or unexported fields
}

func NewConcreteScript

func NewConcreteScript(
	fs boshsys.FileSystem,
	runner boshsys.CmdRunner,
	scriptCommandFactory boshsys.ScriptCommandFactory,
	tag string,
	path string,
	params ScriptParams,
	timeService clock.Clock,
	logger boshlog.Logger,
) ConcreteScript

func (ConcreteScript) Cancel

func (s ConcreteScript) Cancel() error

func (ConcreteScript) Exists

func (s ConcreteScript) Exists() bool

func (ConcreteScript) Params

func (s ConcreteScript) Params() ScriptParams

func (ConcreteScript) Path

func (s ConcreteScript) Path() string

func (ConcreteScript) Run

func (s ConcreteScript) Run() error

func (ConcreteScript) Tag

func (s ConcreteScript) Tag() string

type ScriptParams

type ScriptParams interface {
	JobChange() (change string)
	HashChange() (change string)
	UpdatedPackages() (pkgs []string)
	JobState() (string, error)
	JobNextState() (string, error)

	// ToStatusParams derives a new set of script params that can be used to do the
	// status check call on a dynamic drain script.
	ToStatusParams() ScriptParams
}

func NewShutdownParams

func NewShutdownParams(
	oldSpec boshas.V1ApplySpec,
	newSpec *boshas.V1ApplySpec,
) ScriptParams

func NewUpdateParams

func NewUpdateParams(oldSpec, newSpec boshas.V1ApplySpec) ScriptParams