/ /

Custom Resources

Docs Home

Management

Atlas Kubernetes Operator

Custom Resources

Docs Home

Management

Atlas Kubernetes Operator

Custom Resources

`AtlasBackupCompliancePolicy` Custom Resource

The AtlasBackupCompliancePolicy custom resource configures a Backup Compliance Policy that applies to the AtlasProject Custom Resource to protect your backup data. When you create the AtlasBackupCompliancePolicy custom resource, Atlas Kubernetes Operator tries to create or update a Backup Compliance Policy.

Atlas Kubernetes Operator does one of the following actions using the Atlas Backup Compliance Policy API Resource:

Creates a new Backup Compliance Policy.
Updates an existing Backup Compliance Policy.

Important

See the Prohibited Actions and Considerations. A Backup Compliance Policy applies as the minimum backup policy to all clusters in the project. The Backup Compliance Policy protects all existing snapshots. The Backup Compliance Policy prevents any user, regardless of role, from modifying or deleting existing snapshots prior to their expiration. Changes made to this Backup Compliance Policy apply only to future snapshots. If you enable a Backup Compliance Policy, the Backup Compliance Policy limits your ability to reduce backup storage costs. You can't adjust the retention or delete a backup to reduce the backup storage costs.

Example

The following example shows a BackupCompliancePolicy custom resource. To learn more, see Configure a Backup Compliance Policy.

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

Parameters

AtlasBackupCompliancePolicy

The AtlasBackupCompliancePolicy is a configuration that enforces specific backup and retention requirements

`Name`	Type	Description	Required
`apiVersion`	string	atlas.mongodb.com/v1	true
`kind`	string	`AtlasBackupCompliancePolicy`	true
`metadata`	object	Refer to the Kubernetes `API` documentation for the fields of the `metadata` field.	true
`spec`	object	`AtlasBackupCompliancePolicySpec` is the specification of the desired backup compliance policy configuration.	false
`status`	object	`BackupCompliancePolicyStatus` defines the observed state of `AtlasBackupCompliancePolicy`.	false

AtlasBackupCompliancePolicy.spec

AtlasBackupCompliancePolicySpec is the specification of the desired backup compliance policy configuration.

`Name`	Type	Description	Required
`authorizedEmail`	string	Email address of the user authorized to update Backup Compliance Policy settings.	true
`authorizedUserFirstName`	string	First name of the user authorized to update the Backup Compliance Policy settings.	true
`authorizedUserLastName`	string	Last name of the user authorized to update the Backup Compliance Policy settings.	true
`copyProtectionEnabled`	boolean	Flag that indicates whether to prevent cluster users from deleting backups copied to other regions, even if those additional snapshot regions are removed.	false
`encryptionAtRestEnabled`	boolean	Flag that indicates whether to require Encryption at Rest using Customer Key Management for all clusters with a Backup Compliance Policy.	false
`onDemandPolicy`	object	Specifications for on-demand policy.	false
`overwriteBackupPolicies`	boolean	Flag that indicates whether to overwrite non-complying backup policies with the new data protection settings.	false
`pointInTimeEnabled`	boolean	Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy.	false
`restoreWindowDays`	integer	Number of previous days from which you can restore with Continuous Cloud Backup with a Backup Compliance Policy. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.	false
`scheduledPolicyItems`	[]object	List that contains the specifications for one scheduled policy.	false

AtlasBackupCompliancePolicy.spec.onDemandPolicy

Specifications for on-demand policy.

`Name`	Type	Description	Required
`retentionUnit`	enum	Scope of the backup policy item: days, weeks, or months. Enum: days, weeks, months	true
`retentionValue`	integer	Value to associate with `RetentionUnit`.	true

AtlasBackupCompliancePolicy.spec.scheduledPolicyItems

`Name`	Type	Description	Required
`frequencyInterval`	integer	Frequency of the new backup policy item specified by `FrequencyType`. A value of 1 specifies the first instance of the corresponding `FrequencyType`. You can set `FrequencyInterval` only to 12 for NVMe clusters. Enum: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40	true
`frequencyType`	enum	Frequency associated with the backup policy item. You can specify only one each of hourly or daily backup policy items. Enum: hourly, daily, weekly, monthly, yearly	true
`retentionUnit`	enum	Unit of time in which `MongoDB` Atlas measures snapshot retention. Enum: days, weeks, months, years	true
`retentionValue`	integer	Duration in days, weeks, months, or years that `MongoDB` Cloud retains the snapshot. For less frequent policy items, `MongoDB` Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items.	true

AtlasBackupCompliancePolicy.status

BackupCompliancePolicyStatus defines the observed state of AtlasBackupCompliancePolicy.

`Name`	Type	Description	Required
`conditions`	[]object	Conditions is the list of statuses showing the current state of the Atlas Custom Resource	true
`observedGeneration`	integer	`ObservedGeneration` indicates the generation of the resource specification of which the Atlas Operator is aware. The Atlas Operator updates this field to the value of 'metadata.generation' as soon as it starts reconciliation of the resource. Format: int64	false

AtlasBackupCompliancePolicy.status.conditions

Condition describes the state of an Atlas Custom Resource at a certain point.

`Name`	Type	Description	Required
`status`	string	Status of the condition; one of True, False, Unknown.	true
`type`	string	Type of Atlas Custom Resource condition.	true
`lastTransitionTime`	string	Last time the condition transitioned from one status to another. Represented in `ISO` 8601 format. Format: date-time	false
`message`	string	A `message` providing details about the transition.	false
`reason`	string	The `reason` for the condition's last transition.	false

Back

AtlasThirdPartyIntegration

AtlasTeam