Documentation
¶
Index ¶
- Constants
- func EncodeScriptTask(task *Task) (props map[string]any, headers map[string]any)
- func EncodeServiceTask(service *Service) (props map[string]any, headers map[string]any)
- type Builder
- func (b *Builder) Build() *Process
- func (b *Builder) Named(id, name, desc string) *Builder
- func (b *Builder) SetHandlers(handlers ...*Handler) *Builder
- func (b *Builder) SetHosts(hosts ...string) *Builder
- func (b *Builder) SetTasks(tasks ...ITask) *Builder
- func (b *Builder) SetVar(name string, value any) *Builder
- type ChildProcess
- type ChildProcessBuilder
- func (b *ChildProcessBuilder) Build() *ChildProcess
- func (b *ChildProcessBuilder) Named(id, name, desc string) *ChildProcessBuilder
- func (b *ChildProcessBuilder) SetHandlers(handlers ...*Handler) *ChildProcessBuilder
- func (b *ChildProcessBuilder) SetHosts(hosts ...string) *ChildProcessBuilder
- func (b *ChildProcessBuilder) SetTasks(tasks ...ITask) *ChildProcessBuilder
- func (b *ChildProcessBuilder) SetVar(name string, value any) *ChildProcessBuilder
- type Handler
- type HandlerBuilder
- type ICatchTask
- type INamedTask
- type ITask
- type Process
- func (p *Process) Build() (*schema.Definitions, map[string]string, map[string]string, error)
- func (p *Process) SubBuild() (*schema.Definitions, map[string]string, map[string]string, error)
- func (p *Process) ToBuilder() *Builder
- func (p *Process) UnmarshalYAML(unmarshal func(interface{}) error) (err error)
- type Service
- type ServiceBuilder
- func (b *ServiceBuilder) Build() *Service
- func (b *ServiceBuilder) Named(id, name, desc string) *ServiceBuilder
- func (b *ServiceBuilder) SetAction(action string, args map[string]any) *ServiceBuilder
- func (b *ServiceBuilder) SetCatch(catch *Handler) *ServiceBuilder
- func (b *ServiceBuilder) SetFinish(finish *Handler) *ServiceBuilder
- func (b *ServiceBuilder) SetHosts(hosts ...string) *ServiceBuilder
- func (b *ServiceBuilder) SetNotify(notify ...string) *ServiceBuilder
- func (b *ServiceBuilder) SetVar(name string, value any) *ServiceBuilder
- type Task
- type TaskBuilder
- func (b *TaskBuilder) Build() *Task
- func (b *TaskBuilder) Named(id, name, desc string) *TaskBuilder
- func (b *TaskBuilder) SetAction(action string, args map[string]any) *TaskBuilder
- func (b *TaskBuilder) SetCatch(catch *Handler) *TaskBuilder
- func (b *TaskBuilder) SetFinish(finish *Handler) *TaskBuilder
- func (b *TaskBuilder) SetHosts(hosts ...string) *TaskBuilder
- func (b *TaskBuilder) SetNotify(notify ...string) *TaskBuilder
- func (b *TaskBuilder) SetVar(name string, value any) *TaskBuilder
- type YamlKV
Constants ¶
View Source
const ( ChildProcessKey = "process" ServiceKey = "service" TaskKey = "task" )
Variables ¶
This section is empty.
Functions ¶
func EncodeScriptTask ¶ added in v0.3.2
Types ¶
type Builder ¶ added in v0.3.7
type Builder struct {
// contains filtered or unexported fields
}
func NewProcessBuilder ¶ added in v0.3.7
func NewProcessBuilder() *Builder
func (*Builder) SetHandlers ¶ added in v0.3.7
type ChildProcess ¶
type ChildProcess struct { Name string `json:"name,omitempty" yaml:"name,omitempty"` Id string `json:"id,omitempty" yaml:"id,omitempty"` Desc string `json:"desc,omitempty" yaml:"desc,omitempty"` Kind string `json:"kind,omitempty" yaml:"kind,omitempty"` Hosts []string `json:"hosts,omitempty" yaml:"hosts,omitempty"` Vars map[string]any `json:"vars,omitempty" yaml:"vars,omitempty"` RemoteUser string `json:"remote_user,omitempty" yaml:"remote_user,omitempty"` Sudo bool `json:"sudo,omitempty" yaml:"sudo,omitempty"` SudoUser string `json:"sudo_user,omitempty" yaml:"sudo_user,omitempty"` Tasks []ITask `json:"tasks,omitempty" yaml:"tasks,omitempty"` Handlers []*Handler `json:"handlers,omitempty" yaml:"handlers,omitempty"` }
type ChildProcessBuilder ¶ added in v0.3.7
type ChildProcessBuilder struct {
// contains filtered or unexported fields
}
func NewChildProcessBuilder ¶ added in v0.3.7
func NewChildProcessBuilder() *ChildProcessBuilder
func (*ChildProcessBuilder) Build ¶ added in v0.3.7
func (b *ChildProcessBuilder) Build() *ChildProcess
func (*ChildProcessBuilder) Named ¶ added in v0.3.7
func (b *ChildProcessBuilder) Named(id, name, desc string) *ChildProcessBuilder
func (*ChildProcessBuilder) SetHandlers ¶ added in v0.3.7
func (b *ChildProcessBuilder) SetHandlers(handlers ...*Handler) *ChildProcessBuilder
func (*ChildProcessBuilder) SetHosts ¶ added in v0.3.7
func (b *ChildProcessBuilder) SetHosts(hosts ...string) *ChildProcessBuilder
func (*ChildProcessBuilder) SetTasks ¶ added in v0.3.7
func (b *ChildProcessBuilder) SetTasks(tasks ...ITask) *ChildProcessBuilder
func (*ChildProcessBuilder) SetVar ¶ added in v0.3.7
func (b *ChildProcessBuilder) SetVar(name string, value any) *ChildProcessBuilder
type Handler ¶
type Handler struct { Name string `json:"name,omitempty" yaml:"name,omitempty"` Id string `json:"id,omitempty" yaml:"id,omitempty"` Desc string `json:"desc,omitempty" yaml:"desc,omitempty"` Kind string `json:"kind,omitempty" yaml:"kind,omitempty"` Action string `json:"action,omitempty" yaml:"action,omitempty"` Args map[string]any `json:"args,omitempty" yaml:"args,omitempty"` }
type HandlerBuilder ¶ added in v0.3.7
type HandlerBuilder struct {
// contains filtered or unexported fields
}
func NewHandlerBuilder ¶ added in v0.3.7
func NewHandlerBuilder() *HandlerBuilder
func (*HandlerBuilder) Build ¶ added in v0.3.7
func (b *HandlerBuilder) Build() *Handler
func (*HandlerBuilder) Named ¶ added in v0.3.7
func (b *HandlerBuilder) Named(id, name, desc string) *HandlerBuilder
func (*HandlerBuilder) SetAction ¶ added in v0.3.7
func (b *HandlerBuilder) SetAction(action string, args map[string]any) *HandlerBuilder
func (*HandlerBuilder) SetKind ¶ added in v0.3.7
func (b *HandlerBuilder) SetKind(kind string) *HandlerBuilder
type ICatchTask ¶ added in v0.3.0
type INamedTask ¶ added in v0.3.0
type Process ¶
type Process struct { Name string `json:"name,omitempty" yaml:"name,omitempty"` Id string `json:"id,omitempty" yaml:"id,omitempty"` Desc string `json:"desc,omitempty" yaml:"desc,omitempty"` Hosts []string `json:"hosts,omitempty" yaml:"hosts,omitempty"` Vars map[string]any `json:"vars,omitempty" yaml:"vars,omitempty"` RemoteUser string `json:"remote_user,omitempty" yaml:"remote_user,omitempty"` Sudo bool `json:"sudo,omitempty" yaml:"sudo,omitempty"` SudoUser string `json:"sudo_user,omitempty" yaml:"sudo_user,omitempty"` Tasks []ITask `json:"tasks,omitempty" yaml:"tasks,omitempty"` Handlers []*Handler `json:"handlers,omitempty" yaml:"handlers,omitempty"` }
func (*Process) UnmarshalYAML ¶
type Service ¶ added in v0.2.2
type Service struct { Name string `json:"name,omitempty" yaml:"name,omitempty"` Id string `json:"id,omitempty" yaml:"id,omitempty"` Desc string `json:"desc,omitempty" yaml:"desc,omitempty"` Kind string `json:"kind,omitempty" yaml:"kind,omitempty"` Vars map[string]any `json:"vars,omitempty" yaml:"vars,omitempty"` Hosts []string `json:"hosts,omitempty" yaml:"hosts,omitempty"` Action string `json:"action,omitempty" yaml:"action,omitempty"` Args map[string]any `json:"args,omitempty" yaml:"args,omitempty"` Catch *Handler `json:"catch,omitempty" yaml:"catch,omitempty"` Finish *Handler `json:"finish,omitempty" yaml:"finish,omitempty"` Notify []string `json:"notify,omitempty" yaml:"notify,omitempty"` }
func DecodeServiceTask ¶ added in v0.3.2
type ServiceBuilder ¶ added in v0.3.7
type ServiceBuilder struct {
// contains filtered or unexported fields
}
func NewServiceBuilder ¶ added in v0.3.7
func NewServiceBuilder() *ServiceBuilder
func (*ServiceBuilder) Build ¶ added in v0.3.7
func (b *ServiceBuilder) Build() *Service
func (*ServiceBuilder) Named ¶ added in v0.3.7
func (b *ServiceBuilder) Named(id, name, desc string) *ServiceBuilder
func (*ServiceBuilder) SetAction ¶ added in v0.3.7
func (b *ServiceBuilder) SetAction(action string, args map[string]any) *ServiceBuilder
func (*ServiceBuilder) SetCatch ¶ added in v0.3.7
func (b *ServiceBuilder) SetCatch(catch *Handler) *ServiceBuilder
func (*ServiceBuilder) SetFinish ¶ added in v0.3.7
func (b *ServiceBuilder) SetFinish(finish *Handler) *ServiceBuilder
func (*ServiceBuilder) SetHosts ¶ added in v0.3.7
func (b *ServiceBuilder) SetHosts(hosts ...string) *ServiceBuilder
func (*ServiceBuilder) SetNotify ¶ added in v0.3.7
func (b *ServiceBuilder) SetNotify(notify ...string) *ServiceBuilder
func (*ServiceBuilder) SetVar ¶ added in v0.3.7
func (b *ServiceBuilder) SetVar(name string, value any) *ServiceBuilder
type Task ¶
type Task struct { Name string `json:"name,omitempty" yaml:"name,omitempty"` Id string `json:"id,omitempty" yaml:"id,omitempty"` Desc string `json:"desc,omitempty" yaml:"desc,omitempty"` Vars map[string]any `json:"vars,omitempty" yaml:"vars,omitempty"` Action string `json:"action,omitempty" yaml:"action,omitempty"` Args map[string]any `json:"args,omitempty" yaml:"args,omitempty"` RemoteUser string `json:"remote_user,omitempty" yaml:"remote_user,omitempty"` Sudo bool `json:"sudo,omitempty" yaml:"sudo,omitempty"` SudoUser string `json:"sudo_user,omitempty" yaml:"sudo_user,omitempty"` Hosts []string `json:"hosts,omitempty" yaml:"hosts,omitempty"` Catch *Handler `json:"catch,omitempty" yaml:"catch,omitempty"` Finish *Handler `json:"finish,omitempty" yaml:"finish,omitempty"` Notify []string `json:"notify,omitempty" yaml:"notify,omitempty"` }
func DecodeScriptTask ¶ added in v0.3.2
type TaskBuilder ¶ added in v0.3.7
type TaskBuilder struct {
// contains filtered or unexported fields
}
func NewTaskBuilder ¶ added in v0.3.7
func NewTaskBuilder() *TaskBuilder
func (*TaskBuilder) Build ¶ added in v0.3.7
func (b *TaskBuilder) Build() *Task
func (*TaskBuilder) Named ¶ added in v0.3.7
func (b *TaskBuilder) Named(id, name, desc string) *TaskBuilder
func (*TaskBuilder) SetAction ¶ added in v0.3.7
func (b *TaskBuilder) SetAction(action string, args map[string]any) *TaskBuilder
func (*TaskBuilder) SetCatch ¶ added in v0.3.7
func (b *TaskBuilder) SetCatch(catch *Handler) *TaskBuilder
func (*TaskBuilder) SetFinish ¶ added in v0.3.7
func (b *TaskBuilder) SetFinish(finish *Handler) *TaskBuilder
func (*TaskBuilder) SetHosts ¶ added in v0.3.7
func (b *TaskBuilder) SetHosts(hosts ...string) *TaskBuilder
func (*TaskBuilder) SetNotify ¶ added in v0.3.7
func (b *TaskBuilder) SetNotify(notify ...string) *TaskBuilder
func (*TaskBuilder) SetVar ¶ added in v0.3.7
func (b *TaskBuilder) SetVar(name string, value any) *TaskBuilder
Click to show internal directories.
Click to hide internal directories.