rds: Bug in writer/reader definition of clusters

[lucabrunox]

Describe the bug

When creating a fresh cluster with readers and writer, one of the reader instances is effectively created before the writer and becomes the actual writer. So the opposite of what's written in the CDK code happens. This is a bug and it's reproducible.

Expected Behavior

The expected behavior is that the writer specified in CDK is indeed the writer when the cluster is created.

Current Behavior

The current behavior is that the writer becomes the reader, and viceversa, on a fresh cluster creation, which is the opposite of what's specified in CDK.

The CDK puts the writer instance first in CloudFormation, but that's not enough to guarantee that the first instance being created in the cluster because CloudFormation creates resources in parallel.

Reproduction Steps

Code:

import { App, RemovalPolicy, Stack, StackProps } from 'aws-cdk-lib';
import { InstanceClass, InstanceSize, InstanceType, SubnetType, Vpc } from 'aws-cdk-lib/aws-ec2';
import {
  AuroraMysqlEngineVersion,
  ClusterInstance,
  Credentials,
  DatabaseCluster,
  DatabaseClusterEngine,
} from 'aws-cdk-lib/aws-rds';

export class RDSReproduceStack extends Stack {
  constructor(parent: App, id: string, props: StackProps, vpc: Vpc) {
    super(parent, id, props);

    const cluster = new DatabaseCluster(this, 'testcluster', {
      clusterIdentifier: 'testcluster',
      engine: DatabaseClusterEngine.auroraMysql({ version: AuroraMysqlEngineVersion.VER_3_04_1 }),
      credentials: Credentials.fromGeneratedSecret('myuser', {}),
      writer: ClusterInstance.provisioned('writer', {
        instanceIdentifier: 'writer',
        instanceType: InstanceType.of(InstanceClass.BURSTABLE4_GRAVITON, InstanceSize.MEDIUM),
        publiclyAccessible: false,
      }),
      serverlessV2MinCapacity: 0.5,
      serverlessV2MaxCapacity: 1.0,
      readers: [
        ClusterInstance.serverlessV2('reader', {
          scaleWithWriter: true,
          publiclyAccessible: false,
        }),
      ],
      vpc: vpc,
      vpcSubnets: {
        subnetType: SubnetType.PRIVATE_WITH_EGRESS,
      },
      removalPolicy: RemovalPolicy.DESTROY,
    });
  }
}

Result, see in the image that the writer is the reader and viceversa, on a freshly created cluster:

Possible Solution

The possible solution is to add a dependency on the writer instance to all the reader instances here: https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-rds/lib/cluster.ts , to guarantee that the writer instance is the first instance being created in the cluster and thus become the writer.

Additional Information/Context

No response

CDK CLI Version

2.130.0

Framework Version

No response

Node.js Version

18

OS

Ubuntu

Language

TypeScript

Language Version

No response

Other information

No response

[pahud]

internal tracking: D132052101

[pahud]

Hi

According to this:

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

Lines 756 to 764 in 465c8ad

	// need to create the writer first since writer is determined by what instance is first
	const writer = props.writer!.bind(this, this, {
	monitoringInterval: props.monitoringInterval,
	monitoringRole: monitoringRole,
	removalPolicy: props.removalPolicy ?? RemovalPolicy.SNAPSHOT,
	subnetGroup: this.subnetGroup,
	promotionTier: 0, // override the promotion tier so that writers are always 0
	});
	instanceIdentifiers.push(writer.instanceIdentifier);

And this

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

Line 780 in 465c8ad

instanceIdentifiers.push(clusterInstance.instanceIdentifier);

The writer should be at the first position of the instanceIdentifiers and executes the bind() that provisions the instance. But actually there's no dependencies to ensure the first reader would create after the writer.

I think we still need to ensure the dependencies for them.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

[aws-cdk-automation]

Comments on closed issues and PRs are hard for our team to see. If you need help, please open a new issue that references this one.