Plugin System

// pkg/plugin/velero/object_store.go
type ObjectStore interface {
    // Init is called once with the config map from BSL.spec.config
    Init(config map[string]string) error

    // PutObject writes the given body to bucket/key
    PutObject(bucket, key string, body io.Reader) error

    // ObjectExists returns true if bucket/key exists
    ObjectExists(bucket, key string) (bool, error)

    // GetObject returns the body of bucket/key
    GetObject(bucket, key string) (io.ReadCloser, error)

    // ListCommonPrefixes returns all "directories" under prefix/delimiter
    ListCommonPrefixes(bucket, prefix, delimiter string) ([]string, error)

    // ListObjects returns all keys with given prefix
    ListObjects(bucket, prefix string) ([]string, error)

    // DeleteObject deletes the object at bucket/key
    DeleteObject(bucket, key string) error

    // CreateSignedURL returns a pre-signed URL for the object
    CreateSignedURL(bucket, key string, ttl time.Duration) (string, error)
}

// pkg/plugin/velero/backup_item_action.go
type BackupItemAction interface {
    // AppliesTo returns what resource types this action handles
    AppliesTo() (ResourceSelector, error)

    // Execute is called for each matching item during backup.
    // Returns the (possibly mutated) item and any additional items to back up.
    Execute(item runtime.Unstructured, backup *api.Backup) (
        updatedItem runtime.Unstructured,
        additionalItems []ResourceIdentifier,
        error,
    )
}

type ResourceSelector struct {
    IncludedNamespaces []string
    ExcludedNamespaces []string
    IncludedResources  []string  // "pods", "persistentvolumeclaims"
    ExcludedResources  []string
    LabelSelector      string
}

// pkg/plugin/velero/restore_item_action.go
type RestoreItemAction interface {
    AppliesTo() (ResourceSelector, error)

    // Execute is called for each item during restore.
    // Returns the (possibly mutated) item, any additional items to restore,
    // and whether to skip this item entirely.
    Execute(input *RestoreItemActionExecuteInput) (*RestoreItemActionExecuteOutput, error)
}

type RestoreItemActionExecuteInput struct {
    Item           runtime.Unstructured   // item from the backup
    ItemFromBackup runtime.Unstructured   // same item, always unmodified
    Restore        *api.Restore
}

type RestoreItemActionExecuteOutput struct {
    UpdatedItem     runtime.Unstructured
    AdditionalItems []ResourceIdentifier
    SkipRestore     bool
}

// main.go
func main() {
    veleroplugin.NewServer().
        // Register all plugin types your binary implements
        RegisterObjectStore("my.company/my-store", newMyObjectStore).
        RegisterBackupItemAction("my.company/strip-secrets", newStripSecretsAction).
        RegisterRestoreItemAction("my.company/remap-storageclass", newRemapStorageClass).
        Serve()
}

func newMyObjectStore(logger logrus.FieldLogger) (interface{}, error) {
    return &MyObjectStore{logger: logger}, nil
}

// MyObjectStore implements the ObjectStore interface
type MyObjectStore struct {
    logger logrus.FieldLogger
    client *minio.Client
}

func (o *MyObjectStore) Init(config map[string]string) error {
    endpoint := config["endpoint"]
    // ... initialize minio client
    return nil
}