Bitnami package for ClickHouse

What is ClickHouse?

ClickHouse is an open-source column-oriented OLAP database management system. Use it to boost your database performance while providing linear scalability and hardware efficiency.

Overview of ClickHouse 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 run --name clickhouse bitnami/clickhouse: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 ClickHouse in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.

How to deploy ClickHouse in Kubernetes?

Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the Bitnami ClickHouse Chart GitHub repository.

Bitnami containers can be used with Kubeapps for deployment and management of Helm Charts in clusters.

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 ClickHouse Docker Image is to pull the prebuilt image from the Docker Hub Registry.

docker pull bitnami/clickhouse: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/clickhouse:[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 .

Persisting your application

If you remove the container all your data will be lost, and the next time you run the image the database 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 directory at the /bitnami/clickhouse path. If the mounted directory is empty, it will be initialized on the first run.

docker run \
    --volume /path/to/clickhouse-persistence:/bitnami/clickhouse \
    --env ALLOM_EMPTY_PASSWORD=false \
    bitnami/clickhouse:latest

You can also do this with a minor change to the docker-compose.yml file present in this repository:

clickhouse:
  ...
  volumes:
    - /path/to/clickhouse-persistence:/bitnami/clickhouse
  ...

Connecting to other containers

Using Docker container networking, a different server running inside a container can easily be accessed by your application containers and vice-versa.

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

Using the Command Line

In this example, we will create a ClickHouse client instance that will connect to the server instance that is running on the same docker network as the client.

Step 1: Create a network

docker network create my-network --driver bridge

Step 2: Launch the ClickHouse container within your network

Use the --network <NETWORK> argument to the docker run command to attach the container to the my-network network.

docker run -d --name clickhouse-server \
  --network my-network \
  --env ALLOW_EMPTY_PASSWORD=yes \
  bitnami/clickhouse:latest

Step 3: Launch your ClickHouse client instance

Finally we create a new container instance to launch the ClickHouse client and connect to the server created in the previous step:

docker run -it --rm \
    --network my-network \
    bitnami/clickhouse:latest clickhouse-client --host clickhouse-server

Using a Docker Compose file

When not specified, Docker Compose automatically sets up a new network and attaches all deployed services to that network. However, we will explicitly define a new bridge network named my-network. In this example we assume that you want to connect to the ClickHouse server from your own custom application image which is identified in the following snippet by the service name myapp.

version: '2'

networks:
  my-network:
    driver: bridge

services:
  clickhouse:
    image: bitnami/clickhouse:latest
    environment:
      - ALLOW_EMPTY_PASSWORD=no
    networks:
      - my-network
  myapp:
    image: 'YOUR_APPLICATION_IMAGE'
    networks:
      - my-network

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 clickhouse to connect to the ClickHouse server

Launch the containers using:

docker-compose up -d

Configuration

ClickHouse can be configured via environment variables or using a configuration file (config.xml). If a configuration option is not specified in either the configuration file or in an environment variable, ClickHouse uses its internal default configuration.

Configuration overrides

The configuration can easily be setup by mounting your own configuration overrides on the directory /bitnami/clickhouse/etc/conf.d or /bitnami/clickhouse/etc/users.d:

docker run --name clickhouse \
    --volume /path/to/override.xml:/bitnami/clickhouse/etc/conf.d/override.xml:ro \
    bitnami/clickhouse:latest

or using Docker Compose:

version: '2'

services:
  clickhouse:
    image: bitnami/clickhouse:latest
    volumes:
      - /path/to/override.xml:/bitnami/clickhouse/etc/conf.d/override.xml:ro

Check the official ClickHouse configuration documentation for all the possible overrides and settings.

Initializing a new instance

When the container is executed for the first time, it will execute the files with extensions .sh located at /docker-entrypoint-initdb.d. For scripts to be executed every time the container starts, use the /docker-entrypoint-startdb.d folder.

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

Environment variables

Customizable environment variables

Read-only environment variables

Setting the admin password on first run

Passing the CLICKHOUSE_ADMIN_PASSWORD environment variable when running the image for the first time will set the password of the CLICKHOUSE_ADMIN_USER user to the value of CLICKHOUSE_ADMIN_PASSWORD.

docker run --name clickhouse -e CLICKHOUSE_ADMIN_PASSWORD=password123 bitnami/clickhouse:latest

or by modifying the docker-compose.yml file present in this repository:

services:
  clickhouse:
  ...
    environment:
      - CLICKHOUSE_ADMIN_PASSWORD=password123
  ...

Allowing empty passwords

By default the ClickHouse image expects all the available passwords to be set. In order to allow empty passwords, it is necessary to set the ALLOW_EMPTY_PASSWORD=yes env variable. This env variable is only recommended for testing or development purposes. We strongly recommend specifying the CLICKHOUSE_ADMIN_PASSWORD for any other scenario.

docker run --name clickhouse --env ALLOW_EMPTY_PASSWORD=yes bitnami/clickhouse:latest

or by modifying the docker-compose.yml file present in this repository:

services:
  clickhouse:
  ...
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
  ...

Logging

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

docker logs clickhouse

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 ClickHouse, 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/clickhouse:latest

or if you're using Docker Compose, update the value of the image property to bitnami/clickhouse:latest.

Step 2: Stop and backup the currently running container

Stop the currently running container using the command

docker stop clickhouse

or using Docker Compose:

docker-compose stop clickhouse

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

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

Step 3: Remove the currently running container

docker rm -v clickhouse

or using Docker Compose:

docker-compose rm -v clickhouse

Step 4: Run the new image

Re-create your container from the new image.

docker run --name clickhouse bitnami/clickhouse:latest

or using Docker Compose:

docker-compose up clickhouse

Using docker-compose.yaml

Please be aware this file has not undergone internal testing. Consequently, we advise its use exclusively for development or testing purposes. For production-ready deployments, we highly recommend utilizing its associated Bitnami Helm chart.

If you detect any issue in the docker-compose.yaml file, feel free to report it or contribute with a fix by following our Contributing Guidelines.

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.