compose

Documentation

Index

• func GetTaskConfig(name, action string, conf *config.ComposeConfig) (types.TaskConfig, error)
• func NewTask(run actionFunc, stop actionFunc) func(task.Name, config.Resource) types.Task
• func RunDown(_ *context.ExecuteContext, t *Task) error
• func RunUp(_ *context.ExecuteContext, t *Task) error
• func RunUpAttached(ctx *context.ExecuteContext, t *Task) error
• func StopNothing(_ *context.ExecuteContext, _ *Task) error
• func StopUp(_ *context.ExecuteContext, t *Task) error
• type Task
  • func (t *Task) Name() task.Name
  • func (t *Task) Repr() string
  • func (t *Task) Run(ctx *context.ExecuteContext, _ bool) (bool, error)
  • func (t *Task) Stop(ctx *context.ExecuteContext) error

Functions

func GetTaskConfig

func GetTaskConfig(name, action string, conf *config.ComposeConfig) (types.TaskConfig, error)

GetTaskConfig returns a new task for the action

func NewTask

func NewTask(run actionFunc, stop actionFunc) func(task.Name, config.Resource) types.Task

NewTask creates a new Task object

func RunDown

func RunDown(_ *context.ExecuteContext, t *Task) error

RunDown removes all the project resources

func RunUp

func RunUp(_ *context.ExecuteContext, t *Task) error

RunUp starts the Compose project

func RunUpAttached

func RunUpAttached(ctx *context.ExecuteContext, t *Task) error

RunUpAttached starts the Compose project

func StopNothing

func StopNothing(_ *context.ExecuteContext, _ *Task) error

StopNothing implements the Stop interface but does nothing

func StopUp

func StopUp(_ *context.ExecuteContext, t *Task) error

StopUp stops the project

Types

type Task

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

Task runs a Docker Compose project

func (*Task) Name

func (t *Task) Name() task.Name

Name returns the name of the task

func (*Task) Repr

func (t *Task) Repr() string

Repr formats the task for logging

func (*Task) Run

func (t *Task) Run(ctx *context.ExecuteContext, _ bool) (bool, error)

Run runs the action

func (*Task) Stop

func (t *Task) Stop(ctx *context.ExecuteContext) error

Stop the task