Opensearch-py and Opensearch-java gRPC transparent support documentation- #12873 - #12872
Open
dayana-j wants to merge 5 commits into
Open
Opensearch-py and Opensearch-java gRPC transparent support documentation- #12873#12872dayana-j wants to merge 5 commits into
dayana-j wants to merge 5 commits into
Conversation
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). |
github-actions
Bot
added
the
In progress
dayana-j
changed the title
dayana-j
changed the title
New pages: - _clients/java-grpc.md: Java gRPC transport (HybridTransport, TLS, basic auth, JWT, AWS SigV4, GrpcTransportOptions, examples) - _clients/python-grpc.md: Python gRPC transport (OpenSearchGrpc, basic auth, AWS SigV4, bulk operations, server config) Updated pages: - _clients/index.md: Added gRPC transport links for both Java and Python - _clients/java.md: Added section pointing to Java gRPC transport - _clients/python-low-level.md: Added section pointing to Python gRPC transport - _api-reference/grpc-apis/index.md: Added both Java and Python as transparent client transports (recommended approach) - _api-reference/grpc-apis/bulk.md: Added transparent client example Signed-off-by: Dayana Jean <jeadayao@amazon.com>
dayana-j
marked this pull request as ready for review
July 29, 2026 18:13
dayana-j
requested review from
cwperks,
dlvenable,
epugh,
kolchfa-aws,
mgodwan,
peterzhuamazon and
sumobrian
as code owners
July 29, 2026 18:13
github-actions
Bot
added
Tech review
finnegancarroll
suggested changes
Jul 29, 2026
Signed-off-by: Dayana Jean <jeadayao@amazon.com>
Signed-off-by: Dayana Jean <jeadayao@amazon.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
Adds documentation for the opensearch-py client's gRPC transport, which routes bulk ingestion and ML streaming over gRPC for improved performance while automatically falling back to REST for all other operations. It also adds documentation for the new opensearch-java gRPC transport module, which provides transparent gRPC support for the OpenSearch Java client. Covers installation, client setup with OpenSearchGrpc, TLS/mTLS configuration, and authentication methods (basic auth, JWT bearer tokens, and AWS SigV4). Also adds cross-references to the Python and java client in the gRPC APIs index, JWT authentication, and TLS configuration pages.
Version
OpenSearch version 3.0 and later (gRPC transport module transport-grpc available since OpenSearch 3.0)
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.