集群设置

你可以根据此文档启动IoTDB集群。

安装环境

为使用IoTDB，你首先需要:

1. 安装前需要保证设备上配有 JDK>=1.8 的运行环境，并配置好 JAVA_HOME 环境变量。

2. 设置最大文件打开数为 65535。

安装步骤

IoTDB 支持多种安装途径。用户可以使用三种方式对 IoTDB 进行安装——下载二进制可运行程序、使用源码、使用 docker 镜像。

• 使用源码：您可以从代码仓库下载源码并编译，具体编译方法见下方。
• 二进制可运行程序：请从 下载 (opens new window) 页面下载最新的安装包，解压后即完成安装。
• 使用 Docker 镜像：dockerfile 文件位于 https://github.com/apache/iotdb/blob/master/docker/src/main

源码编译

下载源码:

git clone https://github.com/apache/iotdb.git

默认分支为master分支，你可以切换到其他发布版本，例如：

git checkout rel/0.12

在iotdb根目录下:

> mvn clean package -pl cluster -am -DskipTests

集群的二进制版本在目录 cluster/target/{iotdb-project.version} 下

下载

你可以直接下载二进制版本 Download Page (opens new window)

文件目录

完成IoTDB Cluster安装后，默认会在IoTDB Cluster的根目录下生成下列目录文件：

配置

为方便 IoTDB Server 的配置与管理，IoTDB Server 为用户提供三种配置项，使得您可以在启动服务或服务运行时对其进行配置。

三种配置项的配置文件均位于 IoTDB 安装目录：$IOTDB_HOME/conf文件夹下，其中涉及 server 配置的共有 4 个文件，分别为：iotdb-cluster.properties、iotdb-engine.properties、logback.xml 和 iotdb-env.sh(Unix 系统）/iotdb-env.bat(Windows 系统）, 您可以通过更改其中的配置项对系统运行的相关配置项进行配置。

配置文件的说明如下：

• iotdb-env.sh/iotdb-env.bat：环境配置项的默认配置文件。您可以在文件中配置 JAVA-JVM 的相关系统配置项。
• iotdb-engine.properties：IoTDB 引擎层系统配置项的默认配置文件。您可以在文件中配置 IoTDB 引擎运行时的相关参数。此外，用户可以在文件中配置 IoTDB 存储时 TsFile 文件的相关信息，如每次将内存中的数据写入到磁盘前的缓存大小 (group_size_in_byte)，内存中每个列打一次包的大小 (page_size_in_byte) 等。
• logback.xml: 日志配置文件，比如日志级别等。
• iotdb-cluster.properties: IoTDB 集群所需要的一些配置。

iotdb-engine.properties、iotdb-env.sh/iotdb-env.bat 两个配置文件详细说明请参考 附录/配置手册 (opens new window)，与集群有关的配置项是在iotdb-cluster.properties文件中的，你可以直接查看 配置文件 (opens new window) 中的注释，也可以参考 Cluster Configuration。

配置文件位于 {cluster_root_dir}/conf。

你需要修改每个节点以下的配置项去启动你的IoTDB集群：

• iotdb-engine.properties:

  • rpc_address

  • rpc_port

  • base_dir

  • data_dirs

  • wal_dir

• iotdb-cluster.properties

  • internal_ip

  • internal_meta_port

  • internal_data_port

  • cluster_info_public_port

  • seed_nodes

  • default_replica_num

被覆盖的单机版选项

iotdb-engines.properties 配置文件中的部分内容会不再生效：

• enable_auto_create_schema 不再生效，并被视为false. 应使用 iotdb-cluster.properties 中的 enable_auto_create_schema 来控制是否自动创建序列。
• is_sync_enable 不再生效，并被视为 false.

启动服务

启动集群

您可以多节点部署或单机部署分布式集群，两者的主要区别是后者需要处理端口和文件目录的冲突，配置项含义请参考 配置项 (opens new window)。 启动其中一个节点的服务，需要执行如下命令：

# Unix/OS X
> nohup sbin/start-node.sh [printgc] [<conf_path>] >/dev/null 2>&1 &
# Windows
> sbin\start-node.bat [printgc] [<conf_path>]

printgc表示在启动的时候，会开启 GC 日志。 <conf_path>使用conf_path文件夹里面的配置文件覆盖默认配置文件。GC 日志默认是关闭的。为了性能调优，用户可能会需要收集 GC 信息。GC 日志会被存储在IOTDB_HOME/logs/下面。

如果你启动了所有seed节点，并且所有seed节点可以相互通信并没有ip地址/端口和文件目录的冲突，集群就成功启动了。

集群扩展

在集群运行过程中，用户可以向集群中加入新的节点或者删除集群中已有节点。目前仅支持逐节点集群扩展操作，多节点的集群扩展可以转化为一系列单节点集群扩展操作来实现。集群只有在上一次集群扩展操作完成后才会接收新的集群扩展操作。

在要加入集群的新节点上启动以下脚本进行增加节点操作：

# Unix/OS X
> nohup sbin/add-node.sh [printgc] [<conf_path>] >/dev/null 2>&1 &
# Windows
> sbin\add-node.bat [printgc] [<conf_path>]

printgc表示在启动的时候，会开启 GC 日志。 <conf_path>使用conf_path文件夹里面的配置文件覆盖默认配置文件。

在任一集群中的节点上启动以下脚本进行删除节点操作：

# Unix/OS X
> sbin/remove-node.sh <internal_ip> <internal_meta_port>
# Windows
> sbin\remove-node.bat <internal_ip> <internal_meta_port>

internal_ip表示待删除节点的 IP 地址 internal_meta_port表示待删除节点的 meta 服务端口

使用 Cli 工具

安装环境请参考 快速上手/安装环境章节 (opens new window)。你可以根据节点的rpc_address和rpc_port向任何节点发起连接。

停止集群

在任一机器上启动以下脚本进行停止所有运行在该机器上的节点服务操作：

# Unix/OS X
> sbin/stop-node.sh
# Windows
> sbin\stop-node.bat

附录

集群配置项

• internal_ip

• internal_meta_port

• internal_data_port

• cluster_info_public_port

• open_server_rpc_port

• seed_nodes

• rpc_thrift_compression_enable

• default_replica_num

• multi_raft_factor

• cluster_name

• connection_timeout_ms

• heartbeat_interval_ms

• election_timeout_ms

• read_operation_timeout_ms

• write_operation_timeout_ms

• min_num_of_logs_in_mem

• max_num_of_logs_in_mem

• log_deletion_check_interval_second

• enable_auto_create_schema

• consistency_level

• is_enable_raft_log_persistence