Running Kibana on Dockeredit

Docker images for Kibana are available from the Elastic Docker registry. The base image is centos:7.

A list of all published Docker images and tags is available at www.docker.elastic.co. The source code is in GitHub.

These images are free to use under the Elastic license. They contain open source and free commercial features and access to paid commercial features. Start a 30-day trial to try out all of the paid commercial features. See the Subscriptions page for information about Elastic license levels.

Pulling the imageedit

Obtaining Kibana for Docker is as simple as issuing a docker pull command against the Elastic Docker registry.

docker pull docker.elastic.co/kibana/kibana:6.4.1

Alternatively, you can download other Docker images that contain only features available under the Apache 2.0 license. To download the images, go to www.docker.elastic.co.

Configuring Kibana on Dockeredit

The Docker images provide several methods for configuring Kibana. The conventional approach is to provide a kibana.yml file as described in Configuring Kibana, but it’s also possible to use environment variables to define settings.

Bind-mounted configurationedit

One way to configure Kibana on Docker is to provide kibana.yml via bind-mounting. With docker-compose, the bind-mount can be specified like this:

version: '2'
services:
  kibana:
    image: docker.elastic.co/kibana/kibana:6.4.1
    volumes:
      - ./kibana.yml:/usr/share/kibana/config/kibana.yml

Environment variable configurationedit

Under Docker, Kibana can be configured via environment variables. When the container starts, a helper process checks the environment for variables that can be mapped to Kibana command-line arguments.

For compatibility with container orchestration systems, these environment variables are written in all capitals, with underscores as word separators. The helper translates these names to valid Kibana setting names.

Some example translations are shown here:

Table 1. Example Docker Environment Variables

Environment Variable

Kibana Setting

SERVER_NAME

server.name

KIBANA_DEFAULTAPPID

kibana.defaultAppId

XPACK_MONITORING_ENABLED

xpack.monitoring.enabled


In general, any setting listed in Configuring Kibana or X-Pack Settings can be configured with this technique.

These variables can be set with docker-compose like this:

version: '2'
services:
  kibana:
    image: docker.elastic.co/kibana/kibana:6.4.1
    environment:
      SERVER_NAME: kibana.example.org
      ELASTICSEARCH_URL: http://elasticsearch.example.org

Since environment variables are translated to CLI arguments, they take precedence over settings configured in kibana.yml.

Docker defaultsedit

The following settings have different default values when using the Docker images:

server.name

kibana

server.host

"0"

elasticsearch.url

http://elasticsearch:9200

xpack.monitoring.ui.container.elasticsearch.enabled

true

Note

The setting xpack.monitoring.ui.container.elasticsearch.enabled is not defined in the -oss image.

These settings are defined in the default kibana.yml. They can be overridden with a custom kibana.yml or via environment variables.

Important

If replacing kibana.yml with a custom version, be sure to copy the above defaults to the custom file if you want to retain them. If not, they will be "masked" by the new file.