| import{_ as o,r as l,o as n,c as i,b as e,d as t,a as r,e as a}from"./app-Bx8hKGcu.js";const s={},c=a('<h1 id="集群搭建" tabindex="-1"><a class="header-anchor" href="#集群搭建"><span>集群搭建</span></a></h1><h2 id="集群设置" tabindex="-1"><a class="header-anchor" href="#集群设置"><span>集群设置</span></a></h2><p>你可以根据此文档启动IoTDB集群。</p><h3 id="安装环境" tabindex="-1"><a class="header-anchor" href="#安装环境"><span>安装环境</span></a></h3><p>为使用IoTDB，你首先需要:</p><ol><li><p>安装前需要保证设备上配有 JDK>=1.8 的运行环境，并配置好 JAVA_HOME 环境变量。</p></li><li><p>设置最大文件打开数为 65535。</p></li></ol><h3 id="安装步骤" tabindex="-1"><a class="header-anchor" href="#安装步骤"><span>安装步骤</span></a></h3><p>IoTDB 支持多种安装途径。用户可以使用三种方式对 IoTDB 进行安装——下载二进制可运行程序、使用源码、使用 docker 镜像。</p>',8),h=e("li",null,"使用源码：您可以从代码仓库下载源码并编译，具体编译方法见下方。",-1),p={href:"https://iotdb.apache.org/Download/",target:"_blank",rel:"noopener noreferrer"},_={href:"https://github.com/apache/iotdb/blob/master/docker/src/main",target:"_blank",rel:"noopener noreferrer"},u=a(`<h4 id="源码编译" tabindex="-1"><a class="header-anchor" href="#源码编译"><span>源码编译</span></a></h4><p>下载源码:</p><div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code>git clone https://github.com/apache/iotdb.git |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>集群的二进制版本在目录 <strong>cluster/target/{iotdb-project.version}</strong> 下</p><h4 id="下载" tabindex="-1"><a class="header-anchor" href="#下载"><span>下载</span></a></h4>`,9),b={href:"https://iotdb.apache.org/Download/",target:"_blank",rel:"noopener noreferrer"},m=a('<h3 id="文件目录" tabindex="-1"><a class="header-anchor" href="#文件目录"><span>文件目录</span></a></h3><p>完成IoTDB Cluster安装后，默认会在IoTDB Cluster的根目录下生成下列目录文件：</p><table><thead><tr><th><strong>目录</strong></th><th><strong>说明</strong></th></tr></thead><tbody><tr><td>conf</td><td>配置文件目录</td></tr><tr><td>data</td><td>默认数据文件目录，可通过修改配置文件修改位置</td></tr><tr><td>ext</td><td>默认udf目录，可通过修改配置文件修改位置</td></tr><tr><td>lib</td><td>库文件目录</td></tr><tr><td>logs</td><td>运行日志目录</td></tr><tr><td>sbin</td><td>可执行文件目录</td></tr><tr><td>tools</td><td>系统工具目录</td></tr></tbody></table><h3 id="配置" tabindex="-1"><a class="header-anchor" href="#配置"><span>配置</span></a></h3><p>为方便 IoTDB Server 的配置与管理，IoTDB Server 为用户提供三种配置项，使得您可以在启动服务或服务运行时对其进行配置。</p><p>三种配置项的配置文件均位于 IoTDB 安装目录：<code>$IOTDB_HOME/conf</code>文件夹下，其中涉及 server 配置的共有 4 个文件，分别为：<code>iotdb-cluster.properties</code>、<code>iotdb-engine.properties</code>、<code>logback.xml</code> 和 <code>iotdb-env.sh</code>(Unix 系统）/<code>iotdb-env.bat</code>(Windows 系统）, 您可以通过更改其中的配置项对系统运行的相关配置项进行配置。</p><p>配置文件的说明如下：</p><ul><li><code>iotdb-env.sh</code>/<code>iotdb-env.bat</code>：环境配置项的默认配置文件。您可以在文件中配置 JAVA-JVM 的相关系统配置项。</li><li><code>iotdb-engine.properties</code>：IoTDB 引擎层系统配置项的默认配置文件。您可以在文件中配置 IoTDB 引擎运行时的相关参数。此外，用户可以在文件中配置 IoTDB 存储时 TsFile 文件的相关信息，如每次将内存中的数据写入到磁盘前的缓存大小 (<code>group_size_in_byte</code>)，内存中每个列打一次包的大小 (<code>page_size_in_byte</code>) 等。</li><li><code>logback.xml</code>: 日志配置文件，比如日志级别等。</li><li><code>iotdb-cluster.properties</code>: IoTDB 集群所需要的一些配置。</li></ul>',8),g=e("code",null,"iotdb-engine.properties",-1),v=e("code",null,"iotdb-env.sh",-1),f=e("code",null,"iotdb-env.bat",-1),x={href:"https://github.com/apache/iotdb/blob/master/docs/zh/UserGuide/Appendix/Config-Manual.md",target:"_blank",rel:"noopener noreferrer"},y=e("code",null,"iotdb-cluster.properties",-1),I={href:"https://github.com/apache/iotdb/blob/master/cluster/src/assembly/resources/conf/iotdb-cluster.properties",target:"_blank",rel:"noopener noreferrer"},D=e("a",{href:"#%E9%9B%86%E7%BE%A4%E9%85%8D%E7%BD%AE%E9%A1%B9"},"Cluster Configuration",-1),B=a('<p>配置文件位于 <strong>{cluster_root_dir}/conf</strong>。</p><p><strong>你需要修改每个节点以下的配置项去启动你的IoTDB集群：</strong></p><ul><li><p>iotdb-engine.properties:</p><ul><li>rpc_address</li></ul><ul><li><p>rpc_port</p></li><li><p>base_dir</p></li><li><p>data_dirs</p></li><li><p>wal_dir</p></li></ul></li><li><p>iotdb-cluster.properties</p><ul><li><p>internal_ip</p></li><li><p>internal_meta_port</p></li><li><p>internal_data_port</p></li><li><p>cluster_info_public_port</p></li><li><p>seed_nodes</p></li><li><p>default_replica_num</p></li></ul></li></ul><h2 id="被覆盖的单机版选项" tabindex="-1"><a class="header-anchor" href="#被覆盖的单机版选项"><span>被覆盖的单机版选项</span></a></h2><p>iotdb-engines.properties 配置文件中的部分内容会不再生效：</p><ul><li><code>enable_auto_create_schema</code> 不再生效，并被视为<code>false</code>. 应使用 iotdb-cluster.properties 中的<br><code>enable_auto_create_schema</code> 来控制是否自动创建序列。</li><li><code>is_sync_enable</code> 不再生效，并被视为 <code>false</code>.</li></ul><h3 id="启动服务" tabindex="-1"><a class="header-anchor" href="#启动服务"><span>启动服务</span></a></h3><h4 id="启动集群" tabindex="-1"><a class="header-anchor" href="#启动集群"><span>启动集群</span></a></h4>',8),T={href:"https://github.com/apache/iotdb/blob/master/docs/zh/UserGuide/Cluster/Cluster-Setup.md#%E9%85%8D%E7%BD%AE%E9%A1%B9",target:"_blank",rel:"noopener noreferrer"},k=a(`<div class="language-text line-numbers-mode" data-ext="text" data-title="text"><pre class="language-text"><code># Unix/OS X |
| </code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="附录" tabindex="-1"><a class="header-anchor" href="#附录"><span>附录</span></a></h3><h4 id="集群配置项" tabindex="-1"><a class="header-anchor" href="#集群配置项"><span>集群配置项</span></a></h4><ul><li>internal_ip</li></ul><table><thead><tr><th>名字</th><th>internal_ip</th></tr></thead><tbody><tr><td>描述</td><td>IOTDB 集群各个节点之间内部通信的 IP 地址，比如心跳、snapshot 快照、raft log 等。<strong><code>internal_ip</code>是集群内部的私有ip</strong></td></tr><tr><td>类型</td><td>String</td></tr><tr><td>默认值</td><td>127.0.0.1</td></tr><tr><td>改后生效方式</td><td>重启服务生效，集群建立后不可再修改</td></tr></tbody></table><ul><li>internal_meta_port</li></ul><table><thead><tr><th>名字</th><th>internal_meta_port</th></tr></thead><tbody><tr><td>描述</td><td>IoTDB meta 服务端口，用于元数据组（又称集群管理组）通信，元数据组管理集群配置和存储组信息<strong>IoTDB 将为每个 meta 服务自动创建心跳端口。默认 meta 服务心跳端口为<code>internal_meta_port+1</code>，请确认这两个端口不是系统保留端口并且未被占用</strong></td></tr><tr><td>类型</td><td>Int32</td></tr><tr><td>默认值</td><td>9003</td></tr><tr><td>改后生效方式</td><td>重启服务生效，集群建立后不可再修改</td></tr></tbody></table><ul><li>internal_data_port</li></ul><table><thead><tr><th>名字</th><th>internal_data_port</th></tr></thead><tbody><tr><td>描述</td><td>IoTDB data 服务端口，用于数据组通信，数据组管理数据模式和数据的存储<strong>IoTDB 将为每个 data 服务自动创建心跳端口。默认的 data 服务心跳端口为<code>internal_data_port+1</code>。请确认这两个端口不是系统保留端口并且未被占用</strong></td></tr><tr><td>类型</td><td>Int32</td></tr><tr><td>默认值</td><td>40010</td></tr><tr><td>改后生效方式</td><td>重启服务生效，集群建立后不可再修改</td></tr></tbody></table><ul><li>cluster_info_public_port</li></ul><table><thead><tr><th>名字</th><th>cluster_info_public_port</th></tr></thead><tbody><tr><td>描述</td><td>用于查看集群信息（如数据分区）的 RPC 服务的接口</td></tr><tr><td>类型</td><td>Int32</td></tr><tr><td>默认值</td><td>6567</td></tr><tr><td>改后生效方式</td><td>重启服务生效</td></tr></tbody></table><ul><li>open_server_rpc_port</li></ul><table><thead><tr><th>名字</th><th>open_server_rpc_port</th></tr></thead><tbody><tr><td>描述</td><td>是否打开单机模块的 rpc port，用于调试模式，如果设置为 true，则单机模块的 rpc port 设置为<code>rpc_port (in iotdb-engines.properties) + 1</code></td></tr><tr><td>类型</td><td>Boolean</td></tr><tr><td>默认值</td><td>false</td></tr><tr><td>改后生效方式</td><td>重启服务生效，集群建立后不可再修改</td></tr></tbody></table><ul><li>seed_nodes</li></ul><table><thead><tr><th>名字</th><th>seed_nodes</th></tr></thead><tbody><tr><td>描述</td><td>集群中节点的地址（私有ip），<code>{IP/DOMAIN}:internal_meta_port</code>格式，用逗号分割；对于伪分布式模式，可以都填写<code>localhost</code>，或是<code>127.0.0.1</code> 或是混合填写，但是不能够出现真实的 ip 地址；对于分布式模式，支持填写 real ip 或是 hostname，但是不能够出现<code>localhost</code>或是<code>127.0.0.1</code>。当使用<code>start-node.sh(.bat)</code>启动节点时，此配置意味着形成初始群集的节点，每个节点的<code>seed_nodes</code>应该一致，否则群集将初始化失败；当使用<code>add-node.sh(.bat)</code>添加节点到集群中时，此配置项可以是集群中已经存在的任何节点，不需要是用<code>start-node.sh(bat)</code>构建初始集群的节点。</td></tr><tr><td>类型</td><td>String</td></tr><tr><td>默认值</td><td>127.0.0.1:9003,127.0.0.1:9005,127.0.0.1:9007</td></tr><tr><td>改后生效方式</td><td>重启服务生效</td></tr></tbody></table><ul><li>rpc_thrift_compression_enable</li></ul><table><thead><tr><th>名字</th><th>rpc_thrift_compression_enable</th></tr></thead><tbody><tr><td>描述</td><td>是否开启 thrift 压缩通信，<strong>注意这个参数要各个节点保持一致，也要与客户端保持一致，同时也要与<code>iotdb-engine.properties</code>中<code>rpc_thrift_compression_enable</code>参数保持一致</strong></td></tr><tr><td>类型</td><td>Boolean</td></tr><tr><td>默认值</td><td>false</td></tr><tr><td>改后生效方式</td><td>重启服务生效，需要整个集群同时更改</td></tr></tbody></table><ul><li>default_replica_num</li></ul><table><thead><tr><th>名字</th><th>default_replica_num</th></tr></thead><tbody><tr><td>描述</td><td>集群副本数</td></tr><tr><td>类型</td><td>Int32</td></tr><tr><td>默认值</td><td>3</td></tr><tr><td>改后生效方式</td><td>重启服务生效，集群建立后不可更改</td></tr></tbody></table><ul><li>multi_raft_factor</li></ul><table><thead><tr><th>名字</th><th>multi_raft_factor</th></tr></thead><tbody><tr><td>描述</td><td>每个数据组启动的 raft 组实例数量，默认每个数据组启动一个 raft 组</td></tr><tr><td>类型</td><td>Int32</td></tr><tr><td>默认值</td><td>1</td></tr><tr><td>改后生效方式</td><td>重启服务生效，集群建立后不可更改</td></tr></tbody></table><ul><li>cluster_name</li></ul><table><thead><tr><th>名字</th><th>cluster_name</th></tr></thead><tbody><tr><td>描述</td><td>集群名称，集群名称用以标识不同的集群，<strong>一个集群中所有节点的 cluster_name 都应相同</strong></td></tr><tr><td>类型</td><td>String</td></tr><tr><td>默认值</td><td>default</td></tr><tr><td>改后生效方式</td><td>重启服务生效</td></tr></tbody></table><ul><li>connection_timeout_ms</li></ul><table><thead><tr><th>名字</th><th>connection_timeout_ms</th></tr></thead><tbody><tr><td>描述</td><td>raft 节点间的 thrift 连接超时和 socket 超时时间，单位毫秒. <strong>对于发送心跳和投票请求的 thrift 连接的超时时间会被自动调整为 connection_timeout_ms 和 heartbeat_interval_ms 的最小值.</strong></td></tr><tr><td>类型</td><td>Int32</td></tr><tr><td>默认值</td><td>20000</td></tr><tr><td>改后生效方式</td><td>重启服务生效</td></tr></tbody></table><ul><li>heartbeat_interval_ms</li></ul><table><thead><tr><th>名字</th><th>heartbeat_interval_ms</th></tr></thead><tbody><tr><td>描述</td><td>领导者发送心跳广播的间隔时间，单位毫秒</td></tr><tr><td>类型</td><td>Int64</td></tr><tr><td>默认值</td><td>1000</td></tr><tr><td>改后生成方式</td><td>重启服务生效</td></tr></tbody></table><ul><li>election_timeout_ms</li></ul><table><thead><tr><th>名字</th><th>election_timeout_ms</th></tr></thead><tbody><tr><td>描述</td><td>跟随者的选举超时时间, 以及选举者等待投票的超时时间, 单位毫秒</td></tr><tr><td>类型</td><td>Int64</td></tr><tr><td>默认值</td><td>20000</td></tr><tr><td>改后生成方式</td><td>重启服务生效</td></tr></tbody></table><ul><li>read_operation_timeout_ms</li></ul><table><thead><tr><th>名字</th><th>read_operation_timeout_ms</th></tr></thead><tbody><tr><td>描述</td><td>读取操作超时时间，仅用于内部通信，不适用于整个操作，单位毫秒</td></tr><tr><td>类型</td><td>Int32</td></tr><tr><td>默认值</td><td>30000</td></tr><tr><td>改后生效方式</td><td>重启服务生效</td></tr></tbody></table><ul><li>write_operation_timeout_ms</li></ul><table><thead><tr><th>名字</th><th>write_operation_timeout_ms</th></tr></thead><tbody><tr><td>描述</td><td>写入操作超时时间，仅用于内部通信，不适用于整个操作，单位毫秒</td></tr><tr><td>类型</td><td>Int32</td></tr><tr><td>默认值</td><td>30000</td></tr><tr><td>改后生效方式</td><td>重启服务生效</td></tr></tbody></table><ul><li>min_num_of_logs_in_mem</li></ul><table><thead><tr><th>名字</th><th>min_num_of_logs_in_mem</th></tr></thead><tbody><tr><td>描述</td><td>删除日志操作执行后，内存中保留的最多的提交的日志的数量。增大这个值将减少在 CatchUp 使用快照的机会，但也会增加内存占用量</td></tr><tr><td>类型</td><td>Int32</td></tr><tr><td>默认值</td><td>100</td></tr><tr><td>改后生效方式</td><td>重启服务生效</td></tr></tbody></table><ul><li>max_num_of_logs_in_mem</li></ul><table><thead><tr><th>名字</th><th>max_num_of_logs_in_mem</th></tr></thead><tbody><tr><td>描述</td><td>当内存中已提交的日志条数达到这个值之后，就会触发删除日志的操作，增大这个值将减少在 CatchUp 使用快照的机会，但也会增加内存占用量</td></tr><tr><td>类型</td><td>Int32</td></tr><tr><td>默认值</td><td>1000</td></tr><tr><td>改后生效方式</td><td>重启服务生效</td></tr></tbody></table><ul><li>log_deletion_check_interval_second</li></ul><table><thead><tr><th>名字</th><th>log_deletion_check_interval_second</th></tr></thead><tbody><tr><td>描述</td><td>检查删除日志任务的时间间隔，每次删除日志任务将会把已提交日志超过 min_num_of_logs_in_mem 条的最老部分删除，单位秒</td></tr><tr><td>类型</td><td>Int32</td></tr><tr><td>默认值</td><td>60</td></tr><tr><td>改后生效方式</td><td>重启服务生效</td></tr></tbody></table><ul><li>enable_auto_create_schema</li></ul><table><thead><tr><th>名字</th><th>enable_auto_create_schema</th></tr></thead><tbody><tr><td>描述</td><td>是否支持自动创建 schema，<strong>这个值会覆盖<code>iotdb-engine.properties</code>中<code>enable_auto_create_schema</code>的配置</strong></td></tr><tr><td>类型</td><td>BOOLEAN</td></tr><tr><td>默认值</td><td>true</td></tr><tr><td>改后生效方式</td><td>重启服务生效</td></tr></tbody></table><ul><li>consistency_level</li></ul><table><thead><tr><th>名字</th><th>consistency_level</th></tr></thead><tbody><tr><td>描述</td><td>读一致性，目前支持 3 种一致性：strong、mid、weak。strong consistency 每次操作都会尝试与 Leader 同步以获取最新的数据，如果失败（超时），则直接向用户返回错误； mid consistency 每次操作将首先尝试与 Leader 进行同步，但是如果失败（超时），它将使用本地当前数据向用户提供服务； weak consistency 不会与 Leader 进行同步，而只是使用本地数据向用户提供服务</td></tr><tr><td>类型</td><td>strong、mid、weak</td></tr><tr><td>默认值</td><td>mid</td></tr><tr><td>改后生效方式</td><td>重启服务生效</td></tr></tbody></table><ul><li>is_enable_raft_log_persistence</li></ul><table><thead><tr><th>名字</th><th>is_enable_raft_log_persistence</th></tr></thead><tbody><tr><td>描述</td><td>是否开启 raft log 持久化</td></tr><tr><td>类型</td><td>BOOLEAN</td></tr><tr><td>默认值</td><td>true</td></tr><tr><td>改后生效方式</td><td>重启服务生效</td></tr></tbody></table>`,47);function S(A,O){const d=l("ExternalLinkIcon");return n(),i("div",null,[c,e("ul",null,[h,e("li",null,[t("二进制可运行程序：请从 "),e("a",p,[t("下载"),r(d)]),t(" 页面下载最新的安装包，解压后即完成安装。")]),e("li",null,[t("使用 Docker 镜像：dockerfile 文件位于 "),e("a",_,[t("github"),r(d)])])]),u,e("p",null,[t("你可以直接下载二进制版本 "),e("a",b,[t("Download Page"),r(d)])]),m,e("p",null,[g,t("、"),v,t("/"),f,t(" 两个配置文件详细说明请参考 "),e("a",x,[t("附录/配置手册"),r(d)]),t("，与集群有关的配置项是在"),y,t("文件中的，你可以直接查看 "),e("a",I,[t("配置文件"),r(d)]),t(" 中的注释，也可以参考 "),D,t("。")]),B,e("p",null,[t("您可以多节点部署或单机部署分布式集群，两者的主要区别是后者需要处理端口和文件目录的冲突，配置项含义请参考 "),e("a",T,[t("配置项"),r(d)]),t("。 启动其中一个节点的服务，需要执行如下命令：")]),k,e("p",null,[t("安装环境请参考 "),e("a",C,[t("快速上手/安装环境章节"),r(d)]),t("。你可以根据节点的rpc_address和rpc_port向任何节点发起连接。")]),E])}const U=o(s,[["render",S],["__file","Cluster-Setup.html.vue"]]),V=JSON.parse('{"path":"/zh/UserGuide/V0.13.x/Cluster/Cluster-Setup.html","title":"集群搭建","lang":"zh-CN","frontmatter":{"description":"集群搭建 集群设置 你可以根据此文档启动IoTDB集群。 安装环境 为使用IoTDB，你首先需要: 安装前需要保证设备上配有 JDK>=1.8 的运行环境，并配置好 JAVA_HOME 环境变量。 设置最大文件打开数为 65535。 安装步骤 IoTDB 支持多种安装途径。用户可以使用三种方式对 IoTDB 进行安装——下载二进制可运行程序、使用源码、...","head":[["link",{"rel":"alternate","hreflang":"en-us","href":"https://iotdb.apache.org/UserGuide/V0.13.x/Cluster/Cluster-Setup.html"}],["meta",{"property":"og:url","content":"https://iotdb.apache.org/zh/UserGuide/V0.13.x/Cluster/Cluster-Setup.html"}],["meta",{"property":"og:site_name","content":"IoTDB Website"}],["meta",{"property":"og:title","content":"集群搭建"}],["meta",{"property":"og:description","content":"集群搭建 集群设置 你可以根据此文档启动IoTDB集群。 安装环境 为使用IoTDB，你首先需要: 安装前需要保证设备上配有 JDK>=1.8 的运行环境，并配置好 JAVA_HOME 环境变量。 设置最大文件打开数为 65535。 安装步骤 IoTDB 支持多种安装途径。用户可以使用三种方式对 IoTDB 进行安装——下载二进制可运行程序、使用源码、..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:locale","content":"zh-CN"}],["meta",{"property":"og:locale:alternate","content":"en-US"}],["meta",{"property":"og:updated_time","content":"2023-07-10T03:11:17.000Z"}],["meta",{"property":"article:modified_time","content":"2023-07-10T03:11:17.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"集群搭建\\",\\"image\\":[\\"\\"],\\"dateModified\\":\\"2023-07-10T03:11:17.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"集群设置","slug":"集群设置","link":"#集群设置","children":[{"level":3,"title":"安装环境","slug":"安装环境","link":"#安装环境","children":[]},{"level":3,"title":"安装步骤","slug":"安装步骤","link":"#安装步骤","children":[]},{"level":3,"title":"文件目录","slug":"文件目录","link":"#文件目录","children":[]},{"level":3,"title":"配置","slug":"配置","link":"#配置","children":[]}]},{"level":2,"title":"被覆盖的单机版选项","slug":"被覆盖的单机版选项","link":"#被覆盖的单机版选项","children":[{"level":3,"title":"启动服务","slug":"启动服务","link":"#启动服务","children":[]},{"level":3,"title":"附录","slug":"附录","link":"#附录","children":[]}]}],"git":{"createdTime":1688958677000,"updatedTime":1688958677000,"contributors":[{"name":"CritasWang","email":"critas@outlook.com","commits":1}]},"readingTime":{"minutes":10.7,"words":3211},"filePathRelative":"zh/UserGuide/V0.13.x/Cluster/Cluster-Setup.md","localizedDate":"2023年7月10日","autoDesc":true}');export{U as comp,V as data}; |
