Skip to content

Commit f0fbea5

Browse files
committed
Allow AWS compatible cloud services
Users can use their own endpoints for any ec2/s3 compatible API using: `cloud.aws.ec2.endpoint` or `cloud.aws.s3.endpoint` Closes #91.
1 parent 4380b84 commit f0fbea5

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,11 @@ One practical use for tag filtering is when an ec2 cluster contains many nodes t
8484

8585
Though not dependent on actually using `ec2` as discovery (but still requires the cloud aws plugin installed), the plugin can automatically add node attributes relating to ec2 (for example, availability zone, that can be used with the awareness allocation feature). In order to enable it, set `cloud.node.auto_attributes` to `true` in the settings.
8686

87+
### Using other EC2 endpoint
88+
89+
If you are using any EC2 api compatible service, you can set the endpoint you want to use by setting `cloud.aws.ec2.endpoint`
90+
to your URL provider.
91+
8792
## S3 Repository
8893

8994
The S3 repository is using S3 to store snapshots. The S3 repository can be created using the following command:
@@ -114,7 +119,7 @@ See [Generic Configuration](#generic-configuration) for details.
114119

115120
Multiple S3 repositories can be created. If the buckets require different credentials, then define them as part of the repository settings.
116121

117-
## Recommended S3 Permissions
122+
### Recommended S3 Permissions
118123

119124
In order to restrict the Elasticsearch snapshot process to the minimum required resources, we recommend using Amazon IAM in conjunction with pre-existing S3 buckets. Here is an example policy which will allow the snapshot access to an S3 bucket named "snaps.example.com". This may be configured through the AWS IAM console, by creating a Custom Policy, and using a Policy Document similar to this (changing snaps.example.com to your bucket name).
120125

@@ -199,6 +204,12 @@ The bucket needs to exist to register a repository for snapshots. If you did not
199204
}
200205
```
201206

207+
### Using other S3 endpoint
208+
209+
If you are using any S3 api compatible service, you can set the endpoint you want to use by setting `cloud.aws.s3.endpoint`
210+
to your URL provider.
211+
212+
202213
## Testing
203214

204215
Integrations tests in this plugin require working AWS configuration and therefore disabled by default. Three buckets and two iam users have to be created. The first iam user needs access to two buckets in different regions and the final bucket is exclusive for the other iam user. To enable tests prepare a config file elasticsearch.yml with the following content:

0 commit comments

Comments
 (0)