mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 01:13:23 -04:00
3953339ec7
The current docker run code snippet is malformed and renders incorrectly. This fixes the rendering.
147 lines
4.9 KiB
Text
147 lines
4.9 KiB
Text
[[docker]]
|
|
=== Install {kib} with Docker
|
|
++++
|
|
<titleabbrev>Install with Docker </titleabbrev>
|
|
++++
|
|
|
|
Docker images for Kibana are available from the Elastic Docker registry. The
|
|
base image is https://hub.docker.com/_/centos/[centos:7].
|
|
|
|
A list of all published Docker images and tags is available at
|
|
https://www.docker.elastic.co[www.docker.elastic.co]. The source code is in
|
|
https://github.com/elastic/dockerfiles/tree/{branch}/kibana[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.
|
|
<<managing-licenses,Start a 30-day trial>> to try out all of the
|
|
paid commercial features. See the
|
|
https://www.elastic.co/subscriptions[Subscriptions] page for information about
|
|
Elastic license levels.
|
|
|
|
[float]
|
|
[[pull-image]]
|
|
=== Pull the image
|
|
|
|
Obtaining Kibana for Docker is as simple as issuing a +docker pull+ command
|
|
against the Elastic Docker registry.
|
|
|
|
ifeval::["{release-state}"=="unreleased"]
|
|
|
|
However, version {version} of Kibana has not yet been released, so no Docker
|
|
image is currently available for this version.
|
|
|
|
endif::[]
|
|
|
|
ifeval::["{release-state}"!="unreleased"]
|
|
|
|
["source","txt",subs="attributes"]
|
|
--------------------------------------------
|
|
docker pull {docker-repo}:{version}
|
|
--------------------------------------------
|
|
|
|
Alternatively, you can download other Docker images that contain only features
|
|
available under the Apache 2.0 license. To download the images, go to
|
|
https://www.docker.elastic.co[www.docker.elastic.co].
|
|
|
|
[float]
|
|
=== Run Kibana on Docker for development
|
|
Kibana can be quickly started and connected to a local Elasticsearch container for development
|
|
or testing use with the following command:
|
|
|
|
[source,sh,subs="attributes"]
|
|
----
|
|
docker run --link YOUR_ELASTICSEARCH_CONTAINER_NAME_OR_ID:elasticsearch -p 5601:5601 {docker-repo}:{version}
|
|
----
|
|
|
|
endif::[]
|
|
[float]
|
|
[[configuring-kibana-docker]]
|
|
=== Configure Kibana on Docker
|
|
|
|
The Docker images provide several methods for configuring Kibana. The
|
|
conventional approach is to provide a `kibana.yml` file as described in
|
|
{kibana-ref}/settings.html[Configuring Kibana], but it's also possible to use
|
|
environment variables to define settings.
|
|
|
|
[float]
|
|
[[bind-mount-config]]
|
|
==== Bind-mounted configuration
|
|
|
|
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:
|
|
|
|
["source","yaml",subs="attributes"]
|
|
--------------------------------------------
|
|
version: '2'
|
|
services:
|
|
kibana:
|
|
image: {docker-image}
|
|
volumes:
|
|
- ./kibana.yml:/usr/share/kibana/config/kibana.yml
|
|
--------------------------------------------
|
|
|
|
[float]
|
|
[[environment-variable-config]]
|
|
==== Environment variable configuration
|
|
|
|
Under Docker, {kib} 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
|
|
{kib} setting names.
|
|
|
|
WARNING: All information that you include in environment variables is visible through the `ps` command, including sensitive information.
|
|
|
|
Some example translations are shown here:
|
|
|
|
.Example Docker Environment Variables
|
|
[horizontal]
|
|
**Environment Variable**:: **Kibana Setting**
|
|
`SERVER_NAME`:: `server.name`
|
|
`KIBANA_DEFAULTAPPID`:: `kibana.defaultAppId`
|
|
`MONITORING_ENABLED`:: `monitoring.enabled`
|
|
|
|
In general, any setting listed in <<settings>> can be
|
|
configured with this technique.
|
|
|
|
These variables can be set with +docker-compose+ like this:
|
|
|
|
["source","yaml",subs="attributes"]
|
|
----------------------------------------------------------
|
|
version: '2'
|
|
services:
|
|
kibana:
|
|
image: {docker-image}
|
|
environment:
|
|
SERVER_NAME: kibana.example.org
|
|
ELASTICSEARCH_HOSTS: http://elasticsearch.example.org
|
|
----------------------------------------------------------
|
|
|
|
Since environment variables are translated to CLI arguments, they take
|
|
precedence over settings configured in `kibana.yml`.
|
|
|
|
[float]
|
|
[[docker-defaults]]
|
|
==== Docker defaults
|
|
The following settings have different default values when using the Docker
|
|
images:
|
|
|
|
[horizontal]
|
|
`server.name`:: `kibana`
|
|
`server.host`:: `"0"`
|
|
`elasticsearch.hosts`:: `http://elasticsearch:9200`
|
|
`monitoring.ui.container.elasticsearch.enabled`:: `true`
|
|
|
|
NOTE: The setting `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 <<bind-mount-config,custom `kibana.yml`>> or via
|
|
<<environment-variable-config,environment variables>>.
|
|
|
|
IMPORTANT: If replacing `kibana.yml` with a custom version, be sure to copy the
|
|
defaults to the custom file if you want to retain them. If not, they will
|
|
be "masked" by the new file.
|