kbt - Kibana Backup Tool

This script allow to list, export and import kibana resources (search, visualization and dashboard).

You can export everything you want from Kibana interface, but if you want to setup a cronjob to do regular backup or just do it in CLI, this is the right tool to use.

Tested on Kibana 4.x, 5.x and 6.x.

Table of contents

• Installation
  • Package (favourite)
  • Archive
• Usage

Installation

Package (favourite)

I have setup a Debian/Ubuntu apt repository to distribute this package

You can add my personal repository to your /etc/apt/sources.list by adding the following line:

deb [arch=amd64] https://llavaud.github.io/kbt/apt stable main

You must also retrieve and install my GPG key:

wget -O - https://llavaud.github.io/kbt/apt/conf/gpg.key | sudo apt-key add -

And then install the package:

sudo apt-get update
sudo apt-get install kbt

Archive

If you dont want to add a new repository on your system you can also retrieve the latest zip/tar.gz archive

This script depends on several Perl library, so you need to install the following Debian/Ubuntu packages before using it:

sudo apt-get install libhttp-message-perl libjson-perl libwww-perl libfile-which-perl

And if you want to export/import to/from an S3 bucket, you need the following too:

sudo apt-get install awscli

Once the packages are installed, you just need to extract the archive

Usage

kbt [OPTIONS] <COMMAND>

 OPTIONS
   --file          FILE|S3_SCHEME       File to export/import (defaults to kbt_export.json)
   --help                               Print this help
   --host          [SCHEME]IP[:PORT]    Ip address of elasticsearch instance (defaults to http://localhost:9200)
   --index         INDEX                Kibana index (defaults to .kibana)
   --overwrite                          Overwrite existing documents during import (default is to skip existing docs)
   --ssl_noverify                       Do not verify matching hostname if ssl is enabled (verify by default)
   --type          TYPE                 Type of kibana resources {search|visualization|dashboard} (defaults to all)

 COMMAND
   list                                 list resource's id
   export                               export resources
   import                               import resources

Examples:

  * export all resources in a local file
      kbt export --file my_json

  * export search resources in file on S3
      kbt export --type search --file s3://my_bucket/my_json