1. Documentation
×

APIs used with OADP

You can use the following APIs with OADP:

Velero API

Velero API documentation is maintained by Velero and is not maintained by Red Hat.

OADP API

The following are the OADP APIs:

  • DataProtectionApplicationSpec

  • BackupLocation

  • SnapshotLocation

  • ApplicationConfig

  • VeleroConfig

  • CustomPlugin

  • ResticConfig

  • PodConfig

  • Features

  • DataMover

DataProtectionApplicationSpec type

The following are DataProtectionApplicationSpec OADP APIs:

Table 1. DataProtectionApplicationSpec
Property Type Description

backupLocations

[] BackupLocation

Defines the list of configurations to use for BackupStorageLocations.

snapshotLocations

[] SnapshotLocation

Defines the list of configurations to use for VolumeSnapshotLocations.

unsupportedOverrides

map [ UnsupportedImageKey ] string

Can be used to override the deployed dependent images for development. Options are veleroImageFqin, awsPluginImageFqin, hypershiftPluginImageFqin, openshiftPluginImageFqin, azurePluginImageFqin, gcpPluginImageFqin, csiPluginImageFqin, dataMoverImageFqin, resticRestoreImageFqin, kubevirtPluginImageFqin, and operator-type.

podAnnotations

map [ string ] string

Used to add annotations to pods deployed by Operators.

podDnsPolicy

DNSPolicy

Defines the configuration of the DNS of a pod.

podDnsConfig

PodDNSConfig

Defines the DNS parameters of a pod in addition to those generated from DNSPolicy.

backupImages

*bool

Used to specify whether or not you want to deploy a registry for enabling backup and restore of images.

configuration

*ApplicationConfig

Used to define the data protection application’s server configuration.

features

*Features

Defines the configuration for the DPA to enable the Technology Preview features.
Additional resources

BackupLocation type

Use the BackupLocation OADP API type to define where OADP stores backups in OKD. You can specify a Velero backup storage location or an automatically provisioned cloud storage bucket.

Table 2. BackupLocation
Property Type Description

velero

*velero.BackupStorageLocationSpec

Location to store volume snapshots, as described in Backup Storage Location.

bucket

*CloudStorageLocation

Automates creation of a bucket at some cloud storage providers for use as a backup storage location.

The bucket parameter is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.

For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope.
Additional resources

SnapshotLocation type

Use the SnapshotLocation OADP API type to define where OADP stores volume snapshots in OKD. It uses the Velero VolumeSnapshotLocationSpec to specify the snapshot storage backend.

Table 3. SnapshotLocation
Property Type Description

velero

*VolumeSnapshotLocationSpec

Location to store volume snapshots, as described in Volume Snapshot Location.
Additional resources

ApplicationConfig type

Use the ApplicationConfig OADP API type to define Velero and Restic server configuration for OADP backup and restore operations in OKD.

Table 4. ApplicationConfig
Property Type Description

velero

*VeleroConfig

Defines the configuration for the Velero server.

restic

*ResticConfig

Defines the configuration for the Restic server.
Additional resources

VeleroConfig type

Use the VeleroConfig OADP API type to configure the Velero server instance for OADP in OKD. It controls plugins, feature flags, pod configuration, and logging for the Velero server.

Table 5. VeleroConfig
Property Type Description

featureFlags

[] string

Defines the list of features to enable for the Velero instance.

defaultPlugins

[] string

The following types of default Velero plugins can be installed: aws,azure, csi, gcp, kubevirt, and openshift.

customPlugins

[]CustomPlugin

Used for installation of custom Velero plugins.

restoreResourcesVersionPriority

string

Represents a config map that is created if defined for use in conjunction with the EnableAPIGroupVersions feature flag. Defining this field automatically adds EnableAPIGroupVersions to the Velero server feature flag.

noDefaultBackupLocation

bool

To install Velero without a default backup storage location, you must set the noDefaultBackupLocation flag in order to confirm installation.

podConfig

*PodConfig

Defines the configuration of the Velero pod.

logLevel

string

Velero server’s log level (use debug for the most granular logging, leave unset for Velero default). Valid options are trace, debug, info, warning, error, fatal, and panic.
Additional resources

CustomPlugin type

Use the CustomPlugin OADP API type to define the name and container image of a custom Velero plugin for OADP in OKD.

Table 6. CustomPlugin
Property Type Description

name

string

Name of custom plugin.

image

string

Image of custom plugin.
Additional resources

ResticConfig type

Use the ResticConfig OADP API type to enable and configure Restic-based backup and restore in OKD. It defines the Restic timeout, supplemental groups, and pod configuration.

Table 7. ResticConfig
Property Type Description

enable

*bool

If set to true, enables backup and restore using Restic. If set to false, snapshots are needed.

supplementalGroups

[]int64

Defines the Linux groups to be applied to the Restic pod.

timeout

string

A user-supplied duration string that defines the Restic timeout. Default value is 1hr (1 hour). A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as 300ms, -1.5h, or 2h45m. Valid time units are ns, us (or µs), ms, s, m, and h.

podConfig

*PodConfig

Defines the configuration of the Restic pod.
Additional resources

PodConfig type

Use the PodConfig OADP API type to configure pod-level settings for Velero and Restic pods in OKD. It defines node selectors, tolerations, resource limits, and labels for backup and restore pods.

Table 8. PodConfig
Property Type Description

nodeSelector

map [ string ] string

Defines the nodeSelector to be supplied to a Velero podSpec or a Restic podSpec.

tolerations

[]Toleration

Defines the list of tolerations to be applied to a Velero deployment or a Restic daemonset.

resourceAllocations

ResourceRequirements

Set specific resource limits and requests for a Velero pod or a Restic pod as described in the Setting Velero CPU and memory resource allocations section.

labels

map [ string ] string

Labels to add to pods.

Features type

Use the Features OADP API type to configure optional OADP features in OKD. It defines the Data Mover configuration for volume snapshot data movement.

Table 9. Features
Property Type Description

dataMover

*DataMover

Defines the configuration of the Data Mover.
Additional resources

DataMover type

Use the DataMover OADP API type to enable and configure the volume snapshot mover controller and CSI Data Mover plugin in OKD. It controls data movement for volume snapshot backup and restore operations.

Table 10. DataMover
Property Type Description

enable

bool

If set to true, deploys the volume snapshot mover controller and a modified CSI Data Mover plugin. If set to false, these are not deployed.

credentialName

string

User-supplied Restic Secret name for Data Mover.

timeout

string

A user-supplied duration string for VolumeSnapshotBackup and VolumeSnapshotRestore to complete. Default is 10m (10 minutes). A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as 300ms, -1.5h, or 2h45m. Valid time units are ns, us (or µs), ms, s, m, and h.

Additional resources