AtlasBackupSchedule custom resource configures a backup
schedule that you can apply to your
AtlasDeployment Custom Resource. When you
resource, Atlas Kubernetes Operator tries to create or update a backup schedule.
Custom Resources Definitions Take Priority
Atlas Kubernetes Operator uses custom resource configuration files to manage your Atlas configuration. Each custom resource definition overrides settings specified in other ways such as in the Atlas UI. If you delete a custom resource, Atlas Kubernetes Operator deletes the object from Atlas unless you use annotations to skip deletion. To learn more, see the Create and Update Process and the Delete Process.
Atlas Kubernetes Operator does one of the following actions using the Atlas Cloud Backup Schedule API Resource:
Creates a new backup schedule.
Updates an existing backup schedule.
If you remove the
AtlasBackupSchedule resource from your Kubernetes
cluster, Atlas stops creating backups for your cluster.
You must do all of the following to back up a cluster:
Create a backup policy
Create a backup schedule and set the
spec.policy.namefield to the name of the configured backup policy.
To learn more, see Back Up Your Atlas Cluster.
You can specify one backup schedule per cluster, but you can use the same backup schedule for multiple clusters.
The following example shows an
AtlasBackupSchedule custom resource
configured to take snapshots at 10:10 UTC and restore up to two days:
apiVersion: atlas.mongodb.com/v1 kind: AtlasBackupSchedule metadata: name: atlas-default-backupschedule labels: app.kubernetes.io/version: 1.6.0 spec: autoExportExabled: true copySettings: - cloudProvider: AWS frequencies: - HOURLY regionName: US_EAST_1 replicationSpecId: "string" shouldCopyOplogs: true referenceHourOfDay: 10 referenceMinuteOfHour: 10 restoreWindowDays: 2 policy: name: atlas-default-backuppolicy namespace: mongodb-atlas-system
This section describes some of the key
resource parameters available. For a full list of parameters available,
see the Atlas Modify Cloud Backup Backup Policy
to these descriptions, the available examples, and the API
documentation to customize your specifications.
Flag that specifies whether Atlas automatically exports cloud backup snapshots to your AWS backup. Specify
trueto enable automatic export of cloud backup snapshots to the AWS bucket. Specify
falseto disable automatic export.
Unique 24-hexadecimal character string that identifies the AWS bucket.
Human-readable label that indicates the rate at which the export policy item occurs.
Number that indicates the UTC hour of day between
23, inclusive, representing the hour of the day that Atlas takes snapshots for backup policy items.
Number that indicates the minutes after
spec.referenceHourOfDaythat Atlas takes snapshots for backup policy items. Value must be between
Number that indicates the days back in time that you can restore to with continuous cloud backup accuracy. Value must be a positive, non-zero integer.
This setting applies to continuous cloud backups only.
List that contains the details for the backup policy to apply.
metadata.namevalue within thhe
AtlasBackupPolicyCustom Resource for the backup policy that you want to apply. You can specify only one backup policy per backup schedule. You can't use the same backup policy in multiple backup schedules.
String that indicates the namespace that contains the
AtlasBackupPolicyCustom Resource for the backup policy that you want to apply.