Chainguard Container for clickhouse

Clickhouse is the fastest and most resource efficient open-source database for real-time apps and analytics.

Chainguard Containers are regularly-updated, secure-by-default container images.

Download this Container Image

For those with access, this container image is available on cgr.dev:

docker pull cgr.dev/ORGANIZATION/clickhouse:latest

Be sure to replace the ORGANIZATION placeholder with the name used for your organization's private repository within the Chainguard Registry.

Using Clickhouse

The default Clickhouse listen_host is 127.0.0.1 and port is 8123.

Environment Variable Substitution

Environmental variables require the /entrypoint.sh script which is not run by default. You will need to modify and mount configuration files for any values that are not editable via CLI options.

Entrypoint

The entrypoint for the clickhouse Chainguard container is /usr/bin/clickhouse. Commands run as part of docker run or a CMD statement in a Dockerfile will be passed as arguments to clickhouse.

start server instance

To run with Docker and allow empty passwords:

docker run -d --ulimit nofile=262144:262144 cgr.dev/chainguard/clickhouse:latest server

By default, ClickHouse will be accessible only via the Docker network.

By default, starting above server instance will be run as the default user without password.

Users and Directories

By default, this image runs as a non-root user named clickhouse with a uid of 101 and a home directory of /home/clickhouse.

Volumes

Typically you may want to mount the following folders inside your container to achieve persistency:

• /var/lib/clickhouse/ - main folder where ClickHouse stores the data
• /var/log/clickhouse-server/ - logs

docker run -d \
    -v $(realpath ./ch_data):/var/lib/clickhouse/ \
    -v $(realpath ./ch_logs):/var/log/clickhouse-server/ \
    --ulimit nofile=262144:262144 cgr.dev/chainguard/clickhouse:latest

You may also want to mount:

• /etc/clickhouse-server/config.d/*.xml - files with server configuration adjustmenets
• /etc/clickhouse-server/users.d/*.xml - files with user settings adjustmenets
• /docker-entrypoint-initdb.d/ - folder with database initialization scripts

If adding user and server configuration adjustments please ensure to add the --config-file CLI option.

Docker Compose Example

This docker-compose.yaml sets up a Clickhouse database with a default database and user.

version: "3.7"
services:
  clickhouse:
    image: cgr.dev/chainguard/clickhouse:latest
    restart: unless-stopped
    entrypoint: /usr/bin/clickhouse-server -- --listen_host 0.0.0.0
    working_dir: /home/clickhouse
    ports:
      - 8123:8123
    volumes:
      - ./data/clickhouse:/var/lib/clickhouse
      - ./logs/clickhouse:/var/log/clickhouse-server
    networks:
      - wolfi

networks:
  wolfi:
    driver: bridge

Advanced Configuration

Please refer to Clickhouse's documentation for more advanced configuration.

What are Chainguard Containers?

Chainguard's free tier of Starter container images are built with Wolfi, our minimal Linux undistro.

All other Chainguard Containers are built with Chainguard OS, Chainguard's minimal Linux operating system designed to produce container images that meet the requirements of a more secure software supply chain.

The main features of Chainguard Containers include:

• Minimal design, without unnecessary software bloat
• Daily builds to ensure container images are up-to-date with available security patches
• High quality build-time SBOMs attesting to the provenance of all artifacts within the image
• Verifiable signatures provided by Sigstore
• Reproducible builds with Cosign and apko (read more about reproducibility)

For cases where you need container images with shells and package managers to build or debug, most Chainguard Containers come paired with a development, or -dev, variant.

In all other cases, including Chainguard Containers tagged as :latest or with a specific version number, the container images include only an open-source application and its runtime dependencies. These minimal container images typically do not contain a shell or package manager.

Although the -dev container image variants have similar security features as their more minimal versions, they include additional software that is typically not necessary in production environments. We recommend using multi-stage builds to copy artifacts from the -dev variant into a more minimal production image.

Need additional packages?

To improve security, Chainguard Containers include only essential dependencies. Need more packages? Chainguard customers can use Custom Assembly to add packages, either through the Console, chainctl, or API.

To use Custom Assembly in the Chainguard Console: navigate to the image you'd like to customize in your Organization's list of images, and click on the Customize image button at the top of the page.

Learn More

Refer to our Chainguard Containers documentation on Chainguard Academy. Chainguard also offers VMs and Libraries — contact us for access.

Trademarks

This software listing is packaged by Chainguard. The trademarks set forth in this offering are owned by their respective companies, and use of them does not imply any affiliation, sponsorship, or endorsement by such companies.