Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove experimental label for compression settings #76441

Merged
merged 1 commit into from
Aug 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions docs/reference/modules/remote-clusters.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -292,8 +292,17 @@ separately.
to a specific remote cluster. This setting impacts only requests
sent to the remote cluster. If the inbound request is compressed,
Elasticsearch compresses the response. The setting options are `true`,
`indexing_data`, and `false`. The option `indexing_data` is experimental.
If unset, the global `transport.compress` is used as the fallback setting.
`indexing_data`, and `false`. If unset, the global `transport.compress` is
used as the fallback setting.

`cluster.remote.<cluster_alias>.transport.compression_scheme`::

Per cluster setting that enables you to configure compression scheme for
requests to a specific remote cluster. This setting impacts only requests
sent to the remote cluster. If an inbound request is compressed, {es}
compresses the response using the same compression scheme. The setting options
are `deflate` and `lz4`. If unset, the global `transport.compression_scheme`
is used as the fallback setting.
Comment on lines +298 to +305
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably mention this setting in the PR/commit description.


[discrete]
[[remote-cluster-sniff-settings]]
Expand Down
11 changes: 5 additions & 6 deletions docs/reference/modules/transport.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,14 @@ Set to `true`, `indexing_data`, or `false` to configure transport compression
between nodes. The option `true` will compress all data. The option
`indexing_data` will compress only the raw index data sent between nodes during
ingest, ccr following (excluding bootstrap), and operations based shard recovery
(excluding transferring lucene files). The `indexing_data` option is experimental.
Defaults to `false`.
(excluding transferring lucene files). Defaults to `false`.

`transport.compression_scheme`::
(<<static-cluster-setting,Static>>)
Configures the compression scheme for `transport.compress`. The options are
`deflate` or `lz4`. The option `lz4` is experimental. If `lz4` is configured and
the remote node has not been upgraded to a version supporting `lz4`, the traffic
will be sent uncompressed. Defaults to `deflate`.
`deflate` or `lz4`. If `lz4` is configured and the remote node has not been
upgraded to a version supporting `lz4`, the traffic will be sent uncompressed.
Defaults to `deflate`.

`transport.ping_schedule`::
(<<static-cluster-setting,Static>>)
Expand Down Expand Up @@ -186,7 +185,7 @@ connections between nodes.
The `transport.compress` configuration option `indexing_data` will only
compress requests that relate to the transport of raw indexing source data
between nodes. This option primarily compresses data sent during ingest,
ccr, and shard recovery. This option is experimental.
ccr, and shard recovery.

The `transport.compress` setting always configures local cluster request
compression and is the fallback setting for remote cluster request compression.
Expand Down