Add REST & Transport layers section to GeneralArchitectureGuide.md #126377
Conversation
nicktindall
added
>docs
elasticsearchmachine
added
Team:Docs
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/es-distributed-coordination (Team:Distributed Coordination) |
|
|
||
| The node that a REST request arrives at is called the "coordinating" node. Its job is to coordinate the execution of the request with the other nodes in the cluster and when the requested action is completed, return the possibly aggregated response to the REST client via HTTP. | ||
|
|
||
| By default, all nodes will act as coordinating nodes, but by specifying `node.roles` to be empty you can create a [coordinating-only node](https://www.elastic.co/guide/en/elasticsearch/reference/current/node-roles-overview.html#coordinating-only-node-role). |
There was a problem hiding this comment.
Maybe a little confusing to talk about node roles given we're considering coordinating REST requests here. All nodes handle REST requests, this is not optional.
There was a problem hiding this comment.
I took a look at the intro and REST sections, but didn't get to the transport section.
I think you have a lot of great content, but I think it's missing high level explanations to A) make that content easier to understand/digest and B) tie the components together into a big picture.
|
Uhoh. I started feeling like I'd already dug around in this code: we have the REST layer explained over here hiding under networking https://github.com/elastic/elasticsearch/blob/main/docs/internal/DistributedArchitectureGuide.md#networking. You have some more REST bits, though, and the transport layer was not explained. |
I'm sorry I didn't notice this earlier. They'll need to be reconciled. Looks like I was connecting all those topics under networking because the ActionListeners tie responses back to Netty and get passed through the REST layer on netty threads to the Transport layer to then run on potentially different thread pools... That was a little too clever, in retrospect 😅 |
|
I opened #126643 to move the REST documentation into the General guide, so your final diff will be cleaner. But feel free to propose something different. |
…t_layers # Conflicts: # docs/internal/GeneralArchitectureGuide.md
|
Sorry, I did a fairly substantial re-work to try and incorporate the best bits of the new and old text. I tried to address all the feedback but it's quite different to what was there, so probably needs to be re-reviewed altogether. |
Co-authored-by: Dianna Hohensee <[email protected]>
Co-authored-by: Dianna Hohensee <[email protected]>
Co-authored-by: Dianna Hohensee <[email protected]>
Co-authored-by: Dianna Hohensee <[email protected]>
Co-authored-by: Dianna Hohensee <[email protected]>
Co-authored-by: Dianna Hohensee <[email protected]>
As part of the effort to document onboarding topics I tried to document the contents of "REST vs Transport layer and coordinating nodes" topic.
There's a lot more that could be said, advice on how much more of that to include is appreciated. I was hoping to keep the section(s) roughly aligned with onboarding topics, but I think I've already said too much about
TransportActionsSee rendered content at https://github.com/nicktindall/elasticsearch/blob/add_rest_and_transport_layers/docs/internal/GeneralArchitectureGuide.md
Closes: ES-7885