集群版部署

大约 10 分钟

集群版部署

本小节将以IoTDB经典集群部署架构3C3D（3个ConfigNode和3个DataNode）为例，介绍如何部署集群，即通常所说的3C3D集群。3C3D集群架构图如下：

注意事项

安装前请确认系统已参照系统配置准备完成。
部署时推荐优先使用hostname进行IP配置，可避免后期修改主机ip导致数据库无法启动的问题。设置hostname需要在目标服务器上配置/etc/hosts，如本机ip是192.168.1.3，hostname是iotdb-1，则可以使用以下命令设置服务器的 hostname，并使用hostname配置IoTDB的cn_internal_address、dn_internal_address。
```
echo "192.168.1.3  iotdb-1" >> /etc/hosts 
```
有些参数首次启动后不能修改，请参考下方的"参数配置"章节来进行设置。
无论是在linux还是windows中，请确保IoTDB的安装路径中不含空格和中文，避免软件运行异常。
请注意，安装部署IoTDB时需要保持使用同一个用户进行操作，您可以：

使用 root 用户（推荐）：使用 root 用户可以避免权限等问题。
使用固定的非 root 用户：
- 使用同一用户操作：确保在启动、停止等操作均保持使用同一用户，不要切换用户。
- 避免使用 sudo：尽量避免使用 sudo 命令，因为它会以 root 用户权限执行命令，可能会引起权限混淆或安全问题。

准备步骤

准备IoTDB数据库安装包：apache-iotdb-{version}-all-bin.zip（安装包获取见：链接）
按环境要求配置好操作系统环境（系统环境配置见：链接）

安装步骤

假设现在有3台linux服务器，IP地址和服务角色分配如下：

节点ip	主机名	服务
192.168.1.3	iotdb-1	ConfigNode、DataNode
192.168.1.4	iotdb-2	ConfigNode、DataNode
192.168.1.5	iotdb-3	ConfigNode、DataNode

设置主机名

在3台机器上分别配置主机名，设置主机名需要在目标服务器上配置/etc/hosts，使用如下命令：

echo "192.168.1.3  iotdb-1"  >> /etc/hosts
echo "192.168.1.4  iotdb-2"  >> /etc/hosts
echo "192.168.1.5  iotdb-3"  >> /etc/hosts

参数配置

解压安装包并进入安装目录

unzip  apache-iotdb-{version}-all-bin.zip 
cd  apache-iotdb-{version}-all-bin

环境脚本配置

./conf/confignode-env.sh 配置
配置项 说明 默认值 推荐值 备注
MEMORY_SIZE IoTDB ConfigNode节点可以使用的内存总量空可按需填写，填写后系统会根据填写的数值来分配内存重启服务生效
./conf/datanode-env.sh 配置
配置项 说明 默认值 推荐值 备注
MEMORY_SIZE IoTDB DataNode节点可以使用的内存总量空可按需填写，填写后系统会根据填写的数值来分配内存重启服务生效

配置项	说明	默认值	推荐值	备注
MEMORY_SIZE	IoTDB ConfigNode节点可以使用的内存总量	空	可按需填写，填写后系统会根据填写的数值来分配内存	重启服务生效

配置项	说明	默认值	推荐值	备注
MEMORY_SIZE	IoTDB DataNode节点可以使用的内存总量	空	可按需填写，填写后系统会根据填写的数值来分配内存	重启服务生效

通用配置

打开通用配置文件./conf/iotdb-common.properties，可根据部署方式设置以下参数：

配置项	说明	192.168.1.3	192.168.1.4	192.168.1.5
cluster_name	集群名称	defaultCluster	defaultCluster	defaultCluster
schema_replication_factor	元数据副本数，DataNode数量不应少于此数目	3	3	3
data_replication_factor	数据副本数，DataNode数量不应少于此数目	2	2	2

ConfigNode 配置

打开ConfigNode配置文件./conf/iotdb-confignode.properties，设置以下参数

配置项	说明	默认	推荐值	192.168.1.3	192.168.1.4	192.168.1.5	备注
cn_internal_address	ConfigNode在集群内部通讯使用的地址	127.0.0.1	所在服务器的IPV4地址或hostname，推荐使用hostname	iotdb-1	iotdb-2	iotdb-3	首次启动后不能修改
cn_internal_port	ConfigNode在集群内部通讯使用的端口	10710	10710	10710	10710	10710	首次启动后不能修改
cn_consensus_port	ConfigNode副本组共识协议通信使用的端口	10720	10720	10720	10720	10720	首次启动后不能修改
cn_seed_config_node	节点注册加入集群时连接的ConfigNode 的地址，cn_internal_address:cn_internal_port	127.0.0.1:10710	第一个CongfigNode的cn_internal_address:cn_internal_port	iotdb-1:10710	iotdb-1:10710	iotdb-1:10710	首次启动后不能修改

