Skip to content

Commit be7b3e7

Browse files
committed
[DOCS] Show EC2's auto attribute (#21474)
* [DOCS] Show EC2's auto attribute This documents the `aws_availability_zone` node attribute as part of the `discovery-ec2` plugin. Also fixes outdated usage of "cloud aws".
1 parent e9ed88c commit be7b3e7

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

docs/plugins/discovery-ec2.asciidoc

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -250,9 +250,20 @@ name - highly undesirable). Tagging elasticsearch ec2 nodes and then filtering b
250250
[[discovery-ec2-attributes]]
251251
===== Automatic Node Attributes
252252

253-
Though not dependent on actually using `ec2` as discovery (but still requires the cloud aws plugin installed), the
254-
plugin can automatically add node attributes relating to ec2 (for example, availability zone, that can be used with
255-
the awareness allocation feature). In order to enable it, set `cloud.node.auto_attributes` to `true` in the settings.
253+
Though not dependent on actually using `ec2` as discovery (but still requires the `discovery-ec2` plugin installed), the
254+
plugin can automatically add node attributes relating to ec2. In the future this may support other attributes, but this will
255+
currently only add an `aws_availability_zone` node attribute, which is the availability zone of the current node. Attributes
256+
can be used to isolate primary and replica shards across availability zones by using the
257+
{ref}/allocation-awareness.html[Allocation Awareness] feature.
258+
259+
In order to enable it, set `cloud.node.auto_attributes` to `true` in the settings. For example:
260+
261+
[source,yaml]
262+
----
263+
cloud.node.auto_attributes: true
264+
265+
cluster.routing.allocation.awareness.attributes: aws_availability_zone
266+
----
256267

257268
[[discovery-ec2-endpoint]]
258269
===== Using other EC2 endpoint

0 commit comments

Comments
 (0)