OADP API

Velero API
OADP API
- Configuring node agents and node labels

The document provides information about the following APIs that you can use with OADP:

Velero API
OADP API

Velero API

Velero API documentation is maintained by Velero, not by Red Hat. It can be found at Velero API types.

The following tables provide the structure of the OADP API:

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`, `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.

Complete schema definitions for the OADP API.

Table 2. BackupLocation
Property	Type	Description
`velero`	*velero.BackupStorageLocationSpec	Location to store volume snapshots, as described in Backup Storage Location.
`bucket`	*CloudStorageLocation	[Technology Preview] 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.

Complete schema definitions for the type BackupLocation.

Table 3. SnapshotLocation
Property	Type	Description
`velero`	*VolumeSnapshotLocationSpec	Location to store volume snapshots, as described in Volume Snapshot Location.

Complete schema definitions for the type SnapshotLocation.

Table 4. ApplicationConfig
Property	Type	Description
`velero`	*VeleroConfig	Defines the configuration for the Velero server.
`restic`	*ResticConfig	Defines the configuration for the Restic server.

Complete schema definitions for the type ApplicationConfig.

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. Default and custom plugins are described in OADP 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`.

Complete schema definitions for the type VeleroConfig.

Table 6. CustomPlugin
Property	Type	Description
`name`	string	Name of custom plugin.
`image`	string	Image of custom plugin.

Complete schema definitions for the type CustomPlugin.

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.

Complete schema definitions for the type ResticConfig.

Table 8. PodConfig
Property	Type	Description
`nodeSelector`	map [ string ] string	Defines the `nodeSelector` to be supplied to a `Velero` `podSpec` or a `Restic` `podSpec`. For more details, see Configuring node agents and node labels.
`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 Setting Velero CPU and memory resource allocations.
`labels`	map [ string ] string	Labels to add to pods.

Complete schema definitions for the type PodConfig.

Configuring node agents and node labels

The DPA of OADP uses the nodeSelector field to select which nodes can run the node agent. The nodeSelector field is the simplest recommended form of node selection constraint.

Any label specified must match the labels on each node.

The correct way to run the node agent on any node you choose is for you to label the nodes with a custom label:

$ oc label node/<node_name> node-role.kubernetes.io/nodeAgent=""

Use the same custom label in the DPA.spec.configuration.nodeAgent.podConfig.nodeSelector, which you used for labeling nodes. For example:

configuration:
  nodeAgent:
    enable: true
    podConfig:
      nodeSelector:
        node-role.kubernetes.io/nodeAgent: ""

The following example is an anti-pattern of nodeSelector and does not work unless both labels, 'node-role.kubernetes.io/infra: ""' and 'node-role.kubernetes.io/worker: ""', are on the node:

    configuration:
      nodeAgent:
        enable: true
        podConfig:
          nodeSelector:
            node-role.kubernetes.io/infra: ""
            node-role.kubernetes.io/worker: ""

Table 9. Features
Property	Type	Description
`dataMover`	*`DataMover`	Defines the configuration of the Data Mover.

Complete schema definitions for the type Features.

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`.

The OADP API is more fully detailed in OADP Operator.

APIs used with OADP

Velero API

OADP API

Configuring node agents and node labels