DataNode 配置

打开DataNode配置文件 ./conf/iotdb-datanode.properties，设置以下参数：

配置项	说明	默认	推荐值	192.168.1.3	192.168.1.4	192.168.1.5	备注
dn_rpc_address	客户端 RPC 服务的地址	127.0.0.1	推荐使用所在服务器的IPV4地址或hostname	iotdb-1	iotdb-2	iotdb-3	重启服务生效
dn_rpc_port	客户端 RPC 服务的端口	6667	6667	6667	6667	6667	重启服务生效
dn_internal_address	DataNode在集群内部通讯使用的地址	127.0.0.1	所在服务器的IPV4地址或hostname，推荐使用hostname	iotdb-1	iotdb-2	iotdb-3	首次启动后不能修改
dn_internal_port	DataNode在集群内部通信使用的端口	10730	10730	10730	10730	10730	首次启动后不能修改
dn_mpp_data_exchange_port	DataNode用于接收数据流使用的端口	10740	10740	10740	10740	10740	首次启动后不能修改
dn_data_region_consensus_port	DataNode用于数据副本共识协议通信使用的端口	10750	10750	10750	10750	10750	首次启动后不能修改
dn_schema_region_consensus_port	DataNode用于元数据副本共识协议通信使用的端口	10760	10760	10760	10760	10760	首次启动后不能修改
dn_seed_config_node	节点注册加入集群时连接的ConfigNode地址,即cn_internal_address:cn_internal_port	127.0.0.1:10710	第一个CongfigNode的cn_internal_address:cn_internal_port	iotdb-1:10710	iotdb-1:10710	iotdb-1:10710	首次启动后不能修改

❗️注意：VSCode Remote等编辑器无自动保存配置功能，请确保修改的文件被持久化保存，否则配置项无法生效

启动ConfigNode节点

先启动第一个iotdb-1的confignode, 保证种子confignode节点先启动，然后依次启动第2和第3个confignode节点

cd sbin
./start-confignode.sh    -d      #“-d”参数将在后台进行启动

如果启动失败，请参考常见问题。

启动DataNode 节点

分别进入iotdb的sbin目录下，依次启动3个datanode节点：

cd sbin
./start-datanode.sh   -d   # “-d”参数将在后台进行启动

验证部署

可直接执行./sbin目录下的Cli启动脚本：

./start-cli.sh  -h  ip(本机ip或域名)  -p  端口号(6667)

成功启动后，出现如下界面显示IOTDB安装成功。

可以使用show cluster 命令查看集群信息：

出现ACTIVATED(W)为被动激活，表示此ConfigNode没有license文件（或没有签发时间戳最新的license文件），其激活依赖于集群中其它Activate状态的ConfigNode。此时建议检查license文件是否已放入license文件夹，没有请放入license文件，若已存在license文件，可能是此节点license文件与其他节点信息不一致导致，请联系天谋工作人员重新申请.

节点维护步骤

ConfigNode节点维护

ConfigNode节点维护分为ConfigNode添加和移除两种操作，有两个常见使用场景：

集群扩展：如集群中只有1个ConfigNode时，希望增加ConfigNode以提升ConfigNode节点高可用性，则可以添加2个ConfigNode，使得集群中有3个ConfigNode。
集群故障恢复：1个ConfigNode所在机器发生故障，使得该ConfigNode无法正常运行，此时可以移除该ConfigNode，然后添加一个新的ConfigNode进入集群。

❗️注意，在完成ConfigNode节点维护后，需要保证集群中有1或者3个正常运行的ConfigNode。2个ConfigNode不具备高可用性，超过3个ConfigNode会导致性能损失。

添加ConfigNode节点

脚本命令：

# Linux / MacOS
# 首先切换到IoTDB根目录
sbin/start-confignode.sh

# Windows
# 首先切换到IoTDB根目录
sbin/start-confignode.bat

参数介绍：

参数	描述	是否为必填项
-v	显示版本信息	否
-f	在前台运行脚本，不将其放到后台	否
-d	以守护进程模式启动，即在后台运行	否
-p	指定一个文件来存放进程ID，用于进程管理	否
-c	指定配置文件夹的路径，脚本会从这里加载配置文件	否
-g	打印垃圾回收（GC）的详细信息	否
-H	指定Java堆转储文件的路径，当JVM内存溢出时使用	否
-E	指定JVM错误日志文件的路径	否
-D	定义系统属性，格式为 key=value	否
-X	直接传递 -XX 参数给 JVM	否
-h	帮助指令	否

