Skip to content

Commit d9638e6

Browse files
committed
Simplify documentation
Closes #106
1 parent 8a83143 commit d9638e6

File tree

4 files changed

+412
-253
lines changed

4 files changed

+412
-253
lines changed

README.md

+19-16
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,30 @@ AWS Cloud Plugin for Elasticsearch
44
The Amazon Web Service (AWS) Cloud plugin allows to use [AWS API](https://github.com/aws/aws-sdk-java)
55
for the unicast discovery mechanism and add S3 repositories.
66

7-
In order to install the plugin, run: `bin/plugin -install elasticsearch/elasticsearch-cloud-aws/2.1.1`.
7+
In order to install the plugin, run:
88

9-
where `2.1.1` would be the version applicable to your elasticsearch release, as follows:
10-
11-
* For master elasticsearch versions, look at [master branch](https://github.com/elasticsearch/elasticsearch-cloud-aws/tree/master).
12-
* For 1.3.x elasticsearch versions, look at [es-1.3 branch](https://github.com/elasticsearch/elasticsearch-cloud-aws/tree/es-1.3).
13-
* For 1.2.x elasticsearch versions, look at [es-1.2 branch](https://github.com/elasticsearch/elasticsearch-cloud-aws/tree/es-1.2).
14-
* For 1.1.x elasticsearch versions, look at [es-1.1 branch](https://github.com/elasticsearch/elasticsearch-cloud-aws/tree/es-1.1).
15-
* For 1.0.x elasticsearch versions, look at [es-1.0 branch](https://github.com/elasticsearch/elasticsearch-cloud-aws/tree/es-1.0).
16-
* For 0.90.x elasticsearch versions, look at [es-0.90 branch](https://github.com/elasticsearch/elasticsearch-cloud-aws/tree/es-0.90).
9+
```sh
10+
bin/plugin -install elasticsearch/elasticsearch-cloud-aws/2.2.0
11+
```
1712

18-
SNAPSHOT releases are still in development are _NOT_ available for automatic installation with `bin/plugin`. In such cases
19-
you would be responsible building the plugin and providing the file/url yourself.
13+
You need to install a version matching your Elasticsearch version:
2014

21-
| AWS Cloud Plugin | elasticsearch | Release date |
22-
|----------------------------|---------------------|:------------:|
23-
| 3.0.0-SNAPSHOT | master | XXXX-XX-XX |
15+
| Elasticsearch | AWS Cloud Plugin | Docs |
16+
|------------------------|-------------------|------------------------------------------------------------------------------------------------------------------------------------|
17+
| master | Build from source | See below |
18+
| es-1.3 | Build from source | [2.3.0-SNAPSHOT](https://github.com/elasticsearch/elasticsearch-cloud-aws/tree/es-1.3/#version-230-snapshot-for-elasticsearch-13) |
19+
| es-1.2 | 2.2.0 | [2.2.0](https://github.com/elasticsearch/elasticsearch-cloud-aws/tree/v2.2.0/#aws-cloud-plugin-for-elasticsearch) |
20+
| es-1.1 | 2.1.1 | [2.1.1](https://github.com/elasticsearch/elasticsearch-cloud-aws/tree/v2.1.1/#aws-cloud-plugin-for-elasticsearch) |
21+
| es-1.0 | 2.0.0 | [2.0.0](https://github.com/elasticsearch/elasticsearch-cloud-aws/tree/v2.0.0/#aws-cloud-plugin-for-elasticsearch) |
22+
| es-0.90 | 1.16.0 | [1.16.0](https://github.com/elasticsearch/elasticsearch-cloud-aws/tree/v1.16.0/#aws-cloud-plugin-for-elasticsearch) |
2423

25-
Please read documentation relative to the version you are using:
24+
To build a `SNAPSHOT` version, you need to build it with Maven:
2625

27-
* [3.0.0-SNAPSHOT](https://github.com/elasticsearch/elasticsearch-cloud-aws/blob/master/README.md)
26+
```bash
27+
mvn clean install
28+
plugin --install cloud-aws \
29+
--url file:target/releases/elasticsearch-cloud-aws-X.X.X-SNAPSHOT.zip
30+
```
2831

2932
## Generic Configuration
3033

0 commit comments

Comments
 (0)