4.12. 与 OADP 一起使用的 API

本文档提供有关您可以在 OADP 一起使用的以下 API 的信息：

Velero API
OADP API

4.12.1. Velero API

Velero API 文档由 Velero 维护，而不是由红帽维护。它可在 Velero API 类型中找到。

4.12.2. OADP API

下表提供了 OADP API 的结构：

表 4.2. DataProtectionApplicationSpec
属性	类型	描述
`backupLocations`	[] `BackupLocation`	定义用于 `BackupStorageLocations` 的配置列表。
`snapshotLocations`	[] `SnapshotLocation`	定义 `VolumeSnapshotLocations` 使用的配置列表。
`unsupportedOverrides`	map [ UnsupportedImageKey ] string	可用于覆盖为开发而部署的依赖镜像。选项为 `veleroImageFqin`, `awsPluginImageFqin`, `openshiftPluginImageFqin`, `azurePluginImageFqin`, `gcpPluginImageFqin`, `csiPluginImageFqin`, `dataMoverImageFqin`, `resticRestoreImageFqin`, `kubevirtPluginImageFqin`, and `operator-type`。
`podAnnotations`	map [ string ] string	用于将注解添加到 Operator 部署的 pod。
`podDnsPolicy`	`DNSPolicy`	定义 Pod 的 DNS 的配置。
`podDnsConfig`	`PodDNSConfig`	定义除了由 `DNSPolicy` 生成的以外的 pod 的 DNS 参数。
`backupImages`	*bool	用于指定是否要部署 registry 以启用镜像的备份和恢复。
`配置`	*`ApplicationConfig`	用于定义数据保护应用服务器配置。
`功能`	*`特性`	定义 DPA 的配置以启用技术预览功能。

OADP API 的完整架构定义。

表 4.3. BackupLocation
属性	类型	描述
`velero`	*velero.BackupStorageLocationSpec	存储卷快照的位置，如备份存储位置所述。
`bucket`	*CloudStorageLocation	[技术预览] 在某些云存储供应商处自动创建存储桶，用作备份存储位置。

重要

bucket 参数只是一个技术预览功能。技术预览功能不受红帽产品服务等级协议（SLA）支持，且功能可能并不完整。红帽不推荐在生产环境中使用它们。这些技术预览功能可以使用户提早试用新的功能，并有机会在开发阶段提供反馈意见。

有关红帽技术预览功能支持范围的更多信息，请参阅技术预览功能支持范围。

类型 BackupLocation 的完整 schema 定义。

表 4.4. SnapshotLocation
属性	类型	描述
`velero`	*VolumeSnapshotLocationSpec	用于存储卷快照的位置，如卷快照位置。

类型 SnapshotLocation 的完整 schema 定义。

表 4.5. ApplicationConfig
属性	类型	描述
`velero`	*VeleroConfig	定义 Velero 服务器配置。
`restic`	*ResticConfig	定义 Restic 服务器配置。

类型 ApplicationConfig 的完整 schema 定义。

表 4.6. VeleroConfig
属性	类型	描述
`featureFlags`	[] string	定义为 Velero 实例启用的功能列表。
`defaultPlugins`	[] string	可以安装以下类型的默认 Velero 插件： `aws`、`azure`、`csi`、`gcp`、`kubevirt` 和 `openshift`。
`customPlugins`	[]CustomPlugin	用于安装自定义 Velero 插件。默认的以及自定义的插件信息包括在OADP plug-ins 中
`restoreResourcesVersionPriority`	string	代表一个配置映射，它在定义与 `EnableAPIGroupVersions` 功能标记结合使用时会被创建。定义此字段会在 Velero 服务器功能标记中添加 `EnableAPIGroupVersions`。
`noDefaultBackupLocation`	bool	要在没有默认备份存储位置的情况下安装 Velero，您必须设置 `noDefaultBackupLocation` 标志来确认安装。
`podConfig`	*`PodConfig`	定义 `Velero` pod 的配置。
`logLevel`	string	Velero 服务器日志级别（在最精细的日志中使用 `debug`，对 Velero 默认保留未设置）。有效选项包括 `trace`、`debug`、`info`、`warning`、`error`、`fatal` 和 `panic`。

