feat(rds): support Aurora Serverless V2 instances #25437

corymhall · 2023-05-04T12:50:21Z

Adding support for adding aurora serverless v2 instances to a DatabaseCluster.

For detailed information on the design decisions see the adr

This PR adds a lot of validation to try and ensure that the user is configuring the cluster correctly.

It also adds some functionality that allows users to have an easier migration experience from the deprecated properties.

closes #20197

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

Starting off with just an ADR so that we can first agree on the approach we will take in this PR. Once that has been agreed upon then I will work on implementation. closes #20197

gitpod-io · 2023-05-04T12:50:31Z

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

packages/aws-cdk-lib/aws-rds/adr/aurora-serverless-v2.md

rix0rrr · 2023-05-04T14:04:32Z

packages/aws-cdk-lib/aws-rds/adr/aurora-serverless-v2.md

+pool of serverless readers with the appropriate cluster capacity range. Vertical
+scaling at the serverless instance level is much faster compared to launching


How the hell is that possible?

Using the example above for the db.r6g.4xlarge instance, if you had a single db.r6g.4xlarge reader instance and were using auto scaling then when the cluster scaled it would add another db.r6g.4xlarge instance which would take time. Alternatively you could provision 2 serverless readers with min=6.5/max=64. These serverless instances would scale up faster (with the read load split between them) faster than adding a new provisioned instance.

I added the above to the doc.

packages/aws-cdk-lib/aws-rds/adr/aurora-serverless-v2.md

rix0rrr · 2023-05-04T14:07:18Z

packages/aws-cdk-lib/aws-rds/adr/aurora-serverless-v2.md

