AtlasBackupPolicy
自定义资源
AtlasBackupPolicy
自定义资源配置适用于AtlasBackupSchedule
自定义资源的备份策略,您可以将其应用于AtlasDeployment
自定义资源。 当您创建AtlasBackupPolicy
自定义资源时,Atlas Kubernetes Operator 会尝试创建或更新备份策略。
重要
自定义资源不再默认删除对象
Atlas Kubernetes Operator 使用自定义资源配置文件来管理 Atlas 配置,但从 Atlas Kubernetes Operator 2.0 开始,在 Kubernetes 中删除的自定义资源将不再从 Atlas 中删除。相反,Atlas Kubernetes Operator 只是不再管理这些资源。例如,如果您在 Kubernetes 中删除 AtlasProject
自定义资源,Atlas Kubernetes Operator 不会再自动从 Atlas 中删除相应项目,从而防止意外删除。要了解更多信息,包括如何将此行为恢复为 Atlas Kubernetes Operator 2.0 之前使用的默认行为,请参阅新默认值:Atlas Kubernetes Operator 2.0 中的删除保护。
Atlas Kubernetes Operator 使用 Atlas Cloud Backup Schedule API 资源执行以下操作之一:
创建新的备份策略。
更新现有备份策略。
如果您从 Kubernetes 集群中删除AtlasBackupPolicy
资源,Atlas 将停止为集群创建备份。
注意
您必须执行以下所有任务才能备份集群:
创建备份策略。
创建备份安排并将
spec.policy.name
字段设置为已配置备份策略的名称。将
spec.backupRef.name
AtlasDeployment
自定义资源 中的 字段设置为已配置备份计划的名称。
要了解更多信息,请参阅备份 Atlas 集群。
例子
以下示例显示了一个AtlasBackupPolicy
自定义资源,该资源配置为每周拍摄一次快照并将快照保留 7 天:
apiVersion: atlas.mongodb.com/v1 kind: AtlasBackupPolicy metadata: name: "atlas-default-backuppolicy" spec: items: - frequencyType: "weekly" frequencyInterval: 1 retentionUnit: "days" retentionValue: 7
参数
本部分介绍一些可用的关键AtlasBackupPolicy
自定义资源参数。 有关可用参数的完整列表,请参阅 Atlas修改云备份 备份策略 API 。 请参阅这些说明、可用示例和 API文档,自定义您的规范。
spec.items
类型:数组
可选的
包含来自API的策略项参数的列表。 有关可用参数的完整列表,请参阅 Atlas修改云备份备份策略 API。
spec.items.frequencyInterval
类型:数字
必需
数字,表示
spec.items.frequencyType
指定的新备份策略项的所需频率。1
值指定相应spec.items.frequencyType
的第一个实例。例子
在月度策略项中,
1
表示月度快照发生在该月的第一天。在每周策略项中,
1
表示每周快照发生在星期一。
此设置接受以下频率值:
每小时:
1
、2
、4
、6
、8
和12
。每日:
1
。每周:
1
到7
,其中1
为星期一,7
为星期日。每月:
1
到28
和40
,其中1
是该月的第一天,40
是该月的最后一天。每年:
1
到12
,其中1
是一月的第一天,12
是十二月的第一天。
spec.items.frequencyType
类型:字符串
必需
string ,表示与备份策略项关联的频率。 接受的值为:
hourly
、daily
、weekly
、monthly
或yearly
。注意
您不能指定多个
hourly
和daily
备份策略项。
spec.items.retentionUnit
类型:字符串
必需
string ,表示备份策略项的范围。 这些设置与
spec.items.retentionValue
一起定义保留快照的时间长度。 接受的值为:days
、weeks
、months
或years
。
spec.items.retentionValue
类型:字符串
必需
string ,表示要与
spec.items.retentionUnit
关联的值。 这些设置与spec.items.retentionUnit
一起定义保留快照的时间长度。