Skip to content

Commit c014dcf

Browse files
committed
Align docs etc with new discovery setting names
In elastic#38333 and elastic#38350 we moved away from the `discovery.zen` settings namespace since these settings have an effect even though Zen Discovery itself is being phased out. This change aligns the documentation and the names of related classes and methods with the newly-introduced naming conventions.
1 parent e73c9c9 commit c014dcf

File tree

54 files changed

+378
-348
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+378
-348
lines changed

docs/plugins/discovery-azure-classic.asciidoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
[[discovery-azure-classic]]
22
=== Azure Classic Discovery Plugin
33

4-
The Azure Classic Discovery plugin uses the Azure Classic API for unicast discovery.
4+
The Azure Classic Discovery plugin uses the Azure Classic API to identify the
5+
addresses of seed hosts.
56

67
// TODO: Link to ARM plugin when ready
78
// See issue https://github.com/elastic/elasticsearch/issues/19146
@@ -14,8 +15,8 @@ include::install_remove.asciidoc[]
1415
[[discovery-azure-classic-usage]]
1516
==== Azure Virtual Machine Discovery
1617

17-
Azure VM discovery allows to use the azure APIs to perform automatic discovery (similar to multicast in non hostile
18-
multicast environments). Here is a simple sample configuration:
18+
Azure VM discovery allows to use the azure APIs to perform automatic discovery.
19+
Here is a simple sample configuration:
1920

2021
[source,yaml]
2122
----

docs/plugins/discovery-ec2.asciidoc

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
[[discovery-ec2]]
22
=== EC2 Discovery Plugin
33

4-
The EC2 discovery plugin uses the https://github.com/aws/aws-sdk-java[AWS API] for unicast discovery.
4+
The EC2 discovery plugin uses the https://github.com/aws/aws-sdk-java[AWS API]
5+
to identify the addresses of seed hosts.
56

67
*If you are looking for a hosted solution of Elasticsearch on AWS, please visit http://www.elastic.co/cloud.*
78

@@ -11,12 +12,12 @@ include::install_remove.asciidoc[]
1112
[[discovery-ec2-usage]]
1213
==== Getting started with AWS
1314

14-
The plugin provides a hosts provider for zen discovery named `ec2`. This hosts
15-
provider finds other Elasticsearch instances in EC2 through AWS metadata.
16-
Authentication is done using
15+
The plugin adds a seed hosts provider named `ec2`. This seed hosts provider
16+
finds other Elasticsearch instances in EC2 by querying the AWS metadata
17+
service. Authentication is done using
1718
http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html[IAM
18-
Role] credentials by default. To enable the plugin, set the unicast host
19-
provider for Zen discovery to `ec2`:
19+
Role] credentials by default. To enable the plugin, configure {es} to use the
20+
`ec2` seed hosts provider:
2021

2122
[source,yaml]
2223
----
@@ -25,9 +26,9 @@ discovery.seed_providers: ec2
2526

2627
==== Settings
2728

28-
EC2 host discovery supports a number of settings.
29-
Some settings are sensitive and must be stored in the {ref}/secure-settings.html[elasticsearch keystore].
30-
For example, to use explicit AWS access keys:
29+
EC2 discovery supports a number of settings. Some settings are sensitive and
30+
must be stored in the {ref}/secure-settings.html[elasticsearch keystore]. For
31+
example, to use explicit AWS access keys:
3132

3233
[source,sh]
3334
----
@@ -184,15 +185,18 @@ Management Console. It should look similar to this.
184185
[[discovery-ec2-filtering]]
185186
===== Filtering by Tags
186187

187-
The ec2 discovery can also filter machines to include in the cluster based on tags (and not just groups). The settings
188-
to use include the `discovery.ec2.tag.` prefix. For example, if you defined a tag `stage` in EC2 and set it to `dev`,
189-
setting `discovery.ec2.tag.stage` to `dev` will only filter instances with a tag key set to `stage`, and a value
190-
of `dev`. Adding multiple `discovery.ec2.tag` settings will require all of those tags to be set for the instance to be included.
188+
The ec2 discovery plugin can also filter machines to include in the cluster
189+
based on tags (and not just groups). The settings to use include the
190+
`discovery.ec2.tag.` prefix. For example, if you defined a tag `stage` in EC2
191+
and set it to `dev`, setting `discovery.ec2.tag.stage` to `dev` will only
192+
filter instances with a tag key set to `stage`, and a value of `dev`. Adding
193+
multiple `discovery.ec2.tag` settings will require all of those tags to be set
194+
for the instance to be included.
191195

