runner

Documentation

Index

• func NewFromWatches(path string) (map[schema.GroupVersionKind]Runner, error)
• type Finalizer
• type RunResult
• type Runner
  • func NewForPlaybook(path string, gvk schema.GroupVersionKind, finalizer *Finalizer, ...) (Runner, error)
  • func NewForRole(path string, gvk schema.GroupVersionKind, finalizer *Finalizer, ...) (Runner, error)

Functions

func NewFromWatches

func NewFromWatches(path string) (map[schema.GroupVersionKind]Runner, error)

NewFromWatches reads the operator's config file at the provided path.

Types

type Finalizer

type Finalizer struct {
	Name     string                 `yaml:"name"`
	Playbook string                 `yaml:"playbook"`
	Role     string                 `yaml:"role"`
	Vars     map[string]interface{} `yaml:"vars"`
}

Finalizer - Expose finalizer to be used by a user.

type RunResult

type RunResult interface {
	// Stdout returns the stdout from ansible-runner if it is available, else an error.
	Stdout() (string, error)
	// Events returns the events from ansible-runner if it is available, else an error.
	Events() <-chan eventapi.JobEvent
}

RunResult - result of a ansible run

type Runner

type Runner interface {
	Run(string, *unstructured.Unstructured, string) (RunResult, error)
	GetFinalizer() (string, bool)
	GetReconcilePeriod() (time.Duration, bool)
	GetManageStatus() bool
}

Runner - a runnable that should take the parameters and name and namespace and run the correct code.

func NewForPlaybook

func NewForPlaybook(path string, gvk schema.GroupVersionKind, finalizer *Finalizer, reconcilePeriod *time.Duration, manageStatus bool) (Runner, error)

NewForPlaybook returns a new Runner based on the path to an ansible playbook.

func NewForRole

func NewForRole(path string, gvk schema.GroupVersionKind, finalizer *Finalizer, reconcilePeriod *time.Duration, manageStatus bool) (Runner, error)

NewForRole returns a new Runner based on the path to an ansible role.