kibana-plugin-builder

Kibana Plugin Builder - kibana plugin development environment in a docker image

---

Dependencies

• node

Image Tags

REPOSITORY                         TAG                 SIZE
blacktop/kibana-plugin-builder     latest              3.7GB
blacktop/kibana-plugin-builder     7.0.0               3.7GB
blacktop/kibana-plugin-builder     6.6.1               3.51GB
blacktop/kibana-plugin-builder     6.6.0               4.08GB
blacktop/kibana-plugin-builder     6.5.3               4.55GB
blacktop/kibana-plugin-builder     6.4.1               3.48GB
blacktop/kibana-plugin-builder     6.4.0               3.5GB
blacktop/kibana-plugin-builder     6.3.2               3.19GB
blacktop/kibana-plugin-builder     6.3.1               3.19GB
blacktop/kibana-plugin-builder     6.1.3               1.18GB
blacktop/kibana-plugin-builder     6.0.0               1.11GB
blacktop/kibana-plugin-builder     5.6.0               1.09GB
blacktop/kibana-plugin-builder     5.5.2               1.09GB
blacktop/kibana-plugin-builder     node                1.03GB

NOTE: tag node is the base image that has the appropriate version of NodeJS for the version of Kibana you are using to build your plugin (it defaults to the version needed for latest)

Why?

This docker image creates a (small as possible) dev environment to develop a kibana plugin in so you don't have to figure out what version of node to run or elasticsearch etc etc.

Getting Started

Install template-kibana-plugin

$ npm install -g sao template-kibana-plugin

Run the generator

$ git clone https://github.com/elastic/kibana.git
$ git checkout 6.x
$ yarn kbn bootstrap # always bootstrap when switching branches
$ node scripts/generate_plugin my_plugin_name
# generates a plugin for Kibana 6.3 in `../kibana-extra/my_plugin_name`

=OR=

Use kibana-plugin-builder to create new plugin

$ mkdir my-new-plugin
$ docker run --init -it --rm \
             -w /plugin \
             -v `pwd`/my-new-plugin:/plugin/kibana-extra \
             blacktop/kibana-plugin-builder new-plugin hotness

Start Kibana Dev Environment

NOTE: this assumes you have set a version in your package.json

example:

  "kibana": {
    "version": "6.4.1",
    "templateVersion": "1.0.0"
  }
  ...

# Starting kibana elasticsearch...
$ docker run --init -d \
             --name kplug \
             -p 9200:9200 -p 5601:5601 \
             -v `pwd`:/plugin/my-new-plugin \
             blacktop/kibana-plugin-builder:$(jq -r '.version' package.json) elasticsearch
# Running kibana plugin...
$ docker exec -it kplug bash -c "cd ../my-new-plugin && yarn start"

Build Image

To build a kibana dev env that uses version 6.4.1

$ git clone https://github.com/blacktop/kibana-plugin-builder.git
$ cd kibana-plugin-builder
$ VERSION=6.4.1 make build

Issues

Find a bug? Want more features? Find something missing in the documentation? Let me know! Please don't hesitate to file an issue

CHANGELOG

See CHANGELOG.md

Contributing

See all contributors on GitHub.

Please update the CHANGELOG.md and submit a Pull Request on GitHub.

License

MIT Copyright (c) 2017 blacktop