Browse Source

Default ec2 endpoint is ec2.us-east-1.amazonaws.com (#30323)

Today our docs claim that the `discovery-ec2` plugin auto-detects the EC2
endpoint, but this is not the case. This fixes these docs.

Closes #27464.
David Pilato 6 years ago
parent
commit
5fe4c9076c
1 changed files with 9 additions and 8 deletions
  1. 9 8
      docs/plugins/discovery-ec2.asciidoc

+ 9 - 8
docs/plugins/discovery-ec2.asciidoc

@@ -11,11 +11,12 @@ include::install_remove.asciidoc[]
 [[discovery-ec2-usage]]
 ==== Getting started with AWS
 
-The plugin provides a hosts provider for zen discovery named `ec2`. This hosts provider
-finds other Elasticsearch instances in EC2 through AWS metadata. Authentication is done using 
-http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html[IAM Role]
-credentials by default. The only necessary configuration change to enable the plugin
-is setting the unicast host provider for zen discovery:
+The plugin provides a hosts provider for zen discovery named `ec2`. This hosts
+provider finds other Elasticsearch instances in EC2 through AWS metadata.
+Authentication is done using
+http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html[IAM
+Role] credentials by default. To enable the plugin, set the unicast host
+provider for Zen discovery to `ec2`:
 
 [source,yaml]
 ----
@@ -51,9 +52,9 @@ Those that must be stored in the keystore are marked as `Secure`.
 
 `endpoint`::
 
-    The ec2 service endpoint to connect to. This will be automatically
-    figured out by the ec2 client based on the instance location, but
-    can be specified explicitly. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
+    The ec2 service endpoint to connect to. See
+    http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. This
+    defaults to `ec2.us-east-1.amazonaws.com`.
 
 `protocol`::