process

Documentation

Overview

Package clientmgmt contains the plugin client for Velero.

Index

• type KindAndName
• type PluginNotFoundError
  • func (e *PluginNotFoundError) Error() string
• type Process
• type ProcessFactory
• type Registry
  • func NewRegistry(dir string, logger logrus.FieldLogger, logLevel logrus.Level) Registry
• type Reinitializer
• type RestartableProcess
• type RestartableProcessFactory
  • func NewRestartableProcessFactory() RestartableProcessFactory

Types

type KindAndName

type KindAndName struct {
	Kind common.PluginKind
	Name string
}

KindAndName is a convenience struct that combines a PluginKind and a name.

type PluginNotFoundError

type PluginNotFoundError struct {
	// contains filtered or unexported fields
}

pluginNotFoundError indicates a plugin could not be located for kind and name.

func (*PluginNotFoundError) Error

func (e *PluginNotFoundError) Error() string

type Process

type Process interface {
	// contains filtered or unexported methods
}

type ProcessFactory

type ProcessFactory interface {
	// contains filtered or unexported methods
}

type Registry

type Registry interface {
	// DiscoverPlugins discovers all available plugins.
	DiscoverPlugins() error
	// List returns all PluginIdentifiers for kind.
	List(kind common.PluginKind) []framework.PluginIdentifier
	// Get returns the PluginIdentifier for kind and name.
	Get(kind common.PluginKind, name string) (framework.PluginIdentifier, error)
}

Registry manages information about available plugins.

func NewRegistry

func NewRegistry(dir string, logger logrus.FieldLogger, logLevel logrus.Level) Registry

NewRegistry returns a new registry.

type Reinitializer

type Reinitializer interface {
	// reinitialize reinitializes a restartable plugin instance using the newly dispensed plugin.
	Reinitialize(dispensed interface{}) error
}

reinitializer is capable of reinitializing a restartable plugin instance using the newly dispensed plugin.

type RestartableProcess

type RestartableProcess interface {
	AddReinitializer(key KindAndName, r Reinitializer)
	Reset() error
	ResetIfNeeded() error
	GetByKindAndName(key KindAndName) (interface{}, error)
	Stop()
}

type RestartableProcessFactory

type RestartableProcessFactory interface {
	NewRestartableProcess(command string, logger logrus.FieldLogger, logLevel logrus.Level) (RestartableProcess, error)
}

func NewRestartableProcessFactory

func NewRestartableProcessFactory() RestartableProcessFactory