Skip to content

Developer guide (Debian)

archv edited this page Jun 9, 2020 · 8 revisions

Contents:

  1. Install NVM
  2. Install yarn
  3. Download Kibana sources
  4. Download plugin sources
  5. Install dependencies
  6. Launch ElasticSearch and Kibana
  7. Building the plugin distributable

note: this guide was tested on Debian installation. It may or may not work for other Linux distributions or other operation systems.


Setting up Kibana Plugin Development

1. Install NVM

apt-get install build-essential libssl-dev
curl https://raw.githubusercontent.com/creationix/nvm/v0.25.0/install.sh | bash
source ~/.profile

2. Install yarn

curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
sudo apt-get update && sudo apt-get install yarn

3. Download Kibana sources

git clone https://github.com/elastic/kibana.git kibana
cd kibana
nvm install

 (optional) Checkout a specific version of Kibana

git checkout your_version_number

4. Download plugin sources

mkdir plugins && cd plugins
git clone https://github.com/PanDAWMS/InVEx-ParCoords-Kibana.git invex-parcoords
cd invex-parcoords

5. Install dependencies

Run nvm use to install required node version using Node Version Manager.

Run yarn kbn bootstrap to install dependencies. This might take a while, so take a nice warm cup of tea, while it is installing. ☕

6. Launch ElasticSearch and Kibana

Open a separate console window and run the following code to launch the ElasticSearch instance:

cd kibana
nvm use
yarn es snapshot

Then, open another console window and run the following to launch Kibana:

cd kibana/plugins/invex-parcoords
nvm use
NODE_OPTIONS="--max-old-space=8000" yarn start 

7. Building the plugin distributable

Use this in case you want to send this plugin to somebody, or install it on any instance of Kibana:

cd kibana/plugins/invex-parcoords
nvm use
yarn build

Your plugin will be located in kibana/plugins/invex-parcoords/build folder in a zip-archive. Please refer to plugin installation guide for installation instructions.

Clone this wiki locally