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.

Sign up for GitHub

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

feat(opensearchservice): support for MultiAZWithStandBy (under feature flag) #26082

Merged
merged 16 commits into from
Jul 17, 2023
Merged

feat(opensearchservice): support for MultiAZWithStandBy (under feature flag) #26082

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
50a2932
fix(opensearchservice): missing support for MultiAZWithStandBy feature
lpizzinidev Jun 22, 2023
7857cc3
fixed integration tests
lpizzinidev Jun 22, 2023
509ced2
Merge branch 'main' into gh-26026
lpizzinidev Jun 29, 2023
75db8ae
added integration test and ENABLE_OPENSEARCH_MULTIAZ_WITH_STANDBY fea…
lpizzinidev Jun 29, 2023
89d1ba4
Merge branch 'main' into gh-26026
lpizzinidev Jun 29, 2023
febc870
updated feature flag documentation
lpizzinidev Jun 29, 2023
9acc256
updated features unit test
lpizzinidev Jun 30, 2023
929d5be
Merge branch 'main' into gh-26026
lpizzinidev Jun 30, 2023
8bdac89
Merged main branch into gh-26026
lpizzinidev Jul 7, 2023
d7bdad8
Merge branch 'main' into gh-26026
lpizzinidev Jul 8, 2023
48cffdd
fixed feature flag default value
lpizzinidev Jul 8, 2023
46069b5
fixed unit test
lpizzinidev Jul 9, 2023
3f3c158
fixed integration tests
lpizzinidev Jul 10, 2023
94a07fc
Merge branch 'main' into gh-26026
mergify[bot] Jul 17, 2023
7f892c6
Merge branch 'main' into gh-26026
lpizzinidev Jul 17, 2023
d9d2142
fixed README
lpizzinidev Jul 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ...st/aws-appsync/test/integ.graphql-opensearch.js.snapshot/appsync-opensearch.template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"DedicatedMasterEnabled": false,
"InstanceCount": 1,
"InstanceType": "r5.large.search",
"MultiAZWithStandbyEnabled": false,
"ZoneAwarenessEnabled": false
},
"DomainEndpointOptions": {
Expand Down
1 change: 1 addition & 0 deletions ...ensearch.advancedsecurity.js.snapshot/cdk-integ-opensearch-advancedsecurity.template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"DedicatedMasterEnabled": false,
"InstanceCount": 1,
"InstanceType": "r5.large.search",
"MultiAZWithStandbyEnabled": false,
"ZoneAwarenessEnabled": false
},
"DomainEndpointOptions": {
Expand Down
1 change: 1 addition & 0 deletions ...ognitodashboardsauth.js.snapshot/cdk-integ-opensearch-cognitodashboardsauth.template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@
"DedicatedMasterEnabled": false,
"InstanceCount": 1,
"InstanceType": "r5.large.search",
"MultiAZWithStandbyEnabled": false,
"ZoneAwarenessEnabled": false
},
"CognitoOptions": {
Expand Down
1 change: 1 addition & 0 deletions ...g.opensearch.custom-kms-key.js.snapshot/cdk-integ-opensearch-custom-kms-key.template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
"DedicatedMasterEnabled": false,
"InstanceCount": 1,
"InstanceType": "r5.large.search",
"MultiAZWithStandbyEnabled": false,
"ZoneAwarenessEnabled": false
},
"DomainEndpointOptions": {
Expand Down
2 changes: 2 additions & 0 deletions ...ws-opensearchservice/test/integ.opensearch.js.snapshot/cdk-integ-opensearch.template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@
"DedicatedMasterEnabled": false,
"InstanceCount": 1,
"InstanceType": "r5.large.search",
"MultiAZWithStandbyEnabled": false,
"ZoneAwarenessEnabled": false
},
"DomainEndpointOptions": {
Expand Down Expand Up @@ -427,6 +428,7 @@
"DedicatedMasterEnabled": false,
"InstanceCount": 1,
"InstanceType": "r5.large.search",
"MultiAZWithStandbyEnabled": false,
"ZoneAwarenessEnabled": false
},
"DomainEndpointOptions": {
Expand Down
1 change: 1 addition & 0 deletions ...pensearchservice/test/integ.opensearch.min.js.snapshot/cdk-integ-opensearch.template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"DedicatedMasterEnabled": false,
"InstanceCount": 1,
"InstanceType": "r5.large.search",
"MultiAZWithStandbyEnabled": false,
"ZoneAwarenessEnabled": false
},
"DomainEndpointOptions": {
Expand Down
1 change: 1 addition & 0 deletions .../test/integ.opensearch.ultrawarm.js.snapshot/cdk-integ-opensearch-ultrawarm.template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"DedicatedMasterType": "r5.large.search",
"InstanceCount": 1,
"InstanceType": "r5.large.search",
"MultiAZWithStandbyEnabled": false,
"WarmCount": 2,
"WarmEnabled": true,
"WarmType": "ultrawarm1.medium.search",
Expand Down
1 change: 1 addition & 0 deletions ...search.unsignedbasicauth.js.snapshot/cdk-integ-opensearch-unsignedbasicauth.template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
"DedicatedMasterEnabled": false,
"InstanceCount": 1,
"InstanceType": "r5.large.search",
"MultiAZWithStandbyEnabled": false,
"ZoneAwarenessEnabled": false
},
"DomainEndpointOptions": {
Expand Down
1 change: 1 addition & 0 deletions ...earchservice/test/integ.opensearch.vpc.js.snapshot/cdk-integ-opensearch-vpc.template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -424,6 +424,7 @@
"DedicatedMasterEnabled": false,
"InstanceCount": 2,
"InstanceType": "r5.large.search",
"MultiAZWithStandbyEnabled": false,
"ZoneAwarenessConfig": {
"AvailabilityZoneCount": 2
},
Expand Down
11 changes: 11 additions & 0 deletions packages/aws-cdk-lib/aws-opensearchservice/lib/domain.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,14 @@ export interface CapacityConfig {
*/
readonly warmInstanceType?: string;

/**
* Indicates whether Multi-AZ with Standby deployment option is enabled.
* For more information, see [Multi-AZ with Standby]
* (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html#managedomains-za-standby)
*
* @default - false
*/
readonly multiAzWithStandbyEnabled?: boolean;
}

/**
Expand Down Expand Up @@ -1215,6 +1223,8 @@ export class Domain extends DomainBase implements IDomain, ec2.IConnectable {
const warmCount = props.capacity?.warmNodes ?? 0;
const warmEnabled = cdk.Token.isUnresolved(warmCount) ? true : warmCount > 0;

const multiAzWithStandbyEnabled = props.capacity?.multiAzWithStandbyEnabled ?? false;

const availabilityZoneCount =
props.zoneAwareness?.availabilityZoneCount ?? 2;

Expand Down Expand Up @@ -1556,6 +1566,7 @@ export class Domain extends DomainBase implements IDomain, ec2.IConnectable {
: undefined,
instanceCount,
instanceType,
multiAzWithStandbyEnabled,
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
multiAzWithStandbyEnabled,
multiAzWithStandbyEnabled: props.capacity?.multiAzWithStandbyEnabled,

I don't think there is any reason to explicitly set this to false.

Copy link
Contributor Author

@lpizzinidev lpizzinidev Jun 30, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

I've added a feature flag that defaults multiAzWithStandbyEnabled to true.
This is causing some integration tests to fail.
Let me know if the implementation is correct so I can proceed to fix the failing tests.

warmEnabled: warmEnabled
? warmEnabled
: undefined,
Expand Down
15 changes: 15 additions & 0 deletions packages/aws-cdk-lib/aws-opensearchservice/test/domain.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,6 +384,21 @@ each([testedOpenSearchVersions]).test('can use tokens in capacity configuration'
});
});

each([testedOpenSearchVersions]).test('can specify multiAZWithStandbyEnabled in capacity configuration', (engineVersion) => {
new Domain(stack, 'Domain', {
version: engineVersion,
capacity: {
multiAzWithStandbyEnabled: true,
},
});

Template.fromStack(stack).hasResourceProperties('AWS::OpenSearchService::Domain', {
ClusterConfig: {
MultiAZWithStandbyEnabled: true,
},
});
});

each([testedOpenSearchVersions]).describe('log groups', (engineVersion) => {

test('slowSearchLogEnabled should create a custom log group', () => {
Expand Down