1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Files
openshift-docs/modules/oadp-configuring-velero-plugins.adoc
2025-10-28 14:54:43 -04:00

79 lines
2.2 KiB
Plaintext

// Module included in the following assemblies:
//
// * backup_and_restore/application_backup_and_restore/oadp-features-plugins.adoc
:_mod-docs-content-type: CONCEPT
[id="oadp-configuring-velero-plugins_{context}"]
= About OADP Velero plugins
[role="_abstract"]
You can configure two types of plugins when you install Velero:
* Default cloud provider plugins
* Custom plugins
Both types of plugin are optional, but most users configure at least one cloud provider plugin.
== Default Velero cloud provider plugins
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)
ifndef::openshift-rosa,openshift-rosa-hcp[]
* `gcp` ({gcp-full})
* `azure` (Microsoft Azure)
endif::openshift-rosa,openshift-rosa-hcp[]
* `openshift` (OpenShift Velero plugin)
* `csi` (Container Storage Interface)
* `kubevirt` (KubeVirt)
You specify the desired default plugins in the `oadp_v1alpha1_dpa.yaml` file during deployment.
.Example file
The following `.yaml` file installs the `openshift`, `aws`, `azure`, and `gcp` plugins:
[source,yaml]
----
apiVersion: oadp.openshift.io/v1alpha1
kind: DataProtectionApplication
metadata:
name: dpa-sample
spec:
configuration:
velero:
defaultPlugins:
- openshift
- aws
- azure
- gcp
----
== Custom Velero 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 `quay.io/example-repo/custom-velero-plugin`:
[source,yaml]
----
apiVersion: oadp.openshift.io/v1alpha1
kind: DataProtectionApplication
metadata:
name: dpa-sample
spec:
configuration:
velero:
defaultPlugins:
- openshift
- azure
- gcp
customPlugins:
- name: custom-plugin-example
image: quay.io/example-repo/custom-velero-plugin
----