Adding support and examples for AOSS #216

VachaShah · 2023-01-17T19:36:38Z

Signed-off-by: Vacha Shah vachshah@amazon.com

Description

Adding support and examples for AOSS.

Issues Resolved

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

dblock · 2023-01-17T19:49:59Z

I fully expect this not to be needed soon for AOSS, this is work in progress server-side.

dblock · 2023-01-17T20:23:35Z

The root API will be (re)added to OpenSearch Serverless.

I propose we remove the product check altogether, similar to opensearch-project/opensearch-ruby#130. We try to do a version check to see if the client is compatible with the server. I believe this was inherited from Elastic that was trying to maintain some sense of version compatibility without semver, but since we follow semver it's easy to know now whether your client will work against a server or not. My concern is that a version request every single time a new instance of a client is created is not insignificant overhead (in a web app example this could end up making a root request every time a web app serves a client search request!), and is an unexpected side effect when users try to use the client.

VachaShah · 2023-01-18T23:37:16Z

I fully expect this not to be needed soon for AOSS, this is work in progress server-side.

Sounds good! I removed the content-length change from this PR.

VachaShah · 2023-01-18T23:37:50Z

The root API will be (re)added to OpenSearch Serverless.

I propose we remove the product check altogether, similar to opensearch-project/opensearch-ruby#130. We try to do a version check to see if the client is compatible with the server. I believe this was inherited from Elastic that was trying to maintain some sense of version compatibility without semver, but since we follow semver it's easy to know now whether your client will work against a server or not. My concern is that a version request every single time a new instance of a client is created is not insignificant overhead (in a web app example this could end up making a root request every time a web app serves a client search request!), and is an unexpected side effect when users try to use the client.

Sure! I removed the product info check altogether.

VachaShah · 2023-01-18T23:40:40Z

@dblock This is ready for review.

dblock

I think we should make a separate PR with an entry that removes the version check, so we can make it very visible. Should we major increment version, too?

For docs I'd say managed and serverless work the same and the only thing you want to change is the service signing name. Let's say that in the user guide?

dblock · 2023-01-19T23:54:14Z

USER_GUIDE.md

