Skip to content

Latest commit

 

History

History
59 lines (53 loc) · 2.18 KB

custom_plugin_images.md

File metadata and controls

59 lines (53 loc) · 2.18 KB
Raw

Usage of Custom Plugin Images for Velero

The OADP Operator supports custom plugin images under the unsupportedOverrides field as detailed in the YAML below. This feature can be used to support rapid development and testing of custom images for supported plugins and provides a way for developers to quickly deploy and test their changes.

Details for supported plugins and their usage is given below, and please use the respective keys for the plugins. All keys must be entered in the Velero CR under a new field called as unsupportedOverrides, and with the key below for reference and corresponding image tag as their value.

  • Velero Imagekey -> veleroImageFqin
  • AWS Plugin ImageKey -> awsPluginImageFqin
  • OpenShift Plugin ImageKey -> openshiftPluginImageFqin
  • Azure Plugin ImageKey -> azurePluginImageFqin
  • GCP Plugin ImageKey -> gcpPluginImageFqin
  • CSI Plugin ImageKey -> csiPluginImageFqin
  • Restic Restore ImageKey -> resticRestoreImageFqin
  • Data Mover Imagekey -> dataMoverImageFqin

Below is an example DataProtectionApplication (DPA) CR with the unsupportedOverrides key added for reference. Please note that the <IMAGE_PLACEHOLDER WITH TAG> is to be replaced with the plugin image and tag.

apiVersion: oadp.openshift.io/v1alpha1
kind: DataProtectionApplication
metadata:
  name: dpa-sample
spec:
  configuration:
    velero:
      defaultPlugins:
      - openshift
      - aws
    nodeAgent:
      enable: true
      uploaderType: restic
  backupLocations:
    - name: default
      velero:
        provider: aws
        default: true
        objectStorage:
          bucket: my-bucket
          prefix: my-prefix
        config:
          region: us-east-1
          profile: "default"
        credential:
          name: cloud-credentials
          key: cloud
  snapshotLocations:
    - name: default
      velero:
        provider: aws
        config:
          region: us-west-2
          profile: "default"
  unsupportedOverrides:
    awsPluginImageFqin: <IMAGE_PLACEHOLDER WITH TAG>
    openshiftPluginImageFqin: <IMAGE_PLACEHOLDER WITH TAG>