clientmgmt

Documentation

Overview

Package clientmgmt contains the plugin client for Velero.

Index

• type Manager
  • func NewManager(logger logrus.FieldLogger, level logrus.Level, registry Registry) Manager
• type Process
• type ProcessFactory
• type Registry
  • func NewRegistry(dir string, logger logrus.FieldLogger, logLevel logrus.Level) Registry
• type RestartableProcess
• type RestartableProcessFactory

Types

type Manager

type Manager interface {
	// GetObjectStore returns the ObjectStore plugin for name.
	GetObjectStore(name string) (velero.ObjectStore, error)

	// GetVolumeSnapshotter returns the VolumeSnapshotter plugin for name.
	GetVolumeSnapshotter(name string) (velero.VolumeSnapshotter, error)

	// GetBackupItemActions returns all backup item action plugins.
	GetBackupItemActions() ([]velero.BackupItemAction, error)

	// GetBackupItemAction returns the backup item action plugin for name.
	GetBackupItemAction(name string) (velero.BackupItemAction, error)

	// GetRestoreItemActions returns all restore item action plugins.
	GetRestoreItemActions() ([]velero.RestoreItemAction, error)

	// GetRestoreItemAction returns the restore item action plugin for name.
	GetRestoreItemAction(name string) (velero.RestoreItemAction, error)

	// GetDeleteItemActions returns all delete item action plugins.
	GetDeleteItemActions() ([]velero.DeleteItemAction, error)

	// GetDeleteItemAction returns the delete item action plugin for name.
	GetDeleteItemAction(name string) (velero.DeleteItemAction, error)

	// GetItemSnapshotter returns the item snapshotter plugin for name
	GetItemSnapshotter(name string) (v1.ItemSnapshotter, error)

	// GetItemSnapshotters returns all item snapshotter plugins
	GetItemSnapshotters() ([]v1.ItemSnapshotter, error)

	// CleanupClients terminates all of the Manager's running plugin processes.
	CleanupClients()
}

Manager manages the lifecycles of plugins.

func NewManager

func NewManager(logger logrus.FieldLogger, level logrus.Level, registry Registry) Manager

NewManager constructs a manager for getting plugins.

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 framework.PluginKind) []framework.PluginIdentifier
	// Get returns the PluginIdentifier for kind and name.
	Get(kind framework.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 RestartableProcess

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

type RestartableProcessFactory

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