1 {%- from "elasticsearch/map.jinja" import server with context %}
3 ##################### Elasticsearch Configuration Example #####################
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>.
9 # The installation procedure is covered at
10 # <http://elasticsearch.org/guide/en/elasticsearch/reference/current/setup.html>.
12 # Elasticsearch comes with reasonable defaults for most settings,
13 # so you can try it out without bothering with configuration.
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].
20 # Any element in the configuration can be replaced with environment variables
21 # by placing them in ${...} notation. For example:
23 # node.rack: ${RACK_ENV_VAR}
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>
29 ################################### Cluster ###################################
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.
34 # cluster.name: elasticsearch
35 {%- if server.clustername is defined %}
37 cluster.name: {{ server.clustername }}
40 #################################### Node #####################################
42 # Node names are generated dynamically on startup, so you're relieved
43 # from configuring them manually. You can tie this node to a specific name:
45 # node.name: "Franz Kafka"
46 node.name: {{ server.get('name', '${HOSTNAME}') }}
48 # Every node can be configured to allow or deny being eligible as the master,
49 # and to allow or deny to store the data.
51 # Allow this node to be eligible as a master node (enabled by default):
55 # Allow this node to store data (enabled by default):
59 # You can exploit these settings to design advanced cluster topologies.
61 # 1. You want this node to never become a master node, only to hold data.
62 # This will be the "workhorse" of your cluster.
67 # 2. You want this node to only serve as a master: to not store any data and
68 # to have free resources. This will be the "coordinator" of your cluster.
73 # 3. You want this node to be neither master nor data node, but
74 # to act as a "search load balancer" (fetching data from nodes,
75 # aggregating results, etc.)
80 # Use the Cluster Health API [http://localhost:9200/_cluster/health], the
81 # Node Info API [http://localhost:9200/_nodes] or GUI tools
82 # such as <http://www.elasticsearch.org/overview/marvel/>,
83 # <http://github.com/karmi/elasticsearch-paramedic>,
84 # <http://github.com/lukas-vlcek/bigdesk> and
85 # <http://mobz.github.com/elasticsearch-head> to inspect the cluster state.
87 # A node can have generic attributes associated with it, which can later be used
88 # for customized shard allocation filtering, or allocation awareness. An attribute
89 # is a simple key value pair, similar to node.key: value, here is an example:
93 # By default, multiple nodes are allowed to start from the same installation location
94 # to disable it, set the following:
95 # node.max_local_storage_nodes: 1
98 #################################### Index ####################################
100 # You can set a number of options (such as shard/replica options, mapping
101 # or analyzer definitions, translog settings, ...) for indices globally,
104 # Note, that it makes more sense to configure index settings specifically for
105 # a certain index, either when creating it or by using the index templates API.
107 # See <http://elasticsearch.org/guide/en/elasticsearch/reference/current/index-modules.html> and
108 # <http://elasticsearch.org/guide/en/elasticsearch/reference/current/indices-create-index.html>
109 # for more information.
111 # Set the number of shards (splits) of an index (5 by default):
113 # index.number_of_shards: 5
115 # Set the number of replicas (additional copies) of an index (1 by default):
117 # index.number_of_replicas: 1
119 # Note, that for development on a local machine, with small indices, it usually
120 # makes sense to "disable" the distributed features:
122 # index.number_of_shards: 1
123 # index.number_of_replicas: 0
125 # These settings directly affect the performance of index and search operations
126 # in your cluster. Assuming you have enough machines to hold shards and
127 # replicas, the rule of thumb is:
129 # 1. Having more *shards* enhances the _indexing_ performance and allows to
130 # _distribute_ a big index across machines.
131 # 2. Having more *replicas* enhances the _search_ performance and improves the
132 # cluster _availability_.
134 # The "number_of_shards" is a one-time setting for an index.
136 # The "number_of_replicas" can be increased or decreased anytime,
137 # by using the Index Update Settings API.
139 # Elasticsearch takes care about load balancing, relocating, gathering the
140 # results from nodes, etc. Experiment with different settings to fine-tune
143 # Use the Index Status API (<http://localhost:9200/A/_status>) to inspect
147 #################################### Paths ####################################
149 # Path to directory containing configuration (this file and logging.yml):
151 # path.conf: /path/to/conf
153 # Path to directory where to store index data allocated for this node.
155 # path.data: /path/to/data
157 # Can optionally include more than one location, causing data to be striped across
158 # the locations (a la RAID 0) on a file level, favouring locations with most free
159 # space on creation. For example:
161 # path.data: /path/to/data1,/path/to/data2
163 # Path to temporary files:
165 # path.work: /path/to/work
169 # path.logs: /path/to/logs
171 # Path to where plugins are installed:
173 # path.plugins: /path/to/plugins
176 #################################### Plugin ###################################
178 # If a plugin listed here is not installed for current node, the node will not start.
180 # plugin.mandatory: mapper-attachments,lang-groovy
183 ################################### Memory ####################################
185 # Elasticsearch performs poorly when JVM starts swapping: you should ensure that
188 # Set this property to true to lock the memory:
190 # bootstrap.mlockall: true
192 # Make sure that the ES_MIN_MEM and ES_MAX_MEM environment variables are set
193 # to the same value, and that the machine has enough memory to allocate
194 # for Elasticsearch, leaving enough memory for the operating system itself.
196 # You should also make sure that the Elasticsearch process is allowed to lock
197 # the memory, eg. by using `ulimit -l unlimited`.
200 ############################## Network And HTTP ###############################
202 # Elasticsearch, by default, binds itself to the 0.0.0.0 address, and listens
203 # on port [9200-9300] for HTTP traffic and on port [9300-9400] for node-to-node
204 # communication. (the range means that if the port is busy, it will automatically
205 # try the next port).
207 # Set the bind address specifically (IPv4 or IPv6):
210 network.bind_host: {{ server.bind.address }}
211 http.port: {{ server.bind.port }}
213 # Set the address other nodes will use to communicate with this node. If not
214 # set, it is automatically derived. It must point to an actual IP address.
216 # network.publish_host: 192.168.0.1
218 # Set both 'bind_host' and 'publish_host':
220 # network.host: 192.168.0.1
222 # Set a custom port for the node to node communication (9300 by default):
224 # transport.tcp.port: 9300
226 # Enable compression for all communication between nodes (disabled by default):
228 # transport.tcp.compress: true
230 # Set a custom port to listen for HTTP traffic:
234 # Set a custom allowed content length:
236 # http.max_content_length: 100mb
238 # Disable HTTP completely:
240 # http.enabled: false
243 ################################### Gateway ###################################
245 # The gateway allows for persisting the cluster state between full cluster
246 # restarts. Every change to the state (such as adding an index) will be stored
247 # in the gateway, and when the cluster starts up for the first time,
248 # it will read its state from the gateway.
250 # There are several types of gateway implementations. For more information, see
251 # <http://elasticsearch.org/guide/en/elasticsearch/reference/current/modules-gateway.html>.
253 # The default gateway type is the "local" gateway (recommended):
255 # gateway.type: local
257 # Settings below control how and when to start the initial recovery process on
258 # a full cluster restart (to reuse as much local data as possible when using shared
261 # Allow recovery process after N nodes in a cluster are up:
263 # gateway.recover_after_nodes: 1
265 # Set the timeout to initiate the recovery process, once the N nodes
266 # from previous setting are up (accepts time value):
268 # gateway.recover_after_time: 5m
270 # Set how many nodes are expected in this cluster. Once these N nodes
271 # are up (and recover_after_nodes is met), begin recovery process immediately
272 # (without waiting for recover_after_time to expire):
274 # gateway.expected_nodes: 2
277 ############################# Recovery Throttling #############################
279 # These settings allow to control the process of shards allocation between
280 # nodes during initial recovery, replica allocation, rebalancing,
281 # or when adding and removing nodes.
283 # Set the number of concurrent recoveries happening on a node:
285 # 1. During the initial recovery
287 # cluster.routing.allocation.node_initial_primaries_recoveries: 4
289 # 2. During adding/removing nodes, rebalancing, etc
291 # cluster.routing.allocation.node_concurrent_recoveries: 2
293 # Set to throttle throughput when recovering (eg. 100mb, by default 20mb):
295 # indices.recovery.max_bytes_per_sec: 20mb
297 # Set to limit the number of open concurrent streams when
298 # recovering a shard from a peer:
300 # indices.recovery.concurrent_streams: 5
303 ################################## Discovery ##################################
305 # Discovery infrastructure ensures nodes can be found within a cluster
306 # and master node is elected. Multicast discovery is the default.
308 # Set to ensure a node sees N other master eligible nodes to be considered
309 # operational within the cluster. Its recommended to set it to a higher value
310 # than 1 when running more than 2 nodes in the cluster.
312 # discovery.zen.minimum_master_nodes: 1
314 # Set the time to wait for ping responses from other nodes when discovering.
315 # Set this option to a higher value on a slow or congested network
316 # to minimize discovery failures:
318 # discovery.zen.ping.timeout: 3s
320 # For more information, see
321 # <http://elasticsearch.org/guide/en/elasticsearch/reference/current/modules-discovery-zen.html>
323 # Unicast discovery allows to explicitly control which nodes will be used
324 # to discover the cluster. It can be used when multicast is not present,
325 # or to restrict the cluster communication-wise.
327 # 1. Disable multicast discovery (enabled by default):
329 # discovery.zen.ping.multicast.enabled: false
331 # 2. Configure an initial list of master nodes in the cluster
332 # to perform discovery when new nodes (master or data) are started:
334 # discovery.zen.ping.unicast.hosts: ["host1", "host2:port"]
336 # EC2 discovery allows to use AWS EC2 API in order to perform discovery.
338 # You have to install the cloud-aws plugin for enabling the EC2 discovery.
340 # For more information, see
341 # <http://elasticsearch.org/guide/en/elasticsearch/reference/current/modules-discovery-ec2.html>
343 # See <http://elasticsearch.org/tutorials/elasticsearch-on-ec2/>
344 # for a step-by-step tutorial.
346 # GCE discovery allows to use Google Compute Engine API in order to perform discovery.
348 # You have to install the cloud-gce plugin for enabling the GCE discovery.
350 # For more information, see <https://github.com/elasticsearch/elasticsearch-cloud-gce>.
352 # Azure discovery allows to use Azure API in order to perform discovery.
354 # You have to install the cloud-azure plugin for enabling the Azure discovery.
356 # For more information, see <https://github.com/elasticsearch/elasticsearch-cloud-azure>.
358 ################################## Slow Log ##################################
360 # Shard level query and fetch threshold logging.
362 #index.search.slowlog.threshold.query.warn: 10s
363 #index.search.slowlog.threshold.query.info: 5s
364 #index.search.slowlog.threshold.query.debug: 2s
365 #index.search.slowlog.threshold.query.trace: 500ms
367 #index.search.slowlog.threshold.fetch.warn: 1s
368 #index.search.slowlog.threshold.fetch.info: 800ms
369 #index.search.slowlog.threshold.fetch.debug: 500ms
370 #index.search.slowlog.threshold.fetch.trace: 200ms
372 #index.indexing.slowlog.threshold.index.warn: 10s
373 #index.indexing.slowlog.threshold.index.info: 5s
374 #index.indexing.slowlog.threshold.index.debug: 2s
375 #index.indexing.slowlog.threshold.index.trace: 500ms
377 ################################## GC Logging ################################
379 #monitor.jvm.gc.young.warn: 1000ms
380 #monitor.jvm.gc.young.info: 700ms
381 #monitor.jvm.gc.young.debug: 400ms
383 #monitor.jvm.gc.old.warn: 10s
384 #monitor.jvm.gc.old.info: 5s
385 #monitor.jvm.gc.old.debug: 2s