Skip to content

Commit 2ea5372

Browse files
authored
[DOCS] Relocate HTTP module content (#56386) (#57439)
Moves `HTTP` content from the [Modules][0] section to the [Configuring Elasticsearch][1] section. Supporting changes: * Replaces `http` with `HTTP` throughout * Replaces `HTTP module` with `HTTP layer` throughout * Increments several headings * Adds explicit anchors to several headings * Removes several unneeded `[float]` attributes Closes #53306 [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 daaf5a3 commit 2ea5372

File tree

3 files changed

+24
-29
lines changed

3 files changed

+24
-29
lines changed

docs/reference/modules.asciidoc

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,6 @@ The modules in this section are:
3030

3131
How many nodes need to join the cluster before recovery can start.
3232

33-
<<modules-http,HTTP>>::
34-
35-
Settings to control the HTTP REST interface.
36-
3733
<<modules-indices,Indices>>::
3834

3935
Global index-related settings.
@@ -45,5 +41,3 @@ include::modules/discovery.asciidoc[]
4541
include::modules/cluster.asciidoc[]
4642

4743
include::modules/gateway.asciidoc[]
48-
49-
include::modules/http.asciidoc[]

docs/reference/modules/http.asciidoc

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
[[modules-http]]
2-
== HTTP
2+
=== HTTP
33

4-
The http module allows to expose *Elasticsearch* APIs
5-
over HTTP.
4+
The HTTP layer exposes {es}'s REST APIs over HTTP.
65

7-
The http mechanism is completely asynchronous in nature, meaning that
6+
The HTTP mechanism is completely asynchronous in nature, meaning that
87
there is no blocking thread waiting for a response. The benefit of using
98
asynchronous communication for HTTP is solving the
109
http://en.wikipedia.org/wiki/C10k_problem[C10k problem].
@@ -15,8 +14,8 @@ when connecting for better performance and try to get your favorite
1514
client not to do
1615
http://en.wikipedia.org/wiki/Chunked_transfer_encoding[HTTP chunking].
1716

18-
[float]
19-
=== Settings
17+
[http-settings]
18+
==== HTTP settings
2019

2120
The settings in the table below can be configured for HTTP. Note that none of
2221
them are dynamically updatable so for them to take effect they should be set in
@@ -60,19 +59,19 @@ and 9 (maximum compression). Defaults to `3`.
6059

6160
|`http.cors.enabled` |Enable or disable cross-origin resource sharing,
6261
i.e. whether a browser on another origin can execute requests against
63-
Elasticsearch. Set to `true` to enable Elasticsearch to process pre-flight
64-
https://en.wikipedia.org/wiki/Cross-origin_resource_sharing[CORS] requests.
65-
Elasticsearch will respond to those requests with the `Access-Control-Allow-Origin` header
66-
if the `Origin` sent in the request is permitted by the `http.cors.allow-origin`
67-
list. Set to `false` (the default) to make Elasticsearch ignore the `Origin`
68-
request header, effectively disabling CORS requests because Elasticsearch will
69-
never respond with the `Access-Control-Allow-Origin` response header. Note that
70-
if the client does not send a pre-flight request with an `Origin` header or it
71-
does not check the response headers from the server to validate the
72-
`Access-Control-Allow-Origin` response header, then cross-origin security is
73-
compromised. If CORS is not enabled on Elasticsearch, the only way for the client
74-
to know is to send a pre-flight request and realize the required response headers
75-
are missing.
62+
Elasticsearch. Set to `true` to enable Elasticsearch to process pre-flight
63+
https://en.wikipedia.org/wiki/Cross-origin_resource_sharing[CORS] requests.
64+
Elasticsearch will respond to those requests with the `Access-Control-Allow-Origin` header
65+
if the `Origin` sent in the request is permitted by the `http.cors.allow-origin`
66+
list. Set to `false` (the default) to make Elasticsearch ignore the `Origin`
67+
request header, effectively disabling CORS requests because Elasticsearch will
68+
never respond with the `Access-Control-Allow-Origin` response header. Note that
69+
if the client does not send a pre-flight request with an `Origin` header or it
70+
does not check the response headers from the server to validate the
71+
`Access-Control-Allow-Origin` response header, then cross-origin security is
72+
compromised. If CORS is not enabled on Elasticsearch, the only way for the client
73+
to know is to send a pre-flight request and realize the required response headers
74+
are missing.
7675

7776
|`http.cors.allow-origin` |Which origins to allow. Defaults to no origins
7877
allowed. If you prepend and append a `/` to the value, this will
@@ -114,10 +113,10 @@ client HTTP responses, defaults to unbounded.
114113
It also uses the common
115114
<<modules-network,network settings>>.
116115

117-
[float]
118-
=== Rest Request Tracer
116+
[http-rest-request-tracer]
117+
==== REST request tracer
119118

120-
The http module has a dedicated tracer logger which, when activated, logs incoming requests. The log can be dynamically activated
119+
The HTTP layer has a dedicated tracer logger which, when activated, logs incoming requests. The log can be dynamically activated
121120
by setting the level of the `org.elasticsearch.http.HttpTracer` logger to `TRACE`:
122121

123122
[source,console]
@@ -142,4 +141,4 @@ PUT _cluster/settings
142141
"http.tracer.exclude" : ""
143142
}
144143
}
145-
--------------------------------------------------
144+
--------------------------------------------------

docs/reference/setup.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ include::modules/indices/indexing_buffer.asciidoc[]
5555

5656
include::modules/indices/fielddata.asciidoc[]
5757

58+
include::modules/http.asciidoc[]
59+
5860
include::settings/ilm-settings.asciidoc[]
5961

6062
include::settings/license-settings.asciidoc[]

0 commit comments

Comments
 (0)