CLOUDP-159055: Support copySettings field for BackupSchedule (#870)

Support copySettings for backupSchedule

Author: helderjs

config/crd/bases/atlas.mongodb.com_atlasbackupschedules.yaml

@@ -42,6 +42,41 @@ spec:
                   snapshots to the AWS bucket. You must also define the export policy
                   using export. If omitted, defaults to false.
                 type: boolean
+              copySettings:
+                description: Copy backups to other regions for increased resiliency
+                  and faster restores.
+                items:
+                  properties:
+                    cloudProvider:
+                      default: AWS
+                      description: Identifies the cloud provider that stores the snapshot
+                        copy.
+                      enum:
+                      - AWS
+                      - GCP
+                      - AZURE
+                      type: string
+                    frequencies:
+                      description: List that describes which types of snapshots to
+                        copy.
+                      items:
+                        type: string
+                      minItems: 1
+                      type: array
+                    regionName:
+                      description: Target region to copy snapshots belonging to replicationSpecId
+                        to.
+                      type: string
+                    replicationSpecId:
+                      description: Unique identifier that identifies the replication
+                        object for a zone in a cluster.
+                      type: string
+                    shouldCopyOplogs:
+                      description: Flag that indicates whether to copy the oplogs
+                        to the target region.
+                      type: boolean
+                  type: object
+                type: array
               export:
                 description: Export policy for automatically exporting cloud backup
                   snapshots to AWS bucket.

config/crd/bases/atlas.mongodb.com_atlasdeployments.yaml

@@ -917,6 +917,17 @@ spec:
                   reconciliation of the resource.
                 format: int64
                 type: integer
+              replicaSets:
+                items:
+                  properties:
+                    id:
+                      type: string
+                    zoneName:
+                      type: string
+                  required:
+                  - id
+                  type: object
+                type: array
               serverlessPrivateEndpoints:
                 items:
                   properties:

config/samples/atlas_v1_atlasbackuppolicy.yaml

@@ -3,10 +3,8 @@ kind: AtlasBackupPolicy
 metadata:
   name: atlasbackuppolicy-sample
 spec:
-  id: "1"
   items:
-    - id: "2"
-      frequencyType: "WEEKLY"
-      frequencyInterval: 6
-      retentionUnit: "DAYS"
-      retentionValue: 6
+    - frequencyType: daily
+      frequencyInterval: 3
+      retentionUnit: weeks
+      retentionValue: 2

config/samples/atlas_v1_atlasbackupschedule.yaml

@@ -3,13 +3,18 @@ kind: AtlasBackupSchedule
 metadata:
   name: atlasbackupschedule-sample
 spec:
-  autoExportEnabled: true
+  autoExportEnabled: false
   referenceHourOfDay: 10
   referenceMinuteOfHour: 10
   restoreWindowDays: 2
-  policies:
-    - name: atlas-default-backuppolicy
-      namespace: mongodb-atlas-system
-    - name: atlas-default-backuppolicy2
-      namespace: mongodb-atlas-system
+  copySettings:
+    - regionName: US_WEST_1
+      cloudProvider: AWS
+      replicationSpecId: a1b2c3
+      shouldCopyOplogs: false
+      frequencies:
+        - WEEKLY
+  useOrgAndGroupNamesInExportPrefix: true
+  policy:
+    name: atlasbackuppolicy-sample
 

pkg/api/v1/atlasbackupschedule_types.go

@@ -54,6 +54,10 @@ type AtlasBackupScheduleSpec struct {
 	// Specify true to use organization and project names instead of organization and project UUIDs in the path for the metadata files that Atlas uploads to your S3 bucket after it finishes exporting the snapshots
 	// +optional
 	UseOrgAndGroupNamesInExportPrefix bool `json:"useOrgAndGroupNamesInExportPrefix,omitempty"`
+
+	// Copy backups to other regions for increased resiliency and faster restores.
+	// +optional
+	CopySettings []CopySetting `json:"copySettings,omitempty"`
 }
 
 type AtlasBackupExportSpec struct {
@@ -64,6 +68,22 @@ type AtlasBackupExportSpec struct {
 	FrequencyType string `json:"frequencyType"`
 }
 
+type CopySetting struct {
+	// Identifies the cloud provider that stores the snapshot copy.
+	// +kubebuilder:validation:Enum:=AWS;GCP;AZURE
+	// +kubebuilder:default:=AWS
+	CloudProvider *string `json:"cloudProvider,omitempty"`
+	// Target region to copy snapshots belonging to replicationSpecId to.
+	RegionName *string `json:"regionName,omitempty"`
+	// Unique identifier that identifies the replication object for a zone in a cluster.
+	ReplicationSpecID *string `json:"replicationSpecId,omitempty"`
+	// Flag that indicates whether to copy the oplogs to the target region.
+	ShouldCopyOplogs *bool `json:"shouldCopyOplogs,omitempty"`
+	// List that describes which types of snapshots to copy.
+	// +kubebuilder:validation:MinItems=1
+	Frequencies []string `json:"frequencies,omitempty"`
+}
+
 // AtlasBackupSchedule is the Schema for the atlasbackupschedules API
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status

pkg/api/v1/status/atlasdeployment.go

@@ -20,6 +20,8 @@ type AtlasDeploymentStatus struct {
 	// ConnectionStrings is a set of connection strings that your applications use to connect to this cluster.
 	ConnectionStrings *ConnectionStrings `json:"connectionStrings,omitempty"`
 
+	ReplicaSets []ReplicaSet `json:"replicaSets,omitempty"`
+
 	ServerlessPrivateEndpoints []ServerlessPrivateEndpoint `json:"serverlessPrivateEndpoints,omitempty"`
 
 	CustomZoneMapping *CustomZoneMapping `json:"customZoneMapping,omitempty"`
@@ -40,6 +42,11 @@ const (
 	StateREPAIRING = "REPAIRING"
 )
 
+type ReplicaSet struct {
+	ID       string `json:"id"`
+	ZoneName string `json:"zoneName,omitempty"`
+}
+
 // ConnectionStrings contains configuration for applications use to connect to this cluster
 type ConnectionStrings struct {
 	// Public mongodb:// connection string for this cluster.
@@ -114,6 +121,12 @@ func AtlasDeploymentStateNameOption(stateName string) AtlasDeploymentStatusOptio
 	}
 }
 
+func AtlasDeploymentReplicaSet(replicas []ReplicaSet) AtlasDeploymentStatusOption {
+	return func(s *AtlasDeploymentStatus) {
+		s.ReplicaSets = replicas
+	}
+}
+
 func AtlasDeploymentSPEOption(pe []ServerlessPrivateEndpoint) AtlasDeploymentStatusOption {
 	return func(s *AtlasDeploymentStatus) {
 		s.ServerlessPrivateEndpoints = pe

pkg/api/v1/status/zz_generated.deepcopy.go

@@ -258,6 +258,19 @@ func (r *AtlasDeploymentReconciler) handleAdvancedDeployment(ctx *workflow.Conte
 		return result, nil
 	}
 
+	replicaSetStatus := make([]status.ReplicaSet, 0, len(deployment.Spec.AdvancedDeploymentSpec.ReplicationSpecs))
+	for _, replicaSet := range c.ReplicationSpecs {
+		replicaSetStatus = append(
+			replicaSetStatus,
+			status.ReplicaSet{
+				ID:       replicaSet.ID,
+				ZoneName: replicaSet.ZoneName,
+			},
+		)
+	}
+
+	ctx.EnsureStatusOption(status.AtlasDeploymentReplicaSet(replicaSetStatus))
+
 	backupEnabled := false
 	if c.BackupEnabled != nil {
 		backupEnabled = *c.BackupEnabled
@@ -266,8 +279,7 @@ func (r *AtlasDeploymentReconciler) handleAdvancedDeployment(ctx *workflow.Conte
 	if err := r.ensureBackupScheduleAndPolicy(
 		context.Background(),
 		ctx, project.ID(),
-		c.Name,
-		*deployment.Spec.BackupScheduleRef.GetObject(deployment.Namespace),
+		deployment,
 		backupEnabled,
 		req.NamespacedName,
 	); err != nil {
@@ -306,6 +318,19 @@ func (r *AtlasDeploymentReconciler) handleRegularDeployment(ctx *workflow.Contex
 		return result, nil
 	}
 
+	replicaSetStatus := make([]status.ReplicaSet, 0, len(deployment.Spec.DeploymentSpec.ReplicationSpecs))
+	for _, replicaSet := range atlasDeployment.ReplicationSpecs {
+		replicaSetStatus = append(
+			replicaSetStatus,
+			status.ReplicaSet{
+				ID:       replicaSet.ID,
+				ZoneName: replicaSet.ZoneName,
+			},
+		)
+	}
+
+	ctx.EnsureStatusOption(status.AtlasDeploymentReplicaSet(replicaSetStatus))
+
 	backupEnabled := false
 	providerBackupEnabled := false
 	if atlasDeployment.ProviderBackupEnabled != nil {
@@ -319,8 +344,7 @@ func (r *AtlasDeploymentReconciler) handleRegularDeployment(ctx *workflow.Contex
 		context.Background(),
 		ctx,
 		project.ID(),
-		atlasDeployment.Name,
-		*deployment.Spec.BackupScheduleRef.GetObject(deployment.Namespace),
+		deployment,
 		providerBackupEnabled || backupEnabled,
 		req.NamespacedName,
 	); err != nil {