New kibana config load/restore

[clamp.git] / extra / docker / elk / README.md

diff --git a/extra/docker/elk/README.md b/extra/docker/elk/README.md
index 04c2439..f74c4e0 100644 (file)
--- a/extra/docker/elk/README.md
+++ b/extra/docker/elk/README.md
@@ -11,9 +11,58 @@ Deployment instructions
 Requirements: docker-compose
 
 1. Update configuration in docker-compose file
-2. `docker-compose up -d logstash kibana`
-3. `docker-compose run default`  # loads the dashboard configuration for Kibana
+2. `docker-compose up -d elasticsearch logstash kibana`
 
+If you encounter connection problems with kibana, first deploy elasticsearch, wait for it to be available, then kibana.
+
+Backup/restore
+--------------
+
+backup.py and restore.py scripts are available inside the kibana docker image for saving and restoring the configuration.
+
+### backup.py 
+```
+docker-compose exec kibana backup.py -C /saved-objects/
+```
+```
+usage: backup.py [-h] [-v] [-C CONFIGURATION_PATH] [-f] [-H KIBANA_HOST]
+
+Description of the script
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -v, --verbose         Use verbose logging
+  -C CONFIGURATION_PATH, --configuration_path CONFIGURATION_PATH
+                        Path of the configuration to be backed up.
+  -f, --force           If the save folder already exists, overwrite files
+                        matching a configuration item that should be written.
+                        Files already in the folder that do not match are left
+                        as-is.
+  -H KIBANA_HOST, --kibana-host KIBANA_HOST
+                        Kibana endpoint.
+
+```
+
+### restore.py
+```
+docker-compose exec kibana restore.py -C /saved-objects/ -f
+```
+```
+usage: restore.py [-h] [-v] [-C CONFIGURATION_PATH] [-H KIBANA_HOST] [-f]
+
+Restores the kibana configuration.
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -v, --verbose         Use verbose logging
+  -C CONFIGURATION_PATH, --configuration_path CONFIGURATION_PATH
+                        Path of the configuration to be restored.Should
+                        contain at least one folder named index-
+                        pattern,config,search,visualization or dashboard
+  -H KIBANA_HOST, --kibana-host KIBANA_HOST
+                        Kibana endpoint.
+  -f, --force           Overwrite configuration if needed.
+```
 
 Tools
 -----
@@ -30,3 +79,7 @@ It reads a json file as a query for Elasticsearch, pushes it on the ES server, a
 ### DMaaP Service Mocker
 
 Script that simulates control loop DMaaP services to provide sample data to logstash through DMaaP.
+
+TODO
+----
+* Add a script that verifies that elasticsearch is available before starting loading the default configuration for kibana