elasticsearch-plugin

README

Elasticsearch Plugin

This is a plugin for Kubemove to sync data between two Elasticsearch clusters deployed with ECK Operator.

Pre-requisite

You must install Kubemove before installing this plugin. In order to install Kubemove framework, please for the guide here.

Supported Repositories

Currently, Elasticsearch plugin supports the following repositories,

• S3 / S3 Compatible Services (i.e. Minio)

Install Plugin

At first, export your source cluster's and destination cluster's context.

export SRC_CONTEXT=<source cluster context>
export DST_CONTEXT=<destination cluster context>

Then, run the following command to install the Elasticsearch Plugin in both of your source and destination cluster.

make install-plugin

Uninstall Plugin

In order to uninstall Elasticsearch plugin from your cluster, run the following command.

make uninstall-plugin

Developer Guide

Here are few tricks to help with working with this project.

Setup Environment

Setup your development environment by the following steps.

• Use your own docker account for the docker images:

  export REGISTRY=<your docker username>
  

• Checkout into kubemove/kubemove repository and build the developer image with all dependencies:

  make dev-image
  

Build Project

• Run gofmt and goimports:

  make format
  

• Run linter:

  make lint
  

• Revendor project dependencies:

  make revendor
  

• Build project:

  make build
  

• Make plugin docker image:

  make plugin-image
  

• Push plugin docker image into your docker registry:

  make deploy-images
  

Test

Follow the following steps to run the E2E tests.

• At first, install the Kubemove framework.
• Install Elasticsearch plugin.
• Run e2e tests:

  make e2e-test
  

There are some other commands that automate many of the tasks that you will need to do to test this plugin functionalities. Check them on the Makefile.