Skip to content

Commit

Permalink
updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Ayache Khettar committed Feb 21, 2021
1 parent 06a5057 commit 8a208c8
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,18 @@
![main](https://github.com/akhettar/odfe-kibana-sync/workflows/main/badge.svg)

## Overview
This is a command line tool to sync and create the `Kibana object configs` from a given [open distro elk cluster](https://opendistro.github.io/for-elasticsearch-docs/) - see below the help section. This tool assumes that Kibana cluster holds the source of the truth in relation to the configuration file. The sole purpose of this tool is to be run periodically to sync these configuration files with the a given Git repository.
This is a command line tool to sync and create the `Kibana object configs` from a given [open distro elk cluster](https://opendistro.github.io/for-elasticsearch-docs/) - see below the help section. This tool assumes that Kibana cluster holds the source of the truth in relation to the configuration files. The sole purpose of this tool is to be run periodically in a given CI pipeline to sync these configuration files with the a given Git repository.

Idelly, this tool should be run in a CI pipeline for a given project that hosts Kibana configuration files - see example Github project.

`Read carefully before usage please`:

* This cli is not a full blown command line interface for the open distro elasticsearch. There is one, see [doc](https://opendistro.github.io/for-elasticsearch-docs/docs/cli/).
* This cli assumes that the all the updates, create and delete are done through the Kiban console.
* This cli is for synching the Kibana configuration files with a given Git repository.
* Deleted configs in Kibana console will be automatically deleted with the `sync folder`.

## Supported Kibana configurations
The following kibana configuration files can be synched and created in a given kiban instance:
1. Monitors
2. Dashboards
Expand Down

0 comments on commit 8a208c8

Please sign in to comment.