Skip to content

Commit 33a06c0

Browse files
authored
[DOCS] Relocate transport module content (#55472) (#57426)
Moves `transport` content from the [Modules][0] section to the [Configuring Elasticsearch][1] section. Supporting changes: * Adds explicit anchors to several headings * Changes several headings to sentence case * Increments several headings * Removes several unneeded `[float]` attributes * Replaces `transport module` with `transport layer` Relates to #53305 [0]: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules.html [1]: https://www.elastic.co/guide/en/elasticsearch/reference/master/settings.html
1 parent 2f2e81d commit 33a06c0

3 files changed

Lines changed: 18 additions & 25 deletions

File tree

docs/reference/modules.asciidoc

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,11 +50,6 @@ The modules in this section are:
5050

5151
Information about the dedicated thread pools used in Elasticsearch.
5252

53-
<<modules-transport,Transport>>::
54-
55-
Configure the transport networking layer, used internally by Elasticsearch
56-
to communicate between nodes.
57-
5853
<<modules-cross-cluster-search, {ccs-cap}>>::
5954

6055
{ccs-cap} enables executing search requests across more than one cluster
@@ -75,5 +70,3 @@ include::modules/network.asciidoc[]
7570
include::modules/node.asciidoc[]
7671

7772
include::modules/threadpool.asciidoc[]
78-
79-
include::modules/transport.asciidoc[]

docs/reference/modules/transport.asciidoc

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
[[modules-transport]]
2-
== Transport
2+
=== Transport
33

4-
The transport module is used for internal communication between nodes
4+
The transport networking layer is used for internal communication between nodes
55
within the cluster. Each call that goes from one node to the other uses
6-
the transport module (for example, when an HTTP GET request is processed
6+
the transport layer (for example, when an HTTP GET request is processed
77
by one node, and should actually be processed by another node that holds
88
the data). The transport module is also used for the `TransportClient` in the
99
{es} Java API.
@@ -15,8 +15,8 @@ http://en.wikipedia.org/wiki/C10k_problem[C10k problem], as well as
1515
being the ideal solution for scatter (broadcast) / gather operations such
1616
as search in Elasticsearch.
1717

18-
[float]
19-
=== Transport Settings
18+
[[transport-settings]]
19+
==== Transport settings
2020

2121
The internal transport communicates over TCP. You can configure it with the
2222
following settings:
@@ -57,8 +57,8 @@ transport connections.
5757
It also uses the common
5858
<<modules-network,network settings>>.
5959

60-
[float]
61-
==== Transport Profiles
60+
[[transport-profiles]]
61+
===== Transport profiles
6262

6363
Elasticsearch allows you to bind to multiple ports on different interfaces by
6464
the use of transport profiles. See this example configuration
@@ -106,8 +106,8 @@ example above:
106106
* `tcp.send_buffer_size`: Configures the send buffer size of the socket
107107
* `tcp.receive_buffer_size`: Configures the receive buffer size of the socket
108108

109-
[float]
110-
==== Long-lived idle connections
109+
[[long-lived-connections]]
110+
===== Long-lived idle connections
111111

112112
Elasticsearch opens a number of long-lived TCP connections between each pair of
113113
nodes in the cluster, and some of these connections may be idle for an extended
@@ -120,11 +120,9 @@ and ensuring that the keepalive interval is shorter than any timeout that might
120120
cause idle connections to be closed, or by setting `transport.ping_schedule` if
121121
keepalives cannot be configured.
122122

123-
[float]
124-
==== Transport Compression
125123

126-
[float]
127-
===== Request Compression
124+
[[request-compression]]
125+
===== Request compression
128126

129127
By default, the `transport.compress` setting is `false` and network-level
130128
request compression is disabled between nodes in the cluster. This default
@@ -139,19 +137,19 @@ request compression, you can set it on a per-remote cluster basis using the
139137
<<remote-cluster-settings,`cluster.remote.${cluster_alias}.transport.compress` setting>>.
140138

141139

142-
[float]
143-
===== Response Compression
140+
[[response-compression]]
141+
===== Response compression
144142

145143
The compression settings do not configure compression for responses. {es} will
146144
compress a response if the inbound request was compressed--even when compression
147145
is not enabled. Similarly, {es} will not compress a response if the inbound
148146
request was uncompressed--even when compression is enabled.
149147

150148

151-
[float]
152-
=== Transport Tracer
149+
[[transport-tracer]]
150+
==== Transport tracer
153151

154-
The transport module has a dedicated tracer logger which, when activated, logs incoming and out going requests. The log can be dynamically activated
152+
The transport layer has a dedicated tracer logger which, when activated, logs incoming and out going requests. The log can be dynamically activated
155153
by setting the level of the `org.elasticsearch.transport.TransportService.tracer` logger to `TRACE`:
156154

157155
[source,console]

docs/reference/setup.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,8 @@ include::settings/sql-settings.asciidoc[]
8181

8282
include::settings/transform-settings.asciidoc[]
8383

84+
include::modules/transport.asciidoc[]
85+
8486
include::settings/notification-settings.asciidoc[]
8587

8688
include::setup/important-settings.asciidoc[]

0 commit comments

Comments
 (0)