Skip to content

Commit 0549c40

Browse files
authored
Minor network docs fixes (#60905)
Followup to #60216, fixing the formatting of `transport.tcp.reuse_address` and clarifying some wording around the distinction between the transport and HTTP layers.
1 parent 186e8b8 commit 0549c40

File tree

4 files changed

+22
-25
lines changed

4 files changed

+22
-25
lines changed

docs/reference/modules/http.asciidoc

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,14 @@
22
=== HTTP
33
[[modules-http-description]]
44
// tag::modules-http-description-tag[]
5-
The HTTP layer exposes {es}'s REST APIs over HTTP.
6-
7-
The HTTP mechanism is completely asynchronous in nature, meaning that
8-
there is no blocking thread waiting for a response. The benefit of using
9-
asynchronous communication for HTTP is solving the
10-
{wikipedia}/C10k_problem[C10k problem].
11-
12-
When possible, consider using
13-
{wikipedia}/Keepalive#HTTP_Keepalive[HTTP keep alive]
14-
when connecting for better performance and try to get your favorite
15-
client not to do
16-
{wikipedia}/Chunked_transfer_encoding[HTTP chunking].
5+
The HTTP layer exposes {es}'s REST APIs over HTTP. Clients send HTTP requests
6+
to a node in the cluster which either handles it locally or else passes it on
7+
to other nodes for further processing using the <<modules-transport,Transport
8+
layer>>.
9+
10+
When possible, consider using {wikipedia}/Keepalive#HTTP_Keepalive[HTTP keep
11+
alive] when connecting for better performance and try to get your favorite
12+
client not to do {wikipedia}/Chunked_transfer_encoding[HTTP chunking].
1713
// end::modules-http-description-tag[]
1814

1915
[http-settings]

docs/reference/modules/network.asciidoc

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -163,18 +163,19 @@ The size of the TCP receive buffer (specified with <<size-units,size units>>).
163163
By default not explicitly set.
164164

165165
[discrete]
166-
=== Transport and HTTP protocols
166+
=== HTTP and transport network communication
167167

168-
An Elasticsearch node exposes two network protocols which inherit the above
169-
settings, but may be further configured independently:
168+
Each {es} node uses the network for two different methods of communication:
170169

171-
TCP Transport::
170+
* it exposes an <<modules-http,HTTP interface>> for use by clients.
172171

173-
Used for communication between nodes in the cluster, by the Java
174-
{javaclient}/transport-client.html[Transport client].
175-
See <<modules-transport>>.
172+
* it exposes a <<modules-transport,transport interface>> for communication
173+
between nodes within a cluster, for communication with a
174+
<<modules-remote-clusters,remote cluster>>, and for the
175+
{javaclient}/transport-client.html[Java Transport client] to communicate with a
176+
cluster.
176177

177-
HTTP::
178-
179-
Exposes the JSON-over-HTTP interface used by all clients.
180-
See <<modules-http>>.
178+
The network settings described above apply to both methods of communication,
179+
and you can also configure each interface separately if needed. See the
180+
<<modules-http,HTTP>> and <<modules-transport,transport>> pages for more
181+
details on their respective configurations.

docs/reference/modules/remote-clusters.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ remote cluster connections: <<sniff-mode,sniff mode>> and
1111
<<proxy-mode,proxy mode>>.
1212

1313
Communication with a remote cluster uses the <<modules-transport,transport
14-
layer>> to establishe a number of <<long-lived-connections,long-lived>> TCP
14+
layer>> to establish a number of <<long-lived-connections,long-lived>> TCP
1515
connections from the coordinating nodes of the local cluster to the chosen
1616
nodes in the remote cluster.
1717

docs/reference/modules/transport.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ sent on a connection before it is dropped. Defaults to `network.tcp.keep_count`
8686
if set, or the system default otherwise. Only applicable on Linux and macOS, and
8787
requires Java 11 or newer.
8888

89-
transport.tcp.reuse_address::
89+
`transport.tcp.reuse_address`::
9090
Should an address be reused or not. Defaults to `network.tcp.reuse_address`.
9191

9292
`transport.tcp.send_buffer_size`::

0 commit comments

Comments
 (0)