Skip to content

Commit

Permalink
[DOCS] Relocate HTTP module content (#56386) (#57441)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
jrodewig authored Jun 1, 2020
1 parent 0cd532b commit ed3ecf2
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 29 deletions.
6 changes: 0 additions & 6 deletions docs/reference/modules.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,6 @@ The modules in this section are:

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

<<modules-http,HTTP>>::

Settings to control the HTTP REST interface.

<<modules-indices,Indices>>::

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

include::modules/gateway.asciidoc[]

include::modules/http.asciidoc[]
45 changes: 22 additions & 23 deletions docs/reference/modules/http.asciidoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
[[modules-http]]
== HTTP
=== HTTP

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

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

[float]
=== Settings
[http-settings]
==== HTTP settings

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

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

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

[float]
=== Rest Request Tracer
[http-rest-request-tracer]
==== REST request tracer

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

[source,console]
Expand All @@ -142,4 +141,4 @@ PUT _cluster/settings
"http.tracer.exclude" : ""
}
}
--------------------------------------------------
--------------------------------------------------
2 changes: 2 additions & 0 deletions docs/reference/setup.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ include::modules/indices/indexing_buffer.asciidoc[]

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

include::modules/http.asciidoc[]

include::settings/ilm-settings.asciidoc[]

include::settings/license-settings.asciidoc[]
Expand Down

0 comments on commit ed3ecf2

Please sign in to comment.