+	- [How to use IAMs as authentication method](#how-to-use-iams-as-authentication-method)
+			- [AWS SDK V1](#aws-sdk-v1)
+			- [AWS SDK V2](#aws-sdk-v2)
+			- [AWS SDK V2 with OpenSearch Serverless](#aws-sdk-v2-with-opensearch-serverless)


Tabs vs. spaces? 🤔

My bad, fixed

dblock · 2023-01-19T23:54:58Z

USER_GUIDE.md

@@ -283,3 +286,91 @@ func main() {
 }

 ```
+
+#### AWS SDK V2 with OpenSearch Serverless


We should merge the managed and serverless portions, these are the same now no?

Combined them.

VachaShah · 2023-01-20T06:41:08Z

I think we should make a separate PR with an entry that removes the version check, so we can make it very visible. Should we major increment version, too?

For docs I'd say managed and serverless work the same and the only thing you want to change is the service signing name. Let's say that in the user guide?

Sure! Created a separate PR #219 for removing the version check and incrementing the version.
Updated the user guide.

dblock

Looks good! I have some potential nits for docs, feel free to ignore them and merge.

USER_GUIDE.md

Signed-off-by: Vacha Shah <vachshah@amazon.com>

VachaShah · 2023-01-21T01:47:52Z

@dblock I addressed the comments for documentation, it needs your approval once more.

VijayanB · 2023-01-21T05:38:50Z

USER_GUIDE.md

+	mapping := strings.NewReader(`{
+	 "settings": {
+	   "index": {
+	        "number_of_shards": 4
+	        }
+	      }
+	 }`)


Where is this mapping used?

My bad, I added its usage

VijayanB · 2023-01-21T05:41:37Z

signer/awsv2/sdkv2signer.go

@@ -68,6 +68,7 @@ func (s *awsSdkV2Signer) SignRequest(r *http.Request) error {
 	}

 	hash, err := hexEncodedSha256OfRequest(r)
+	r.Header.Set("X-Amz-Content-Sha256", hash)


nit: Shall we move this to constant?

Since its just used here, I kept it as a string

Signed-off-by: Vacha Shah <vachshah@amazon.com>

VachaShah · 2023-01-21T06:04:14Z

@VijayanB @dblock Review again please?

VachaShah force-pushed the aoss branch 2 times, most recently from 426f540 to 64e573a Compare January 18, 2023 23:36

VachaShah changed the title ~~[WIP] Removing content-length for signed headers to support AOSS~~ [WIP] Adding support and examples for AOSS Jan 18, 2023

VachaShah changed the title ~~[WIP] Adding support and examples for AOSS~~ Adding support and examples for AOSS Jan 18, 2023

VachaShah marked this pull request as ready for review January 18, 2023 23:40

VachaShah requested a review from svencowart as a code owner January 18, 2023 23:40

VachaShah requested a review from dblock January 18, 2023 23:50

dblock requested changes Jan 19, 2023

View reviewed changes

VachaShah mentioned this pull request Jan 20, 2023

Removing info call before performing requests #219

Merged

VachaShah force-pushed the aoss branch from 6ace457 to 635edb2 Compare January 20, 2023 06:39

VachaShah requested a review from VijayanB as a code owner January 20, 2023 06:39

VachaShah requested a review from dblock January 20, 2023 06:41

dblock previously approved these changes Jan 20, 2023

View reviewed changes

USER_GUIDE.md Show resolved Hide resolved

USER_GUIDE.md Outdated Show resolved Hide resolved

USER_GUIDE.md Outdated Show resolved Hide resolved

USER_GUIDE.md Outdated Show resolved Hide resolved

VachaShah added 4 commits January 20, 2023 19:58

Adding x-amzn-content-sha256 header for signed requests

9bfd707

Signed-off-by: Vacha Shah <vachshah@amazon.com>

Adding examples in user guide

d19782f

Signed-off-by: Vacha Shah <vachshah@amazon.com>

Adding CHANGELOG entry

43a8fc8

Signed-off-by: Vacha Shah <vachshah@amazon.com>

Addressing comments

a54809d

Signed-off-by: Vacha Shah <vachshah@amazon.com>

VachaShah dismissed dblock’s stale review via a54809d January 21, 2023 01:45

VachaShah force-pushed the aoss branch from 635edb2 to a54809d Compare January 21, 2023 01:45

VachaShah requested a review from dblock January 21, 2023 01:46

dblock previously approved these changes Jan 21, 2023

View reviewed changes

VijayanB reviewed Jan 21, 2023

View reviewed changes

Fixing user guide

82dce75

Signed-off-by: Vacha Shah <vachshah@amazon.com>

VachaShah dismissed dblock’s stale review via 82dce75 January 21, 2023 05:48

VachaShah requested review from VijayanB and dblock January 21, 2023 05:50

dblock approved these changes Jan 21, 2023

View reviewed changes

VachaShah merged commit d38a466 into opensearch-project:main Jan 22, 2023

VachaShah deleted the aoss branch January 22, 2023 06:21

This was referenced Mar 20, 2023

Update signer v1 example for AOSS #252

Closed

Update signer v1 example for AOSS #259

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding support and examples for AOSS #216

Adding support and examples for AOSS #216

VachaShah commented Jan 17, 2023 •

edited

Loading

dblock commented Jan 17, 2023

dblock commented Jan 17, 2023

VachaShah commented Jan 18, 2023

VachaShah commented Jan 18, 2023

VachaShah commented Jan 18, 2023

dblock left a comment

dblock Jan 19, 2023

VachaShah Jan 20, 2023

dblock Jan 19, 2023

VachaShah Jan 20, 2023

VachaShah commented Jan 20, 2023 •

edited

Loading

dblock left a comment

VachaShah commented Jan 21, 2023

VijayanB Jan 21, 2023

VachaShah Jan 21, 2023

VijayanB Jan 21, 2023 •

edited

Loading

VachaShah Jan 21, 2023

VachaShah commented Jan 21, 2023

Adding support and examples for AOSS #216

Adding support and examples for AOSS #216

Conversation

VachaShah commented Jan 17, 2023 • edited Loading

Description

Issues Resolved

dblock commented Jan 17, 2023

dblock commented Jan 17, 2023

VachaShah commented Jan 18, 2023

VachaShah commented Jan 18, 2023

VachaShah commented Jan 18, 2023

dblock left a comment

Choose a reason for hiding this comment

dblock Jan 19, 2023

Choose a reason for hiding this comment

VachaShah Jan 20, 2023

Choose a reason for hiding this comment

dblock Jan 19, 2023

Choose a reason for hiding this comment

VachaShah Jan 20, 2023

Choose a reason for hiding this comment

VachaShah commented Jan 20, 2023 • edited Loading

dblock left a comment

Choose a reason for hiding this comment

VachaShah commented Jan 21, 2023

VijayanB Jan 21, 2023

Choose a reason for hiding this comment

VachaShah Jan 21, 2023

Choose a reason for hiding this comment

VijayanB Jan 21, 2023 • edited Loading

Choose a reason for hiding this comment

VachaShah Jan 21, 2023

Choose a reason for hiding this comment

VachaShah commented Jan 21, 2023

VachaShah commented Jan 17, 2023 •

edited

Loading

VachaShah commented Jan 20, 2023 •

edited

Loading

VijayanB Jan 21, 2023 •

edited

Loading