recipe

Documentation

Index

• type BladeArgumentDetails
  • func (a *BladeArgumentDetails) AttachFlag(cobraCommand *cobra.Command)
  • func (a *BladeArgumentDetails) FlagValue() string
  • func (a *BladeArgumentDetails) Name() string
• type BladeRecipeArguments
• type BladeRecipeHelp
• type BladeRecipeOverrides
• type BladeRecipeResilience
• type BladeRecipeYaml
  • func LoadRecipeYaml(path string) (*BladeRecipeYaml, error)

Types

type BladeArgumentDetails

type BladeArgumentDetails struct {
	Value string
	Help  string
	// contains filtered or unexported fields
}

func (*BladeArgumentDetails) AttachFlag

func (a *BladeArgumentDetails) AttachFlag(cobraCommand *cobra.Command)

AttachFlag allows you to pass in a Cobra command if you'd like to attach an override flag in relation to this argument.

func (*BladeArgumentDetails) FlagValue

func (a *BladeArgumentDetails) FlagValue() string

FlagValue returns the applied flag which either came from a command-line override or from the Recipe itself.

func (*BladeArgumentDetails) Name

func (a *BladeArgumentDetails) Name() string

Name returns the argument name or what string is in the {{}} construct.

type BladeRecipeArguments

type BladeRecipeArguments map[string]*BladeArgumentDetails

type BladeRecipeHelp

type BladeRecipeHelp struct {
	Short string
	Long  string
	Usage string
}

type BladeRecipeOverrides

type BladeRecipeOverrides struct {
	Concurrency int
	Port        int
	User        string
}

type BladeRecipeResilience

type BladeRecipeResilience struct {
	WaitDuration           string
	Retries                int
	RetryBackoffStrategy   string
	RetryBackoffMultiplier string // <-- this is a duration like 5s
	FailBatch              bool
}

type BladeRecipeYaml

type BladeRecipeYaml struct {
	Args BladeRecipeArguments

	Name     string
	Filename string

	Hosts      []string
	HostLookup string
	Exec       []string

	Help       *BladeRecipeHelp
	Overrides  *BladeRecipeOverrides
	Resilience *BladeRecipeResilience
}

func LoadRecipeYaml

func LoadRecipeYaml(path string) (*BladeRecipeYaml, error)