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.
This commit is contained in:
David Pilato 2018-12-14 10:30:39 +01:00 committed by David Turner
parent b7ba2fa74b
commit 5fe4c9076c
1 changed files with 9 additions and 8 deletions

View File

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