Skip to content

punchplatform-setup-kibana.sh

Synopsis

punchplatform-setup-kibana.sh [--import|--export] [options]

Description

Manage dashboards, visualization, searches and index-patterns for various Kibana instances.

Command

  • -h | --help :

    • Print the help menu.
  • -l | --url <url> :

    • Kibana URL. By default is 'localhost:5601'.
  • -u | --user <name> :

    • Username and password for authenticating to Kibana using Basic Authentication. The username and password should be separated by a colon (i.e. "admin:secret"). By default no username and password are used.
  • -i | --import :

    • Import: imports each ndjson file from Kibana resources directories (resources/kibana//.ndjson) to an running Kibana instance.
  • -x | --export :

    • Export: Generate a json output containing all objects Default export location : resources/kibana/export/export.ndjson
  • -o | --output <name> :

    • The name given to the export output file.
  • -p | --pattern <pattern> :

    • Import Kibana objects based on a pattern. An object is selected if its title contains this pattern (case insensitive).
  • --debug :

    • Debug mode: outputs elasticsearch urls calls and the generated json.

Examples

Import every resources into Kibana

$ punchplatform-setup-kibana.sh --import
Import all objects with a title containing "top-"
$ punchplatform-setup-kibana.sh -i -p "top-"
Export all existing Kibana objects
$ punchplatform-setup-kibana.sh -x
Save your export to a file '[kibana]/bulk/myfile.json'
$ punchplatform-setup-kibana.sh -x -o "myfile"
Define another elasticsearch address, user or kibana index
$ punchplatform-setup-kibana.sh -l "http://example:9200" -u admin:secret
Debug an export
$ punchplatform-setup-kibana.sh -x --debug

See also

environment