Docs 菜单
Docs 主页
/
MongoDB Atlas
/
MongoDB Atlas Kubernetes Operator
/
自定义资源

AtlasBackupCompliancePolicy 自定义资源

在此页面上

  • 例子
  • 参数

AtlasBackupCompliancePolicy自定义资源配置备份合规策略，该策略应用于 AtlasProject自定义资源以保护您的备份数据。 当您创建AtlasBackupCompliancePolicy自定义资源时， Atlas Kubernetes Operator会尝试创建或更新备份合规策略。

Atlas Kubernetes Operator使用Atlas备份合规策略API资源执行以下操作之一：

  • 创建新的备份合规策略。

  • 更新现有备份合规性策略。

重要

请参阅“禁止的操作和注意事项” 。 备份合规策略作为最低备份策略应用于项目中的所有集群。 备份合规策略可保护所有现有快照。 备份合规策略可防止任何用户（无论角色如何）在现有快照过期之前修改或删除它们。 对此备份合规性策略所做的更改仅应用于未来的快照。 如果启用备份合规策略，则备份合规策略会限制您降低备份存储成本的能力。 您无法通过调整保留或删除备份来降低备份存储成本。

例子

以下示例显示了一个BackupCompliancePolicy自定义资源。 要学习；了解详情，请参阅配置备份合规策略。

apiVersion: atlas.mongodb.com/v1
kind: AtlasBackupCompliancePolicy
metadata:
  name: my-backup-compliance-policy
  namespace: mongodb-atlas-system
spec:
  authorizedEmail: john.doe@example.com
  authorizedUserFirstName: John
  authorizedUserLastName: Doe
  copyProtectionEnabled: false
  encryptionAtRestEnabled: false
  onDemandPolicy:
    retentionUnit: weeks
    retentionValue: 3
  overwriteBackupPolicies: false
  pointInTimeEnabled: true
  restoreWindowDays: 42
  scheduledPolicyItems:
  - frequencyInterval: 2
    frequencyType: daily
    retentionUnit: days
    retentionValue: 7

参数

本部分介绍一些可用的关键BackupCompliancePolicy自定义资源参数。 有关可用参数的完整列表，请参阅Atlas更新或启用备份合规性策略设置API 。 请参阅这些说明、可用示例和 API文档，自定义您的规范。

spec.authorizedEmail

类型：字符串

必需

授权证券或法定代表人的电子邮件解决。

重要

无效或不正确的电子邮件地址会阻止您修改或启用此备份合规性策略，直到您通过 MongoDB 支持予以更正。

spec.authorizedUserFirstName

类型：字符串

必需

授权证券或法定代表人的名字。

spec.authorizedUserLastName

类型：字符串

必需

授权证券或法定代表人的姓氏。

spec.copyProtectionEnabled

类型：布尔值

Optional

指示在删除其他快照区域时是否保留所有快照的标志。 此参数默认为false 。

注意

即使您将此参数更改为false ，也可以防止集群用户删除复制到其他区域的备份。 要学习；了解更多信息，请参阅配置Atlas以自动将Atlas 备份快照复制到其他区域。

spec.encryptionAtRestEnabled

类型：布尔值

Optional

指示是否要求使用客户数密钥管理对所有集群进行静态加密的标志。 此参数默认为false 。

注意

要启用此选项，您必须为当前所有集群启用静态加密。 您无法在未启用静态加密的已暂停集群上启用此选项。

spec.onDemandPolicy

类型：对象

Optional

包含按需快照策略项设置的对象。

spec.onDemandPolicy.frequencyInterval

类型：数字

必需

数字，表示spec.onDemandPolicy.frequencyType指定的策略项的所需频率。 1值指定相应spec.onDemandPolicy.frequencyType的第一个实例。

例子

  • 在月度备份合规策略中， 1表示月度快照发生在该月的第一天。

  • 在每周备份合规策略中， 1表示每周快照发生在星期一。

