OpenShift APIs for Data Protection (OADP) FAQ

Updated -

An important part of any platform used to host business and user workloads is data protection. Data protection may include operations including on-demand backup, scheduled backup and restore. These operations allow the objects within a cluster to be backed up to a storage provider, either locally or on a public cloud, and restore that cluster from the backup in the event of a failure or scheduled maintenance.

Red Hat has created OpenShift API for Data Protection, or OADP, for this purpose. OADP brings an API to the OpenShift Container Platform that Red Hat partners can leverage in creating a disaster recovery and data protection solution.

Frequently Asked Questions

What is OADP?

OADP (OpenShift APIs for Data Protection) is an operator that Red Hat has created to create backup and restore APIs in the OpenShift cluster.

What APIs does the operator provide?

OADP provides the following APIs:

  • Backup
  • Restore
  • Schedule
  • BackupStorageLocation
  • VolumeSnapshotLocation

Red Hat has not added, removed or modified any of the APIs as documented in the Velero upstream project. The Velero site has more details on the Velero API Types.

Is there an upstream project for OADP?

Yes. The OADP operator is developed in the oadp-operator upstream project.

What is the support status of the OADP operator?

The Red Hat OADP operator version 1.0 was released in Feb 2022 and is the first generally available release and fully supported. Earlier versions (pre-1.0) of the operator were available as a community operator with only community support.

Is OADP a full end-to-end data protection solution?

No. OADP only provides the required APIs for data protection. It will be up to the storage providers to integrate their own components of the solution to enhance scheduling, policy control and enhanced data movement features.

What data can OADP protect?

OADP provides APIs to backup and restore OpenShift cluster resources (yaml files), internal images and persistent volume data.

What is the OADP operator installing?

The OADP operator will install Velero, and OpenShift plugins for Velero to use, for backup and restore operations.

Does OADP support CSI snapshots?

Starting with the OCP 4.6 and OCS 4.6 releases, Red Hat will support CSI snapshots for OpenShift Container Storage and OpenShift Virtualization only. Once the CSI snapshot feature is GA in the upstream community, Red Hat will support the use of CSI snapshots for 3rd party storage solutions as well.

Is there a recorded demo of OADP?

Yes! The OADP team did a great presentation and demonstration of how to install and use OADP for backup and restore in Sept 2020, when the community operator was first released. Check it out here.

What versions of OpenShift Container Platform can OADP be installed?

The OADP 1.0 operator (and later) can be found within the embedded OperatorHub in the OpenShift web console, and fully supported, in versions 4.6 and later.

Are there plans to include a data mover with OADP?

It is something that Red Hat is looking into, though it is very early and has a lot of work to do. See the upstream work here.

How do I determine the version of Velero OADP installed?

After OADP installation, the velero deployment it will contain the tag of the image. If you install OADP with the default config you will be using upstream tagged images with the version called out in the deployment. You can also check out the version matrix.

Where can I find examples of using OADP APIs for backup/restore?

The OADP operator page in the upstream oadp-operator project has examples that walk through usage.