Micro-service for managing Elastic Search Clusters

Description

This micro-service is responsible for managing various Elastic Search operations. It includes the following capabilities:

• Index Creation
• Document Indexing
• Alias Management
• Re-indexing Without Downtime

Usage and Management

This repo includes two setups: a production setup and a local setup.

Environment Variables Files

The service can use three different .env files: .env.local, .env.development, .env.production.

It is IMPORTANT to note that if multiple .env files are present, it will use them in the following order: local -> development -> production.

The easiest method is to simply copy the needed file from the .env.example file:

cp .env.example .env.local

Local Usage

The following prerequisites are needed for the project:

• Elastic Search Cluster
• Docker
• Node/pnpm

Installation

# The service is set up with pnpm, so make sure to install packages with it.
pnpm install

Start the required Services

The required services are included in the docker-compose.yml file. You can start all needed services with the following command:

# Docker only supports .env files by default, so we need to specify the exact file.
docker compose up --env-file .env.local -d

Running the app

# development
$ pnpm run start

# watch mode
$ pnpm run start:dev

# production mode
$ pnpm run start:prod

Test

# unit tests
$ pnpm run test

# e2e tests
$ pnpm run test:e2e

# test coverage
$ pnpm run test:cov