+new rds.DatabaseCluster(this, 'Cluster', {
+  engine: rds.DatabaseClusterEngine.auroraMysql({ version: rds.AuroraMysqlEngineVersion.VER_3_03_0 }),
+  clusterInstances: {
+    writer: ClusterInstance.provisioned('writer'),


Surely provisioned needs more parameters. Are those elided for focus on this particular decision?

Yes, i'll update the example to atleast show that there are properties here.

rix0rrr · 2023-05-04T14:07:56Z

packages/aws-cdk-lib/aws-rds/adr/aurora-serverless-v2.md

+    readers: [
+      // puts it in promition tier 0-1
+      ClusterInstance.serverlessV2('reader1', { scaleWithWriter: true }),
+      ClusterInstance.serverlessV2('reader2'),


...and scaling parameters for the serverless instance?

Also: any thoughts on how we would incorporate groups/endpoints in here?

and scaling parameters for the serverless instance?

I'll update for this. You can't set scaling at the instance level though, you set it at the cluster level and it applies to all instances.

Also: any thoughts on how we would incorporate groups/endpoints in here?

My thought is that we could add a ClusterInstances.fromGroup or something like that once there is CloudFormation support.

Added both to the doc.

rix0rrr · 2023-05-04T14:10:31Z

packages/aws-cdk-lib/aws-rds/adr/aurora-serverless-v2.md

+The main consequence of this decision is maybe just some confusion on how
+to use the new properties vs the old ones and changing some property validation
+from linter to runtime validation (`instanceProps` was required and would show


I think @deprecation and updating the examples in the README should be sufficient.

rix0rrr · 2023-05-04T14:10:53Z

packages/aws-cdk-lib/aws-rds/adr/aurora-serverless-v2.md

+
+We can also provide instructions on how to migrate from `instanceProps` to
+`clusterInstances` which would just entail overwriting the logicalId of the
+instances. We could also add something like `ClusterInstance.fromInstanceProps(props: InstanceProps)`


👍 on the migration path

Co-authored-by: Rico Hermans <rix0rrr@gmail.com>

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

mergify · 2023-05-25T16:15:49Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

not ready yet

corymhall · 2023-05-25T17:14:43Z

packages/@aws-cdk-testing/framework-integ/test/aws-rds/test/integ.cluster-dual.ts

This test illustrates the migration path. The test migrated from the old config to the new config with no change in output.

corymhall · 2023-05-25T17:16:13Z

packages/@aws-cdk-testing/framework-integ/test/aws-rds/test/integ.cluster-rotation.lit.ts

-    instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE3, ec2.InstanceSize.SMALL),
-    vpc,
-  },
+  engine: rds.DatabaseClusterEngine.auroraMysql({


This update isn't really part of this feature, but I noticed that you can no longer create a provisioned cluster with DatabaseClusterEngine.AURORA because that uses mysql 5.6. It now assumes that you are trying to create a serverless cluster. Updated the test so that it actually deploys now.

corymhall · 2023-05-25T17:16:40Z

packages/@aws-cdk-testing/framework-integ/test/aws-rds/test/integ.cluster-s3.mysql-8.ts

updated without any change to snapshot.

corymhall · 2023-05-25T17:20:30Z

packages/aws-cdk-lib/aws-rds/lib/cluster.ts


    this.singleUserRotationApplication = props.engine.singleUserRotationApplication;
    this.multiUserRotationApplication = props.engine.multiUserRotationApplication;

-    const { subnetIds } = props.instanceProps.vpc.selectSubnets(props.instanceProps.vpcSubnets);
+    this.serverlessV2MaxCapacity = props.serverlessV2MaxCapacity ?? 2;


This matches the the default for provisioned (t3.small)

otaviomacedo · 2023-05-31T09:57:36Z

packages/aws-cdk-lib/aws-rds/lib/aurora-cluster-instance.ts

+  public static serverlessV2(id: string, props: ServerlessV2ClusterInstanceProps = {}): IClusterInstance {
+    return new ClusterInstance(id, {
+      ...props,
+      promotionTier: props.scaleWithWriter ? 1 : 2,


Should we give users the freedom to choose the promotion tier for reader instances? I don't know if this is an important use case, but I can think of a case in which, to save costs, you want to have a smaller instance with lower priority, for the rare case in which the writer and the high priority reader fail.

I thought about this and I decided to do it for provisioned instances, but for serverless I decided not to. The reason is that all serverless instances in the cluster have the same min/max capacity. The only difference is whether it is in tier 0-1 or 2-15. 0-1 means it will scale with the writer and 2-15 means it will not.

I think it would be easy enough to add in later if a use case comes up, but I can't think of one right now.

otaviomacedo · 2023-05-31T10:06:02Z

packages/aws-cdk-lib/aws-rds/lib/cluster.ts

+      throw new Error('serverlessV2MinCapacity must be >= 0.5 & <= 128');
+    }
+
+    if (this.serverlessV2MaxCapacity === 0.5 && this.serverlessV2MinCapacity === 0.5) {


Minor thing, but we should take the opportunity to also validate that min <= max.

otaviomacedo · 2023-05-31T10:07:50Z

packages/aws-cdk-lib/aws-rds/lib/cluster.ts

+      }
+    } else {
+      // TODO: add some info around serverless instance tiers and matching scaling
+      Annotations.of(this).addInfo('...');


I suppose this is still a work in progress, but calling your attention to this, just in case.

ahh forgot about that. I'll fix.

The PR is not a work in progress though it's ready for a final review 🚀

mergify · 2023-05-31T10:50:18Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

aws-cdk-automation · 2023-05-31T11:16:59Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: 7b4adb5
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2023-05-31T11:17:21Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

moltar · 2023-06-02T10:19:15Z

@corymhall Was there no way to preserve the IDs?

I've replaced instanceProps with:

      writer: ClusterInstance.serverlessV2('Instance', {
        publiclyAccessible: databaseEngine?.public,
        parameterGroup: this.parameterGroup,
      }),

And get a diff now, which means I'll have to re-create the instance when deploying:

    -     "ClusterInstance1448F06E4": Object {
    +     "ClusterInstanceAAE2C8BD": Object {
            "DeletionPolicy": "Delete",
            "Properties": Object {
              "DBClusterIdentifier": Object {
                "Ref": "ClusterEB0386A7",
              },
              "DBInstanceClass": "db.serverless",
              "DBParameterGroupName": Object {
                "Ref": "DatabaseWarehouseParameterGroupInstanceParameterGroupE36E617C",
    -         },
    -         "DBSubnetGroupName": Object {
    -           "Ref": "ClusterSubnetsDCFA5CB7",
              },
              "Engine": "aurora-postgresql",
    +         "PromotionTier": 0,
              "PubliclyAccessible": false,
            },

corymhall · 2023-06-05T09:59:22Z

@moltar there is a way to preserve the ids when migrating from provisioned => provisioned

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_rds-readme.html#migrating-from-instanceprops

I'm assuming that you instanceProps and then an escape hatch to change the instance class to serverless?

moltar · 2023-06-05T10:09:48Z

I'm assuming that you instanceProps and then an escape hatch to change the instance class to serverless?

I was using this solution:

#20197 (comment)

hertino76 · 2023-06-08T17:57:16Z

Was there no way to preserve the IDs when we migrated to Writer and Reader and use monitoringInterval? I've an already functional database.

I've replaced instanceProps according to the migration recommendations just changing the location of the properties like this:

` Code :

 let cluster = new rds.DatabaseCluster(scope, 'DBCluster', {
  clusterIdentifier: props.nomCluster,
  engine: rds.DatabaseClusterEngine.auroraMysql({ version: varVersion }),
  defaultDatabaseName: props.nomDB,
  credentials: rds.Credentials.fromSecret(this.dbSecret),
  parameterGroup: this.parameterGroupCluster,
  monitoringInterval: Duration.seconds(60),
  copyTagsToSnapshot: false,
  storageEncrypted: true,
  backtrackWindow: Duration.hours(6),
  backup: {
    retention: Duration.days(RetentionDays.ONE_WEEK),
    preferredWindow: '01:00-03:00',
  },
  cloudwatchLogsExports: ['audit'],
  preferredMaintenanceWindow: 'Sat:03:00-Sun:11:00',
  deletionProtection: true,
  removalPolicy: RemovalPolicy.RETAIN,
  vpc: props.vpc,
  vpcSubnets: props.vpcSubnetsData,
  securityGroups: [props.securityGroup],

  writer : rds.ClusterInstance.serverlessV2('instance1', {
    parameterGroup: this.parameterGroupInst,
    publiclyAccessible: false,
    autoMinorVersionUpgrade: true,
    allowMajorVersionUpgrade: false,
    enablePerformanceInsights: true
  }),  ...`

And I'm getting a difference with the MonitoringRole property, which means I'll have to re-create the instance when deploying.

petersendidit · 2023-06-08T18:21:53Z

packages/aws-cdk-lib/aws-rds/README.md

-    },
-    vpc,
+  credentials: rds.Credentials.fromGeneratedSecret('clusteradmin'), // Optional - will default to 'admin' username and generated password
+  writer: rds.ClusterInstance.provisioned('writer', {


I think this is missing some lines of code

My problem is another one, the code works, the instance is serverless and the secret key works, but with the new structure using writer and reader, the new version of my cdk application destroys the MonitoringRole and recreates the instances.

corymhall · 2023-06-12T10:28:11Z

For everyone commenting on this PR, can you please create new issues instead? It's hard to monitor and comment on closed PRs.

…stance.serverlessV2` (#26472) **Context** A recent feature release #25437 has added support for Aurora Serverless V2 cluster instances. This change also introduced a new approach for defining cluster instances, deprecating `instanceProps` in the process. The new approach uses `ClusterInstance.provisioned()` and `ClusterInstance.serverlessV2()` to define instances and their parameters on a per-instance basis. A migration flag `isFromLegacyInstanceProps` has also been added to the `ClusterInstance.provisioned()` constructor props to allow for migration to this new approach without destructive changes to the generated CFN template. **Bug** Because the `DatabaseCluster` construct has not previously had official support for Serverless V2 instances, the same migration flag has not been made available for `ClusterInstance.serverlessV2()`. This ignores the fact that many people have already provisioned serverless v2 instances using a common workaround described here #20197 (comment). People who have used this method previously have no clean migration path. This has been previously raised in #25942. **Fix** This fix simply exposes the `isFromLegacyInstanceProps` flag on **both** `ProvisionedClusterInstanceProps` and `ServerlessV2ClusterInstanceProps`. The behaviour for this flag is already implemented and applied across both instance types, so this is a type-only change. I have however added a test to capture this upgrade path for Serverless V2 instances from the common workaround. Closes #25942. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

…stance.serverlessV2` (aws#26472) **Context** A recent feature release aws#25437 has added support for Aurora Serverless V2 cluster instances. This change also introduced a new approach for defining cluster instances, deprecating `instanceProps` in the process. The new approach uses `ClusterInstance.provisioned()` and `ClusterInstance.serverlessV2()` to define instances and their parameters on a per-instance basis. A migration flag `isFromLegacyInstanceProps` has also been added to the `ClusterInstance.provisioned()` constructor props to allow for migration to this new approach without destructive changes to the generated CFN template. **Bug** Because the `DatabaseCluster` construct has not previously had official support for Serverless V2 instances, the same migration flag has not been made available for `ClusterInstance.serverlessV2()`. This ignores the fact that many people have already provisioned serverless v2 instances using a common workaround described here aws#20197 (comment). People who have used this method previously have no clean migration path. This has been previously raised in aws#25942. **Fix** This fix simply exposes the `isFromLegacyInstanceProps` flag on **both** `ProvisionedClusterInstanceProps` and `ServerlessV2ClusterInstanceProps`. The behaviour for this flag is already implemented and applied across both instance types, so this is a type-only change. I have however added a test to capture this upgrade path for Serverless V2 instances from the common workaround. Closes aws#25942. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

feat(rds): support Aurora Serverless V2 instances

f0ac86a

Starting off with just an ADR so that we can first agree on the approach we will take in this PR. Once that has been agreed upon then I will work on implementation. closes #20197

aws-cdk-automation requested a review from a team May 4, 2023 12:50

github-actions bot added effort/large Large work item – several weeks of effort feature-request A feature should be added or improved. p1 labels May 4, 2023

mergify bot added the contribution/core This is a PR that came from AWS. label May 4, 2023

aws-cdk-automation previously requested changes May 4, 2023

View reviewed changes

rix0rrr reviewed May 4, 2023

View reviewed changes

corymhall and others added 3 commits May 4, 2023 10:56

Update packages/aws-cdk-lib/aws-rds/adr/aurora-serverless-v2.md

c85fd89

Co-authored-by: Rico Hermans <rix0rrr@gmail.com>

Update packages/aws-cdk-lib/aws-rds/adr/aurora-serverless-v2.md

cd3894c

Co-authored-by: Rico Hermans <rix0rrr@gmail.com>

updating based on comments

f95067a

otaviomacedo previously approved these changes May 18, 2023

View reviewed changes

started working on it

ae00864

updates

20f1f9b

corymhall added 2 commits May 25, 2023 18:38

adding section on metrics

414ef4e

Merge branch 'main' into corymhall/rds/aurora-serverless-v2

1bcfebc

corymhall marked this pull request as ready for review May 25, 2023 18:45

aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label May 25, 2023

Merge branch 'main' into corymhall/rds/aurora-serverless-v2

1226706

corymhall commented May 26, 2023

View reviewed changes

corymhall added 3 commits May 26, 2023 16:46

fixing linting errors

0cf77ed

re-run integ test due to upstream changes

e98a724

Merge branch 'main' into corymhall/rds/aurora-serverless-v2

104e779

otaviomacedo reviewed May 31, 2023

View reviewed changes

fixing review comments

056d2a3

otaviomacedo approved these changes May 31, 2023

View reviewed changes

Merge branch 'main' into corymhall/rds/aurora-serverless-v2

7b4adb5

mergify bot merged commit fe5ed10 into aws:main May 31, 2023
7 checks passed

corymhall mentioned this pull request Jun 5, 2023

feat(rds): Support Multi AZ Database Clusters #25651

Closed

petersendidit reviewed Jun 8, 2023

View reviewed changes

moltar mentioned this pull request Jun 12, 2023

(rds): Aurora Serverless V2 instances are re-created when switching from a common workaround to an official solution #25942

Closed

filletofish mentioned this pull request Jul 2, 2023

feat(scheduler): ScheduleGroup #26196

Merged

dabrowne mentioned this pull request Jul 21, 2023

feat(rds): isFromLegacyInstanceProps migration flag with ClusterInstance.serverlessV2 #26472

Merged

plumdog mentioned this pull request Aug 11, 2023

aws-rds: deprecate writer and readers props for DatabaseCluster #26726

Open

neilferreira mentioned this pull request Jan 5, 2024

aws_rds: Add support for the Data API to DatabaseCluster construct #28574

Closed

2 tasks

		pool of serverless readers with the appropriate cluster capacity range. Vertical
		scaling at the serverless instance level is much faster compared to launching

feat(rds): support Aurora Serverless V2 instances #25437

feat(rds): support Aurora Serverless V2 instances #25437

Conversation

corymhall commented May 4, 2023 • edited

gitpod-io bot commented May 4, 2023

aws-cdk-automation left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mergify bot commented May 25, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mergify bot commented May 31, 2023

aws-cdk-automation commented May 31, 2023

AWS CodeBuild CI Report

mergify bot commented May 31, 2023

moltar commented Jun 2, 2023

corymhall commented Jun 5, 2023

moltar commented Jun 5, 2023

hertino76 commented Jun 8, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

corymhall commented Jun 12, 2023

corymhall commented May 4, 2023 •

edited

hertino76 commented Jun 8, 2023 •

edited