Elastic Search Index Feeder

Edition

Incubator (services)

Issues

ESINDEXF

Git

Git

Latest

1.0

Compatible with Magnolia 6.2.

The Elastic Search Index Feeder module allows you to feed the Elasticsearch index with pre-defined data from Magnolia during publication events.

This module is at the INCUBATOR level.

Prerequisites

In order to use this module, you’ll need to make sure you have the following as well:

Installing with Maven

Maven is the easiest way to install the module. Add the following to your bundle:

<dependency>
  <groupId>info.magnolia.elasticsearch</groupId>
  <artifactId>elastic-search-index-feeder</artifactId>
  <version>1.0</version>
</dependency>

Usage

Elasticsearch Index Creation and Treatment

One Index per Workspace

  • One Index per Workspace

  • One Index for every webhook

useOneIndexPerWorkspace: true

If this setting was chosen, the indexName settings is suffixed with the workspace-name using this naming scheme: indexName + "_" + workspace.

To apply that for the example above, mgnl_elastic_website would be created in Elasticsearch.

useOneIndexPerWorkspace: false

If this setting was chosen, the indexName settings is used untouched.

Wildcard approach

Using the wildcard configuration approach, every content published in the specified workspace will be pushed to elasticsearch.

Try to make sure you define properties that every content has in common.

Selective approach

The selective approach allows you to filter out specific data from your content to push into elasticsearch.

contentSelectionAttribute: "mgnl:template"
contentAttributesToPush:
  "mtk2:pages/basic": (1)
    - title
    - description
1 Here, only pages of the website workspace based on the "mtk2:pages/basic"-template will be considered for elasticsearch feeding:

Changelog

Version Notes

1.0

Initial release of the module.
Feedback