192-
One practical use for tag filtering is when an ec2 cluster contains many nodes that are not running Elasticsearch. In
193-
this case (particularly with high `discovery.zen.ping_timeout` values) there is a risk that a new node's discovery phase
194-
will end before it has found the cluster (which will result in it declaring itself master of a new cluster with the same
195-
name - highly undesirable). Tagging Elasticsearch ec2 nodes and then filtering by that tag will resolve this issue.
196+
One practical use for tag filtering is when an ec2 cluster contains many nodes
197+
that are not master-eligible {es} nodes. In this case, tagging the ec2
198+
instances that _are_ running the master-eligible {es} nodes, and then filtering
199+
by that tag, will help discovery to run more efficiently.
196200

197201
[[discovery-ec2-attributes]]
198202
===== Automatic Node Attributes
@@ -229,7 +233,6 @@ Prefer https://aws.amazon.com/amazon-linux-ami/[Amazon Linux AMIs] as since Elas
229233

230234
===== Networking
231235
* Networking throttling takes place on smaller instance types in both the form of https://lab.getbase.com/how-we-discovered-limitations-on-the-aws-tcp-stack/[bandwidth and number of connections]. Therefore if large number of connections are needed and networking is becoming a bottleneck, avoid https://aws.amazon.com/ec2/instance-types/[instance types] with networking labeled as `Moderate` or `Low`.
232-
* Multicast is not supported, even when in an VPC; the aws cloud plugin which joins by performing a security group lookup.
233236
* When running in multiple http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html[availability zones] be sure to leverage {ref}/allocation-awareness.html[shard allocation awareness] so that not all copies of shard data reside in the same availability zone.
234237
* Do not span a cluster across regions. If necessary, use a cross cluster search.
235238

docs/plugins/discovery-gce.asciidoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
[[discovery-gce]]
22
=== GCE Discovery Plugin
33

4-
The Google Compute Engine Discovery plugin uses the GCE API for unicast discovery.
4+
The Google Compute Engine Discovery plugin uses the GCE API to identify the
5+
addresses of seed hosts.
56

67
:plugin_name: discovery-gce
78
include::install_remove.asciidoc[]
89

910
[[discovery-gce-usage]]
1011
==== GCE Virtual Machine Discovery
1112

12-
Google Compute Engine VM discovery allows to use the google APIs to perform automatic discovery (similar to multicast
13-
in non hostile multicast environments). Here is a simple sample configuration:
13+
Google Compute Engine VM discovery allows to use the google APIs to perform
14+
automatic discovery of seed hosts. Here is a simple sample configuration:
1415

1516
[source,yaml]
1617
--------------------------------------------------
@@ -358,11 +359,10 @@ The GCE discovery can also filter machines to include in the cluster based on ta
358359
For example, setting `discovery.gce.tags` to `dev` will only filter instances having a tag set to `dev`. Several tags
359360
set will require all of those tags to be set for the instance to be included.
360361

361-
One practical use for tag filtering is when an GCE cluster contains many nodes that are not running
362-
Elasticsearch. In this case (particularly with high `discovery.zen.ping_timeout` values) there is a risk that a new
363-
node's discovery phase will end before it has found the cluster (which will result in it declaring itself master of a
364-
new cluster with the same name - highly undesirable). Adding tag on Elasticsearch GCE nodes and then filtering by that
365-
tag will resolve this issue.
362+
One practical use for tag filtering is when a GCE cluster contains many nodes
363+
that are not master-eligible {es} nodes. In this case, tagging the GCE
364+
instances that _are_ running the master-eligible {es} nodes, and then filtering
365+
by that tag, will help discovery to run more efficiently.
366366

367367
Add your tag when building the new instance:
368368

docs/plugins/discovery.asciidoc

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
[[discovery]]
22
== Discovery Plugins
33

4-
Discovery plugins extend Elasticsearch by adding new hosts providers that can be
5-
used to extend the {ref}/modules-discovery.html[cluster formation module].
4+
Discovery plugins extend Elasticsearch by adding new seed hosts providers that
5+
can be used to extend the {ref}/modules-discovery.html[cluster formation
6+
module].
67

78
[float]
89
==== Core discovery plugins
@@ -12,22 +13,22 @@ The core discovery plugins are:
1213
<<discovery-ec2,EC2 discovery>>::
1314