类型为 VeleroConfig 的完整 schema 定义。

表 4.7. CustomPlugin
属性	类型	描述
`name`	string	自定义插件的名称。
`image`	string	自定义插件的镜像。

类型 CustomPlugin 的完整 schema 定义。

表 4.8. ResticConfig
属性	类型	描述
`enable`	*bool	如果设置为 `true`，则使用 Restic 启用备份和恢复。如果设置为 `false`，则需要快照。
`supplementalGroups`	[]int64	定义要应用到 `Restic` pod 的 Linux 组。
`timeout`	string	定义 Restic 超时的用户提供的持续时间字符串。默认值为 `1hr` （1 小时）。一个代表时间段的字符串，可以是一组十进制数字序列，每个数字都可以带有一个可选的分数及单位后缀，如 `300ms`、-1.5h' 或 `2h45m`。有效时间单位是 `ns`、`us` （或 `µs`）、`ms`、`s`、`m` 和 `h`。
`podConfig`	*`PodConfig`	定义 `Restic` pod 的配置。

类型为 ResticConfig 的完整 schema 定义。

表 4.9. PodConfig
属性	类型	描述
`nodeSelector`	map [ string ] string	定义要提供给 `Velero` `podSpec` 或 `Restic` `podSpec` 的 `nodeSelector`。如需了解更多详细信息，请参阅配置节点代理和节点标签。
`容限（tolerations）`	[]Toleration	定义要应用到 Velero 部署或 Restic `daemonset` 的容限列表。
`resourceAllocations`	ResourceRequirements	为一个 `Velero` pod 或 `Restic` pod 设置特定的资源`限值`和`请求`，如设置 Velero CPU 和内存分配所述。
`labels`	map [ string ] string	要添加到 pod 的标签。

类型 PodConfig 的完整 schema 定义。

4.12.2.1. 配置节点代理和节点标签

OADP 的 DPA 使用 nodeSelector 字段来选择哪些节点可以运行节点代理。nodeSelector 字段是节点选择限制的最简单的形式。

任何指定的标签都需要与每个节点上的标签匹配。

在您选择的任何节点上运行节点代理的正确方法是使用自定义标签标记节点：

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

在 DPA.spec.configuration.nodeAgent.podConfig.nodeSelector 中使用相同的自定义标签，用于标记节点。例如：

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

以下示例是 nodeSelector 的反模式，除非标签 'node-role.kubernetes.io/infra: ""' 和 'node-role.kubernetes.io/worker: ""' 都位于节点上，否则无法工作：

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

表 4.10. 功能
属性	类型	描述
`dataMover`	*`DataMover`	定义 Data Mover 的配置。

类型 Features 的完整 schema 定义。

表 4.11. DataMover
属性	类型	描述
`enable`	bool	如果设置为 `true`，请部署卷快照控制器和修改的 CSI Data Mover 插件。如果设置为 `false`，则不会部署它们。
`credentialName`	string	Data Mover 用户提供的 Restic `Secret` 名称。
`timeout`	string	要完成 `VolumeSnapshotBackup` 和 `VolumeSnapshotRestore` 的用户提供的持续时间字符串。默认值为 `10m`（10 分钟）。一个代表时间段的字符串，可以是一组十进制数字序列，每个数字都可以带有一个可选的分数及单位后缀，如 `300ms`、-1.5h' 或 `2h45m`。有效时间单位是 `ns`、`us` （或 `µs`）、`ms`、`s`、`m` 和 `h`。

OADP API 在 OADP Operator 中更为详细。

4.12. 与 OADP 一起使用的 API

4.12.1. Velero API

4.12.2. OADP API

4.12.2.1. 配置节点代理和节点标签

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Red Hat legal and privacy links

Red Hat legal and privacy links