Skip to content

feat(opensearch): rebrand Elasticsearch as OpenSearch#16517

Merged
mergify[bot] merged 2 commits intoreleasefrom
chaimber/opensearch_rebrand_copy
Sep 16, 2021
Merged

feat(opensearch): rebrand Elasticsearch as OpenSearch#16517
mergify[bot] merged 2 commits intoreleasefrom
chaimber/opensearch_rebrand_copy

Conversation

@BenChaimberg
Copy link
Copy Markdown
Contributor

See individual commit messages.


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

Amazon Elasticsearch Service is being rebranded to Amazon OpenSearch Service. All customer-facing references to Elasticsearch within AWS CDK must be replaced with their OpenSearch equivalent, including documentation and API. To avoid breaking existing customers, all API changes will be implemented as a deprecation of the old API and introduction of a new, rebranded API.

Concretely, this change consists of the following:

- add a disclaimer at the top of the @aws-cdk/aws-elasticsearch module README about the rebranding
- add migration instructions to the @aws-cdk/aws-elasticsearch module README
- introduce the @aws-cdk/aws-opensearch module
  - copy all files from the Elasticsearch module
  - uses new AWS::OpenSearch::Domain resource. CFN guarantees a no-replacement update when a resource moves from AWS::Elasticsearch::Domain to AWS::OpenSearch::Domain, meaning customers should be able to move from the old CDK module to the new one with no downtime.
  - rename DomainProps.cognitoKibanaAuth -> DomainProps.cognitoDashboardsAuth
  - replaces ElasticsearchVersion with OpenSearchVersion
    - ElasticsearchVersion.V{major}_{minor} -> OpenSearchVersion.ELASTICSEARCH_{major}_{minor}
    - ElasticsearchVersion.of(version: string) -> OpenSearchVersion.elasticsearch(version: string)
    - introduces OpenSearchVersion.OPENSEARCH_1_0 and OpenSearchVersion.openSearch(version: string)
  - replace .elasticsearch instance suffix with .search
  - rename logical ID and type of a custom resource (Custom::ElasticsearchAccessPolicy -> Custom::OpenSearchAccessPolicy) that we generate to update the domain's access policy. This will cause a resource replacement, which will avoid a CloudFormation error (Update of resource type is not permitted) for stacks that switch modules

Closes #16467
@BenChaimberg BenChaimberg added @aws-cdk/aws-elasticsearch Related to Amazon Elasticsearch Service pr/no-squash This PR should be merged instead of squash-merging it labels Sep 16, 2021
@BenChaimberg BenChaimberg requested a review from a team September 16, 2021 22:45
@BenChaimberg BenChaimberg self-assigned this Sep 16, 2021
@gitpod-io
Copy link
Copy Markdown

gitpod-io bot commented Sep 16, 2021

@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Sep 16, 2021
@aws-cdk-automation
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
  • Commit ID: aa572eb
  • 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 fad855e into release Sep 16, 2021
@mergify mergify bot deleted the chaimber/opensearch_rebrand_copy branch September 16, 2021 23:43
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Sep 16, 2021

Thank you for contributing! Your pull request will be automatically updated and merged without squashing (do not update manually, and be sure to allow changes to be pushed to your fork).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

@aws-cdk/aws-elasticsearch Related to Amazon Elasticsearch Service contribution/core This is a PR that came from AWS. pr/no-squash This PR should be merged instead of squash-merging it

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants