OADP features and plugins

    The default plugins enable Velero to integrate with certain cloud providers and to back up and restore OKD resources.

    OpenShift API for Data Protection (OADP) supports the following features:

    Backup

    You can back up all resources in your cluster or you can filter the resources by type, namespace, or label.

    OADP backs up Kubernetes objects and internal images by saving them as an archive file on object storage. OADP backs up persistent volumes (PVs) by creating snapshots with the native cloud snapshot API or with the Container Storage Interface (CSI). For cloud providers that do not support snapshots, OADP backs up resources and PV data with Restic.

    Restore

    You can restore resources and PVs from a backup. You can restore all objects in a backup or filter the restored objects by namespace, PV, or label.

    Schedule

    You can schedule backups at specified intervals.

    Hooks

    You can use hooks to run commands in a container on a pod, for example, to freeze a file system. You can configure a hook to run before or after a backup or restore. Restore hooks can run in an init container or in the application container.

    The OpenShift API for Data Protection (OADP) provides default Velero plugins that are integrated with storage providers to support backup and snapshot operations. You can create custom plugins based on the Velero plugins.

    OADP also provides plugins for OKD resource backups, OpenShift Virtualization resource backups, and Container Storage Interface (CSI) snapshots.

    1. Mandatory.

    2. Virtual machine disks are backed up with CSI snapshots or Restic.

    You can configure two types of plugins when you install Velero:

    • Custom plugins

    Both types of plugin are optional, but most users configure at least one cloud provider plugin.

    You can install any of the following default Velero cloud provider plugins when you configure the oadp_v1alpha1_dpa.yaml file during deployment:

    • aws (Amazon Web Services)

    • gcp (Google Cloud Platform)

    • azure (Microsoft Azure)

    • openshift (OpenShift Velero plugin)

    • csi (Container Storage Interface)

    • kubevirt (KubeVirt)

    You specify the desired default plugins in the file during deployment.

    Example file

    The following .yaml file installs the openshift, aws, azure, and gcp plugins:

    You can install a custom Velero plugin by specifying the plugin image and name when you configure the oadp_v1alpha1_dpa.yaml file during deployment.

    You specify the desired custom plugins in the oadp_v1alpha1_dpa.yaml file during deployment.

    Example file

    The following .yaml file installs the default openshift, azure, and gcp plugins and a custom plugin that has the name custom-plugin-example and the image :

    1. apiVersion: oadp.openshift.io/v1alpha1
    2. kind: DataProtectionApplication
    3.  name: dpa-sample
    4. spec:
    5.  configuration:
    6.    velero:
    7.      defaultPlugins:
    8.      - openshift
    9.      - azure
    10.      - gcp
    11.      customPlugins:
    12.      - name: custom-plugin-example

    OpenShift API for Data Protection (OADP) is platform neutral. The information that follows relates only to IBM Power and to IBM zSystems.

    OADP 1.1.0 was tested successfully against OKD 4.11 for both IBM Power and IBM zSystems. The sections that follow give testing and support information for OADP 1.1.0 in terms of backup locations for these systems.

    IBM Power running with OKD 4.11 and 4.12, and OpenShift API for Data Protection (OADP) 1.1.2 was tested successfully against an AWS S3 backup location target. Although the test involved only an AWS S3 target, Red Hat supports running IBM Power with OKD 4.11 and 4.12, and OADP 1.1.2 against all non-AWS S3 backup location targets as well.

    IBM zSystems running with OKD 4.11 and 4.12, and OpenShift API for Data Protection (OADP) 1.1.2 was tested successfully against an AWS S3 backup location target. Although the test involved only an AWS S3 target, Red Hat supports running IBM zSystems with OKD 4.11 and 4.12, and OADP 1.1.2 against all non-AWS S3 backup location targets as well.