feat(redshift): relocating a cluster by badmintoncryer · Pull Request #31993 · aws/aws-cdk

badmintoncryer · 2024-11-02T10:41:04Z

Issue # (if applicable)

None

Reason for this change

AWS Redshift supports for configuring relocation a cluster and this feature is supported by cfn.

Description of changes

Add availabilityZoneRelocation to CusterProps.

Documents says that this feature is not supported for DC2 node type.

Relocation isn't supported on DC2 instance families of products.

However, this feature is only supported for RA3 node type in actual.

Example implementation:

new redshift.Cluster(stack, 'Cluster', {
  vpc: vpc,
  masterUser: {
    masterUsername: 'admin',
  },
  availabilityZoneRelocation: true,
  nodeType: redshift.NodeType.DC2_LARGE,
});

Result:

Failed resources:
AzRelocationClusterStack | 6:52:00 PM | CREATE_FAILED        | AWS::Redshift::Cluster                      | Cluster (ClusterEB0386A7) Resource handler returned message: "If the cluster node type isn?t RA3, availability zone relocation isn?t supported. (Service: Redshift, Status Code: 400, Request ID: 6382b593-cce5-4fe5-b4de-de1ad1c3a604)" (RequestToken: 94c999d9-7b72-19c4-9cfe-154fe6abc717, HandlerErrorCode: GeneralServiceException)

So I added this validation.

    if (props.availabilityZoneRelocation && !nodeType.startsWith('ra3')) {
      throw new Error(`Availability zone relocation is supported for only RA3 node types, got: ${props.nodeType}`);
    }

Description of how you validated changes

Add both unit and integ tests.

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

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

pahud · 2024-11-02T11:00:32Z

packages/@aws-cdk/aws-redshift-alpha/lib/cluster.ts

