diff --git a/bitnami/clickhouse/26/debian-12/Dockerfile b/bitnami/clickhouse/26/debian-12/Dockerfile index e329762e65c8..628746bd0455 100644 --- a/bitnami/clickhouse/26/debian-12/Dockerfile +++ b/bitnami/clickhouse/26/debian-12/Dockerfile @@ -7,13 +7,13 @@ ARG DOWNLOADS_URL="downloads.bitnami.com/files/stacksmith" ARG TARGETARCH LABEL org.opencontainers.image.base.name="docker.io/bitnami/minideb:bookworm" \ - org.opencontainers.image.created="2026-02-19T01:05:34Z" \ + org.opencontainers.image.created="2026-02-19T13:44:11Z" \ org.opencontainers.image.description="Application packaged by Broadcom, Inc." \ org.opencontainers.image.documentation="https://github.com/bitnami/containers/tree/main/bitnami/clickhouse/README.md" \ org.opencontainers.image.source="https://github.com/bitnami/containers/tree/main/bitnami/clickhouse" \ org.opencontainers.image.title="clickhouse" \ org.opencontainers.image.vendor="Broadcom, Inc." \ - org.opencontainers.image.version="26.1.2" + org.opencontainers.image.version="26.1.3" ENV HOME="/" \ OS_ARCH="${TARGETARCH:-amd64}" \ @@ -28,7 +28,7 @@ RUN --mount=type=secret,id=downloads_url,env=SECRET_DOWNLOADS_URL \ DOWNLOADS_URL=${SECRET_DOWNLOADS_URL:-${DOWNLOADS_URL}} ; \ mkdir -p /tmp/bitnami/pkg/cache/ ; cd /tmp/bitnami/pkg/cache/ || exit 1 ; \ COMPONENTS=( \ - "clickhouse-26.1.2-0-linux-${OS_ARCH}-debian-12" \ + "clickhouse-26.1.3-0-linux-${OS_ARCH}-debian-12" \ ) ; \ for COMPONENT in "${COMPONENTS[@]}"; do \ if [ ! -f "${COMPONENT}.tar.gz" ]; then \ @@ -47,9 +47,9 @@ RUN uninstall_packages curl COPY rootfs / RUN /opt/bitnami/scripts/clickhouse/postunpack.sh -ENV APP_VERSION="26.1.2" \ +ENV APP_VERSION="26.1.3" \ BITNAMI_APP_NAME="clickhouse" \ - IMAGE_REVISION="1" \ + IMAGE_REVISION="0" \ PATH="/opt/bitnami/clickhouse/bin:/opt/bitnami/common/bin:$PATH" \ clickhouseCTL_API="3" diff --git a/bitnami/clickhouse/README.md b/bitnami/clickhouse/README.md index 9d7b5e024ecd..b43200e3ca5f 100644 --- a/bitnami/clickhouse/README.md +++ b/bitnami/clickhouse/README.md @@ -60,126 +60,29 @@ cd bitnami/APP/VERSION/OPERATING-SYSTEM docker build -t bitnami/APP:latest . ``` +## 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](https://github.com/bitnami/charts/tree/main/bitnami/clickhouse). + ## 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. -```console -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`](https://github.com/bitnami/containers/blob/main/bitnami/clickhouse/docker-compose.yml) file present in this repository: - -```console -clickhouse: - ... - volumes: - - /path/to/clickhouse-persistence:/bitnami/clickhouse - ... -``` - ## Connecting to other containers Using [Docker container networking](https://docs.docker.com/engine/userguide/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 - -```console -docker network create my-network --driver bridge -``` - -#### Step 2: Launch the ClickHouse container within your network - -Use the `--network ` argument to the `docker run` command to attach the container to the `my-network` network. - -```console -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: - -```console -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`. - -```yaml -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: - -```console -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/config.d` or `/bitnami/clickhouse/etc/users.d`: - -```console -docker run --name clickhouse \ - --volume /path/to/override.xml:/bitnami/clickhouse/etc/config.d/override.xml:ro \ - bitnami/clickhouse:latest -``` - -or using Docker Compose: - -```yaml -version: '2' - -services: - clickhouse: - image: bitnami/clickhouse:latest - volumes: - - /path/to/override.xml:/bitnami/clickhouse/etc/config.d/override.xml:ro -``` +The configuration can easily be setup by mounting your own configuration overrides on the directory `/bitnami/clickhouse/etc/config.d` or `/bitnami/clickhouse/etc/users.d`. Check the [official ClickHouse configuration documentation](https://clickhouse.com/docs/en/operations/configuration-files/) for all the possible overrides and settings. @@ -227,44 +130,6 @@ In order to have your custom files inside the docker image you can mount them as | `CLICKHOUSE_DAEMON_USER` | ClickHouse daemon system user. | `clickhouse` | | `CLICKHOUSE_DAEMON_GROUP` | ClickHouse daemon system group. | `clickhouse` | -### 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`. - -```console -docker run --name clickhouse -e CLICKHOUSE_ADMIN_PASSWORD=password123 bitnami/clickhouse:latest -``` - -or by modifying the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/clickhouse/docker-compose.yml) file present in this repository: - -```yaml -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. - -```console -docker run --name clickhouse --env ALLOW_EMPTY_PASSWORD=yes bitnami/clickhouse:latest -``` - -or by modifying the [`docker-compose.yml`](https://github.com/bitnami/containers/blob/main/bitnami/clickhouse/docker-compose.yml) file present in this repository: - -```yaml -services: - clickhouse: - ... - environment: - - ALLOW_EMPTY_PASSWORD=yes - ... -``` - ### FIPS configuration in Bitnami Secure Images The Bitnami ClickHouse Docker image from the [Bitnami Secure Images](https://go-vmware.broadcom.com/contact-us) catalog includes extra features and settings to configure the container with FIPS capabilities. You can configure the next environment variables: @@ -281,72 +146,6 @@ docker logs clickhouse You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) 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 - -```console -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 - -```console -docker stop clickhouse -``` - -or using Docker Compose: - -```console -docker-compose stop clickhouse -``` - -Next, take a snapshot of the persistent volume `/path/to/clickhouse-persistence` using: - -```console -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 - -```console -docker rm -v clickhouse -``` - -or using Docker Compose: - -```console -docker-compose rm -v clickhouse -``` - -#### Step 4: Run the new image - -Re-create your container from the new image. - -```console -docker run --name clickhouse bitnami/clickhouse:latest -``` - -or using Docker Compose: - -```console -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](https://github.com/bitnami/charts/tree/main/bitnami/clickhouse). - -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](https://github.com/bitnami/containers/blob/main/CONTRIBUTING.md). - ## License Copyright © 2026 Broadcom. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.