flow

Documentation

Index

• type FlowDefine
• type FlowPluginTypeDef
• type FlowTaskDef
• type FlowTaskIf
  • func (fti *FlowTaskIf) IfEvaluate(repo *forjfile.RepoStruct, Forjfile *forjfile.DeployForgeYaml) (_ bool, _ error)
• type FlowTaskList
  • func (ftl *FlowTaskList) Get(repo *forjfile.RepoStruct, _ *forjfile.DeployForgeYaml) (list []interface{})
• type FlowTaskLists
• type FlowTaskModel
  • func New_FlowTaskModel(current *forjfile.RepoStruct, forjf *forjfile.DeployForgeYaml) (ret *FlowTaskModel)
• type FlowTaskSet
• type Flows
  • func (fs *Flows) AddRepoPath(pathStr *url.URL) (bool, error)
  • func (fs *Flows) Apply(flowName string, repo *forjfile.RepoStruct, Forjfile *forjfile.DeployForgeYaml) error
  • func (fs *Flows) Load(flows ...string) error
  • func (fs *Flows) SetRepoPath(paths ...*url.URL)

Types

type FlowDefine

type FlowDefine struct {
	Name   string
	Title  string // Flow title
	Define map[string]FlowPluginTypeDef
	OnRepo map[string]FlowTaskDef `yaml:"on-repo-do"`
	OnForj map[string]FlowTaskDef `yaml:"on-forjfile-do"`
}

type FlowPluginTypeDef

type FlowPluginTypeDef struct {
	MaxInstances int `yaml:"max_instances"`
	Roles        []string
}

type FlowTaskDef

type FlowTaskDef struct {
	Description string

	If []FlowTaskIf

	List FlowTaskLists `yaml:"loop-on-list"`

	Set FlowTaskSet // key1: object, key2: instance, key3: value key, then value
}

type FlowTaskIf

type FlowTaskIf struct {
	Rule string
	List map[string]string `yaml:",inline"`
}

func (*FlowTaskIf) IfEvaluate

func (fti *FlowTaskIf) IfEvaluate(repo *forjfile.RepoStruct, Forjfile *forjfile.DeployForgeYaml) (_ bool, _ error)

IfEvaluate will interpret

type FlowTaskList

type FlowTaskList struct {
	Name       string
	List       string
	Parameters []string
	// contains filtered or unexported fields
}

func (*FlowTaskList) Get

func (ftl *FlowTaskList) Get(repo *forjfile.RepoStruct, _ *forjfile.DeployForgeYaml) (list []interface{})

type FlowTaskLists

type FlowTaskLists []*FlowTaskList

type FlowTaskModel

type FlowTaskModel struct {
	Repo     forjfile.RepoModel
	Forjfile forjfile.ForgeModel
	List     map[string]interface{}
}

func New_FlowTaskModel

func New_FlowTaskModel(current *forjfile.RepoStruct, forjf *forjfile.DeployForgeYaml) (ret *FlowTaskModel)

type FlowTaskSet

type FlowTaskSet map[string]map[string]forjfile.ForjValues

type Flows

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

func (*Flows) AddRepoPath

func (fs *Flows) AddRepoPath(pathStr *url.URL) (bool, error)

AddRepoPath add a repo in the list of repository at the end of the list...

func (*Flows) Apply

func (fs *Flows) Apply(flowName string, repo *forjfile.RepoStruct, Forjfile *forjfile.DeployForgeYaml) error

Apply the flow to the Forjfile loaded.

func (*Flows) Load

func (fs *Flows) Load(flows ...string) error

Load flow the first flow file found.

func (*Flows) SetRepoPath

func (fs *Flows) SetRepoPath(paths ...*url.URL)

SetRepoPath set the collection of repositories in the flows object.