plugins.md

---

Plugins Customization

---

Configure Velero Plugins

There are mainly two categories of Velero plugins that can be specified while installing Velero:

1. defaultPlugins:
   There are several types of default Velero plugins can be installed:

   • AWS Plugins for AWS
   • Legacy AWS Plugins for Legacy AWS
   • GCP Plugins for Google Cloud Platform
   • Azure Plugins for Microsoft Azure
   • OpenShift OpenShift Velero Plugin
   • CSI Plugins for CSI
   • kubevirt Plugins for Kubevirt
   • VSM (OADP 1.2 or below) Plugin for Volume-Snapshot-Mover

   Note that only one of AWS and Legacy AWS may be installed at the same time. Legacy AWS is intended for use with certain S3 providers that do not support the V2 AWS SDK APIs used in the AWS plugin.

   For installation, you need to specify them in the oadp_v1alpha1_dpa.yaml file during deployment.

    apiVersion: oadp.openshift.io/v1alpha1
    kind: DataProtectionApplication
    metadata:
      name: dpa-sample
    spec:
      configuration:
        velero:
          defaultPlugins:
          - openshift
          - aws
          - azure
          - gcp
   

   The above specification will install Velero with four of the default plugins.

    apiVersion: oadp.openshift.io/v1alpha1
    kind: DataProtectionApplication
    metadata:
      name: dpa-sample
    spec:
      configuration:
        velero:
          defaultPlugins:
          - openshift
          - legacy-aws
   

   The above specification will install Velero with two of the default plugins.

2. customPlugins:
   For installation of custom Velero plugins, you need to specify the plugin image and plugin name in the oadp_v1alpha1_dpa.yaml file during deployment.

   For instance,

    apiVersion: oadp.openshift.io/v1alpha1
    kind: DataProtectionApplication
    metadata:
      name: dpa-sample
    spec:
      configuration:
        velero:
          defaultPlugins:
          - azure
          - gcp
          customPlugins:
          - name: custom-plugin-example
            image: quay.io/example-repo/custom-velero-plugin
   

   The above specification will install Velero with three plugins: azure, gcp, and custom-plugin-example.