此设置接受以下频率值：

  • 每小时： 1 、 2 、 4 、 6 、 8和12 。

  • 每日： 1 。

  • 每周： 1到7 ，其中1为星期一， 7为星期日。

  • 每月： 1到28和40 ，其中1是该月的第一天， 40是该月的最后一天。

spec.onDemandPolicy.frequencyType

类型：字符串

必需

string ，表示与策略项关联的频率。 接受的值为： hourly 、 daily 、 weekly或monthly 。

注意

您不能在 onDemandPolicy 上指定多个hourly和daily备份策略。

spec.onDemandPolicy.retentionUnit

类型：字符串

必需

string ，表示策略项的范围。 这些设置与spec.onDemandPolicy.retentionValue一起定义保留快照的时间长度。 接受的值为： days 、 weeks或months 。

spec.onDemandPolicy.retentionValue

类型：字符串

必需

string ，表示要与spec.onDemandPolicy.retentionUnit关联的值。 这些设置与spec.onDemandPolicy.retentionUnit一起定义保留快照的时间长度。

spec.overwriteBackupPolicies

类型：布尔值

必需

标志，用于指示是否升级项目中的所有备份策略，而无论AtlasBackupPolicy自定义资源中的指定内容如何。

重要

如果您将此参数设立为true ， Atlas都会升级项目中的所有备份策略，无论AtlasBackupPolicy自定义资源中指定了什么内容。 Atlas覆盖AtlasBackupPolicy自定义资源，并将该自定义资源的状态更新为Ready: False 。 您必须手动更新AtlasBackupPolicy自定义资源，以与备份合规策略保持一致。

如果将此参数设立为false ，则如果现有备份策略不满足备份合规性策略，则创建备份合规性策略将失败。

spec.pitEnabled

类型：布尔值

Optional

指示是否需要对所有集群进行时间点恢复的标志。 此参数默认为false 。

spec.restoreWindowDays

类型：数字

可选的

用于时间点恢复的恢复窗口中的天数。 如果设立spec.pitEnabled设置为true ，则必须指定此参数。

重要

您不能配置比每小时快照保留时间更长的恢复窗口。 保存此备份合规策略后，如果没有MongoDB支持，您将无法更改此设置。 要更改此设置，为备份合规策略指定的安全或法定代表必须请求支持并完成广泛的验证进程。

spec.scheduledPolicyItems

类型：对象

Optional

包含快照策略项设置的对象。

spec.scheduledPolicyItems.frequencyInterval

类型：数字

必需

数字，表示spec.scheduledPolicyItems.frequencyType指定的策略项的所需频率。 1值指定相应spec.scheduledPolicyItems.frequencyType的第一个实例。

例子

  • 在月度备份合规策略中， 1表示月度快照发生在该月的第一天。

  • 在每周备份合规策略中， 1表示每周快照发生在星期一。

此设置接受以下频率值：

  • 每小时： 1 、 2 、 4 、 6 、 8和12 。

  • 每日： 1 。

  • 每周： 1到7 ，其中1为星期一， 7为星期日。

  • 每月： 1到28和40 ，其中1是该月的第一天， 40是该月的最后一天。

spec.scheduledPolicyItems.frequencyType

类型：字符串

必需

string ，表示与策略项关联的频率。 接受的值为： hourly 、 daily 、 weekly或monthly 。

注意

您不能指定多个hourly和daily备份策略 ScheduledPolicyItems。

spec.scheduledPolicyItems.retentionUnit

类型：字符串

必需

string ，表示策略项的范围。 这些设置与spec.scheduledPolicyItems.retentionValue一起定义保留快照的时间长度。 接受的值为： days 、 weeks或months 。

spec.scheduledPolicyItems.retentionValue

类型：字符串

必需

string ，表示要与spec.scheduledPolicyItems.retentionUnit关联的值。 这些设置与spec.scheduledPolicyItems.retentionUnit一起定义保留快照的时间长度。

后退

AtlasBackupSchedule

来年

AtlasTeam

在此页面上