amd64/clickhouse Docker 镜像

注意：这是https://hub.docker.com/_/clickhouse的`amd64`架构构建的"每架构"仓库——更多信息，请参见官方镜像文档中的https://github.com/docker-library/official-images#architectures-other-than-amd64和官方镜像FAQ中的https://github.com/docker-library/faq#an-images-source-changed-in-git-now-what。

快速参考

• 维护者：
  https://github.com/ClickHouse/ClickHouse

• 获取帮助：
  https://dockr.ly/comm-slack、Server Fault、https://unix.stackexchange.com/help/on-topic或https://stackoverflow.com/help/on-topic

支持的标签及对应的Dockerfile链接

• https://github.com/ClickHouse/docker-library/blob/5ed67d07b9e3aeb6592de702fa53c1f3e8209a71/server/26.3.3.20/Dockerfile.ubuntu

• https://github.com/ClickHouse/docker-library/blob/5ed67d07b9e3aeb6592de702fa53c1f3e8209a71/server/26.2.7.17/Dockerfile.ubuntu

• https://github.com/ClickHouse/docker-library/blob/5ed67d07b9e3aeb6592de702fa53c1f3e8209a71/server/26.1.7.13/Dockerfile.ubuntu

• https://github.com/ClickHouse/docker-library/blob/5ed67d07b9e3aeb6592de702fa53c1f3e8209a71/server/25.8.21.7/Dockerfile.ubuntu

快速参考（续）

• 问题提交地址：
  https://github.com/ClickHouse/ClickHouse/issues?q=

