plugins

Documentation

Index

• type Factory
• type Interface
• type Options
  • func (o *Options) FleetClientOrDie() fleet.Interface
  • func (o *Options) KubeClientOrDie() kubernetes.Interface

Types

type Factory

type Factory interface {
	// New creates a new Plugin instance.
	New(Options) Interface
}

type Interface

type Interface interface {
	// Init the plugin and also run any preparation work needed.
	Init(context.Context, string, string, string) error
	// Diff checks whether there is any difference.
	Diff(context.Context) (bool, error)
	// Run is the step to make real changes or dryRun if is told to do so.
	Run(context.Context, bool) error
	// Test verifies the change.
	Test(context.Context, time.Time) error
}

type Options

type Options struct {
	Config     string
	Namespace  string
	Name       string
	Kubeconfig string
	Workspace  string
	Reconcile  bool
	DryRun     bool
	Timeout    time.Duration
	Parameters map[string]string
}

Options is the contextual parameters for plugins.

func (*Options) FleetClientOrDie

func (o *Options) FleetClientOrDie() fleet.Interface

FleetClientOrDie initializes a new fleet client.

func (*Options) KubeClientOrDie

func (o *Options) KubeClientOrDie() kubernetes.Interface

KubeClientOrDie initializes a new kubernetes client.