runbooks

Documentation

Index

• func AddOtherEmbeddedRunbooks(fs embed.FS)
• func AddRunbookFromYaml(yaml string) error
• func CreateMapForRunbookArgumentPointers(runbookAction *RunbookAction) map[string]*string
• func GetRunbookNames() []string
• func GetRunbooks() map[string]Runbook
• func InitializeBuiltInRunbooks()
• func LoadBuiltInRunbooks(fs embed.FS)
• func LoadRunbooksFromDirectory(dir string) uint32
• func RenderTemplates(templateName string, rawCmd string, stringVars map[string]*string, ...) ([]string, error)
• func Reset()
• func ValidateRunbook(runbook *Runbook) error
• type Runbook
• type RunbookAction
• type RunbookDescription
• type Variable

Functions

func AddOtherEmbeddedRunbooks

func AddOtherEmbeddedRunbooks(fs embed.FS)

func AddRunbookFromYaml

func AddRunbookFromYaml(yaml string) error

func CreateMapForRunbookArgumentPointers

func CreateMapForRunbookArgumentPointers(runbookAction *RunbookAction) map[string]*string

func GetRunbookNames

func GetRunbookNames() []string

func GetRunbooks

func GetRunbooks() map[string]Runbook

func InitializeBuiltInRunbooks

func InitializeBuiltInRunbooks()

func LoadBuiltInRunbooks

func LoadBuiltInRunbooks(fs embed.FS)

func LoadRunbooksFromDirectory

func LoadRunbooksFromDirectory(dir string) uint32

func RenderTemplates

func RenderTemplates(templateName string, rawCmd string, stringVars map[string]*string, variableDefinitions map[string]Variable) ([]string, error)

func Reset

func Reset()

func ValidateRunbook

func ValidateRunbook(runbook *Runbook) error

Types

type Runbook

type Runbook struct {

	// The name of the runbook
	Name string `yaml:"name"`

	Description *RunbookDescription `yaml:"description"`

	// The location of relevant documentation
	Docs string `yaml:"docs"`

	RunbookActions map[string]*RunbookAction `yaml:"actions"`
}

type RunbookAction

type RunbookAction struct {
	Name         string
	Description  *RunbookDescription
	RawCommands  []string `yaml:"commands"`
	IgnoreErrors bool     `yaml:"ignore_errors"`

	Variables map[string]Variable `yaml:"variables"`
}

type RunbookDescription

type RunbookDescription struct {
	Long  string `yaml:"long"`
	Short string `yaml:"short"`
}

type Variable

type Variable struct {
	Name        string
	Type        string `yaml:"type"`
	Default     string `yaml:"default"`
	Required    bool   `yaml:"required"`
	Description *RunbookDescription
}