blob: 7d2a04f13806af1b3bd8a5d7903d3541f12b4595 [file] [log] [blame]
Filip Pytloun5163dfb2015-10-06 16:28:31 +02001{%- from "elasticsearch/map.jinja" import server with context %}
2
3##################### Elasticsearch Configuration Example #####################
4
5# This file contains an overview of various configuration settings,
6# targeted at operations staff. Application developers should
7# consult the guide at <http://elasticsearch.org/guide>.
8#
9# The installation procedure is covered at
10# <http://elasticsearch.org/guide/en/elasticsearch/reference/current/setup.html>.
11#
12# Elasticsearch comes with reasonable defaults for most settings,
13# so you can try it out without bothering with configuration.
14#
15# Most of the time, these defaults are just fine for running a production
16# cluster. If you're fine-tuning your cluster, or wondering about the
17# effect of certain configuration option, please _do ask_ on the
18# mailing list or IRC channel [http://elasticsearch.org/community].
19
20# Any element in the configuration can be replaced with environment variables
21# by placing them in ${...} notation. For example:
22#
23# node.rack: ${RACK_ENV_VAR}
24
25# For information on supported formats and syntax for the config file, see
26# <http://elasticsearch.org/guide/en/elasticsearch/reference/current/setup-configuration.html>
27
28
29################################### Cluster ###################################
30
31# Cluster name identifies your cluster for auto-discovery. If you're running
32# multiple clusters on the same network, make sure you're using unique names.
33#
34# cluster.name: elasticsearch
Filip Pytloun63c8c252016-05-05 16:14:02 +020035{%- if server.get('cluster', {}).name is defined %}
36cluster.name: {{ server.cluster.name }}
Filip Pytloun5163dfb2015-10-06 16:28:31 +020037{% endif %}
38#################################### Node #####################################
39
40# Node names are generated dynamically on startup, so you're relieved
41# from configuring them manually. You can tie this node to a specific name:
42#
43# node.name: "Franz Kafka"
Filip Pytloun465fa7a2016-05-05 14:39:30 +020044node.name: {{ server.get('name', '${HOSTNAME}') }}
Filip Pytloun5163dfb2015-10-06 16:28:31 +020045
46# Every node can be configured to allow or deny being eligible as the master,
47# and to allow or deny to store the data.
48#
49# Allow this node to be eligible as a master node (enabled by default):
50#
Filip Pytloun63c8c252016-05-05 16:14:02 +020051node.master: {{ server.get('master', True)|lower }}
Filip Pytloun5163dfb2015-10-06 16:28:31 +020052#
53# Allow this node to store data (enabled by default):
54#
Filip Pytloun63c8c252016-05-05 16:14:02 +020055node.data: {{ server.get('data', True)|lower }}
Filip Pytloun5163dfb2015-10-06 16:28:31 +020056
57# You can exploit these settings to design advanced cluster topologies.
58#
59# 1. You want this node to never become a master node, only to hold data.
60# This will be the "workhorse" of your cluster.
61#
62# node.master: false
63# node.data: true
64#
65# 2. You want this node to only serve as a master: to not store any data and
66# to have free resources. This will be the "coordinator" of your cluster.
67#
68# node.master: true
69# node.data: false
70#
71# 3. You want this node to be neither master nor data node, but
72# to act as a "search load balancer" (fetching data from nodes,
73# aggregating results, etc.)
74#
75# node.master: false
76# node.data: false
77
78# Use the Cluster Health API [http://localhost:9200/_cluster/health], the
79# Node Info API [http://localhost:9200/_nodes] or GUI tools
80# such as <http://www.elasticsearch.org/overview/marvel/>,
81# <http://github.com/karmi/elasticsearch-paramedic>,
82# <http://github.com/lukas-vlcek/bigdesk> and
83# <http://mobz.github.com/elasticsearch-head> to inspect the cluster state.
84
85# A node can have generic attributes associated with it, which can later be used
86# for customized shard allocation filtering, or allocation awareness. An attribute
87# is a simple key value pair, similar to node.key: value, here is an example:
88#
89# node.rack: rack314
Filip Pytloun63c8c252016-05-05 16:14:02 +020090{%- if server.rack is defined %}
91node.rack: {{ server.rack }}
92{%- endif %}
Filip Pytloun5163dfb2015-10-06 16:28:31 +020093
94# By default, multiple nodes are allowed to start from the same installation location
95# to disable it, set the following:
96# node.max_local_storage_nodes: 1
97
Guillaume Thouvenina4e640d2016-10-19 15:06:32 +020098{%- if server.get('threadpool', {}).get('bulk', {}).queue_size is defined %}
99# For bulk operations. Thread pool type is fixed with a size of # of available processors.
100threadpool.bulk.queue_size: {{ server.threadpool.bulk.queue_size }}
101{%- endif %}
Filip Pytloun5163dfb2015-10-06 16:28:31 +0200102
103#################################### Index ####################################
104
105# You can set a number of options (such as shard/replica options, mapping
106# or analyzer definitions, translog settings, ...) for indices globally,
107# in this file.
108#
109# Note, that it makes more sense to configure index settings specifically for
110# a certain index, either when creating it or by using the index templates API.
111#
112# See <http://elasticsearch.org/guide/en/elasticsearch/reference/current/index-modules.html> and
113# <http://elasticsearch.org/guide/en/elasticsearch/reference/current/indices-create-index.html>
114# for more information.
115
116# Set the number of shards (splits) of an index (5 by default):
117#
Filip Pytloun63c8c252016-05-05 16:14:02 +0200118index.number_of_shards: {{ server.get('index', {}).get('shards', 5) }}
Filip Pytloun5163dfb2015-10-06 16:28:31 +0200119
120# Set the number of replicas (additional copies) of an index (1 by default):
121#
Filip Pytloun63c8c252016-05-05 16:14:02 +0200122index.number_of_replicas: {{ server.get('index', {}).get('replicas', 1) }}
Filip Pytloun5163dfb2015-10-06 16:28:31 +0200123
124# Note, that for development on a local machine, with small indices, it usually
125# makes sense to "disable" the distributed features:
126#
127# index.number_of_shards: 1
128# index.number_of_replicas: 0
129
130# These settings directly affect the performance of index and search operations
131# in your cluster. Assuming you have enough machines to hold shards and
132# replicas, the rule of thumb is:
133#
134# 1. Having more *shards* enhances the _indexing_ performance and allows to
135# _distribute_ a big index across machines.
136# 2. Having more *replicas* enhances the _search_ performance and improves the
137# cluster _availability_.
138#
139# The "number_of_shards" is a one-time setting for an index.
140#
141# The "number_of_replicas" can be increased or decreased anytime,
142# by using the Index Update Settings API.
143#
144# Elasticsearch takes care about load balancing, relocating, gathering the
145# results from nodes, etc. Experiment with different settings to fine-tune
146# your setup.
147
148# Use the Index Status API (<http://localhost:9200/A/_status>) to inspect
149# the index status.
150
151
152#################################### Paths ####################################
153
154# Path to directory containing configuration (this file and logging.yml):
155#
156# path.conf: /path/to/conf
157
158# Path to directory where to store index data allocated for this node.
159#
160# path.data: /path/to/data
161#
162# Can optionally include more than one location, causing data to be striped across
163# the locations (a la RAID 0) on a file level, favouring locations with most free
164# space on creation. For example:
165#
166# path.data: /path/to/data1,/path/to/data2
167
168# Path to temporary files:
169#
170# path.work: /path/to/work
171
172# Path to log files:
173#
174# path.logs: /path/to/logs
175
176# Path to where plugins are installed:
177#
178# path.plugins: /path/to/plugins
179
180
181#################################### Plugin ###################################
182
183# If a plugin listed here is not installed for current node, the node will not start.
184#
185# plugin.mandatory: mapper-attachments,lang-groovy
186
187
188################################### Memory ####################################
189
190# Elasticsearch performs poorly when JVM starts swapping: you should ensure that
191# it _never_ swaps.
192#
193# Set this property to true to lock the memory:
194#
195# bootstrap.mlockall: true
Guillaume Thouvenina4e640d2016-10-19 15:06:32 +0200196{%- if server.mlockall is defined %}
197bootstrap.mlockall: {{ server.mlockall|lower }}
198{%- endif %}
Filip Pytloun5163dfb2015-10-06 16:28:31 +0200199
200# Make sure that the ES_MIN_MEM and ES_MAX_MEM environment variables are set
201# to the same value, and that the machine has enough memory to allocate
202# for Elasticsearch, leaving enough memory for the operating system itself.
203#
204# You should also make sure that the Elasticsearch process is allowed to lock
205# the memory, eg. by using `ulimit -l unlimited`.
206
207
208############################## Network And HTTP ###############################
209
210# Elasticsearch, by default, binds itself to the 0.0.0.0 address, and listens
211# on port [9200-9300] for HTTP traffic and on port [9300-9400] for node-to-node
212# communication. (the range means that if the port is busy, it will automatically
213# try the next port).
214
215# Set the bind address specifically (IPv4 or IPv6):
216#
217#
218network.bind_host: {{ server.bind.address }}
219http.port: {{ server.bind.port }}
220http.enabled: true
221# Set the address other nodes will use to communicate with this node. If not
222# set, it is automatically derived. It must point to an actual IP address.
223#
Filip Pytloun63c8c252016-05-05 16:14:02 +0200224{%- if server.publish_host is defined %}
225network.publish_host: {{ server.publish_host }}
226{%- endif %}
Filip Pytloun5163dfb2015-10-06 16:28:31 +0200227
228# Set both 'bind_host' and 'publish_host':
229#
230# network.host: 192.168.0.1
231
232# Set a custom port for the node to node communication (9300 by default):
233#
234# transport.tcp.port: 9300
235
236# Enable compression for all communication between nodes (disabled by default):
237#
238# transport.tcp.compress: true
239
240# Set a custom port to listen for HTTP traffic:
241#
242# http.port: 9200
243
244# Set a custom allowed content length:
245#
246# http.max_content_length: 100mb
247
248# Disable HTTP completely:
249#
250# http.enabled: false
251
252
253################################### Gateway ###################################
254
255# The gateway allows for persisting the cluster state between full cluster
256# restarts. Every change to the state (such as adding an index) will be stored
257# in the gateway, and when the cluster starts up for the first time,
258# it will read its state from the gateway.
259
260# There are several types of gateway implementations. For more information, see
261# <http://elasticsearch.org/guide/en/elasticsearch/reference/current/modules-gateway.html>.
262
263# The default gateway type is the "local" gateway (recommended):
264#
265# gateway.type: local
266
267# Settings below control how and when to start the initial recovery process on
268# a full cluster restart (to reuse as much local data as possible when using shared
269# gateway).
270
271# Allow recovery process after N nodes in a cluster are up:
272#
273# gateway.recover_after_nodes: 1
274
275# Set the timeout to initiate the recovery process, once the N nodes
276# from previous setting are up (accepts time value):
277#
278# gateway.recover_after_time: 5m
279
280# Set how many nodes are expected in this cluster. Once these N nodes
281# are up (and recover_after_nodes is met), begin recovery process immediately
282# (without waiting for recover_after_time to expire):
283#
284# gateway.expected_nodes: 2
285
286
287############################# Recovery Throttling #############################
288
289# These settings allow to control the process of shards allocation between
290# nodes during initial recovery, replica allocation, rebalancing,
291# or when adding and removing nodes.
292
293# Set the number of concurrent recoveries happening on a node:
294#
295# 1. During the initial recovery
296#
297# cluster.routing.allocation.node_initial_primaries_recoveries: 4
298#
299# 2. During adding/removing nodes, rebalancing, etc
300#
301# cluster.routing.allocation.node_concurrent_recoveries: 2
302
303# Set to throttle throughput when recovering (eg. 100mb, by default 20mb):
304#
305# indices.recovery.max_bytes_per_sec: 20mb
306
307# Set to limit the number of open concurrent streams when
308# recovering a shard from a peer:
309#
310# indices.recovery.concurrent_streams: 5
311
312
313################################## Discovery ##################################
314
315# Discovery infrastructure ensures nodes can be found within a cluster
316# and master node is elected. Multicast discovery is the default.
317
318# Set to ensure a node sees N other master eligible nodes to be considered
319# operational within the cluster. Its recommended to set it to a higher value
320# than 1 when running more than 2 nodes in the cluster.
321#
Filip Pytloun6c815a92016-06-28 21:49:00 +0200322discovery.zen.minimum_master_nodes: {{ server.get('cluster', {}).minimum_master_nodes|default(1) }}
Filip Pytloun5163dfb2015-10-06 16:28:31 +0200323
324# Set the time to wait for ping responses from other nodes when discovering.
325# Set this option to a higher value on a slow or congested network
326# to minimize discovery failures:
327#
328# discovery.zen.ping.timeout: 3s
329
330# For more information, see
331# <http://elasticsearch.org/guide/en/elasticsearch/reference/current/modules-discovery-zen.html>
332
333# Unicast discovery allows to explicitly control which nodes will be used
334# to discover the cluster. It can be used when multicast is not present,
335# or to restrict the cluster communication-wise.
336#
337# 1. Disable multicast discovery (enabled by default):
338#
Filip Pytloun63c8c252016-05-05 16:14:02 +0200339discovery.zen.ping.multicast.enabled: {{ server.get('cluster', {}).get('multicast', True)|lower }}
Filip Pytloun5163dfb2015-10-06 16:28:31 +0200340#
341# 2. Configure an initial list of master nodes in the cluster
342# to perform discovery when new nodes (master or data) are started:
343#
Filip Pytloun63c8c252016-05-05 16:14:02 +0200344{%- if server.get('cluster', {}).members is defined %}
345discovery.zen.ping.unicast.hosts: [{% for member in server.cluster.members %}"{{ member.host }}:{{ member.get('port', 9300) }}"{% if not loop.last %}, {% endif %}{% endfor %}]
346{%- endif %}
Filip Pytloun5163dfb2015-10-06 16:28:31 +0200347
348# EC2 discovery allows to use AWS EC2 API in order to perform discovery.
349#
350# You have to install the cloud-aws plugin for enabling the EC2 discovery.
351#
352# For more information, see
353# <http://elasticsearch.org/guide/en/elasticsearch/reference/current/modules-discovery-ec2.html>
354#
355# See <http://elasticsearch.org/tutorials/elasticsearch-on-ec2/>
356# for a step-by-step tutorial.
357
358# GCE discovery allows to use Google Compute Engine API in order to perform discovery.
359#
360# You have to install the cloud-gce plugin for enabling the GCE discovery.
361#
362# For more information, see <https://github.com/elasticsearch/elasticsearch-cloud-gce>.
363
364# Azure discovery allows to use Azure API in order to perform discovery.
365#
366# You have to install the cloud-azure plugin for enabling the Azure discovery.
367#
368# For more information, see <https://github.com/elasticsearch/elasticsearch-cloud-azure>.
369
370################################## Slow Log ##################################
371
372# Shard level query and fetch threshold logging.
373
374#index.search.slowlog.threshold.query.warn: 10s
375#index.search.slowlog.threshold.query.info: 5s
376#index.search.slowlog.threshold.query.debug: 2s
377#index.search.slowlog.threshold.query.trace: 500ms
378
379#index.search.slowlog.threshold.fetch.warn: 1s
380#index.search.slowlog.threshold.fetch.info: 800ms
381#index.search.slowlog.threshold.fetch.debug: 500ms
382#index.search.slowlog.threshold.fetch.trace: 200ms
383
384#index.indexing.slowlog.threshold.index.warn: 10s
385#index.indexing.slowlog.threshold.index.info: 5s
386#index.indexing.slowlog.threshold.index.debug: 2s
387#index.indexing.slowlog.threshold.index.trace: 500ms
388
389################################## GC Logging ################################
390
391#monitor.jvm.gc.young.warn: 1000ms
392#monitor.jvm.gc.young.info: 700ms
393#monitor.jvm.gc.young.debug: 400ms
394
395#monitor.jvm.gc.old.warn: 10s
396#monitor.jvm.gc.old.info: 5s
397#monitor.jvm.gc.old.debug: 2s