Allow restore db snapshot from snapshot (#101)

It's similar to what we did in #78
This PR will enable restore db cluster from snapshot, either dbSnapshot or dbClusterSnapshot.

Fixed the issue during testing and verified it can work with both cluster snapshot and db instance snapshot. Controller can issue restore db cluster from snapshot API and resource is synced after creation succeed.

Co-authored-by: Tenglong Gu <[email protected]>

Author: brucegucode

apis/v1alpha1/ack-generate-metadata.yaml

@@ -1,13 +1,13 @@
 ack_generate_info:
-  build_date: "2022-07-12T23:19:21Z"
-  build_hash: d09bac5fa87cffd0028014833a5e7e786c0187dd
+  build_date: "2022-07-18T22:15:47Z"
+  build_hash: cb4bca850e1d1dd678d8ae9bd9d5fd537c06ca51
   go_version: go1.18.2
-  version: v0.19.2-6-gd09bac5
-api_directory_checksum: a60467e94dc7e76bf34ff50f21691507d576fefc
+  version: v0.19.2-7-gcb4bca8
+api_directory_checksum: e768ca701f6e5b113f74fbde422fc59fb2e7b3fe
 api_version: v1alpha1
 aws_sdk_go_version: v1.44.27
 generator_config_info:
-  file_checksum: 0b31df47b2d4db92ee4536c1713f64c60d266c72
+  file_checksum: 1647eb82151b4d1e1115dec606abb62c842f881b
   original_file_name: generator.yaml
 last_modification:
   reason: API generation

apis/v1alpha1/db_cluster.go

@@ -79,6 +79,8 @@ resources:
       # resolved.
       custom_method_name: customUpdate
     hooks:
+      sdk_create_pre_build_request:
+        template_path: hooks/db_cluster/sdk_create_pre_build_request.go.tpl
       delta_pre_compare:
         template_path: hooks/db_cluster/delta_pre_compare.go.tpl
       sdk_create_post_set_output:
@@ -87,6 +89,8 @@ resources:
         template_path: hooks/db_cluster/sdk_read_many_post_set_output.go.tpl
       sdk_delete_pre_build_request:
         template_path: hooks/db_cluster/sdk_delete_pre_build_request.go.tpl
+      sdk_file_end:
+        template_path: hooks/db_cluster/sdk_file_end.go.tpl
     exceptions:
       terminal_codes:
         - DBClusterQuotaExceededFault
@@ -120,6 +124,10 @@ resources:
           resource: SecurityGroup
           service_name: ec2
           path: Status.ID
+      SnapshotIdentifier:
+        from:
+          operation: RestoreDBClusterFromSnapshot
+          path: SnapshotIdentifier
     renames:
       operations:
         CreateDBCluster:

apis/v1alpha1/generator.yaml

@@ -544,6 +544,14 @@ spec:
                   minCapacity:
                     type: number
                 type: object
+              snapshotIdentifier:
+                description: "The identifier for the DB snapshot or DB cluster snapshot
+                  to restore from. \n You can use either the name or the Amazon Resource
+                  Name (ARN) to specify a DB cluster snapshot. However, you can use
+                  only the ARN to specify a DB snapshot. \n Constraints: \n    * Must
+                  match the identifier of an existing Snapshot. \n Valid for: Aurora
+                  DB clusters and Multi-AZ DB clusters"
+                type: string
               sourceRegion:
                 description: SourceRegion is the source region where the resource
                   exists. This is not sent over the wire and is only used for presigning.

apis/v1alpha1/zz_generated.deepcopy.go

@@ -79,6 +79,8 @@ resources:
       # resolved.
       custom_method_name: customUpdate
     hooks:
+      sdk_create_pre_build_request:
+        template_path: hooks/db_cluster/sdk_create_pre_build_request.go.tpl
       delta_pre_compare:
         template_path: hooks/db_cluster/delta_pre_compare.go.tpl
       sdk_create_post_set_output:
@@ -87,6 +89,8 @@ resources:
         template_path: hooks/db_cluster/sdk_read_many_post_set_output.go.tpl
       sdk_delete_pre_build_request:
         template_path: hooks/db_cluster/sdk_delete_pre_build_request.go.tpl
+      sdk_file_end:
+        template_path: hooks/db_cluster/sdk_file_end.go.tpl
     exceptions:
       terminal_codes:
         - DBClusterQuotaExceededFault
@@ -120,6 +124,10 @@ resources:
           resource: SecurityGroup
           service_name: ec2
           path: Status.ID
+      SnapshotIdentifier:
+        from:
+          operation: RestoreDBClusterFromSnapshot
+          path: SnapshotIdentifier
     renames:
       operations:
         CreateDBCluster:

config/crd/bases/rds.services.k8s.aws_dbclusters.yaml

@@ -544,6 +544,14 @@ spec:
                   minCapacity:
                     type: number
                 type: object
+              snapshotIdentifier:
+                description: "The identifier for the DB snapshot or DB cluster snapshot
+                  to restore from. \n You can use either the name or the Amazon Resource
+                  Name (ARN) to specify a DB cluster snapshot. However, you can use
+                  only the ARN to specify a DB snapshot. \n Constraints: \n    * Must
+                  match the identifier of an existing Snapshot. \n Valid for: Aurora
+                  DB clusters and Multi-AZ DB clusters"
+                type: string
               sourceRegion:
                 description: SourceRegion is the source region where the resource
                   exists. This is not sent over the wire and is only used for presigning.

generator.yaml

@@ -192,7 +192,7 @@
       "type": "array",
       "items": {
         "type": "string",
-        "pattern": "^.*=.*$"
+        "pattern": "(^$|^.*=.*$)"
       }
     },
     "serviceAccount": {

helm/crds/rds.services.k8s.aws_dbclusters.yaml

@@ -20,9 +20,11 @@ import (
 
 	svcapitypes "github.com/aws-controllers-k8s/rds-controller/apis/v1alpha1"
 	ackcompare "github.com/aws-controllers-k8s/runtime/pkg/compare"
+	ackcondition "github.com/aws-controllers-k8s/runtime/pkg/condition"
 	ackrequeue "github.com/aws-controllers-k8s/runtime/pkg/requeue"
 	ackrtlog "github.com/aws-controllers-k8s/runtime/pkg/runtime/log"
 	svcsdk "github.com/aws/aws-sdk-go/service/rds"
+	corev1 "k8s.io/api/core/v1"
 )
 
 // NOTE(jaypipes): The below list is derived from looking at the RDS control
@@ -318,3 +320,32 @@ func equalStrings(a, b *string) bool {
 	}
 	return (*a == "" && b == nil) || *a == *b
 }