• 支持的架构：(https://github.com/docker-library/official-images#architectures-other-than-amd64)
  https://hub.docker.com/r/amd64/clickhouse/、https://hub.docker.com/r/arm64v8/clickhouse/

• 已发布镜像制品详情：
  https://github.com/docker-library/repo-info/blob/master/repos/clickhouse（https://github.com/docker-library/repo-info/commits/master/repos/clickhouse）
  （镜像元数据、传输大小等）

• 镜像更新：
  https://github.com/docker-library/official-images/issues?q=label%3Alibrary%2Fclickhouse
  https://github.com/docker-library/official-images/blob/master/library/clickhouse（https://github.com/docker-library/official-images/commits/master/library/clickhouse）

• 本描述的来源：
  https://github.com/docker-library/docs/tree/master/clickhouse（https://github.com/docker-library/docs/commits/master/clickhouse）

ClickHouse服务器Docker镜像

什么是ClickHouse？

ClickHouse是一个开源的列式数据库管理系统（DBMS），用于在线分析处理（OLAP），允许用户使用SQL查询实时生成分析报告。

ClickHouse的速度比传统数据库管理系统快100-1000倍，每台服务器每秒可处理数亿到超过十亿行数据以及数十GB的数据。其在全球拥有广泛的用户基础，因可靠性、易用性和容错性而受到好评。

更多信息和文档请参见https://clickhouse.com/。

版本

• latest标签指向最新稳定分支的最新版本。
• 分支标签（如22.2）指向对应分支的最新版本。
• 完整版本标签（如22.2.3和22.2.3.5）指向对应版本。

兼容性

• amd64镜像需要支持SSE3指令。2005年后的几乎所有x86 CPU都支持SSE3。
• arm64镜像需要支持ARMv8.2-A架构，并额外支持Load-Acquire RCpc寄存器。该寄存器在ARMv8.2-A中为可选，在ARMv8.3-A中为强制。支持Graviton >=2、Azure和GCP实例。不支持的设备示例包括Raspberry Pi 4（ARMv8.0-A）和Jetson AGX Xavier/Orin（ARMv8.2-A）。
• 从ClickHouse 24.11开始，Ubuntu镜像使用ubuntu:22.04作为基础镜像。它需要docker版本>=20.10.10（包含https://github.com/moby/moby/commit/977283509f75303bc6612665a04abf76ff1d2468）。作为解决方法，可使用`docker run --security-opt seccomp=unconfined`，但这存在安全隐患。

如何使用此镜像

启动服务器实例

bash
docker run -d --name some-clickhouse-server --ulimit nofile=262144:262144 docker.xuanyuan.run/amd64/clickhouse

默认情况下，ClickHouse仅可通过Docker网络访问。详见下文网络部分。

默认情况下，上述启动的服务器实例将以default用户运行，无密码。

通过原生客户端连接

bash
docker run -it --rm --network=container:some-clickhouse-server --entrypoint clickhouse-client docker.xuanyuan.run/amd64/clickhouse
# 或
docker exec -it some-clickhouse-server clickhouse-client

更多关于https://clickhouse.com/docs/interfaces/cli/的信息。

使用curl连接

bash
echo "SELECT 'Hello, ClickHouse!'" | docker run -i --rm --network=container:some-clickhouse-server buildpack-deps:curl curl 'http://localhost:8123/?query=' -s --data-binary @-

更多关于https://clickhouse.com/docs/interfaces/http/的信息。

停止/删除容器

bash
docker stop some-clickhouse-server
docker rm some-clickhouse-server

网络

⚠️ 注意：预定义用户default在未设置密码的情况下没有网络访问权限，详见下文"如何在启动时创建默认数据库和用户"和"管理default用户"

可通过https://docs.docker.com/config/containers/container-networking/来暴露Docker中运行的ClickHouse：

bash
docker run -d -p 18123:8123 -p 19000:9000 -e CLICKHOUSE_PASSWORD=changeme --name some-clickhouse-server --ulimit nofile=262144:262144 docker.xuanyuan.run/amd64/clickhouse
echo 'SELECT version()' | curl 'http://localhost:18123/?password=changeme' --data-binary @-

22.6.3.35

或者通过使用--network=host允许容器https://docs.docker.com/network/host/（也可获得更好的网络性能）：

bash
docker run -d --network=host --name some-clickhouse-server --ulimit nofile=262144:262144 docker.xuanyuan.run/amd64/clickhouse
echo 'SELECT version()' | curl 'http://localhost:8123/' --data-binary @-

22.6.3.35

⚠️ 注意：上述示例中的default用户仅对本地主机请求可用

卷

通常，你可能需要将以下文件夹挂载到容器内以实现持久化：

• /var/lib/clickhouse/ - ClickHouse存储数据的主文件夹
• /var/log/clickhouse-server/ - 日志

bash
docker run -d \
    -v "$PWD/ch_data:/var/lib/clickhouse/" \
    -v "$PWD/ch_logs:/var/log/clickhouse-server/" \
    --name some-clickhouse-server --ulimit nofile=262144:262144 docker.xuanyuan.run/amd64/clickhouse

你可能还需要挂载：

• /etc/clickhouse-server/config.d/*.xml - 服务器配置调整文件
• /etc/clickhouse-server/users.d/*.xml - 用户设置调整文件
• /docker-entrypoint-initdb.d/ - 数据库初始化脚本文件夹（见下文）。

Linux capabilities

ClickHouse有一些高级功能，需要启用几个https://man7.org/linux/man-pages/man7/capabilities.7.html。

它们是可选的，可使用以下https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities启用：

bash
docker run -d \
    --cap-add=SYS_NICE --cap-add=NET_ADMIN --cap-add=IPC_LOCK \
    --name some-clickhouse-server --ulimit nofile=262144:262144 docker.xuanyuan.run/amd64/clickhouse

更多信息见https://clickhouse.com/docs/knowledgebase/configure_cap_ipc_lock_and_cap_sys_nice_in_docker。

配置

容器暴露端口8123用于https://clickhouse.com/docs/interfaces/http_interface/，端口9000用于https://clickhouse.com/docs/interfaces/tcp/。

ClickHouse配置由文件"config.xml"表示（https://clickhouse.com/docs/operations/configuration_files/）

使用自定义配置启动服务器实例

bash
docker run -d --name some-clickhouse-server --ulimit nofile=262144:262144 -v /path/to/your/config.xml:/etc/clickhouse-server/config.xml docker.xuanyuan.run/amd64/clickhouse

以自定义用户启动服务器

bash
# $PWD/data/clickhouse应存在且归当前用户所有
docker run --rm --user "${UID}:${GID}" --name some-clickhouse-server --ulimit nofile=262144:262144 -v "$PWD/logs/clickhouse:/var/log/clickhouse-server" -v "$PWD/data/clickhouse:/var/lib/clickhouse" docker.xuanyuan.run/amd64/clickhouse

当使用挂载本地目录的镜像时，你可能需要指定用户以维护正确的文件所有权。使用--user参数并将/var/lib/clickhouse和/var/log/clickhouse-server挂载到容器内。否则，镜像将报错且无法启动。

以root用户启动服务器（在启用用户命名空间的情况下有用）

bash
docker run --rm -e CLICKHOUSE_RUN_AS_ROOT=1 --name clickhouse-server-userns -v "$PWD/logs/clickhouse:/var/log/clickhouse-server" -v "$PWD/data/clickhouse:/var/lib/clickhouse" docker.xuanyuan.run/amd64/clickhouse

如何在启动时创建默认数据库和用户

有时你可能希望在容器启动时创建用户（默认使用default用户）和数据库。可使用环境变量CLICKHOUSE_DB、CLICKHOUSE_USER、CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT和CLICKHOUSE_PASSWORD实现：

bash
docker run --rm -e CLICKHOUSE_DB=my_database -e CLICKHOUSE_USER=username -e CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT=1 -e CLICKHOUSE_PASSWORD=password -p 9000:9000/tcp docker.xuanyuan.run/amd64/clickhouse

管理default用户

在未设置CLICKHOUSE_USER、CLICKHOUSE_PASSWORD或CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT的情况下，default用户默认禁用网络访问。

可通过将环境变量CLICKHOUSE_SKIP_USER_SETUP设置为1，使default用户不安全地可用：

bash
docker run --rm -e CLICKHOUSE_SKIP_USER_SETUP=1 -p 9000:9000/tcp docker.xuanyuan.run/amd64/clickhouse

如何扩展此镜像

要在基于此镜像的派生镜像中执行额外初始化，可在/docker-entrypoint-initdb.d下添加一个或多个*.sql、*.sql.gz或*.sh脚本。入口点调用initdb后，将运行该目录中所有*.sql文件、可执行*.sh脚本，并 sourcing 非可执行*.sh脚本，以在启动服务前进行进一步初始化。
此外，可提供环境变量CLICKHOUSE_USER和CLICKHOUSE_PASSWORD，初始化期间将用于clickhouse-client。

例如，要添加额外用户和数据库，可在/docker-entrypoint-initdb.d/init-db.sh中添加以下内容：

bash
#!/bin/bash
set -e

clickhouse client -n <<-EOSQL
    CREATE DATABASE docker;
    CREATE TABLE docker.docker (x Int32) ENGINE = Log;
EOSQL

许可

查看此镜像中包含的软件的https://github.com/ClickHouse/ClickHouse/blob/master/LICENSE。

与所有Docker镜像一样，这些镜像可能还包含其他软件，可能受其他许可（如基础发行版中的Bash等，以及包含的主要软件的任何直接或间接依赖项）约束。

一些能够自动检测到的额外许可信息可能位于https://github.com/docker-library/repo-info/tree/master/repos/clickhouse中。

对于任何预构建镜像的使用，镜像用户有责任确保对该镜像的任何使用符合其中包含的所有软件的相关许可。