commands

Documentation

Index

• func Build(e Executor) *cobra.Command
• type Executor
• type RootExecutor
• type ServiceExecutor
• type WorkflowExecutor

Functions

func Build

func Build(e Executor) *cobra.Command

Build constructs root command and returns it.

Types

type Executor

type Executor interface {
	RootExecutor
	ServiceExecutor
	WorkflowExecutor
}

Executor is an interface that keeps all commands interfaces.

type RootExecutor

type RootExecutor interface {
	Start() error
	Stop() error
	Status() (container.StatusType, error)
	Logs() (io.ReadCloser, error)
}

RootExecutor is an interface that handles core commands.

type ServiceExecutor

type ServiceExecutor interface {
	ServiceByID(id string) (*coreapi.Service, error)
	ServiceDeleteAll(deleteData bool) error
	ServiceDelete(deleteData bool, ids ...string) error
	ServiceDeploy(path string, statuses chan provider.DeployStatus) (id string, validationError, err error)
	ServiceListenEvents(id, eventFilter string) (chan *coreapi.EventData, chan error, error)
	ServiceListenResults(id, taskFilter, outputFilter string, tagFilters []string) (chan *coreapi.ResultData, chan error, error)
	ServiceLogs(id string, dependencies ...string) (logs []*provider.Log, closer func(), err error)
	ServiceExecuteTask(id, taskKey, inputData string, tags []string) error
	ServiceStart(id string) error
	ServiceStop(id string) error
	ServiceValidate(path string) (string, error)
	ServiceGenerateDocs(path string) error
	ServiceList() ([]*coreapi.Service, error)
	ServiceInitTemplateList() ([]*servicetemplate.Template, error)
	ServiceInitDownloadTemplate(t *servicetemplate.Template, dst string) error
}

ServiceExecutor is an interface that handles services commands.

type WorkflowExecutor

type WorkflowExecutor interface {
	CreateWorkflow(filePath string, name string) (id string, err error)
	DeleteWorkflow(id string) error
}

WorkflowExecutor is an interface that handles workflow commands.