Skip to content

Commit

Permalink
Cleaning documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
imotov authored and dadoonet committed May 28, 2014
1 parent b3f9e12 commit 67c5e39
Showing 1 changed file with 23 additions and 25 deletions.
48 changes: 23 additions & 25 deletions README.md
Expand Up @@ -24,11 +24,12 @@ Please read documentation relative to the version you are using:

The plugin will automatically use the instance level security credentials (as of 1.7.0), but they can be provided explicitly using `cloud.aws.access_key` and `cloud.aws.secret_key`:

cloud:
aws:
access_key: AKVAIQBF2RECL7FJWGJQ
secret_key: vExyMThREXeRMm/b/LRzEB8jWwvzQeXgjqMX+6br

```
cloud:
aws:
access_key: AKVAIQBF2RECL7FJWGJQ
secret_key: vExyMThREXeRMm/b/LRzEB8jWwvzQeXgjqMX+6br
```

### Region

Expand All @@ -50,13 +51,13 @@ The `cloud.aws.region` can be set to a region and will automatically use the rel

ec2 discovery allows to use the ec2 APIs to perform automatic discovery (similar to multicast in non hostile multicast environments). Here is a simple sample configuration:

cloud:
aws:
access_key: AKVAIQBF2RECL7FJWGJQ
secret_key: vExyMThREXeRMm/b/LRzEB8jWwvzQeXgjqMX+6br
```
discovery:
type: ec2
```

discovery:
type: ec2
The ec2 discovery is using the same credentials as the rest of the AWS services provided by this plugin (`repositories`).
See [Generic Configuration](#generic-configuration) for details.

The following are a list of settings (prefixed with `discovery.ec2`) that can further control the discovery:

Expand All @@ -80,13 +81,15 @@ Though not dependent on actually using `ec2` as discovery (but still requires th

The S3 repository is using S3 to store snapshots. The S3 repository can be created using the following command:

$ curl -XPUT 'http://localhost:9200/_snapshot/my_s3_repository' -d '{
"type": "s3",
"settings": {
"bucket": "my_bucket_name",
"region": "us-west"
}
}'
```sh
$ curl -XPUT 'http://localhost:9200/_snapshot/my_s3_repository' -d '{
"type": "s3",
"settings": {
"bucket": "my_bucket_name",
"region": "us-west"
}
}'
```

The following settings are supported:

Expand All @@ -99,13 +102,8 @@ The following settings are supported:
* `compress`: When set to `true` metadata files are stored in compressed format. This setting doesn't affect index files that are already compressed by default. Defaults to `false`.
* `server_side_encryption`: When set to `true` files are encrypted on server side using AES256 algorithm. Defaults to `false`.

The S3 repositories are using the same credentials as the rest of the AWS services provided by this plugin (`discovery` and `gateway`). They can be configured the following way:

cloud:
aws:
access_key: AKVAIQBF2RECL7FJWGJQ
secret_key: vExyMThREXeRMm/b/LRzEB8jWwvzQeXgjqMX+6br

The S3 repositories are using the same credentials as the rest of the AWS services provided by this plugin (`discovery`).
See [Generic Configuration](#generic-configuration) for details.

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

Expand Down

0 comments on commit 67c5e39

Please sign in to comment.