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

chore(opensearchservice): t3 instance type does not support Multi-AZ with standby feature #29607

Merged
merged 4 commits into from
Mar 28, 2024

Conversation

tmokmss
Copy link
Contributor

@tmokmss tmokmss commented Mar 25, 2024

Issue # (if applicable)

Related with #26026

Reason for this change

#26082 enabled Multi-AZ with Standby by default, but deployment fails if we use t3 instance type, because it does not support the feature. To fail fast, this PR adds validation on synth time.

Multi-AZ with Standby only works with the m5, c5, r5, r6g, c6g, m6g, r6gd and i3 instance types.
https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html

You can use T3 instance types only if your domain is provisioned without standby.
https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html#latest-gen

Description of changes

If the instance type of data node or master node is t3, throws an error.

I also considered to automatically set multiAzWithStandbyEnabled: false if we detect any t3 instance type, but it would introduce unwanted behavior e.g. in the below case:

// Initial state
// multiAzWithStandbyEnabled: true as there's no t3 instance type
 new Domain(stack, 'Domain', {
    version: engineVersion,
    capacity: {
      dataNodeInstanceType: 'r5.large.search',
    },
})

// Update domain to add master nodes with t3 instance type
new Domain(stack, 'Domain', {
    version: engineVersion,
    capacity: {
      dataNodeInstanceType: 'r5.large.search',
      masterNodeInstanceType: 't3.medium.search',
      masterNodes: 3,
    },
})

// multiAzWithStandbyEnabled suddenly become false!

so we just throw an error.

Description of how you validated changes

Added some unit tests.

I also confirmed that it results in deployment error if we try to deploy with t3 instance type & multiAzWithStandbyEnabled : true for both data node and master node.

Checklist


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

@github-actions github-actions bot added p2 star-contributor [Pilot] contributed between 25-49 PRs to the CDK labels Mar 25, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team March 25, 2024 15:25
Copy link
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

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

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.

@tmokmss tmokmss changed the title chore(opensearchservice): T3 instance type does not support Multi-AZ with standby feature chore(opensearchservice): t3 instance type does not support Multi-AZ with standby feature Mar 25, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review March 25, 2024 15:38

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

@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 Mar 25, 2024
Copy link
Contributor

@go-to-k go-to-k left a comment

Choose a reason for hiding this comment

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

From what I can see in the management console, OR1 and Im4gn instance types are apparently supported in the Multi-AZ with standby as well.

I selected "Domain with standby" and was able to select both OR1 and Im4gn. I also confirmed that t3 cannot be selected for "Domain with standby", and the t3 can be selected for "Domain without standby" (with the "Include previous generation instance types" toggle).

(Note that I did not actually create the domain.)

#26026 (comment)

open-search-console

packages/aws-cdk-lib/aws-opensearchservice/lib/domain.ts Outdated Show resolved Hide resolved
@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 Mar 27, 2024
@tmokmss
Copy link
Contributor Author

tmokmss commented Mar 27, 2024

Thanks @go-to-k!

Copy link
Contributor

@go-to-k go-to-k left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks @tmokmss

@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Mar 27, 2024
Copy link
Contributor

@GavinZZ GavinZZ left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for contributing.

Copy link
Contributor

mergify bot commented Mar 28, 2024

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-maintainer-review This PR needs a review from a Core Team Member label Mar 28, 2024
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 2c4596d
  • 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 8a7c5c8 into aws:main Mar 28, 2024
12 checks passed
Copy link
Contributor

mergify bot commented Mar 28, 2024

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

@tmokmss tmokmss deleted the no-multiaz-standby-with-t3 branch March 28, 2024 23:32
This was referenced Apr 1, 2024
@aws aws locked as resolved and limited conversation to collaborators Jul 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
p2 star-contributor [Pilot] contributed between 25-49 PRs to the CDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants