Skip to content

OADP Operator

OpenShift API for Data Protection

Go Report CardcodecovLicenseGo Reference

Periodic Unit Tests

Unit tests

Periodic E2E Tests in OpenShift

Status and known CI issues: See the CI Status & Issues Wiki for up-to-date CI status, known problems, and troubleshooting guidance.

Periodic AWS E2E Tests in OpenShift

See the wiki: Current CI Status

OADP repositories images job

OADPOpenShift Velero pluginVeleroVelero plugin for AWSVelero plugin for Legacy AWSVelero plugin for GCPVelero plugin for Microsoft AzureNon AdminKubeVirt Velero PluginMust GatherCLIKubeVirt Datamover ControllerVM File RestoreFilebrowserVMDPKubeVirt Datamover Plugin
OADP repositoryOpenShift Velero plugin repositoryOADP's Velero repositoryOADP's Velero plugin for AWS repositoryOADP's Velero plugin for Legacy AWS repositoryOADP's Velero plugin for GCP repositoryOADP's Velero plugin for Microsoft Azure repositoryNon Admin repositoryKubeVirt Velero Plugin repositoryMust Gather repositoryCLI repositoryKubeVirt Datamover Controller repositoryVM File Restore repositoryFilebrowser repositoryVMDP repositoryKubeVirt Datamover Plugin repository

Mirroring images to quay.io Mirror images

Rebase status from upstream Velero

🌊 Wave I - Independent Dependencies

Componentoadp-devoadp-1.5main
kopiaoadp-devoadp-1.5
kubevirt-velero-pluginmain
resticSkippedSkipped
udistributionmain

🌊 Wave II - Velero Integration

Componentoadp-devoadp-1.5
velerooadp-devoadp-1.5

🌊 Wave III - Plugins and Operator

Componentoadp-devoadp-1.5
oadp-operatoroadp-devoadp-1.5
velero-plugin-for-awsoadp-devoadp-1.5
velero-plugin-for-csiSkipped
velero-plugin-for-gcpoadp-devoadp-1.5
velero-plugin-for-legacy-awsSkippedSkipped
velero-plugin-for-microsoft-azureoadp-devoadp-1.5

🌊 Wave IV - Non-Admin Controller and OpenShift Plugin

Componentoadp-devoadp-1.5
oadp-non-adminoadp-devoadp-1.5
openshift-velero-pluginoadp-devoadp-1.5

🌊 Wave V - OADP Must-Gather

Componentoadp-devoadp-1.5
oadp-must-gatheroadp-devoadp-1.5

Note: Official Overview and documentation can be found in the OpenShift Documentation

Documentation in this repository are considered unofficial and for development purposes only.

Table of Contents

  1. About

  2. Installing OADP

  3. API References

  4. API Usage

    1. Configure Plugins
    2. Backup Storage Locations and Volume Snapshot Locations
    3. Resource Requests and Limits
    4. Self-Signed Certificate
    5. Use NooBaa as a Backup Storage Location
    6. Use Velero --features flag
    7. Use Custom Plugin Images for Velero
    8. Enable VM File Restore
  5. Examples

    1. Sample Apps used in OADP CI
    2. Stateless App Backup/Restore
    3. Stateful App Backup/Restore
    4. CSI Backup/Restore
  6. Troubleshooting

  7. Contribute

    1. Install & Build from Source
    2. OLM Integration
    3. E2E Test Suite
  8. Velero Version Relationship


About

OADP is the OpenShift API for Data Protection operator. This open source operator sets up and installs Velero on the OpenShift platform, allowing users to backup and restore applications. See video demo!

  • We maintain an up to date FAQ page here

Velero Version Relationship

By default, OADP will install the forked versions of Velero that exist under the openshift organization. These images have minor tweaks to support the OpenShift specific use cases of using Velero with OCP. The openshift images tend to lag behind Velero upstream releases as we are more cautious about supporting older versions. Here is the default mapping of versions:

For the current and planned supported versions, please refer to the version compatibility table in PARTNERS.md.

About

OADP Operator

Resources

Code of conduct

Contributing

Security policy

Stars

91 stars

Watchers

21 watching

Forks

Releases

Packages

Used by

Contributors

Languages