steps

Documentation

Index

• type ContextContainer
• type IncludesStep
• type InputStep
  • func (inputStep InputStep) PluginName() string
  • func (inputStep InputStep) ServiceName() string
• type InventoryStep
  • func (inventoryStep InventoryStep) PluginName() (string, error)
  • func (inventoryStep InventoryStep) ServiceName() (string, error)
• type PlaybookSteps
• type RoleContainer
• type RoleContainers
  • func (roleContainers RoleContainers) FindByName(name string) (RoleContainer, error)
• type ServerStep
• type Step
• type StepList
• type TaskStep
  • func (task TaskStep) PluginName() string
  • func (task TaskStep) TaskName() string
• type VariableStep

Types

type ContextContainer

type ContextContainer struct {
	Name    string
	Steps   StepList
	User    *hcl.Attribute
	ApplyTo *hcl.Attribute
}

ContextContainer connects to a resource and applies all steps to that resource

User - the user that will be used to run the tasks ApplyTo - the servers resources to apply the tasks to

type IncludesStep

type IncludesStep struct {
	Roles *hcl.Attribute
}

IncludesStep brings in other roles and files to make up a full role/context

type InputStep

type InputStep struct {
	Type string
	Name string
	Body hcl.Body
}

InputStep load variables from an external source

func (InputStep) PluginName

func (inputStep InputStep) PluginName() string

PluginName returns the plugin name for the InputStep

func (InputStep) ServiceName

func (inputStep InputStep) ServiceName() string

ServiceName returns the service name for the inventory

type InventoryStep

type InventoryStep struct {
	Type string
	Body hcl.Body
}

InventoryStep fetch server details from an external source

func (InventoryStep) PluginName

func (inventoryStep InventoryStep) PluginName() (string, error)

PluginName returns the plugin name for the inventory

func (InventoryStep) ServiceName

func (inventoryStep InventoryStep) ServiceName() (string, error)

ServiceName returns the service name for the inventory

type PlaybookSteps

type PlaybookSteps struct {
	StepList StepList
	RoleList RoleContainers
}

PlaybookSteps container for steps and roles

type RoleContainer

type RoleContainer struct {
	Name  string
	File  string
	User  *hcl.Attribute
	Steps StepList
}

RoleContainer container for role steps. This inherites the context from the outer context. Any changes are lost once role has been completed

Name - name of role File - file path that the role was loaded from User - user used to run all tasks with role Steps - list of steps to be ran against selected servers

type RoleContainers

type RoleContainers []RoleContainer

RoleContainers collection of role containers

func (RoleContainers) FindByName

func (roleContainers RoleContainers) FindByName(name string) (RoleContainer, error)

FindByName find a role in container by name.

type ServerStep

type ServerStep struct {
	Name      string
	Addresses *hcl.Attribute
}

ServerStep name and address of a server resource

type Step

type Step interface{}

Step base for all step types

type StepList

type StepList []Step

StepList lists steps

type TaskStep

type TaskStep struct {
	Type      string
	Label     string
	User      *hcl.Attribute
	Condition *hcl.Attribute
	Debug     *hcl.Attribute
	WithItems *hcl.Attribute
	Body      hcl.Body
}

TaskStep apply an operation to an external resource over ssh

func (TaskStep) PluginName

func (task TaskStep) PluginName() string

PluginName name of plugin

func (TaskStep) TaskName

func (task TaskStep) TaskName() string

TaskName name of task

type VariableStep

type VariableStep struct {
	Name  string
	Type  *hcl.Attribute
	Value *hcl.Attribute
}

VariableStep config value with name

Available types are string, map, array