3.29. Elasticsearch Embedded mode Configuration

Warning

You are looking at documentation for an older release. Not what you want? See the current release documentation.

When deployed as embedded, the Elasticsearch configuration files (elasticsearch.yml and logging.yml) are embedded in the add-on. All the properties can be set directly in exo.properties and will override the default properties defined in elasticsearch.yml and logging.yml.

Properties of the Elasticsearch embedded node

All the properties below are standard properties of Elasticsearch. When a property es.xxx is defined in exo.properties, it is automatically picked by the embedded Elasticsearch node (without the "es." prefix).

################################ Elasticsearch Embedded node ################################

es.cluster.name=exoplatform-es
es.node.name=exoplatform-es-embedded
es.network.host=127.0.0.1
es.discovery.zen.ping.multicast.enabled=false
es.discovery.zen.ping.unicast.hosts=["127.0.0.1"]
es.http.port=9200
es.path.data=gatein/data

More details about these properties can be found in the Properties reference chapter.

Properties of the Elasticsearch client

eXo Platform communicates with the Elasticsearch server via multiple components through so-called client code. The client code differentiates calls done to the server for indexing and for searching. It allows to have different a deployment topology where different Elasticsearch server have different roles. The following client paramters are configurable in exo.properties

################################ Elasticsearch ################################
exo.es.embedded.enabled=true
exo.es.index.server.url=http://127.0.0.1:9200
exo.es.index.server.username=root
exo.es.index.server.password=xxxxx
exo.es.indexing.batch.number=1000
exo.es.indexing.replica.number.default=1
exo.es.indexing.shard.number.default=5
exo.es.indexing.request.size.limit=10485760
exo.es.reindex.batch.size=100
exo.es.search.server.url=http://127.0.0.1:9200
exo.es.search.server.username=root
exo.es.search.server.password=xxxxx

The parameter

exo.es.embedded.enabled=true

allows to enable/disable Elasticsearch Embedded node startup. It is set to True by default. More details about the parameters in Properties reference.

Properties of the indexing processor and connectors

The properties below allow to configure indexing parameters such as the number of shards, replicas, batch size...

For more details about indexing with Elasticseach, you can take a look in this documentation

################################ Properties of the indexing processor ################################
exo.es.indexing.batch.number=1000
exo.es.indexing.request.size.limit=10485760
exo.es.reindex.batch.size=100
################################ Properties of the indexing connectors ################################
exo.es.indexing.replica.number.default=1
exo.es.indexing.shard.number.default=5
More details about the parameters in Properties reference.
Copyright ©. All rights reserved. eXo Platform SAS
blog comments powered byDisqus