Getting started #

kuzzle-storage-opensearch-2 is the OpenSearch 2 storage driver of Kuzzle 2. It is Kuzzle's Elasticsearch 7 driver on the OpenSearch 2 client (@opensearch-project/opensearch 2.13.0): same mappings, same queries, same errors. Kuzzle 2 does not ship it: you install it next to Kuzzle.

Install #

Install the package in your application, next to kuzzle:

npm install kuzzle-storage-opensearch-2

Then select it in your .kuzzlerc, with the address of your OpenSearch 2 cluster:

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

majorVersion is not read when driver is set, and Kuzzle logs a warning if both are set: remove majorVersion. The same works with the kuzzle_services__storageEngine__driver environment variable.

Check #

At startup, Kuzzle logs the driver it runs:

[ℹ] Storage driver: kuzzle-storage-opensearch-2@<version>

The rest of services.storageEngine is described in Configuration.