本文将介绍关于 IoTDB 使用的基本流程，如果需要更多信息，请浏览我们官网的 指引.
安装前需要保证设备上配有 JDK>=1.8 的运行环境，并配置好 JAVA_HOME 环境变量。
设置最大文件打开数为 65535。
IoTDB 支持多种安装途径。用户可以使用三种方式对 IoTDB 进行安装——下载二进制可运行程序、使用源码、使用 docker 镜像。
使用源码：您可以从代码仓库下载源码并编译，具体编译方法见下方。
二进制可运行程序：请从 下载 页面下载最新的安装包，解压后即完成安装。
使用 Docker 镜像：dockerfile 文件位于github
用户可以根据以下操作对 IoTDB 进行简单的试用，若以下操作均无误，则说明 IoTDB 安装成功。
IoTDB 是一个基于分布式系统的数据库。要启动 IoTDB ，你可以先启动单机版（一个 ConfigNode 和一个 DataNode）来检查安装。
用户可以使用 sbin 文件夹下的 start-standalone 脚本启动 IoTDB。
Linux 系统与 MacOS 系统启动命令如下：
> bash sbin/start-standalone.sh
Windows 系统启动命令如下：
> sbin\start-standalone.bat
注意：目前，要使用单机模式，你需要保证所有的地址设置为 127.0.0.1，如果需要从非 IoTDB 所在的机器访问此IoTDB，请将配置项 dn_rpc_address 修改为 IoTDB 所在的机器 IP。副本数设置为1。并且，推荐使用 SimpleConsensus，因为这会带来额外的效率。这些现在都是默认配置。
以本地环境为例，演示 IoTDB 集群的启动、扩容与缩容。
注意：本文档为使用本地不同端口，进行伪分布式环境部署的教程，仅用于练习。在真实环境部署时，一般不需要修改节点端口，仅需配置节点 IPV4 地址或域名即可。
解压 apache-iotdb-1.0.0-all-bin.zip 至 cluster0 目录。
在 Linux 环境中，部署 1 个 ConfigNode 和 1 个 DataNode（1C1D）集群版，默认 1 副本：
./cluster0/sbin/start-confignode.sh ./cluster0/sbin/start-datanode.sh
./cluster0/sbin/start-cli.sh
IoTDB> show cluster details +------+----------+-------+---------------+------------+-------------------+----------+-------+--------+-------------------+-----------------+ |NodeID| NodeType| Status|InternalAddress|InternalPort|ConfigConsensusPort|RpcAddress|RpcPort|MppPort |SchemaConsensusPort|DataConsensusPort| +------+----------+-------+---------------+------------+-------------------+----------+-------+--------+-------------------+-----------------+ | 0|ConfigNode|Running| 127.0.0.1| 10710| 10720| | | | | | | 1| DataNode|Running| 127.0.0.1| 10730| | 127.0.0.1| 6667| 10740| 10750| 10760| +------+----------+-------+---------------+------------+-------------------+----------+-------+--------+-------------------+-----------------+ Total line number = 2 It costs 0.242s
解压 apache-iotdb-1.0.0-all-bin.zip 至 cluster1 目录和 cluster2 目录
对于 cluster1 目录：
| 配置项 | 值 |
|---|---|
| cn_internal_address | 127.0.0.1 |
| cn_internal_port | 10711 |
| cn_consensus_port | 10721 |
| cn_target_config_node_list | 127.0.0.1:10710 |
| 配置项 | 值 |
|---|---|
| dn_rpc_address | 127.0.0.1 |
| dn_rpc_port | 6668 |
| dn_internal_address | 127.0.0.1 |
| dn_internal_port | 10731 |
| dn_mpp_data_exchange_port | 10741 |
| dn_schema_region_consensus_port | 10751 |
| dn_data_region_consensus_port | 10761 |
| dn_target_config_node_list | 127.0.0.1:10710 |
对于 cluster2 目录：
| 配置项 | 值 |
|---|---|
| cn_internal_address | 127.0.0.1 |
| cn_internal_port | 10712 |
| cn_consensus_port | 10722 |
| cn_target_config_node_list | 127.0.0.1:10710 |
| 配置项 | 值 |
|---|---|
| dn_rpc_address | 127.0.0.1 |
| dn_rpc_port | 6669 |
| dn_internal_address | 127.0.0.1 |
| dn_internal_port | 10732 |
| dn_mpp_data_exchange_port | 10742 |
| dn_schema_region_consensus_port | 10752 |
| dn_data_region_consensus_port | 10762 |
| dn_target_config_node_list | 127.0.0.1:10710 |
将集群扩容至 3 个 ConfigNode 和 3 个 DataNode（3C3D）集群版， 指令执行顺序为先启动 ConfigNode，再启动 DataNode：
./cluster1/sbin/start-confignode.sh ./cluster2/sbin/start-confignode.sh ./cluster1/sbin/start-datanode.sh ./cluster2/sbin/start-datanode.sh
在 Cli 执行 show cluster details，结果如下：
IoTDB> show cluster details +------+----------+-------+---------------+------------+-------------------+----------+-------+-------+-------------------+-----------------+ |NodeID| NodeType| Status|InternalAddress|InternalPort|ConfigConsensusPort|RpcAddress|RpcPort|MppPort|SchemaConsensusPort|DataConsensusPort| +------+----------+-------+---------------+------------+-------------------+----------+-------+-------+-------------------+-----------------+ | 0|ConfigNode|Running| 127.0.0.1| 10710| 10720| | | | | | | 2|ConfigNode|Running| 127.0.0.1| 10711| 10721| | | | | | | 3|ConfigNode|Running| 127.0.0.1| 10712| 10722| | | | | | | 1| DataNode|Running| 127.0.0.1| 10730| | 127.0.0.1| 6667| 10740| 10750| 10760| | 4| DataNode|Running| 127.0.0.1| 10731| | 127.0.0.1| 6668| 10741| 10751| 10761| | 5| DataNode|Running| 127.0.0.1| 10732| | 127.0.0.1| 6669| 10742| 10752| 10762| +------+----------+-------+---------------+------------+-------------------+----------+-------+-------+-------------------+-----------------+ Total line number = 6 It costs 0.012s
# 使用 ip:port 移除 ./cluster0/sbin/remove-confignode.sh 127.0.0.1:10711 # 使用节点编号移除 ./cluster0/sbin/remove-confignode.sh 2
# 使用 ip:port 移除 ./cluster0/sbin/remove-datanode.sh 127.0.0.1:6668 # 使用节点编号移除 ./cluster0/sbin/remove-confignode.sh 4
在 Cli 执行 show cluster details，结果如下：
IoTDB> show cluster details +------+----------+-------+---------------+------------+-------------------+----------+-------+-------+-------------------+-----------------+ |NodeID| NodeType| Status|InternalAddress|InternalPort|ConfigConsensusPort|RpcAddress|RpcPort|MppPort|SchemaConsensusPort|DataConsensusPort| +------+----------+-------+---------------+------------+-------------------+----------+-------+-------+-------------------+-----------------+ | 0|ConfigNode|Running| 127.0.0.1| 10710| 10720| | | | | | | 3|ConfigNode|Running| 127.0.0.1| 10712| 10722| | | | | | | 1| DataNode|Running| 127.0.0.1| 10730| | 127.0.0.1| 6667| 10740| 10750| 10760| | 5| DataNode|Running| 127.0.0.1| 10732| | 127.0.0.1| 6669| 10742| 10752| 10762| +------+----------+-------+---------------+------------+-------------------+----------+-------+-------+-------------------+-----------------+ Total line number = 4 It costs 0.005s
你可以选择下载二进制文件（见 3.1）或从源代码编译（见 3.2）。
Git
git clone https://github.com/apache/iotdb.git git checkout v1.0.0
官网下载
在 IoTDB 源码根目录下:
mvn clean package -pl distribution -am -DskipTests
编译成功后，可在目录 distribution/target/apache-iotdb-1.0.0-SNAPSHOT-all-bin/apache-iotdb-1.0.0-SNAPSHOT-all-bin 找到集群版本的二进制文件。
打开 apache-iotdb-1.0.0-SNAPSHOT-all-bin，可见以下目录：
| 目录 | 说明 |
|---|---|
| conf | 配置文件目录，包含 ConfigNode、DataNode、JMX 和 logback 等配置文件 |
| data | 数据文件目录，包含 ConfigNode 和 DataNode 的数据文件 |
| lib | 库文件目录 |
| licenses | 证书文件目录 |
| logs | 日志文件目录，包含 ConfigNode 和 DataNode 的日志文件 |
| sbin | 脚本目录，包含 ConfigNode 和 DataNode 的启停移除脚本，以及 Cli 的启动脚本等 |
| tools | 系统工具目录 |
apache-iotdb-1.0.0-SNAPSHOT-all-bin 包含 ConfigNode 和 DataNode， 请将安装包部署于你目标集群的所有机器上，推荐将安装包部署于所有服务器的相同目录下。
如果你希望先在一台服务器上尝试部署 IoTDB 集群，请参考 Cluster Quick Start。
接下来需要修改每个服务器上的配置文件，登录服务器， 并将工作路径切换至 apache-iotdb-1.0.0-SNAPSHOT-all-bin， 配置文件在 ./conf 目录内。
对于所有部署 ConfigNode 的服务器，需要修改通用配置（见 5.2.1）和 ConfigNode 配置（见 5.2.2）。
对于所有部署 DataNode 的服务器，需要修改通用配置（见 5.2.1）和 DataNode 配置（见 5.2.3）。
打开通用配置文件 ./conf/iotdb-common.properties， 可根据 部署推荐 设置以下参数：
| 配置项 | 说明 | 默认 |
|---|---|---|
| cluster_name | 节点希望加入的集群的名称 | defaultCluster |
| config_node_consensus_protocol_class | ConfigNode 使用的共识协议 | org.apache.iotdb.consensus.ratis.RatisConsensus |
| schema_replication_factor | 元数据副本数，DataNode 数量不应少于此数目 | 1 |
| schema_region_consensus_protocol_class | 元数据副本组的共识协议 | org.apache.iotdb.consensus.ratis.RatisConsensus |
| data_replication_factor | 数据副本数，DataNode 数量不应少于此数目 | 1 |
| data_region_consensus_protocol_class | 数据副本组的共识协议。注：RatisConsensus 目前不支持多数据目录 | org.apache.iotdb.consensus.iot.IoTConsensus |
注意：上述配置项在集群启动后即不可更改，且务必保证所有节点的通用配置完全一致，否则节点无法启动。
打开 ConfigNode 配置文件 ./conf/iotdb-confignode.properties，根据服务器/虚拟机的 IP 地址和可用端口，设置以下参数：
| 配置项 | 说明 | 默认 | 用法 |
|---|---|---|---|
| cn_internal_address | ConfigNode 在集群内部通讯使用的地址 | 127.0.0.1 | 设置为服务器的 IPV4 地址或域名 |
| cn_internal_port | ConfigNode 在集群内部通讯使用的端口 | 10710 | 设置为任意未占用端口 |
| cn_consensus_port | ConfigNode 副本组共识协议通信使用的端口 | 10720 | 设置为任意未占用端口 |
| cn_target_config_node_list | 节点注册加入集群时连接的 ConfigNode 的地址。注：只能配置一个 | 127.0.0.1:10710 | 对于 Seed-ConfigNode，设置为自己的 cn_internal_address:cn_internal_port；对于其它 ConfigNode，设置为另一个正在运行的 ConfigNode 的 cn_internal_address:cn_internal_port |
注意：上述配置项在节点启动后即不可更改，且务必保证所有端口均未被占用，否则节点无法启动。
打开 DataNode 配置文件 ./conf/iotdb-datanode.properties，根据服务器/虚拟机的 IP 地址和可用端口，设置以下参数：
| 配置项 | 说明 | 默认 | 用法 |
|---|---|---|---|
| dn_rpc_address | 客户端 RPC 服务的地址 | 127.0.0.1 | 设置为服务器的 IPV4 地址或域名 |
| dn_rpc_port | 客户端 RPC 服务的端口 | 6667 | 设置为任意未占用端口 |
| dn_internal_address | DataNode 在集群内部接收控制流使用的地址 | 127.0.0.1 | 设置为服务器的 IPV4 地址或域名 |
| dn_internal_port | DataNode 在集群内部接收控制流使用的端口 | 10730 | 设置为任意未占用端口 |
| dn_mpp_data_exchange_port | DataNode 在集群内部接收数据流使用的端口 | 10740 | 设置为任意未占用端口 |
| dn_data_region_consensus_port | DataNode 的数据副本间共识协议通信的端口 | 10750 | 设置为任意未占用端口 |
| dn_schema_region_consensus_port | DataNode 的元数据副本间共识协议通信的端口 | 10760 | 设置为任意未占用端口 |
| dn_target_config_node_list | 集群中正在运行的 ConfigNode 地址 | 127.0.0.1:10710 | 设置为任意正在运行的 ConfigNode 的 cn_internal_address:cn_internal_port，可设置多个，用逗号（“,”）隔开 |
注意：上述配置项在节点启动后即不可更改，且务必保证所有端口均未被占用，否则节点无法启动。
本小节描述如何启动包括若干 ConfigNode 和 DataNode 的集群。 集群可以提供服务的标准是至少启动一个 ConfigNode 且启动 不小于（数据/元数据）副本个数 的 DataNode。
总体启动流程分为三步：
集群第一个启动的节点必须是 ConfigNode，第一个启动的 ConfigNode 必须遵循本小节教程。
第一个启动的 ConfigNode 是 Seed-ConfigNode，标志着新集群的创建。 在启动 Seed-ConfigNode 前，请打开通用配置文件 ./conf/iotdb-common.properties，并检查如下参数：
| 配置项 | 检查 |
|---|---|
| cluster_name | 已设置为期望的集群名称 |
| config_node_consensus_protocol_class | 已设置为期望的共识协议 |
| schema_replication_factor | 已设置为期望的元数据副本数 |
| schema_region_consensus_protocol_class | 已设置为期望的共识协议 |
| data_replication_factor | 已设置为期望的数据副本数 |
| data_region_consensus_protocol_class | 已设置为期望的共识协议 |
注意： 请根据部署推荐配置合适的通用参数，这些参数在首次配置后即不可修改。
接着请打开它的配置文件 ./conf/iotdb-confignode.properties，并检查如下参数：
| 配置项 | 检查 |
|---|---|
| cn_internal_address | 已设置为服务器的 IPV4 地址或域名 |
| cn_internal_port | 该端口未被占用 |
| cn_consensus_port | 该端口未被占用 |
| cn_target_config_node_list | 已设置为自己的内部通讯地址，即 cn_internal_address:cn_internal_port |
检查完毕后，即可在服务器上运行启动脚本：
# Linux 前台启动 bash ./sbin/start-confignode.sh # Linux 后台启动 nohup bash ./sbin/start-confignode.sh >/dev/null 2>&1 & # Windows .\sbin\start-confignode.bat
ConfigNode 的其它配置参数可参考 ConfigNode 配置参数。
只要不是第一个启动的 ConfigNode 就必须遵循本小节教程。
可向集群添加更多 ConfigNode，以保证 ConfigNode 的高可用。常用的配置为额外增加两个 ConfigNode，使集群共有三个 ConfigNode。
新增的 ConfigNode 需要保证 ./conf/iotdb-common.properites 中的所有配置参数与 Seed-ConfigNode 完全一致，否则可能启动失败或产生运行时错误。 因此，请着重检查通用配置文件中的以下参数：
| 配置项 | 检查 |
|---|---|
| cluster_name | 与 Seed-ConfigNode 保持一致 |
| config_node_consensus_protocol_class | 与 Seed-ConfigNode 保持一致 |
| schema_replication_factor | 与 Seed-ConfigNode 保持一致 |
| schema_region_consensus_protocol_class | 与 Seed-ConfigNode 保持一致 |
| data_replication_factor | 与 Seed-ConfigNode 保持一致 |
| data_region_consensus_protocol_class | 与 Seed-ConfigNode 保持一致 |
接着请打开它的配置文件 ./conf/iotdb-confignode.properties，并检查以下参数：
| 配置项 | 检查 |
|---|---|
| cn_internal_address | 已设置为服务器的 IPV4 地址或域名 |
| cn_internal_port | 该端口未被占用 |
| cn_consensus_port | 该端口未被占用 |
| cn_target_config_node_list | 已设置为另一个正在运行的 ConfigNode 的内部通讯地址，推荐使用 Seed-ConfigNode 的内部通讯地址 |
检查完毕后，即可在服务器上运行启动脚本：
# Linux 前台启动 bash ./sbin/start-confignode.sh # Linux 后台启动 nohup bash ./sbin/start-confignode.sh >/dev/null 2>&1 & # Windows .\sbin\start-confignode.bat
ConfigNode 的其它配置参数可参考 ConfigNode配置参数。
确保集群已有正在运行的 ConfigNode 后，才能开始增加 DataNode。
可以向集群中添加任意个 DataNode。 在添加新的 DataNode 前，请先打开通用配置文件 ./conf/iotdb-common.properties 并检查以下参数：
| 配置项 | 检查 |
|---|---|
| cluster_name | 与 Seed-ConfigNode 保持一致 |
接着打开它的配置文件 ./conf/iotdb-datanode.properties 并检查以下参数：
| 配置项 | 检查 |
|---|---|
| dn_rpc_address | 已设置为服务器的 IPV4 地址或域名 |
| dn_rpc_port | 该端口未被占用 |
| dn_internal_address | 已设置为服务器的 IPV4 地址或域名 |
| dn_internal_port | 该端口未被占用 |
| dn_mpp_data_exchange_port | 该端口未被占用 |
| dn_data_region_consensus_port | 该端口未被占用 |
| dn_schema_region_consensus_port | 该端口未被占用 |
| dn_target_config_node_list | 已设置为正在运行的 ConfigNode 的内部通讯地址，推荐使用 Seed-ConfigNode 的内部通讯地址 |
检查完毕后，即可在服务器上运行启动脚本：
# Linux 前台启动 bash ./sbin/start-datanode.sh # Linux 后台启动 nohup bash ./sbin/start-datanode.sh >/dev/null 2>&1 & # Windows .\sbin\start-datanode.bat
DataNode 的其它配置参数可参考 DataNode配置参数。
注意：当且仅当集群拥有不少于副本个数（max{schema_replication_factor, data_replication_factor}）的 DataNode 后，集群才可以提供服务
若搭建的集群仅用于本地调试，可直接执行 ./sbin 目录下的 Cli 启动脚本：
# Linux ./sbin/start-cli.sh # Windows .\sbin\start-cli.bat
若希望通过 Cli 连接生产环境的集群， 请阅读 Cli 使用手册。
以在6台服务器上启动的3C3D（3个ConfigNode 和 3个DataNode）集群为例， 这里假设3个ConfigNode的IP地址依次为192.168.1.10、192.168.1.11、192.168.1.12，且3个ConfigNode启动时均使用了默认的端口10710与10720； 3个DataNode的IP地址依次为192.168.1.20、192.168.1.21、192.168.1.22，且3个DataNode启动时均使用了默认的端口6667、10730、10740、10750与10760。
当按照6.1步骤成功启动集群后，在 Cli 执行 show cluster details，看到的结果应当如下：
IoTDB> show cluster details +------+----------+-------+---------------+------------+-------------------+------------+-------+-------+-------------------+-----------------+ |NodeID| NodeType| Status|InternalAddress|InternalPort|ConfigConsensusPort| RpcAddress|RpcPort|MppPort|SchemaConsensusPort|DataConsensusPort| +------+----------+-------+---------------+------------+-------------------+------------+-------+-------+-------------------+-----------------+ | 0|ConfigNode|Running| 192.168.1.10| 10710| 10720| | | | | | | 2|ConfigNode|Running| 192.168.1.11| 10710| 10720| | | | | | | 3|ConfigNode|Running| 192.168.1.12| 10710| 10720| | | | | | | 1| DataNode|Running| 192.168.1.20| 10730| |192.168.1.20| 6667| 10740| 10750| 10760| | 4| DataNode|Running| 192.168.1.21| 10730| |192.168.1.21| 6667| 10740| 10750| 10760| | 5| DataNode|Running| 192.168.1.22| 10730| |192.168.1.22| 6667| 10740| 10750| 10760| +------+----------+-------+---------------+------------+-------------------+------------+-------+-------+-------------------+-----------------+ Total line number = 6 It costs 0.012s
若所有节点的状态均为 Running，则说明集群部署成功； 否则，请阅读启动失败节点的运行日志，并检查对应的配置参数。
本小节描述如何手动关闭 IoTDB 的 ConfigNode 或 DataNode 进程。
执行停止 ConfigNode 脚本：
# Linux ./sbin/stop-confignode.sh # Windows .\sbin\stop-confignode.bat
执行停止 DataNode 脚本：
# Linux ./sbin/stop-datanode.sh # Windows .\sbin\stop-datanode.bat
首先获取节点的进程号：
jps # 或 ps aux | grep iotdb
结束进程：
kill -9 <pid>
注意：有些端口的信息需要 root 权限才能获取，在此情况下请使用 sudo
本小节描述如何将 ConfigNode 或 DataNode 移出集群。
在移除 ConfigNode 前，请确保移除后集群至少还有一个活跃的 ConfigNode。 在活跃的 ConfigNode 上执行 remove-confignode 脚本：
# Linux ## 根据 confignode_id 移除节点 ./sbin/remove-confignode.sh <confignode_id> ## 根据 ConfigNode 内部通讯地址和端口移除节点 ./sbin/remove-confignode.sh <cn_internal_address>:<cn_internal_port> # Windows ## 根据 confignode_id 移除节点 .\sbin\remove-confignode.bat <confignode_id> ## 根据 ConfigNode 内部通讯地址和端口移除节点 .\sbin\remove-confignode.bat <cn_internal_address>:<cn_internal_port>
在移除 DataNode 前，请确保移除后集群至少还有不少于（数据/元数据）副本个数的 DataNode。 在活跃的 DataNode 上执行 remove-datanode 脚本：
# Linux ## 根据 datanode_id 移除节点 ./sbin/remove-datanode.sh <datanode_id> ## 根据 DataNode RPC 服务地址和端口移除节点 ./sbin/remove-datanode.sh <dn_rpc_address>:<dn_rpc_port> # Windows ## 根据 datanode_id 移除节点 .\sbin\remove-datanode.bat <datanode_id> ## 根据 DataNode RPC 服务地址和端口移除节点 .\sbin\remove-datanode.bat <dn_rpc_address>:<dn_rpc_port>
请参考 分布式部署FAQ