+
+// function to create restoreDbClusterFromSnapshot payload and call restoreDbClusterFromSnapshot API
+func (rm *resourceManager) restoreDbClusterFromSnapshot(
+	ctx context.Context,
+	r *resource,
+) (created *resource, err error) {
+	rlog := ackrtlog.FromContext(ctx)
+	exit := rlog.Trace("rm.restoreDbClusterFromSnapshot")
+	defer func(err error) { exit(err) }(err)
+
+	resp, respErr := rm.sdkapi.RestoreDBClusterFromSnapshotWithContext(ctx, rm.newRestoreDBClusterFromSnapshotInput(r))
+	rm.metrics.RecordAPICall("CREATE", "RestoreDbClusterFromSnapshot", respErr)
+	if respErr != nil {
+		return nil, respErr
+	}
+
+	rm.setResourceFromRestoreDBClusterFromSnapshotOutput(r, resp)
+	rm.setStatusDefaults(r.ko)
+
+	// We expect the DB cluster to be in 'creating' status since we just
+	// issued the call to create it, but I suppose it doesn't hurt to check
+	// here.
+	if clusterCreating(&resource{r.ko}) {
+		// Setting resource synced condition to false will trigger a requeue of
+		// the resource. No need to return a requeue error here.
+		ackcondition.SetSynced(&resource{r.ko}, corev1.ConditionFalse, nil, nil)
+	}
+	return &resource{r.ko}, nil
+}