Skip to content

Commit a09d14e

Browse files
committed
[TASK] update README.md to update install instructions for ElasticSearch 1.2, 1.3, 1.4
1 parent be083d6 commit a09d14e

1 file changed

Lines changed: 65 additions & 33 deletions

File tree

README.md

Lines changed: 65 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -32,39 +32,6 @@ Relevant Packages:
3232

3333
The configuration from Version 1 to Version 2 has changed; here's what to change:
3434

35-
**elasticsearch.yaml**
36-
37-
Due to the fact that the default scripting language has changed from marvel to groovy since elasticsearch 1.3.0,
38-
there is a need, depending on your running installation of ElasticSearch, to add following lines of configuration to your
39-
ElasticSearch Configuration File `elasticsearch.yaml`.
40-
41-
If you are using ElasticSearch version 1.2 you have also to install groovy as a plugin. To install the plugin just run
42-
the following command in the root folder of your elastic:
43-
44-
```
45-
bin/plugin -install elasticsearch/elasticsearch-lang-groovy/2.2.0.
46-
```
47-
48-
```
49-
script.disable_dynamic: false
50-
script.default_lang: groovy
51-
52-
```
53-
54-
For running with version > 1.3.x, what is recommended, it is sufficient to add following lines to your
55-
`elasticsearch.yaml`.
56-
57-
58-
```
59-
script.groovy.sandbox.class_whitelist: java.util.LinkedHashMap
60-
script.groovy.sandbox.receiver_whitelist: java.util.Iterator, java.lang.Object, java.util.Map, java.util.Map$Entry
61-
```
62-
63-
You can get further information about this topic here:
64-
65-
http://www.elasticsearch.org/blog/elasticsearch-1-3-0-released/
66-
http://www.elasticsearch.org/blog/scripting-security/
67-
http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-scripting.html
6835

6936
**Settings.yaml**
7037

@@ -94,6 +61,71 @@ http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-sc
9461
4. Search for `ElasticSearch.` (inside the `indexing` expressions) and replace them by `Indexing.`
9562

9663

64+
65+
66+
67+
## ElasticSearch Configuration file elasticsearch.yaml
68+
69+
Due to the fact that the default scripting language has changed from marvel to groovy since elasticsearch 1.3.0,
70+
there is a need, depending on your running installation of ElasticSearch, to add following lines of configuration to your
71+
ElasticSearch Configuration File `elasticsearch.yaml`.
72+
73+
### Needed Configuration in configuration.yaml for ElasticSearch 1.4.x
74+
75+
```
76+
# The following settings are absolutely required for the CR adaptor to work
77+
script.disable_dynamic: sandbox
78+
script.groovy.sandbox.class_whitelist: java.util.LinkedHashMap
79+
script.groovy.sandbox.receiver_whitelist: java.util.Iterator, java.lang.Object, java.util.Map, java.util.Map$Entry
80+
script.groovy.sandbox.enabled: true
81+
82+
# the following settings secure your cluster
83+
cluster.name: [PUT_YOUR_CUSTOM_NAME_HERE]
84+
network.host: 127.0.0.1
85+
86+
# the following settings are well-suited for smaller ElasticSearch instances (e.g. as long as you can stay on one host)
87+
index.number_of_shards: 1
88+
index.number_of_replicas: 0
89+
```
90+
91+
### Needed Configuration in configuration.yaml for ElasticSearch 1.3.x
92+
93+
```
94+
# The following settings are absolutely required for the CR adaptor to work
95+
script.groovy.sandbox.class_whitelist: java.util.LinkedHashMap
96+
script.groovy.sandbox.receiver_whitelist: java.util.Iterator, java.lang.Object, java.util.Map, java.util.Map$Entry
97+
98+
# the following settings secure your cluster
99+
cluster.name: [PUT_YOUR_CUSTOM_NAME_HERE]
100+
network.host: 127.0.0.1
101+
102+
# the following settings are well-suited for smaller ElasticSearch instances (e.g. as long as you can stay on one host)
103+
index.number_of_shards: 1
104+
index.number_of_replicas: 0
105+
```
106+
107+
You can get further information about this topic here:
108+
109+
http://www.elasticsearch.org/blog/elasticsearch-1-3-0-released/
110+
http://www.elasticsearch.org/blog/scripting-security/
111+
http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-scripting.html
112+
113+
## Needed Configuration for ElasticSearch 1.2.x
114+
115+
116+
If you are using ElasticSearch version 1.2 you have also to install groovy as a plugin. To install the plugin just run
117+
the following command in the root folder of your elastic:
118+
119+
```
120+
bin/plugin -install elasticsearch/elasticsearch-lang-groovy/2.2.0.
121+
```
122+
123+
```
124+
script.disable_dynamic: false
125+
script.default_lang: groovy
126+
127+
```
128+
97129
## Building up the Index
98130

99131
The node index is updated on the fly, but during development you need to update it frequently.

0 commit comments

Comments
 (0)