plugin

Documentation

Index

• type Resolver
  • func NewResolver() Resolver
• type StepPlugin

Types

type Resolver

type Resolver interface {
	// Resolve is a factory to create the correct StepPlugin based on the current step and global configurations
	Resolve(index int32, plugin v1alpha1.PluginStep, log *log.Entry) (StepPlugin, error)
}

Resolver allows to resolve a StepPlugin object

func NewResolver

func NewResolver() Resolver

NewResolver creaates a new Resolver

type StepPlugin

type StepPlugin interface {
	// Run executes the run operation for of a step plugin and returns a Run operation status
	Run(*v1alpha1.Rollout) (*v1alpha1.StepPluginStatus, error)
	// Terminate cancels an ongoing running Run operation and returns a Terminate status if it did
	Terminate(*v1alpha1.Rollout) (*v1alpha1.StepPluginStatus, error)
	// Abort reverts a completed Run operation and returns a Terminate status if it did
	Abort(*v1alpha1.Rollout) (*v1alpha1.StepPluginStatus, error)
}

StepPlugin allows to execute different operation for a step plugin specifc to a rollout