atrix-elasticsearch

Elasticsearch plugin for the atrix miscroservice framework

Compatibility

atrix-elasticsearch < 1.0.0 works with atrix < 6.0.0 atrix-elasticsearch >= 1.0.0 works with atrix >= 6.0.0

Features

• Connection setup
• connect to multiple nodes

Installation

# install atrix
npm install -S @trigo/atrix

# install elasticsearch plugin
npm install -S @trigo/atrix-elasticsearch

# No need to install @elastic/elasticsearch itself!

Configuraton & Usage

handlers/GET.js

module.exports = async (req, reply, service) => {
    // access elasticseracg for connection "m1"
    const cient = service.dataConnections.m1.client;
		
		// fetch info from cluster complete 
		// client API docs: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html
		const info = await client.info(); 
		
		// send to callee
		reply(info);
}
		

index.js

'use strict';

const atrix = require('@trigo/atrix');
const path = require('path');

const svc = atrix.addService({
	name: 'mongoose', 
    endpoints: {
        http: {
            // declare port to bind
      port: 3007,

      // the directory containing the handler files
      handlerDir: `${__dirname}/handlers`,
    },
  },
    // declare a dataSource config section
    dataSource: {
        // name of the data source
        m1: {
            // type of data connection
            type: 'elasticsearch',
            // connection configuration
            config: 
                // database connection string, sommaseperated to connnect several nodes
                connectionString: 'http://es-01:9200,http://es-02:9200',
            },
        },
        m2: {
            type: 'mongoose',
            config: {
                modelFactory: path.join(__dirname, './models/factory'),
                connectionString: 'localhost:27017/test-atrix-mongoose-m2',
            },
        },
    },
});

// start service. 
// This will wait for the elasticsearch connection to be available waits for cluster state 'yellow' before starting up. 
svc.start();

Running the tests

Start the dependencies with make dev-inf-up and run the tests with make test.

To simulate a CI test run you can use the make ci-test command.

Authentication test is disabled by default, to enable them execute the tests with the following command line: TEST_SECURDED_ELASTICSEARCH=<Secured ES Url> TEST_SECURDED_ELASTICSEARCH_USER=<user> TEST_SECURDED_ELASTICSEARCH_PASSWORD=<password> make test