Docker--Bitnami/kibana

Bitnami package for Kibana

What is Kibana?

Kibana is an open source, browser based analytics and search dashboard for Elasticsearch. Kibana strives to be easy to get started with, while also being flexible and powerful.

Overview of Kibana⁠ Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR

Docker Compose

docker run --name kibana bitnami/kibana:latest

Why use Bitnami Images?

• Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
• With Bitnami images the latest bug fixes and features are available as soon as possible.
• Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
• All our images are based on minideb⁠ -a minimalist Debian based container image that gives you a small base container image and the familiarity of a leading Linux distribution- or scratch -an explicitly empty image-.
• All Bitnami images available in Docker Hub are signed with Notation⁠. Check this post⁠ to know how to verify the integrity of the images.
• Bitnami container images are released on a regular basis with the latest distribution packages available.

Looking to use Kibana in production? Try VMware Tanzu Application Catalog⁠, the commercial edition of the Bitnami catalog.

Why use a non-root container?

Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers in our docs⁠.

Supported tags and respective Dockerfile links

Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page⁠.

You can see the equivalence between the different tags by taking a look at the tags-info.yaml file present in the branch folder, i.e bitnami/ASSET/BRANCH/DISTRO/tags-info.yaml.

Subscribe to project updates by watching the bitnami/containers GitHub repo⁠.

Get this image

The recommended way to get the Bitnami Kibana Docker Image is to pull the prebuilt image from the Docker Hub Registry.

docker pull bitnami/kibana:latest

To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.

docker pull bitnami/kibana:[TAG]

If you wish, you can also build the image yourself by cloning the repository, changing to the directory containing the Dockerfile and executing the docker build command. Remember to replace the APP, VERSION and OPERATING-SYSTEM path placeholders in the example command below with the correct values.

git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .

How to use this image

Run the application manually

If you want to run the application manually instead of using the chart, these are the basic steps you need to run:

1. Create a new network for the application and the database:

   docker network create kibana_network
   

2. Run the Elasticsearch container:

   docker run -d -p 9200:9200 --name elasticsearch --net=kibana_network bitnami/elasticsearch
   

3. Run the Kibana container:

   docker run -d -p 5601:5601 --name kibana --net=kibana_network \
     -e KIBANA_ELASTICSEARCH_URL=elasticsearch \
     bitnami/kibana
   

Then you can access your application at http://your-ip:5601/

Persisting your application

If you remove the container all your data and configurations will be lost, and the next time you run the image the application will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.

For persistence you should mount a volume at the /bitnami path. Additionally you should mount a volume for persistence of the Elasticsearch data⁠.

The above examples define docker volumes namely elasticsearch_data and kibana_data. The Kibana application state will persist as long as these volumes are not removed.

To avoid inadvertent removal of these volumes you can mount host directories as data volumes⁠. Alternatively you can make use of volume plugins to host the volume data.

docker run -v /path/to/kibana-persistence:/bitnami/kibana bitnami/kibana:latest

NOTE: As this is a non-root container, the mounted files and directories must have the proper permissions for the UID 1001.

Connecting to other containers

Using Docker container networking⁠, a Kibana server running inside a container can easily be accessed by your application containers.

Containers attached to the same network can communicate with each other using the container name as the hostname.

Using the Command Line

Step 1: Create a network

docker network create app-tier --driver bridge

Step 2: Launch the Kibana server instance

Use the --network app-tier argument to the docker run command to attach the Kibana container to the app-tier network.

docker run -d --name kibana-server \
    --network app-tier \
    bitnami/kibana:latest

Step 3: Launch your application container

docker run -d --name myapp \
    --network app-tier \
    YOUR_APPLICATION_IMAGE

IMPORTANT:

1. Please update the YOUR_APPLICATION_IMAGE_ placeholder in the above snippet with your application image
2. In your application container, use the hostname kibana-server to connect to the Kibana server

Configuration

Environment variables

Customizable environment variables

Read-only environment variables

When you start the kibana image, you can adjust the configuration of the instance by passing one or more environment variables on the docker run command line.

Specifying Environment Variables on the Docker command line

docker run -d -e KIBANA_ELASTICSEARCH_URL=elasticsearch --name kibana bitnami/kibana:latest

Initializing a new instance

When the container is executed for the first time, it will execute the files with extension .sh, located at /docker-entrypoint-initdb.d.

In order to have your custom files inside the docker image you can mount them as a volume.

Configuration file

The image looks for configurations in /bitnami/kibana/conf/. As mentioned in Persisting your application you can mount a volume at /bitnami and copy/edit the configurations in the /path/to/kibana-persistence/kibana/conf/. The default configurations will be populated to the conf/ directory if it's empty.

Step 1: Run the Kibana image

Run the Kibana image, mounting a directory from your host.

docker run --name kibana -v /path/to/kibana-persistence:/bitnami bitnami/kibana:latest

Step 2: Edit the configuration

Edit the configuration on your host using your favorite editor.

vi /path/to/kibana-persistence/kibana/conf/kibana.conf

Step 3: Restart Kibana

After changing the configuration, restart your Kibana container for changes to take effect.

docker restart kibana

Refer to the configuration⁠ manual for the complete list of configuration options.

Logging

The Bitnami Kibana Docker image sends the container logs to the stdout. To view the logs:

docker logs kibana

You can configure the containers logging driver⁠ using the --log-driver option if you wish to consume the container logs differently. In the default configuration docker uses the json-file driver.

Maintenance

Upgrade this image

Bitnami provides up-to-date versions of Kibana, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container.

Step 1: Get the updated image

docker pull bitnami/kibana:latest

Step 2: Stop and backup the currently running container

Stop the currently running container using the command

docker stop kibana

Next, take a snapshot of the persistent volume /path/to/kibana-persistence using:

rsync -a /path/to/kibana-persistence /path/to/kibana-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)

Additionally, snapshot the Elasticsearch data⁠

You can use these snapshots to restore the application state should the upgrade fail.

Step 3: Remove the currently running container

docker rm -v kibana

Step 4: Run the new image

Re-create your container from the new image, restoring your backup if necessary.

docker run --name kibana bitnami/kibana:latest

Notable Changes

Starting January 16, 2024

• The docker-compose.yaml file has been removed, as it was solely intended for internal testing purposes.

6.8.15-debian-10-r12 & 7.10.2-debian-10-r62 & 7.12.0-debian-10-r0

• The size of the container image has been decreased.
• The configuration logic is now based on Bash scripts in the rootfs/ folder.
• Kibana 7.12.0 version or later are licensed under the Elastic License that is not currently accepted as an Open Source license by the Open Source Initiative (OSI).
• Kibana 7.12.0 version or later are including x-pack plugin installed by default. Follow official documentation to use it.

6.5.1-r3 & 5.6.13-r20

• The Kibana container has been migrated to a non-root user approach. Previously the container ran as the root user and the Kibana daemon was started as the kibana user. From now on, both the container and the Kibana daemon run as user 1001. As a consequence, the data directory must be writable by that user. You can revert this behavior by changing USER 1001 to USER root in the Dockerfile.

4.5.4-r1

• ELASTICSEARCH_URL parameter has been renamed to KIBANA_ELASTICSEARCH_URL.
• ELASTICSEARCH_PORT parameter has been renamed to KIBANA_ELASTICSEARCH_PORT.

Contributing

We'd love for you to contribute to this container. You can request new features by creating an issue⁠ or submitting a pull request⁠ with your contribution.

Issues

If you encountered a problem running this container, you can file an issue⁠. For us to provide better support, be sure to fill the issue template.

License

Copyright © 2024 Broadcom. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0⁠

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.