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

Update transport docs and settings for changes #36786

Merged
merged 5 commits into from
Dec 18, 2018

Conversation

Tim-Brooks
Copy link
Contributor

This is related to #36652. In 7.0 we plan to deprecate a number of
settings that make reference to the concept of a tcp transport. We
mostly just have a single transport type now (based on tcp). Settings
should only reference tcp if they are referring to socket options. This
commit updates the settings in the docs. And removes string usages of
the old settings. Additionally it adds a missing remote compress setting
to the docs.

@Tim-Brooks Tim-Brooks added >docs General docs changes :Distributed Coordination/Network Http and internode communication implementations v7.0.0 labels Dec 18, 2018
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed

@Tim-Brooks Tim-Brooks changed the title Update transport settings and strings for changes Update transport docs and settings for changes Dec 18, 2018
Copy link
Member

@original-brownbear original-brownbear left a comment

Choose a reason for hiding this comment

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

LGTM

@@ -161,6 +161,14 @@ PUT _cluster/settings
are sent according to the global `transport.ping_schedule` setting, which
defaults to ``-1` meaning that pings are not sent.

`cluster.remote.${cluster_alias}.transport.compress`::

Per cluster boolean setting that allows compression to be configured for
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Per cluster boolean setting that allows compression to be configured for
Per cluster boolean setting that enables you to configure compression for

`cluster.remote.${cluster_alias}.transport.compress`::

Per cluster boolean setting that allows compression to be configured for
requests to a specific remote cluster. This setting only impacts requests
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
requests to a specific remote cluster. This setting only impacts requests
requests to a specific remote cluster. This setting impacts only requests


Per cluster boolean setting that allows compression to be configured for
requests to a specific remote cluster. This setting only impacts requests
sent to the remote cluster. Elasticsearch will compress a response if the
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
sent to the remote cluster. Elasticsearch will compress a response if the
sent to the remote cluster. If the

Per cluster boolean setting that allows compression to be configured for
requests to a specific remote cluster. This setting only impacts requests
sent to the remote cluster. Elasticsearch will compress a response if the
inbound request was compressed. If unset, the global `transport.compress`
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
inbound request was compressed. If unset, the global `transport.compress`
inbound request is compressed, Elasticsearch compresses the response. If unset, the global `transport.compress`


The TCP transport is an implementation of the transport module using
TCP. It allows for the following settings:
The internal transport communicates over TCP. It allows for the following
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The internal transport communicates over TCP. It allows for the following
The internal transport communicates over TCP. You can configure it with the following

@Tim-Brooks
Copy link
Contributor Author

I marked this for 6.7 too. The new settings exist starting 6.6. So it seems reasonable to update the doc for the new settings in 6.7.

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

Docs LGTM. Thanks for making those changes!

@Tim-Brooks Tim-Brooks merged commit 47a9a8d into elastic:master Dec 18, 2018
Tim-Brooks added a commit to Tim-Brooks/elasticsearch that referenced this pull request Dec 19, 2018
Commit elastic#36786 updated docs and strings to reference transport.port instead of
transport.tcp.port. However, this breaks backwards compatibility tests
as the tests rely on string configurations and transport.port does not
exist prior to 6.6. This commit reverts the places were we reference
transport.tcp.port for tests. This work will need to be reintroduced in
a backwards compatible way.
Tim-Brooks added a commit to Tim-Brooks/elasticsearch that referenced this pull request Dec 19, 2018
Commit elastic#36786 updated docs and strings to reference transport.port instead of
transport.tcp.port. However, this breaks backwards compatibility tests
as the tests rely on string configurations and transport.port does not
exist prior to 6.6. This commit reverts the places were we reference
transport.tcp.port for tests. This work will need to be reintroduced in
a backwards compatible way.
Tim-Brooks added a commit to Tim-Brooks/elasticsearch that referenced this pull request Dec 20, 2018
This is related to elastic#36652. In 7.0 we plan to deprecate a number of
settings that make reference to the concept of a tcp transport. We
mostly just have a single transport type now (based on tcp). Settings
should only reference tcp if they are referring to socket options. This
commit updates the settings in the docs. And removes string usages of
the old settings. Additionally it adds a missing remote compress setting
to the docs.
Tim-Brooks added a commit to Tim-Brooks/elasticsearch that referenced this pull request Dec 20, 2018
Commit elastic#36786 updated docs and strings to reference transport.port instead of
transport.tcp.port. However, this breaks backwards compatibility tests
as the tests rely on string configurations and transport.port does not
exist prior to 6.6. This commit reverts the places were we reference
transport.tcp.port for tests. This work will need to be reintroduced in
a backwards compatible way.
@Tim-Brooks Tim-Brooks deleted the update_strings_for_settings branch December 18, 2019 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Distributed Coordination/Network Http and internode communication implementations >docs General docs changes v6.7.0 v7.0.0-beta1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants