Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(redshift): add details on cluster resizing #26928

Merged
merged 5 commits into from
Aug 30, 2023

Conversation

msambol
Copy link
Contributor

@msambol msambol commented Aug 30, 2023

I felt it best to keep most of the details in the linked documentation, but I believe this provides a good overview.

Closes #21103.


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

@aws-cdk-automation aws-cdk-automation requested a review from a team August 30, 2023 00:57
@github-actions github-actions bot added effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 repeat-contributor [Pilot] contributed between 3-5 PRs to the CDK labels Aug 30, 2023
@msambol msambol changed the title doc(redshift): add details on cluster resizing docs(redshift): add details on cluster resizing Aug 30, 2023

As your data warehousing needs change, it's possible to resize your Redshift cluster, but it's important to understand certain caveats.
Most importantly, if the cluster was deployed via CDK, the cluster should be resized via CDK so it's registered in the AWS CloudFormation template.
This ensures the `NumberOfNodes` parameter gets updated so the correct type of resize is done. There are two types of resize operations:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CFN has this as NumberOfNodes, CDK has it as numberOfNodes. I felt it best to be NumberOfNodes to represent the CFN template.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this whole sentence can be removed. Just noting that the resize has to be done via CloudFormation is a good reminder, no need to go into detail. You are saying "certain caveats". Are there more than one?

As for your casing example: as a rule, I would say that CDK documentation should stay in CDK-land, and not presume CloudFormation knowledge. I know this is not entirely achievable always, but that should be our goal. The point is moot though, again, I would remove the sentence.

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

As your data warehousing needs change, it's possible to resize your Redshift cluster, but it's important to understand certain caveats.
Most importantly, if the cluster was deployed via CDK, the cluster should be resized via CDK so it's registered in the AWS CloudFormation template.
This ensures the `NumberOfNodes` parameter gets updated so the correct type of resize is done. There are two types of resize operations:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this whole sentence can be removed. Just noting that the resize has to be done via CloudFormation is a good reminder, no need to go into detail. You are saying "certain caveats". Are there more than one?

As for your casing example: as a rule, I would say that CDK documentation should stay in CDK-land, and not presume CloudFormation knowledge. I know this is not entirely achievable always, but that should be our goal. The point is moot though, again, I would remove the sentence.

Comment on lines 553 to 556
* Elastic resize - You can add nodes to or remove nodes from the cluster. Also, you can change the node type, such as from DS2 nodes to RA3 nodes.
AWS recommmends elastic resize as the first option, as it's a fast operation and typically completes in minutes. Elastic resize is appropriate when you:
* Add or reduce nodes in your existing cluster, but don't change the node type.
* Change the node type of your cluster.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It sounds like elastic resize applies when you change the node count, or the node type, but not both at the same time. Is that a fair summarization?

Comment on lines 558 to 559
* Classic resize - Number of nodes, node type, or both, can be changed. This operation takes longer to complete, but is useful when the resize operation
doesn't meet the criteria of an elastic resize. See [AWS Knowledge Center](https://repost.aws/knowledge-center/redshift-troubleshoot-elastic-resize) for further conditions that require classic resizing.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It feels a bit like teasing to say "see this other place for the conditions". Can you summarize? Or is it by exclusion, everything that's not an elastic resize is a classic resize?

Also, do people have to do anything to their code to pick one or the other resize? Please explain if they do or do not.

Copy link
Contributor Author

@msambol msambol Aug 30, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added more details on conditions and clarified that elastic is default but there is an option to set classic 👍🏼

@aws-cdk-automation aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Aug 30, 2023
@mergify mergify bot dismissed rix0rrr’s stale review August 30, 2023 14:27

Pull request has been modified.

@msambol msambol force-pushed the redshift-resizing branch 6 times, most recently from a2dae5a to 3cd45a6 Compare August 30, 2023 14:42
@msambol
Copy link
Contributor Author

msambol commented Aug 30, 2023

@rix0rrr Thanks for the feedback! Updated per your comments.

@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Aug 30, 2023
Copy link
Contributor

@rix0rrr rix0rrr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👨‍🍳👌

@mergify
Copy link
Contributor

mergify bot commented Aug 30, 2023

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 aws-cdk-automation removed the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Aug 30, 2023
@mergify
Copy link
Contributor

mergify bot commented Aug 30, 2023

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
Copy link
Collaborator

AWS CodeBuild CI Report

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

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

@mergify mergify bot merged commit ed0b5c0 into aws:main Aug 30, 2023
9 checks passed
@mergify
Copy link
Contributor

mergify bot commented Aug 30, 2023

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

@msambol msambol deleted the redshift-resizing branch August 30, 2023 18:09
mikewrighton pushed a commit that referenced this pull request Sep 14, 2023
I felt it best to keep most of the details in the linked documentation, but I believe this provides a good overview.

Closes #21103.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort/medium Medium work item – several days of effort feature-request A feature should be added or improved. p2 repeat-contributor [Pilot] contributed between 3-5 PRs to the CDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(redshift): document the resizing operation
3 participants