在本示例中,您将学习如何搭建一个可扩展的简单 ClickHouse 集群。 该集群配置了五台服务器,其中两台用于数据分片。 另外三台服务器用于协调。您将要搭建的集群架构如下所示:
尽管可以在同一台服务器上同时运行 ClickHouse Server 和 ClickHouse Keeper,
但我们强烈建议在生产环境中为 ClickHouse Keeper 使用专用主机,
这也是我们将在本示例中演示的方法。Keeper server 所需配置可以更小,通常每个 Keeper server 配置 4GB RAM 就足够了,
至少在你的 ClickHouse Server 规模扩大之前都是如此。
前置条件
- 你此前已设置过本地 ClickHouse 服务器
- 你熟悉 ClickHouse 的基本配置概念,例如配置文件
- 你的机器上已安装 Docker
1
设置目录结构和测试环境
在本教程中,您将使用 Docker compose 搭建 ClickHouse 集群。该配置同样可以修改后用于独立的本地机器、虚拟机或云实例。运行以下命令,为本示例创建目录结构:将以下 创建以下子目录和文件:
docker-compose.yml 文件添加到 cluster_2S_1R 目录中:docker-compose.yml
config.d目录包含 ClickHouse server 配置文件config.xml, 其中定义了每个 ClickHouse 节点的自定义配置。该 配置会与每个 ClickHouse 安装自带的默认config.xmlClickHouse 配置 文件合并。users.d目录包含用户配置文件users.xml,其中 定义了用户的自定义配置。该配置会与每个 ClickHouse 安装自带的默认 ClickHouseusers.xml配置文件合并。
2
配置 ClickHouse 节点
服务器配置
现在修改位于fs/volumes/clickhouse-{}/etc/clickhouse-server/config.d 的每个空配置文件 config.xml。下方高亮显示的行需要根据各节点进行相应修改:以下将对上述配置文件的各个部分进行详细说明。
网络与日志
通过启用 listen host 设置,即可允许通过网络接口进行外部通信。这可确保 ClickHouse server 主机可被其他 主机访问:8123:9000:<logger> 块中定义。以下示例配置将生成一个调试日志,文件大小达到 1000M 时自动轮转,最多保留三个轮转文件:集群配置
集群的配置在<remote_servers> 块中设置,集群名称 cluster_2S_1R 即在此处定义。<cluster_2S_1R></cluster_2S_1R> 块定义了集群的布局,使用 <shard></shard> 和 <replica></replica> 配置项,并作为 distributed DDL 查询的模板,这类查询通过 ON CLUSTER 子句在整个集群中执行。默认情况下,distributed DDL 查询是允许的,但也可以通过设置 allow_distributed_ddl_queries 将其关闭。internal_replication 默认保持为 false,因为每个分片只有一个副本。Keeper 配置
<ZooKeeper> 部分用于告知 ClickHouse,ClickHouse Keeper (或 ZooKeeper) 的运行位置。
由于我们使用的是 ClickHouse Keeper 集群,需要指定集群中的每个 <node>,
并分别通过 <host> 和 <port> 标签指定其 hostname 和端口号。ClickHouse Keeper 的配置将在本教程的下一步骤中介绍。虽然可以让 ClickHouse Keeper 与 ClickHouse Server 运行在同一台服务器上,
但在生产环境中,我们强烈建议将 ClickHouse Keeper 部署在专用主机上。
宏配置
此外,<macros> 部分用于为复制表定义参数替换。这些替换项列于 system.macros 中,可在查询中使用 {shard} 和 {replica} 等替换占位符。这些需要根据集群的布局单独定义。
用户配置
现在,将以下内容写入位于fs/volumes/clickhouse-{}/etc/clickhouse-server/users.d 的每个空配置文件 users.xml:/users.d/users.xml
在此示例中,为简便起见,默认用户未设置密码。
实际生产环境中,不建议采用此方式。
在此示例中,集群中所有节点上的
users.xml 文件都相同。3
配置 ClickHouse Keeper
Keeper 配置
为了使复制正常工作,需要先搭建并配置 ClickHouse Keeper 集群。ClickHouse Keeper 为数据复制提供协调系统, 可作为 ZooKeeper 的替代方案,当然也可以直接使用 ZooKeeper。 不过,推荐使用 ClickHouse Keeper,因为它能提供更好的保障和 可靠性,并且比 ZooKeeper 占用更少的资源。为了实现高可用性并 保持 quorum,建议至少运行三个 ClickHouse Keeper 节点。ClickHouse Keeper 可以与 ClickHouse 一起运行在集群的任何节点上,不过
更推荐将其部署在专用节点上,这样就可以独立于数据库集群对
ClickHouse Keeper 集群进行扩缩容和管理。
keeper_config.xml 文件:fs/volumes/clickhouse-keeper-{}/etc/clickhouse-keeper 中创建的空配置文件。下方高亮显示的内容需要改为各节点对应的具体值:/clickhouse-keeper/keeper_config.xml
每个配置文件都应包含以下唯一配置 (如下所示) 。
所使用的
server_id 对于集群中的对应 ClickHouse Keeper 节点必须是唯一的,
并且要与 <raft_configuration> 部分中定义的服务器 <id> 一致。
tcp_port 是 ClickHouse Keeper 客户端 使用的端口。4
测试配置
确保你的机器上已运行 Docker。
在 你应该会看到 Docker 开始拉取 ClickHouse 和 Keeper 镜像,
随后启动容器:要确认集群正在运行,请连接到 如果成功,您将看到 ClickHouse 客户端提示符:运行以下查询,查看为哪些
主机定义了哪些集群拓扑:运行以下查询,检查 ClickHouse Keeper 集群的状态:下面的响应展示了来自 follower 节点的示例响应:下面的响应显示了 leader 节点返回的示例响应:至此,你已成功搭建了一个包含两个分片、且每个分片各有一个副本的 ClickHouse 集群。
下一步,你将在该集群中创建一个表。
cluster_2S_1R 目录的根目录中,使用 docker-compose up 命令启动集群:clickhouse-01 或 clickhouse-02,然后执行
以下查询。下面显示的是连接到第一个节点的命令:Query
Response
Query
Response
mntr 命令也常用于验证 ClickHouse Keeper 是否正在运行,并获取三个 Keeper 节点之间关系的状态信息。
在此示例使用的配置中,有三个节点协同工作。
这些节点会选举出一个 leader,其余节点则为跟随者。mntr 命令会提供与性能相关的信息,以及特定节点是跟随者还是 leader。在 clickhouse-keeper-01、clickhouse-keeper-02 和
clickhouse-keeper-03 的 shell 中运行以下命令,以检查每个 Keeper 节点的状态。下面显示的是
clickhouse-keeper-01 的命令:Response
Response
5
创建数据库
现在,你已经验证 cluster 已正确设置并正在运行,接下来你将重新创建与英国房产价格
示例数据集教程中所用相同的表。该数据集包含自 1995 年以来英格兰和威尔士约 3000 万行
房地产成交价格数据。请在不同的终端标签页或窗口中分别运行以下命令,以连接到每个主机的客户端:你可以在每台主机的 clickhouse-client 中运行下面的查询,以确认
除默认数据库外,尚未创建其他数据库:在 你可以再次在每台主机的客户端中运行与之前相同的查询,
以确认虽然该查询仅在
Query
Response
clickhouse-01 客户端中,使用
ON CLUSTER 子句执行以下分布式 DDL 查询,以创建一个名为 uk 的新数据库:clickhouse-01 上执行,
数据库也已在整个集群中创建:6
在集群上创建表
现在数据库已创建完成,接下来创建一个表。
在任意主机客户端上运行以下查询:请注意,它与 UK property prices 示例 dataset 教程中原始 在插入英国房价成交数据之前,我们先做个简单实验,看看从任一主机向普通表插入数据时会发生什么。从任一主机执行以下查询,创建一个测试数据库和表:现在,在 切换到 现在在 你会注意到,与
CREATE statement 使用的查询完全相同,
唯一的区别是 ON CLUSTER clause。ON CLUSTER clause 用于对 CREATE、DROP、ALTER 和 RENAME 等 DDL (数据定义语言)
查询进行分布式执行,以确保这些
schema 变更会应用到 cluster 中的所有节点。你可以在每台主机的客户端中运行以下查询,以确认该表已在整个 cluster 中创建:Query
Response
clickhouse-01 上运行以下 INSERT 查询:clickhouse-02,然后运行以下 INSERT 查询:Query
clickhouse-01 或 clickhouse-02 上执行以下查询:ReplicatedMergeTree 表不同,这里返回的只有插入到该特定主机上的那一行,
而不是两行都返回。要读取跨两个分片的数据,我们需要一种能够处理跨所有分片查询的接口:
当我们对它运行 select 查询时,它会合并两个分片中的数据;
而当我们运行 insert 查询时,它会将数据插入到两个分片中。在 ClickHouse 中,这种接口称为分布式表,我们使用
Distributed 表引擎来创建它。下面来看看它的工作方式。7
创建分布式表
使用以下查询创建一个分布式表:在这个示例中,选择 我们也对英国房价数据执行同样的操作。在任意一个主机客户端上,
运行以下查询,基于我们之前使用
rand() 函数作为分片键,这样
插入的数据就会随机分布到各个分片上。现在,从任一主机查询该分布式表,返回的都会是
分别插入到两台主机上的两行数据,这与前一个示例不同:ON CLUSTER 创建的现有表
创建一个分布式表:8
向分布式表插入数据
现在连接到任意一台主机并插入数据:数据插入后,您可以使用分布式表查询行数:在任意一台主机上运行以下查询,您将看到数据已大致均匀地分布在各个分片上 (请注意,写入哪个分片是由 如果其中一台主机发生故障,会发生什么?我们通过关闭 运行以下命令确认主机已停止:现在在 遗憾的是,我们的集群并不具备容错能力。一旦某个主机发生故障,集群将被视为不健康状态,查询也会随之失败。这与我们在上一个示例中看到的副本表有所不同——在那个示例中,即使某个主机发生故障,我们仍然能够正常写入数据。
Query
Response
rand() 决定的,因此您的结果可能与此不同) :clickhouse-01 来模拟这一场景:Response
clickhouse-02 上对 Distributed 表执行与之前相同的 select 查询:Response