Skip to content

Commit 7de964c

Browse files
committed
Updated docs for 6.x
1 parent 6d7e011 commit 7de964c

File tree

1 file changed

+10
-13
lines changed

1 file changed

+10
-13
lines changed

README.md

+10-13
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
This module sets up [Elasticsearch](https://www.elastic.co/overview/elasticsearch/) instances with additional resource for plugins, templates, and more.
2323

24-
This module is actively tested against Elasticsearch 2.x and 5.x.
24+
This module is actively tested against Elasticsearch 2.x, 5.x, and 6.x.
2525

2626
## Setup
2727

@@ -62,15 +62,11 @@ Declare the top-level `elasticsearch` class (managing repositories) and set up a
6262
```puppet
6363
include ::java
6464
65-
class { 'elasticsearch':
66-
manage_repo => true,
67-
repo_version => '5.x',
68-
}
69-
65+
class { 'elasticsearch': }
7066
elasticsearch::instance { 'es-01': }
7167
```
7268

73-
**Note**: Elasticsearch 5.x requires a recent version of the JVM.
69+
**Note**: Elasticsearch 6.x requires a recent version of the JVM.
7470

7571
## Usage
7672

@@ -83,7 +79,7 @@ The following are some parameters that may be useful to override:
8379

8480
```puppet
8581
class { 'elasticsearch':
86-
version => '1.4.2'
82+
version => '6.0.0'
8783
}
8884
```
8985

@@ -208,7 +204,7 @@ Note that `module_dir` is where the plugin will install itself to and must match
208204
#### From an official repository
209205

210206
```puppet
211-
elasticsearch::plugin { 'lmenezes/elasticsearch-kopf':
207+
elasticsearch::plugin { 'x-pack':
212208
instances => 'instance_name'
213209
}
214210
```
@@ -257,7 +253,7 @@ elasticsearch::plugin { 'elasticsearch/elasticsearch-cloud-aws/2.4.1': }
257253

258254
Please note that this does not work when you specify 'latest' as a version number.
259255

260-
#### ES 2.x official plugins
256+
#### ES 2.x, 5.x, and 6.x official plugins
261257
For the Elasticsearch commercial plugins you can refer them to the simple name.
262258

263259
See [Plugin installation](https://www.elastic.co/guide/en/elasticsearch/plugins/current/installation.html) for more details.
@@ -445,12 +441,13 @@ class { 'elasticsearch':
445441
}
446442
```
447443

448-
For 2.x versions of Elasticsearch, use `repo_version => '2.x'`.
444+
For 2.x versions of Elasticsearch onward, use the major version of Elasticsearch suffixed by an `x`.
445+
For example:
449446

450447
```puppet
451448
class { 'elasticsearch':
452449
manage_repo => true,
453-
repo_version => '2.x',
450+
repo_version => '6.x',
454451
}
455452
```
456453

@@ -567,7 +564,7 @@ For example, the following manifest will install Elasticseach with a single inst
567564
```puppet
568565
class { 'elasticsearch':
569566
manage_repo => true,
570-
repo_version => '5.x',
567+
repo_version => '6.x',
571568
security_plugin => 'x-pack',
572569
}
573570

0 commit comments

Comments
 (0)