yaest v0.0.6

yaest

An elasticsearch toolbox for backing-up/restoring Elasticsearch clusters. yaest gives you real-time progress updates of your Elasticsearch backup jobs with a time-left timer, so you are never left guessing when your job will be complete.

Installing

Local

npm install yaest
./bin/yaest

Global

npm install yaest -g
yaest

Use

Standard Install

yaest commands are broken down into two parts source and destination. Both can either be file or url.

Elasticsearch:

• Format: {protocol}://{host}:{port}/{index}
• Example: https://localhost:9200/logs_index

Files:

• Format: {filePath}
• Example: /this/is/a/unix/path
• Example: c:\this\is\a\windows\path
• Example: relative/path

Output Structure

When operating on file input/ouput, yaest operates on a directory of the specified name. If a directory of dump is specified for the destination, yaest will create the following directory structure:

• dump/
• dump/index.meta
• dump/mapping.json

• dump/data.json

Getting info of Elasticsearch cluster

yaest info <host>

Listing indices

yaest ls <host>

Sorting list view of indices

yaest ls <host> -s <column_name>

yaest also supports watching a clusters indices and outputting real-time updates to the terminal:

yaest ls <host> -w

Backing up indices:

yaest cp <source> <destination>

Backing up a cluster

yaest.js cluster_cp <source> <destination>

Note

This has only been well tested for 5.x clusters.