search

openshift / oadp-operator

OADP Operator
Apache License 2.0
76 stars 69 forks source link

readme

OADP Operator

OpenShift API for Data Protection

[![Go Report Card](https://goreportcard.com/badge/github.com/openshift/oadp-operator)](https://goreportcard.com/report/github.com/openshift/oadp-operator) [![codecov](https://codecov.io/gh/openshift/oadp-operator/branch/master/graph/badge.svg?token=qLM0hAzjpD)](https://codecov.io/gh/openshift/oadp-operator) [![License](https://img.shields.io/:license-apache-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0.html) [![Go Reference](https://pkg.go.dev/badge/github.com/openshift/oadp-operator.svg)](https://pkg.go.dev/github.com/openshift/oadp-operator) Mirroring images to quay.io [![Mirror images](https://prow.ci.openshift.org/badge.svg?jobs=periodic-image-mirroring-konveyor)](https://prow.ci.openshift.org/job-history/gs/origin-ci-test/logs/periodic-image-mirroring-konveyor) Periodic Unit Tests [![Unit tests](https://prow.ci.openshift.org/badge.svg?jobs=periodic-ci-openshift-oadp-operator-master-unit-test-periodic)](https://prow.ci.openshift.org/job-history/gs/origin-ci-test/logs/periodic-ci-openshift-oadp-operator-master-unit-test-periodic) 4.14, 4.15, 4.16 Periodic E2E Tests AWS : [![AWS builds](https://prow.ci.openshift.org/badge.svg?jobs=periodic-ci-openshift-oadp-operator-master-4.14-e2e-test-aws-periodic)](https://prow.ci.openshift.org/job-history/gs/origin-ci-test/logs/periodic-ci-openshift-oadp-operator-master-4.14-e2e-test-aws-periodic) [![AWS builds](https://prow.ci.openshift.org/badge.svg?jobs=periodic-ci-openshift-oadp-operator-master-4.15-e2e-test-aws-periodic)](https://prow.ci.openshift.org/job-history/gs/origin-ci-test/logs/periodic-ci-openshift-oadp-operator-master-4.15-e2e-test-aws-periodic) [![AWS builds](https://prow.ci.openshift.org/badge.svg?jobs=periodic-ci-openshift-oadp-operator-master-4.16-e2e-test-aws-periodic)](https://prow.ci.openshift.org/job-history/gs/origin-ci-test/logs/periodic-ci-openshift-oadp-operator-master-4.16-e2e-test-aws-periodic)

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
  5. Upgrade from 0.2
  6. Examples
    1. Stateless App Backup/Restore
    2. Stateful App Backup/Restore
    3. CSI Backup/Restore
    4. Data Mover (OADP 1.2 or below)
  7. Troubleshooting
  8. Contribute
    1. Install & Build from Source
    2. OLM Integration
    3. Test Operator Changes
    4. E2E Test Suite
  9. 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!

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:

OADP Version Velero Version
v0.2.6 v1.6.0
v0.5.5 v1.7.1
v1.0.0 - v1.0.z v1.7.1
v1.1.0 v1.9.1
v1.1.1 v1.9.4
v1.1.2 - v1.1.5 v1.9.5
v1.2.0 v1.11.0
v1.3.0 v1.12.1
v1.3.1 v1.12.4