Getting started #

kuzzle-storage-es-8 is the Elasticsearch 8 storage driver of Kuzzle 2: the code Kuzzle used to embed for Elasticsearch 8, moved as it is to its own package. Same mappings, same queries, same errors.

Install #

Nothing to install: Kuzzle 2 depends on kuzzle-storage-es-8 at a pinned version and installs it with itself. It is the built-in Elasticsearch 8 driver, the one Kuzzle runs when services.storageEngine.majorVersion is "8":

{
  "services": {
    "storageEngine": {
      "majorVersion": "8",
      "client": { "node": "http://localhost:9200" },
    },
  },
}

An existing Elasticsearch 8 application keeps its .kuzzlerc and its package.json unchanged.

Select it by name #

You can also name the driver, as you would an external one. This is how Kuzzle 3 will select every storage engine (majorVersion is deprecated, see Towards Kuzzle 3). Add the package to your application, at the version your Kuzzle depends on (npm ls kuzzle-storage-es-8), then set driver:

npm install kuzzle-storage-es-8@<the version npm ls shows>

{
  "services": {
    "storageEngine": {
      "driver": "kuzzle-storage-es-8",
      "client": { "node": "http://localhost:9200" },
    },
  },
}

With driver set, majorVersion is ignored, and Kuzzle logs a warning if both are set: remove majorVersion.

Check #

At startup, Kuzzle logs the driver it runs:

[ℹ] Elasticsearch configuration is set to major version : 8

([ℹ] Storage driver: kuzzle-storage-es-8@<version> when you select it with driver.) The rest of services.storageEngine is described in Configuration.