Document new experimental HTTP transport based on Netty 4 and Project Reactor #6265
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
reta
requested review from
hdhalter,
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower and
dlvenable
as code owners
… Reactor Signed-off-by: Andriy Redko <[email protected]>
|
Thanks, @reta ! Is this ready for a doc review? |
hdhalter
added
4 - Doc review
vagimeli
approved these changes
Jan 26, 2024
|
|
||
| ## Selecting the transport | ||
|
|
||
| The default OpenSearch transport is provided by `transport-netty4` module and internally uses Netty 4 engine for both internal TCP-based communication between nodes in the cluster as well as external HTTP-based communication with the clients. This communication is fully asynchronous and non-blocking. However, there are other transport plugins available that could be used interchangeably: |
There was a problem hiding this comment.
Suggested change
| The default OpenSearch transport is provided by `transport-netty4` module and internally uses Netty 4 engine for both internal TCP-based communication between nodes in the cluster as well as external HTTP-based communication with the clients. This communication is fully asynchronous and non-blocking. However, there are other transport plugins available that could be used interchangeably: | |
| The default OpenSearch transport is provided by the `transport-netty4` module and internally uses the [Netty 4](https://netty.io/) engine for both internal TCP-based communication between nodes in the cluster and external HTTP-based communication with the clients. This communication is fully asynchronous and non-blocking. However, there are other transport plugins available that could be used interchangeably: |
There was a problem hiding this comment.
@reta I made some copy edits and added a link to Netty. Please review.
There was a problem hiding this comment.
@reta I made some copy edits and added a link to Netty. Please review.
Thanks @vagimeli , two comment here:
Transmission Control Protocol- definitely does not need expansion (we don't do that for HTTP either)nonblockingis reallynon-blocking(first words from https://netty.io/)
| Plugin | Description | ||
| :---------- | :-------- | ||
| `transport-nio` | The OpenSearch transport based on Java NIO. <br> Installation: `./bin/opensearch-plugin install transport-nio` <br> Configuration (using `opensearch.yml`): <br> `transport.type: nio-transport` <br> `http.type: nio-http-transport` | ||
| `transport-reactor-netty4` | The OpenSearch HTTP transport based on Project Reactor and Netty 4 (**experimental**) <br> Installation: `./bin/opensearch-plugin install transport-reactor-netty4` <br> Configuration (using `opensearch.yml`): <br> `http.type: reactor-netty4` |
There was a problem hiding this comment.
Should we include a link to the Project Reactor source?
Signed-off-by: Andriy Redko <[email protected]>
vagimeli
added
5 - Editorial review
natebower
reviewed
Jan 29, 2024
|
|
||
| ## Selecting the transport | ||
|
|
||
| The default OpenSearch transport is provided by the `transport-netty4` module and internally uses the [Netty 4](https://netty.io/) engine for both internal TCP-based communication between nodes in the cluster and external HTTP-based communication with the clients. This communication is fully asynchronous and non-blocking. However, there are other transport plugins available that could be used interchangeably: |
There was a problem hiding this comment.
Suggested change
| The default OpenSearch transport is provided by the `transport-netty4` module and internally uses the [Netty 4](https://netty.io/) engine for both internal TCP-based communication between nodes in the cluster and external HTTP-based communication with the clients. This communication is fully asynchronous and non-blocking. However, there are other transport plugins available that could be used interchangeably: | |
| The default OpenSearch transport is provided by the `transport-netty4` module and uses the [Netty 4](https://netty.io/) engine for both internal TCP-based communication between nodes in the cluster and external HTTP-based communication with clients. This communication is fully asynchronous and non-blocking. However, there are other transport plugins available that can be used interchangeably: |
natebower
reviewed
Jan 29, 2024
|
|
||
| ## Selecting the transport | ||
|
|
||
| The default OpenSearch transport is provided by the `transport-netty4` module and uses the [Netty 4](https://netty.io/) engine for both internal TCP-based communication between nodes in the cluster and external HTTP-based communication with clients. This communication is fully asynchronous and non-blocking. However, there are other transport plugins available that сфт be used interchangeably: |
There was a problem hiding this comment.
Suggested change
| The default OpenSearch transport is provided by the `transport-netty4` module and uses the [Netty 4](https://netty.io/) engine for both internal TCP-based communication between nodes in the cluster and external HTTP-based communication with clients. This communication is fully asynchronous and non-blocking. However, there are other transport plugins available that сфт be used interchangeably: | |
| The default OpenSearch transport is provided by the `transport-netty4` module and uses the [Netty 4](https://netty.io/) engine for both internal TCP-based communication between nodes in the cluster and external HTTP-based communication with clients. This communication is fully asynchronous and non-blocking. However, there are other transport plugins available that can be used interchangeably: |
There was a problem hiding this comment.
Sorry about that, slipped through :(
Signed-off-by: Andriy Redko <[email protected]>
vagimeli
added
3 - Done
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.
Description
Document new experimental HTTP transport based on Netty 4 and Project Reactor
Issues Resolved
Closes #5540
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.