Skip to content

Commit 58b1b33

Browse files
authored
[DOCS] Relocate transport module content (#55472)
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 a9b35f4 commit 58b1b33

File tree

3 files changed

+18
-25
lines changed

3 files changed

+18
-25
lines changed

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).
99

@@ -14,8 +14,8 @@ http://en.wikipedia.org/wiki/C10k_problem[C10k problem], as well as
1414
being the ideal solution for scatter (broadcast) / gather operations such
1515
as search in Elasticsearch.
1616

17-
[float]
18-
=== Transport Settings
17+
[[transport-settings]]
18+
==== Transport settings
1919

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

59-
[float]
60-
==== Transport Profiles
59+
[[transport-profiles]]
60+
===== Transport profiles
6161

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

108-
[float]
109-
==== Long-lived idle connections
108+
[[long-lived-connections]]
109+
===== Long-lived idle connections
110110

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

122-
[float]
123-
==== Transport Compression
124122

125-
[float]
126-
===== Request Compression
123+
[[request-compression]]
124+
===== Request compression
127125

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

140138

141-
[float]
142-
===== Response Compression
139+
[[response-compression]]
140+
===== Response compression
143141

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

149147

150-
[float]
151-
=== Transport Tracer
148+
[[transport-tracer]]
149+
==== Transport tracer
152150

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

156154
[source,console]

docs/reference/setup.asciidoc

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

8080
include::settings/transform-settings.asciidoc[]
8181

82+
include::modules/transport.asciidoc[]
83+
8284
include::settings/notification-settings.asciidoc[]
8385

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

0 commit comments

Comments
 (0)