移除ConfigNode节点

首先通过CLI连接集群，通过show confignodes确认想要移除ConfigNode的内部地址与端口号：

IoTDB> show confignodes
+------+-------+---------------+------------+--------+
|NodeID| Status|InternalAddress|InternalPort|    Role|
+------+-------+---------------+------------+--------+
|     0|Running|      127.0.0.1|       10710|  Leader|
|     1|Running|      127.0.0.1|       10711|Follower|
|     2|Running|      127.0.0.1|       10712|Follower|
+------+-------+---------------+------------+--------+
Total line number = 3
It costs 0.030s

然后使用脚本将DataNode移除。脚本命令：

# Linux / MacOS 
sbin/remove-confignode.sh [confignode_id]
或
./sbin/remove-confignode.sh [cn_internal_address:cn_internal_port]

#Windows
sbin/remove-confignode.bat [confignode_id]
或
./sbin/remove-confignode.bat [cn_internal_address:cn_internal_port]

DataNode节点维护

DataNode节点维护有两个常见场景：

集群扩容：出于集群能力扩容等目的，添加新的DataNode进入集群
集群故障恢复：一个DataNode所在机器出现故障，使得该DataNode无法正常运行，此时可以移除该DataNode，并添加新的DataNode进入集群

❗️注意，为了使集群能正常工作，在DataNode节点维护过程中以及维护完成后，正常运行的DataNode总数不得少于数据副本数（通常为2），也不得少于元数据副本数（通常为3）。

添加DataNode节点

脚本命令：

# Linux / MacOS 
# 首先切换到IoTDB根目录
sbin/start-datanode.sh

# Windows
# 首先切换到IoTDB根目录
sbin/start-datanode.bat

参数介绍：

缩写	描述	是否为必填项
-v	显示版本信息	否
-f	在前台运行脚本，不将其放到后台	否
-d	以守护进程模式启动，即在后台运行	否
-p	指定一个文件来存放进程ID，用于进程管理	否
-c	指定配置文件夹的路径，脚本会从这里加载配置文件	否
-g	打印垃圾回收（GC）的详细信息	否
-H	指定Java堆转储文件的路径，当JVM内存溢出时使用	否
-E	指定JVM错误日志文件的路径	否
-D	定义系统属性，格式为 key=value	否
-X	直接传递 -XX 参数给 JVM	否
-h	帮助指令	否

说明：在添加DataNode后，随着新的写入到来（以及旧数据过期，如果设置了TTL），集群负载会逐渐向新的DataNode均衡，最终在所有节点上达到存算资源的均衡。

移除DataNode节点

首先通过CLI连接集群，通过show datanodes确认想要移除的DataNode的RPC地址与端口号：

IoTDB> show datanodes
+------+-------+----------+-------+-------------+---------------+
|NodeID| Status|RpcAddress|RpcPort|DataRegionNum|SchemaRegionNum|
+------+-------+----------+-------+-------------+---------------+
|     1|Running|   0.0.0.0|   6667|            0|              0|
|     2|Running|   0.0.0.0|   6668|            1|              1|
|     3|Running|   0.0.0.0|   6669|            1|              0|
+------+-------+----------+-------+-------------+---------------+
Total line number = 3
It costs 0.110s

然后使用脚本将DataNode移除。脚本命令：

# Linux / MacOS 
sbin/remove-datanode.sh [dn_rpc_address:dn_rpc_port]

#Windows
sbin/remove-datanode.bat [dn_rpc_address:dn_rpc_port]

常见问题

Confignode节点启动失败
步骤 1: 请查看启动日志，检查是否修改了某些首次启动后不可改的参数。
步骤 2: 请查看启动日志，检查是否出现其他异常。日志中若存在异常现象，请联系天谋技术支持人员咨询解决方案。
步骤 3: 如果是首次部署或者数据可删除，也可按下述步骤清理环境，重新部署后，再次启动。
步骤 4: 清理环境：
a. 结束所有 ConfigNode 和 DataNode 进程。
```
    # 1. 停止 ConfigNode 和 DataNode 服务
    sbin/stop-standalone.sh

    # 2. 检查是否还有进程残留
    jps
    # 或者
    ps -ef|gerp iotdb

    # 3. 如果有进程残留，则手动kill
    kill -9 <pid>
    # 如果确定机器上仅有1个iotdb，可以使用下面命令清理残留进程
    ps -ef|grep iotdb|grep -v grep|tr -s '  ' ' ' |cut -d ' ' -f2|xargs kill -9
```
b. 删除 data 和 logs 目录。
说明：删除 data 目录是必要的，删除 logs 目录是为了纯净日志，非必需。
```
    cd /data/iotdb
    rm -rf data logs
```