v1

Documentation

Index

• type ItemBlockAction

Types

type ItemBlockAction

type ItemBlockAction interface {
	// Name returns the name of this IBA. Plugins which implement this interface must define Name,
	// but its content is unimportant, as it won't actually be called via RPC. Velero's plugin infrastructure
	// will implement this directly rather than delegating to the RPC plugin in order to return the name
	// that the plugin was registered under. The plugins must implement the method to complete the interface.
	Name() string

	// AppliesTo returns information about which resources this action should be invoked for.
	// A ItemBlockAction's GetRelatedItems function will only be invoked on items that match the returned
	// selector. A zero-valued ResourceSelector matches all resources.
	AppliesTo() (velero.ResourceSelector, error)

	// GetRelatedItems allows the ItemBlockAction to identify related items which must be backed up
	// along with the current item. In many cases, these will be the same items that a related
	// BackupItemAction's Execute method will return as additionalItems, but there may be differences.
	// For example, items that are newly-created in the BIA Execute and don't yet exist at backup
	// start will *not* be returned here.
	GetRelatedItems(item runtime.Unstructured, backup *api.Backup) ([]velero.ResourceIdentifier, error)
}

ItemBlockAction is an action that returns a list of related items that must be backed up along with the current item (and not in a separate parallel backup thread).