Skip to content

cloudbees-oss/inject-metadata-velero-plugin

Repository files navigation

A restore plugin for Velero which mutates all restored StatefulSets and Deployments, adding (or replacing) the environment variable RESTORED_FROM_BACKUP in each container. The value will be the identifier of the Velero restore object.

This is useful for informing a stateful application that it has been freshly restored from backup. It might then take special steps to recover from partly written files, etc. CloudBees CI honors this variable.

Usage:

initContainers:
# your existing plugins, then add:
- name: inject-metadata-velero-plugin
  image: ghcr.io/cloudbees-oss/inject-metadata-velero-plugin:main
  imagePullPolicy: Always
  volumeMounts:
  - mountPath: /target
    name: plugins

Binaries are signed with Sigstore.

Kubernetes feature #48180, if implemented, would offer an alternate approach.