Skip to main content

Simple backup/restore for Kibana saved objects: config, index patterns, dashboards, saved searches, etc.

Project description

PyPI version

Simple backup for Kibana saved objects: config, index patterns, dashboards, saved searches, etc.

Uses python3 and awesome python-requests library.

Usage

kibana-backup.py backup [--kibana-url KIBANA_URL] [--user USER] [--password PASSWORD] > backup.ndjson

cat backup.ndjson | kibana-backup.py restore [--kibana-url KIBANA_URL] [--user USER] [--password PASSWORD]

kibana-backup.py backup [--kibana-url KIBANA_URL] [--user USER] [--password PASSWORD] --space-id=myspace --backup-file=myspace.ndjson

kibana-backup.py backup [--kibana-url KIBANA_URL] [--user USER] [--password PASSWORD] --all-spaces --backup-file-prefix=backup-
# result: backup-default.ndjson backup-myspace.ndjson backup-myspace2.ndjson

kibana-backup.py restore [--kibana-url KIBANA_URL] [--user USER] [--password PASSWORD] --all-spaces --backup-file-prefix=backup-
# restores backup-default.ndjson to space id=default, backup-myspace.ndjson to space id=myspace, ...

  • backup create backup file in newline-delimitered json format
  • restore restore backup from stdin
  • --kibana-url base URL to access Kibana API, default: http://127.0.0.1:5601
  • --user Kibana user
  • --password Kibana password
  • --space-id Kibana space id. If not set then the default space is used.
  • --all-spaces Backup all spaces to separate files. Backup file name is used as prefix: <backup file>-<space-id>.ndjson

Installation

From pypi.org:

pip install kibana-backup-simple

Local installation:

git clone https://github.com/selivan/kibana-backup-simple.git
cd kibana-backup-simple
python setup.py install

Or just create a Docker image and use it:

docker build -t kibana-backup-simple .
docker run -it --rm kibana-backup-simple [options]

Documentation

License

WTFPL

P.S. If this code is useful for you - don't forget to put a star on it's github repo.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kibana-backup-simple-0.99.12.tar.gz (4.3 kB view hashes)

Uploaded Source

Built Distribution

kibana_backup_simple-0.99.12-py2.py3-none-any.whl (6.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page