Skip to content

Commit

Permalink
Update documentation about Kidash
Browse files Browse the repository at this point in the history
This commit updates the README.md about Kidash and adds
its usage and relevant links.

Signed-off-by: Venu Vardhan Reddy Tekula <venuvardhanreddytekula8@gmail.com>
  • Loading branch information
vchrombie committed Aug 18, 2020
1 parent e393419 commit fd05679
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,12 +183,15 @@ More information at the [Schema](https://github.com/chaoss/grimoirelab-elk/tree/
How this info was retrieved
---------------------------

These json files were retrieved taking advantage of the toolchain provided in the grimoirelab project in GitHub. Specifically the script GrimoireELK/utils/kidash.py.
These json files were retrieved using [Kidash](https://github.com/chaoss/grimoirelab-kidash).

Example of how to run this:

```
$ kidash -g -e <elasticsearch-url> --dashboard <dashboard-id>* --export <local-file-path> --split-index-patterns
$ ./kidash.py -e https://<user>:<password>@<domain>:443/<path>/ --dashboard <dashboard_name> --export <export_path>/<file_name>.json
example:
$ kidash -g -e https://admin:admin@localhost:9200 --dashboard overview --export overview.json --split-index-patterns
```

More information: [Kidash - Usage](https://github.com/chaoss/grimoirelab-kidash#usage).

0 comments on commit fd05679

Please sign in to comment.