always ApplyImmediately for DBCluster/Instance (#20)

Sets the ApplyImmediately field in the ModifyDBInstance and
ModifyDBCluster API Input shapes to always be `true`, enabling immediate
modification of the DB cluster or instance.

Issue aws-controllers-k8s/community#865

By submitting this pull request, I confirm that my contribution is made under
the terms of the Apache 2.0 license.

Author: jaypipes

apis/v1alpha1/ack-generate-metadata.yaml

@@ -1,14 +1,14 @@
 ack_generate_info:
-  build_date: "2021-07-19T15:18:11Z"
+  build_date: "2021-07-19T15:47:38Z"
   build_hash: c77aa9c75d944952dee198029ba9822691cd82b0
   go_version: go1.15.5 linux/amd64
   version: v0.6.0
 api_directory_checksum: c2500a34cb9377122cf5382a6456812006d8261b
 api_version: v1alpha1
 aws_sdk_go_version: ""
 generator_config_info:
-  file_checksum: 39e5c7eb8d1a39ab0a1c27e9185f412972ce84be
+  file_checksum: bb80f830d61e1a1c6016fde6102463862f9dc8dd
   original_file_name: generator.yaml
 last_modification:
   reason: API generation
-  timestamp: 2021-07-19 15:18:16.161125161 +0000 UTC
+  timestamp: 2021-07-19 15:47:43.42123851 +0000 UTC

apis/v1alpha1/generator.yaml

@@ -18,12 +18,40 @@ ignore:
     - OptionGroup
   field_paths:
 operations:
+  ModifyDBCluster:
+    override_values:
+      # The whole concept of a "maintenance window" isn't aligned with the
+      # declarative state model in Kubernetes. Users should build "maintenance
+      # window" functionality at a higher layer than the APIs that manage the
+      # lifecycle of individual resources like a DB cluster or DB instance. For
+      # example, users can build maintenance window functionality into their
+      # deployment pipeline solution or GitOps solution.
+      #
+      # We override the value of the ApplyImmediately field in the modify
+      # operations to "true" because we want changes that a Kubernetes user
+      # makes to a resource's Spec to be reconciled by the ACK service
+      # controller, not a different service.
+      ApplyImmediately: true
   DeleteDBCluster:
     override_values:
       # Clearly this is not ideal, but will suffice until we add custom hook
       # points to the build_request methods to enable a genmeration of the
       # final snapshot identifier to use.
       SkipFinalSnapshot: true
+  ModifyDBInstance:
+    override_values:
+      # The whole concept of a "maintenance window" isn't aligned with the
+      # declarative state model in Kubernetes. Users should build "maintenance
+      # window" functionality at a higher layer than the APIs that manage the
+      # lifecycle of individual resources like a DB cluster or DB instance. For
+      # example, users can build maintenance window functionality into their
+      # deployment pipeline solution or GitOps solution.
+      #
+      # We override the value of the ApplyImmediately field in the modify
+      # operations to "true" because we want changes that a Kubernetes user
+      # makes to a resource's Spec to be reconciled by the ACK service
+      # controller, not a different service.
+      ApplyImmediately: true
   DeleteDBInstance:
     override_values:
       # Clearly this is not ideal, but will suffice until we add custom hook

generator.yaml

@@ -18,12 +18,40 @@ ignore:
     - OptionGroup
   field_paths:
 operations:
+  ModifyDBCluster:
+    override_values:
+      # The whole concept of a "maintenance window" isn't aligned with the
+      # declarative state model in Kubernetes. Users should build "maintenance
+      # window" functionality at a higher layer than the APIs that manage the
+      # lifecycle of individual resources like a DB cluster or DB instance. For
+      # example, users can build maintenance window functionality into their
+      # deployment pipeline solution or GitOps solution.
+      #
+      # We override the value of the ApplyImmediately field in the modify
+      # operations to "true" because we want changes that a Kubernetes user
+      # makes to a resource's Spec to be reconciled by the ACK service
+      # controller, not a different service.
+      ApplyImmediately: true
   DeleteDBCluster:
     override_values:
       # Clearly this is not ideal, but will suffice until we add custom hook
       # points to the build_request methods to enable a genmeration of the
       # final snapshot identifier to use.
       SkipFinalSnapshot: true
+  ModifyDBInstance:
+    override_values:
+      # The whole concept of a "maintenance window" isn't aligned with the
+      # declarative state model in Kubernetes. Users should build "maintenance
+      # window" functionality at a higher layer than the APIs that manage the
+      # lifecycle of individual resources like a DB cluster or DB instance. For
+      # example, users can build maintenance window functionality into their
+      # deployment pipeline solution or GitOps solution.
+      #
+      # We override the value of the ApplyImmediately field in the modify
+      # operations to "true" because we want changes that a Kubernetes user
+      # makes to a resource's Spec to be reconciled by the ACK service
+      # controller, not a different service.
+      ApplyImmediately: true
   DeleteDBInstance:
     override_values:
       # Clearly this is not ideal, but will suffice until we add custom hook

pkg/resource/db_cluster/sdk.go

@@ -3,6 +3,7 @@ kind: DBCluster
 metadata:
   name: $DB_CLUSTER_ID
 spec:
+  copyTagsToSnapshot: $COPY_TAGS_TO_SNAPSHOT
   dbClusterIdentifier: $DB_CLUSTER_ID
   databaseName: $DB_NAME
   engine: aurora-mysql

pkg/resource/db_instance/sdk.go

@@ -4,6 +4,7 @@ metadata:
   name: $DB_INSTANCE_ID
 spec:
   allocatedStorage: 20
+  copyTagsToSnapshot: $COPY_TAGS_TO_SNAPSHOT
   dbInstanceClass: db.t3.micro
   dbInstanceIdentifier: $DB_INSTANCE_ID
   engine: postgres

test/e2e/resources/db_cluster_mysql_serverless.yaml

@@ -36,6 +36,8 @@
 CREATE_INTERVAL_SLEEP_SECONDS = 15
 CREATE_TIMEOUT_SECONDS = 600
 
+MODIFY_WAIT_AFTER_SECONDS = 20
+
 
 @pytest.fixture(scope="module")
 def rds_client():
@@ -66,6 +68,7 @@ def test_create_delete_mysql_serverless(
         mup_sec_ns, mup_sec_name, mup_sec_key = master_user_pass_secret
 
         replacements = REPLACEMENT_VALUES.copy()
+        replacements['COPY_TAGS_TO_SNAPSHOT'] = "False"
         replacements["DB_CLUSTER_ID"] = db_cluster_id
         replacements["DB_NAME"] = db_name
         replacements["MASTER_USER_PASS_SECRET_NAMESPACE"] = mup_sec_ns
@@ -104,6 +107,22 @@ def test_create_delete_mysql_serverless(
             assert len(aws_res['DBClusters']) == 1
             dbc_rec = aws_res['DBClusters'][0]
 
+        # We're now going to modify the CopyTagsToSnapshot field of the DB
+        # instance, wait some time and verify that the RDS server-side resource
+        # shows the new value of the field.
+        assert dbc_rec['CopyTagsToSnapshot'] == False
+        updates = {
+            "spec": {"copyTagsToSnapshot": True},
+        }
+        k8s.patch_custom_resource(ref, updates)
+        time.sleep(MODIFY_WAIT_AFTER_SECONDS)
+
+        aws_res = rds_client.describe_db_clusters(DBClusterIdentifier=db_cluster_id)
+        assert aws_res is not None
+        assert len(aws_res['DBClusters']) == 1
+        dbc_rec = aws_res['DBClusters'][0]
+        assert dbc_rec['CopyTagsToSnapshot'] == True
+
         # Delete the k8s resource on teardown of the module
         k8s.delete_custom_resource(ref)
 
@@ -126,4 +145,3 @@ def test_create_delete_mysql_serverless(
                     pytest.fail("Status is not 'deleting' for DB cluster that was deleted. Status is "+dbc_rec['Status'])
             except rds_client.exceptions.DBClusterNotFoundFault:
                 break
-

test/e2e/resources/db_instance_postgres13_t3_micro.yaml

@@ -40,6 +40,7 @@
 # Time to wait before we get to an expected `available` state.
 CREATE_TIMEOUT_SECONDS = 600
 
+MODIFY_WAIT_AFTER_SECONDS = 20
 
 @pytest.fixture(scope="module")
 def rds_client():
@@ -60,7 +61,7 @@ def master_user_pass_secret():
 @service_marker
 @pytest.mark.canary
 class TestDBInstance:
-    def test_create_delete_postgres13_t3_micro(
+    def test_crud_postgres13_t3_micro(
             self,
             rds_client,
             master_user_pass_secret,
@@ -69,6 +70,7 @@ def test_create_delete_postgres13_t3_micro(
         mup_sec_ns, mup_sec_name, mup_sec_key = master_user_pass_secret
 
         replacements = REPLACEMENT_VALUES.copy()
+        replacements['COPY_TAGS_TO_SNAPSHOT'] = "False"
         replacements["DB_INSTANCE_ID"] = db_id
         replacements["MASTER_USER_PASS_SECRET_NAMESPACE"] = mup_sec_ns
         replacements["MASTER_USER_PASS_SECRET_NAME"] = mup_sec_name
@@ -108,6 +110,22 @@ def test_create_delete_postgres13_t3_micro(
             assert len(aws_res['DBInstances']) == 1
             dbi_rec = aws_res['DBInstances'][0]
 
+        # We're now going to modify the CopyTagsToSnapshot field of the DB
+        # instance, wait some time and verify that the RDS server-side resource
+        # shows the new value of the field.
+        assert dbi_rec['CopyTagsToSnapshot'] == False
+        updates = {
+            "spec": {"copyTagsToSnapshot": True},
+        }
+        k8s.patch_custom_resource(ref, updates)
+        time.sleep(MODIFY_WAIT_AFTER_SECONDS)
+
+        aws_res = rds_client.describe_db_instances(DBInstanceIdentifier=db_id)
+        assert aws_res is not None
+        assert len(aws_res['DBInstances']) == 1
+        dbi_rec = aws_res['DBInstances'][0]
+        assert dbi_rec['CopyTagsToSnapshot'] == True
+
         # Delete the k8s resource on teardown of the module
         k8s.delete_custom_resource(ref)