hooks

Documentation

Index

• type BaseHook
• type Hook
• type HookArgsCommand
  • func (h *HookArgsCommand) Execute(ctx context.Context, ss *environment.ServiceSettings, tmpl template.Template, ...) (task.Task, error)
• type HookNative
  • func (h *HookNative) Execute(ctx context.Context, ss *environment.ServiceSettings, tmpl template.Template, ...) (task.Task, error)
• type HookShellCommand
  • func (h *HookShellCommand) Execute(ctx context.Context, ss *environment.ServiceSettings, tmpl template.Template, ...) (task.Task, error)
• type HookSignal
  • func (h *HookSignal) Execute(ctx context.Context, ss *environment.ServiceSettings, tmpl template.Template, ...) (task.Task, error)
• type HookType
• type Hooks
• type Maker
  • func CreateMaker(fnd app.Foundation) Maker

Types

type BaseHook

type BaseHook struct {
	Type    HookType
	Enabled bool
}

type Hook

type Hook interface {
	Execute(
		ctx context.Context,
		ss *environment.ServiceSettings,
		tmpl template.Template,
		env environment.Environment,
		st task.Task,
	) (task.Task, error)
}

type HookArgsCommand

type HookArgsCommand struct {
	BaseHook
	Executable string
	Args       []string
}

func (*HookArgsCommand) Execute

func (h *HookArgsCommand) Execute(
	ctx context.Context,
	ss *environment.ServiceSettings,
	tmpl template.Template,
	env environment.Environment,
	st task.Task,
) (task.Task, error)

type HookNative

type HookNative struct {
	BaseHook
}

func (*HookNative) Execute

func (h *HookNative) Execute(
	ctx context.Context,
	ss *environment.ServiceSettings,
	tmpl template.Template,
	env environment.Environment,
	st task.Task,
) (task.Task, error)

type HookShellCommand

type HookShellCommand struct {
	BaseHook
	Command string
	Shell   string
}

func (*HookShellCommand) Execute

func (h *HookShellCommand) Execute(
	ctx context.Context,
	ss *environment.ServiceSettings,
	tmpl template.Template,
	env environment.Environment,
	st task.Task,
) (task.Task, error)

type HookSignal

type HookSignal struct {
	BaseHook
	Signal os.Signal
}

func (*HookSignal) Execute

func (h *HookSignal) Execute(
	ctx context.Context,
	ss *environment.ServiceSettings,
	tmpl template.Template,
	env environment.Environment,
	st task.Task,
) (task.Task, error)

type HookType

type HookType string

const (
	StartHookType   HookType = "start"
	StopHookType    HookType = "stop"
	ReloadHookType  HookType = "reload"
	RestartHookType HookType = "restart"
)

type Hooks

type Hooks map[HookType]Hook

type Maker

type Maker interface {
	MakeHooks(config map[string]types.SandboxHook) (Hooks, error)
	MakeHook(config types.SandboxHook, hookType HookType) (Hook, error)
}

func CreateMaker

func CreateMaker(fnd app.Foundation) Maker