Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Elasticsearch requires configuration and settings file changes to be made consistently across the Elasticsearch cluster.

...

Info

Caution

  • Errors in adding and completing these settings can prevent the Elasticsearch service from working properly.

  • If Elasticsearch's path.data location is customized from the default, adjust all references to it below to reflect the new location.

Elasticsearch Config File

Info

Version differences

The Elasticsearch configuration settings have changed with each major release. To track how they changed since Elasticsearch 2.3.3, see Elasticsearch Configuration Differences.

Edit the Elasticsearch config file: /etc/elasticsearch/elasticsearch.yml

action.auto_create_index: "+csmeter*,+*_nfsconnector,.watches,
.triggered_watches,.watcher-history-*"

Needed to disable automatic index creation, csmeter indices, and Swarm NFS connectors. (v10.1)

cluster.name: <ES_cluster_name>

Provide the Elasticsearch cluster a unique name, which is unrelated to the Swarm cluster name. Do not use periods in the name.

Info

Important

To prevent merging, it must differ from the cluster.name of the legacy ES cluster, if one is operating.

node.name: <ES_node_name>

Optional. Elasticsearch supplies a node name if one is not set. Do not use periods in the name.

network.host: _site_

Assign a specific hostname or IP address, which requires clients to access the ES server using that address. If using a hostname, update /etc/hosts. Defaults to the special value, _site_.

cluster.initial_master_nodes

(ES 7+) For first-time bootstrapping of a production ES cluster. Set to an array or comma-delimited list of the hostnames of the master-eligible ES nodes whose votes should be counted in the very first election.

discovery.zen.
minimum_master_nodes: 3

(ES 6 only)  Set to (number of master-eligible nodes / 2, rounded down) + 1. Prevents split-brain scenarios by setting the minimum number of ES nodes online before deciding on electing a new master.

discovery.seed_hosts

(ES 7+) Enables auto-clustering of ES nodes across hosts. Set to an array or comma-delimited list of the addresses of all master-eligible nodes in the cluster. 

discovery.zen.ping.unicast.hosts: ["es0", "es1"]

(ES 6 only) Set to the list of node names/IPs in the cluster, verifying all ES servers are included. Multicast is disabled by default.

gateway.expected_nodes: 4

Add and set to the number of nodes in the ES cluster. Recovery of local shards starts as soon as this number of nodes have joined the cluster. It falls back to the recover_after_nodes value after 5 minutes. This example is for a 4-node cluster.

gateway.recover_after_nodes: 2

Set to the minimum number of ES nodes started before going into operation status:

  • If total nodes is 1 or 2, set to 1.

  • If total nodes is 3 or 4, set to 2.

  • If total nodes is 5 to 7, set to the number – 2.

  • If total nodes 8 or more, set to the number – 3.

bootstrap.memory_lock: true

Set to lock the memory on startup to verify Elasticsearch does not swap (swapping leads to poor performance). Verify enough system memory resources are available for all processes running on the server.

To allow the elasticsearch user to disable swapping and to increase the number of open file descriptors, the RPM installer makes these edits to/etc/security/limits.d/10-caringo-elasticsearch.conf

Code Block
languagebash
# Custom for Caringo Swarm
elasticsearch soft nofile 65536
elasticsearch hard nofile 65536
elasticsearch soft nproc 4096
elasticsearch hard nproc 4096
# allow user 'elasticsearch' memlock
elasticsearch soft memlock unlimited
elasticsearch hard memlock unlimited

path.data: <path_to_data_directory>

By default, path.data goes to /var/lib/elasticsearch with the needed ownership. Choose a separate, dedicated partition of ample size, and make the elasticsearch user the owner of that directory to move the Elasticsearch data directory:

Code Block
languagebash
chown -R elasticsearch:elasticsearch <path_to_data_directory>

thread_pool.write.queue_size

The size of the queue used for bulk indexing.

This variable was called threadpool.bulk.queue_size in earlier Elasticsearch versions.

...

  1. Create the override file:

    Code Block
    languagebash
     /etc/systemd/system/elasticsearch.service.d/override.conf
  2. Add this content: 

    Code Block
    languagebash
    [Service]
    LimitMEMLOCK=infinity
  3. Load the override file (; otherwise, the setting does not take effect until the next reboot):

    Code Block
    languagebash
    sudo systemctl daemon-reload

...