+      throw new Error(`Availability zone relocation is supported for only RA3 node types, got: ${props.nodeType}`);
+    }
+
    this.cluster = new CfnCluster(this, 'Resource', {


Recommendation generated by Amazon CodeGuru Reviewer. Leave feedback on this recommendation by replying to the comment or by reacting to the comment using emoji.

Ensure that user activity logging is enabled for the Redshift cluster. This feature logs each query before it is executed on the cluster's database. To activate this, associate a Redshift Cluster Parameter Group with the enable_user_activity_logging parameter set to true.

I believe this feedback is inappropriate. This implementation is for existing L2 code, and to avoid breaking changes, we should not forcefully enable enable_user_activity_logging.

mazyu36

Thanks. Just one question.

mazyu36 · 2024-11-03T07:48:22Z

packages/@aws-cdk/aws-redshift-alpha/README.md

+
+By using [relocation in Amazon Redshift](https://docs.aws.amazon.com/redshift/latest/mgmt/managing-cluster-recovery.html), you allow Amazon Redshift to move a cluster to another Availability Zone (AZ) without any loss of data or changes to your applications.
+
+To enable this feature, set the `availabilityZoneRelocation` property to `true` when creating the cluster.


Just to clarify, relocation cannot be enabled after a cluster has been created?

It appears from the current README that relocation cannot be enabled after a cluster is created, but the documentation suggests that it should be possible to enable it post-creation.

https://docs.aws.amazon.com/redshift/latest/mgmt/managing-cluster-recovery.html#cluster-recovery-console

You're absolutely right. I've updated description.

By using [relocation in Amazon Redshift](https://docs.aws.amazon.com/redshift/latest/mgmt/managing-cluster-recovery.html), you allow Amazon Redshift to move a cluster to another Availability Zone (AZ) without any loss of data or changes to your applications. This feature can be applied to both new and existing clusters. To enable this feature, set the `availabilityZoneRelocation` property to `true`.

mazyu36

Thanks. LGTM.

Leo10Gama

Thanks for the contribution! Overall the changes look good, just one minor nit from me for an extra test.

To back your point about relocation only being on RA3 instance types, on top of the error message you encountered, it also seems like it's buried in the fourth paragraph of that documentation page:

Amazon Redshift cluster relocation is supported for the RA3 instance types only.

packages/@aws-cdk/aws-redshift-alpha/test/cluster.test.ts

Leo10Gama

Thanks for the response, LGTM!

Leo10Gama · 2024-11-12T17:39:50Z

@Mergifyio update

mergify · 2024-11-12T17:39:57Z

update

❌ Mergify doesn't have permission to update

Details

For security reasons, Mergify can't update this pull request. Try updating locally.
GitHub response: refusing to allow a GitHub App to create or update workflow .github/workflows/codecov.yml without workflows permission

Pull request has been modified.

codecov · 2024-11-12T17:56:56Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.28%. Comparing base (338d4c2) to head (8ed6b6e).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #31993   +/-   ##
=======================================
  Coverage   77.28%   77.28%           
=======================================
  Files         114      114           
  Lines        7628     7628           
  Branches     1360     1360           
=======================================
  Hits         5895     5895           
  Misses       1551     1551           
  Partials      182      182

Flag	Coverage Δ
suite.unit	`77.28% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
packages/aws-cdk	`77.28% <ø> (ø)`

aws-cdk-automation · 2024-11-12T18:11:14Z

AWS CodeBuild CI Report

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

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

mergify · 2024-11-12T18:11:39Z

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).

github-actions · 2024-11-12T18:12:04Z

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.

badmintoncryer added 3 commits November 2, 2024 19:08

az relocation

ece730e

update unit test

8bdb7fc

update readme

2d8359e

aws-cdk-automation requested a review from a team November 2, 2024 10:41

github-actions bot added p2 distinguished-contributor [Pilot] contributed 50+ PRs to the CDK labels Nov 2, 2024

badmintoncryer marked this pull request as ready for review November 2, 2024 10:51

pahud reviewed Nov 2, 2024

View reviewed changes

remove unnecessary file

dd6a2a9

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

mazyu36 reviewed Nov 3, 2024

View reviewed changes

update readme

7ba3988

mazyu36 approved these changes Nov 3, 2024

View reviewed changes

github-actions bot mentioned this pull request Nov 4, 2024

Weekly PR metrics report #32003

Closed

badmintoncryer added 2 commits November 4, 2024 21:12

Merge branch 'main' into azRelocation

5602dfe

Merge branch 'main' into azRelocation

17ee5b3

aws-cdk-automation added pr/needs-maintainer-review This PR needs a review from a Core Team Member and removed pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. labels Nov 4, 2024

Merge branch 'main' into azRelocation

cd51648

Leo10Gama self-assigned this Nov 6, 2024

Leo10Gama reviewed Nov 7, 2024

View reviewed changes

packages/@aws-cdk/aws-redshift-alpha/test/cluster.test.ts Show resolved Hide resolved

Leo10Gama previously approved these changes Nov 12, 2024

View reviewed changes

Merge branch 'main' into azRelocation

8ed6b6e

Leo10Gama approved these changes Nov 12, 2024

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Nov 12, 2024

mergify bot merged commit b763d86 into aws:main Nov 12, 2024

github-actions bot locked as resolved and limited conversation to collaborators Nov 12, 2024


		By using [relocation in Amazon Redshift](https://docs.aws.amazon.com/redshift/latest/mgmt/managing-cluster-recovery.html), you allow Amazon Redshift to move a cluster to another Availability Zone (AZ) without any loss of data or changes to your applications.

		To enable this feature, set the `availabilityZoneRelocation` property to `true` when creating the cluster.

Conversation

badmintoncryer commented Nov 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Issue # (if applicable)

Reason for this change

Description of changes

Description of how you validated changes

Checklist

Uh oh!

pahud Nov 2, 2024

Choose a reason for hiding this comment

Uh oh!

badmintoncryer Nov 2, 2024

Choose a reason for hiding this comment

Uh oh!

mazyu36 left a comment

Choose a reason for hiding this comment

Uh oh!

mazyu36 Nov 3, 2024

Choose a reason for hiding this comment

Uh oh!

badmintoncryer Nov 3, 2024

Choose a reason for hiding this comment

Uh oh!

mazyu36 left a comment

Choose a reason for hiding this comment

Uh oh!

Leo10Gama left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Leo10Gama left a comment

Choose a reason for hiding this comment

Uh oh!

Leo10Gama commented Nov 12, 2024

Uh oh!

mergify bot commented Nov 12, 2024

❌ Mergify doesn't have permission to update

Uh oh!

codecov bot commented Nov 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

aws-cdk-automation commented Nov 12, 2024

AWS CodeBuild CI Report

Uh oh!

mergify bot commented Nov 12, 2024

Uh oh!

github-actions bot commented Nov 12, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

badmintoncryer commented Nov 2, 2024 •

edited

Loading

codecov bot commented Nov 12, 2024 •

edited

Loading