runner

Documentation

Index

• Constants
• type RunResult
• type Runner
  • func New(watch watches.Watch) (Runner, error)

Constants

const (
	// MaxRunnerArtifactsAnnotation - annotation used by a user to specify the max artifacts to keep
	// in the runner directory. This will override the value provided by the watches file for a
	// particular CR. Setting this to zero will cause all artifact directories to be kept.
	// Example usage "ansible.sdk.operatorframework.io/max-runner-artifacts: 100"
	MaxRunnerArtifactsAnnotation = "ansible.sdk.operatorframework.io/max-runner-artifacts"

	// AnsibleVerbosityAnnotation - annotation used by a user to specify the verbosity given
	// to the ansible-runner command. This will override the value for a particular CR.
	// Example usage "ansible.sdk.operatorframework.io/verbosity: 5"
	AnsibleVerbosityAnnotation = "ansible.sdk.operatorframework.io/verbosity"
)

Types

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)
}

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

func New

func New(watch watches.Watch) (Runner, error)

New - creates a Runner from a Watch struct