1415
The EC2 discovery plugin uses the https://github.com/aws/aws-sdk-java[AWS API]
15-
for unicast discovery.
16+
to identify the addresses of seed hosts.
1617

1718
<<discovery-azure-classic,Azure Classic discovery>>::
1819

19-
The Azure Classic discovery plugin uses the Azure Classic API for unicast
20-
discovery.
20+
The Azure Classic discovery plugin uses the Azure Classic API to identify the
21+
addresses of seed hosts.
2122

2223
<<discovery-gce,GCE discovery>>::
2324

24-
The Google Compute Engine discovery plugin uses the GCE API for unicast
25-
discovery.
25+
The Google Compute Engine discovery plugin uses the GCE API to identify the
26+
addresses of seed hosts.
2627

2728
[float]
2829
==== Community contributed discovery plugins
2930

30-
A number of discovery plugins have been contributed by our community:
31+
The following discovery plugins have been contributed by our community:
3132

3233
* https://github.com/fabric8io/elasticsearch-cloud-kubernetes[Kubernetes Discovery Plugin] (by Jimmi Dyson, http://fabric8.io[fabric8])
3334

docs/reference/migration/migrate_7_0/plugins.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ renamed to `requiresAnalysisSettings`
4141
* This plugin has been removed since its functionality is now part of
4242
Elasticsearch and requires no plugin. The location of the hosts file has moved
4343
from `$ES_PATH_CONF/file-discovery/unicast_hosts.txt` to
44-
`$ES_PATH_CONF/unicast_hosts.txt`. See <<file-based-hosts-provider, the
44+
`$ES_PATH_CONF/unicast_hosts.txt`. See <<file-based-hosts-provider,the
4545
file-based hosts provider documentation>> for further information.
4646

4747
[float]

docs/reference/modules/discovery/discovery-settings.asciidoc

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -130,9 +130,30 @@ Discovery and cluster formation are affected by the following settings:
130130
considering the request to have failed. Defaults to `3s`.
131131

132132
`discovery.seed_providers`::
133-
Specifies which types of <<built-in-hosts-providers,seed provider>> provide
134-
the addresses of seed nodes. By default, it is the
135-
<<settings-based-hosts-provider,settings-based hosts provider>>.
133+
Specifies which types of <<built-in-hosts-providers,seed hosts provider>>
134+
to use to obtain the addresses of the seed nodes used to start the
135+
discovery process. By default, it is the
136+
<<settings-based-hosts-provider,settings-based seed hosts provider>>.
137+
This setting was previously known as `discovery.zen.hosts_provider`. Its
138+
old name is deprecated but continues to work in order to preserve backwards
139+
compatibility. Support for the old name will be removed in a future
140+
version.
141+
142+
`discovery.seed_resolver.max_concurrent_resolvers`::
143+
Specifies how many concurrent DNS lookups to perform when resolving the
144+
addresses of seed nodes. Defaults to `10`. This setting was previously
145+
known as `discovery.zen.ping.unicast.concurrent_connects`. Its old name is
146+
deprecated but continues to work in order to preserve backwards
147+
compatibility. Support for the old name will be removed in a future
148+
version.
149+
150+
`discovery.seed_resolver.timeout`::
151+
Specifies how long to wait for each DNS lookup performed when resolving the
152+
addresses of seed nodes. Defaults to `5s`. This setting was previously
153+
known as `discovery.zen.ping.unicast.hosts.resolve_timeout`. Its old name
154+
is deprecated but continues to work in order to preserve backwards
155+
compatibility. Support for the old name will be removed in a future
156+
version.
136157

137158
[[no-master-block]]`cluster.no_master_block`::
138159
Specifies which operations are rejected when there is no active master in a
@@ -169,6 +190,10 @@ earlier versions. The `discovery.zen.no_master_block` setting is ignored.
169190
format `host:port` or `host`, where `port` defaults to the setting
170191
`transport.profiles.default.port`. Note that IPv6 hosts must be bracketed.
171192
The default value is `127.0.0.1, [::1]`. See <<unicast.hosts>>.
193+
This setting was previously known as `discovery.zen.ping.unicast.hosts`.
194+
Its old name is deprecated but continues to work in order to preserve
195+
backwards compatibility. Support for the old name will be removed in a
196+
future version.
172197

173198
`discovery.seed_resolver.timeout`::
174199

0 commit comments

Comments
 (0)