drain

Documentation

Index

• type ConcreteScript
  • func NewConcreteScript(fs boshsys.FileSystem, runner boshsys.CmdRunner, drainScriptPath string) (script ConcreteScript)
  • func (script ConcreteScript) Exists() bool
  • func (script ConcreteScript) Path() string
  • func (script ConcreteScript) Run(params ScriptParams) (int, error)
• type ConcreteScriptProvider
  • func NewConcreteScriptProvider(cmdRunner boshsys.CmdRunner, fs boshsys.FileSystem, ...) (provider ConcreteScriptProvider)
  • func (p ConcreteScriptProvider) NewScript(templateName string) Script
• type Script
• type ScriptParams
  • func NewShutdownParams(oldSpec boshas.V1ApplySpec, newSpec *boshas.V1ApplySpec) ScriptParams
  • func NewStatusParams(oldSpec boshas.V1ApplySpec, newSpec *boshas.V1ApplySpec) ScriptParams
  • func NewUpdateParams(oldSpec, newSpec boshas.V1ApplySpec) ScriptParams
• type ScriptProvider

Types

type ConcreteScript

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

func NewConcreteScript

func NewConcreteScript(
	fs boshsys.FileSystem,
	runner boshsys.CmdRunner,
	drainScriptPath string,
) (script ConcreteScript)

func (ConcreteScript) Exists

func (script ConcreteScript) Exists() bool

func (ConcreteScript) Path

func (script ConcreteScript) Path() string

func (ConcreteScript) Run

func (script ConcreteScript) Run(params ScriptParams) (int, error)

type ConcreteScriptProvider

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

func NewConcreteScriptProvider

func NewConcreteScriptProvider(
	cmdRunner boshsys.CmdRunner,
	fs boshsys.FileSystem,
	dirProvider boshdirs.Provider,
) (provider ConcreteScriptProvider)

func (ConcreteScriptProvider) NewScript

func (p ConcreteScriptProvider) NewScript(templateName string) Script

type Script

type Script interface {
	Exists() bool
	Run(params ScriptParams) (value int, err error)
	Path() string
}

type ScriptParams

type ScriptParams interface {
	JobChange() (change string)
	HashChange() (change string)
	UpdatedPackages() (pkgs []string)

	JobState() (string, error)
	JobNextState() (string, error)
}

func NewShutdownParams

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

func NewStatusParams

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

func NewUpdateParams

func NewUpdateParams(oldSpec, newSpec boshas.V1ApplySpec) ScriptParams

type ScriptProvider

type ScriptProvider interface {
	NewScript(templateName string) (drainScript Script)
}