Installing Canvas

Canvas isn't like any other Kibana plugin, but the installation process is pretty similar. It's going to be available for free with X-Pack, under the Basic license, when we release it in GA.

During the technology preview period, Canvas will be published as a separate plugin to allow us to iterate quickly based on user feedback. It will require the latest GA versions of Elasticsearch, Kibana, and X-Pack, and should be installed outside of your production environment on a dev/test system.

Installation Instructions

To set up a dev/test environment for Canvas, follow these instructions:

Download and unpack the latest version of Elasticsearch.

NOTE: You can not use the OSS version, as X-Pack with a Basic or higher license is required.

Start Elasticsearch:

bin/elasticsearch

Download and unpack the latest version of Kibana.

NOTE: You can not use the OSS version, as X-Pack with a Basic or higher license is required.

Run this from the unpacked Kibana path to install Canvas:

NODE_OPTIONS="--max-old-space-size=4096" ./bin/kibana-plugin install \
https://download.elastic.co/kibana/canvas/kibana-canvas-0.1.2200.zip

Start Kibana:

bin/kibana

Frequently Asked Questions

I mean, they can't be asked that frequently, we just uploaded this stuff.

What's the deal with the NODE_OPTIONS thing there?

Canvas, like X-Pack, is a good chunk of code and the Kibana plugin installer has to poke every bit of it. By default the Kibana plugin installer isn't allocated very much memory so if you're installing Canvas and X-Pack together, it can be a bit much for the plugin installer to handle without a bump in memory. If you don't have X-Pack installed you can probably leave that out, but:

  1. Install X-Pack because it comes with free awesomeness
  2. It won't hurt anything unless you're running in a container with only a bit of memory
  3. We're working on getting rid of that loooooonnnng optimize time via some changes in Kibana. Stay tuned.

How do I get updates?

Look for the goat. You'll see. Or you can check back on this page, the command above will always point to the latest version.