feat(consumption-opensearch): opensearch api as separate construct #694
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vgkowski
changed the title
lmouhib
force-pushed
the
feat/opensearch-api
branch
from
bec0a8a
to
2bd8d2e
Compare
lmouhib
requested changes
Aug 16, 2024
lmouhib
requested changes
Aug 25, 2024
lmouhib
force-pushed
the
feat/opensearch-api
branch
from
7f0bcbe
to
e211526
Compare
lmouhib
changed the title
lmouhib
force-pushed
the
feat/opensearch-api
branch
from
07ee0ba
to
99fa4b4
Compare
github-actions
bot
added
e2e-testing
lmouhib
added
e2e-ready
github-actions
bot
added
e2e-testing
lmouhib
requested changes
Sep 15, 2024
lmouhib
force-pushed
the
feat/opensearch-api
branch
from
7e95dbe
to
ef909fa
Compare
lmouhib
requested changes
Sep 26, 2024
| @@ -8,23 +8,22 @@ class ExampleOpenSearchApiStack extends cdk.Stack { | |||
| constructor(scope: Construct, id: string , props:cdk.StackProps) { | |||
|
|
|||
| super(scope, id, props); | |||
| this.node.setContext('@data-solutions-framework-on-aws/removeDataOnDestroy', true); | |||
| /// !show | |||
| const osCluster = new dsf.consumption.OpenSearchCluster(this, 'MyOpenSearchCluster',{ | |||
There was a problem hiding this comment.
Can you change this to how the construct should be initialized, and not testing it through the openseach cluster construct. We have an example on kafka-api unit tests kafka-api.test.ts
|
|
||
| The construct leverages the [CDK Provider Framework](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.custom_resources-readme.html#provider-framework) to deploy a custom resource to manage, and provide `addRoleMapping` and `callOpenSearchApi` methods. Both methods return the custom resource so that allows to enforce sequental execution of the API calls. By default all API calls will be executed simultaneously and are independent of each other. | ||
|
|
||
| [example OpenSearch API](examples/opensearch-api.lit.ts) |
There was a problem hiding this comment.
Can you provide a dummy example without initializing the actual OS cluster with construct, but provide how to initialize the OS-api construct.
| [OpenSearch Roles API](https://opensearch.org/docs/2.13/security/access-control/api#create-role-mapping) does not allow to update individual roles, requiring to pass array of roles that needs to be applied. | ||
| To avoid overwriting prevously added roles `addRoleMapping` method provides `persist` parameter to store previously added roles inside the construct. To avoid racing conditions you also need to execute multiple `addRoleMapping` calls sequentionally as shown below. | ||
|
|
||
| ```typescript |
There was a problem hiding this comment.
Can you provide this through an example lit file.
lmouhib
force-pushed
the
feat/opensearch-api
branch
from
8386018
to
539c6cb
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
Description of changes:
Checklist
fix:,feat:,docs:, ...)Breaking change checklist
RFC issue #:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.