blob: 604ca7bd21789c9049bca00c97d923342c4d7690 [file] [log] [blame]
import{_ as s,r as o,o as l,c as r,b as t,d as e,a as i,e as n}from"./app-CkJlK00M.js";const d={},c=t("h1",{id:"stand-alone-deployment",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#stand-alone-deployment"},[t("span",null,"Stand-Alone Deployment")])],-1),h=t("p",null,"This chapter will introduce how to start an IoTDB standalone instance, which includes 1 ConfigNode and 1 DataNode (commonly known as 1C1D).",-1),p=t("h2",{id:"matters-needing-attention",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#matters-needing-attention"},[t("span",null,"Matters Needing Attention")])],-1),g=n(`<li><p>It is recommended to prioritize using &#39;hostname&#39; for IP configuration during deployment, which can avoid the problem of modifying the host IP in the later stage and causing the database to fail to start. To set the host name, you need to configure/etc/hosts on the target server. For example, if the local IP is 192.168.1.3 and the host name is iotdb-1, you can use the following command to set the server&#39;s host name and configure IoTDB&#39;s&#39; cn_internal-address&#39; using the host name dn_internal_addressdn_rpc_address。</p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token builtin class-name">echo</span> <span class="token string">&quot;192.168.1.3 iotdb-1&quot;</span> <span class="token operator">&gt;&gt;</span> /etc/hosts
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div></li><li><p>Some parameters cannot be modified after the first startup. Please refer to the &quot;Parameter Configuration&quot; section below for settings</p></li>`,2),u={href:"https://timecho.com/docs/UserGuide/latest/Deployment-and-Maintenance/Monitoring-Board-Install-and-Deploy.html",target:"_blank",rel:"noopener noreferrer"},m=n(`<h2 id="installation-steps" tabindex="-1"><a class="header-anchor" href="#installation-steps"><span>Installation Steps</span></a></h2><h3 id="_1、unzip-the-installation-package-and-enter-the-installation-directory" tabindex="-1"><a class="header-anchor" href="#_1、unzip-the-installation-package-and-enter-the-installation-directory"><span>1、Unzip the installation package and enter the installation directory</span></a></h3><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token function">unzip</span> iotdb-enterprise-<span class="token punctuation">{</span>version<span class="token punctuation">}</span>-bin.zip
<span class="token builtin class-name">cd</span> iotdb-enterprise-<span class="token punctuation">{</span>version<span class="token punctuation">}</span>-bin
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="_2、parameter-configuration" tabindex="-1"><a class="header-anchor" href="#_2、parameter-configuration"><span>2Parameter Configuration</span></a></h3><h4 id="environment-script-configuration" tabindex="-1"><a class="header-anchor" href="#environment-script-configuration"><span>Environment Script Configuration</span></a></h4>`,5),f={href:"http://env.sh",target:"_blank",rel:"noopener noreferrer"},y=n('<table><thead><tr><th style="text-align:center;"><strong>Configuration</strong></th><th style="text-align:center;"><strong>Description</strong></th><th style="text-align:center;"><strong>Default</strong></th><th style="text-align:center;"><strong>Recommended value</strong></th><th style="text-align:center;">Note</th></tr></thead><tbody><tr><td style="text-align:center;">MEMORY_SIZE</td><td style="text-align:center;">The total amount of memory that IoTDB ConfigNode nodes can use</td><td style="text-align:center;">empty</td><td style="text-align:center;">Can be filled in as needed, and the system will allocate memory based on the filled in values</td><td style="text-align:center;">Restarting the service takes effect</td></tr></tbody></table>',1),x=t("br",null,null,-1),b={href:"http://env.sh",target:"_blank",rel:"noopener noreferrer"},v=t("br",null,null,-1),_=t("strong",null,"Configuration",-1),k=t("strong",null,"Description",-1),D=t("strong",null,"Default",-1),C=t("strong",null,"Recommended value",-1),T=t("br",null,null,-1),w=t("br",null,null,-1),N=n(`<h4 id="system-general-configuration" tabindex="-1"><a class="header-anchor" href="#system-general-configuration"><span>System General Configuration</span></a></h4><p>Open the general configuration file (./conf/iotdb common. properties file) and set the following parameters:</p><table><thead><tr><th style="text-align:center;"><strong>Configuration</strong></th><th style="text-align:center;"><strong>Description</strong></th><th style="text-align:center;"><strong>Default</strong></th><th style="text-align:center;"><strong>Recommended value</strong></th><th style="text-align:center;">Note</th></tr></thead><tbody><tr><td style="text-align:center;">cluster_name</td><td style="text-align:center;">Cluster Name</td><td style="text-align:center;">defaultCluster</td><td style="text-align:center;">The cluster name can be set as needed, and if there are no special needs, the default can be kept</td><td style="text-align:center;">Cannot be modified after initial startup</td></tr><tr><td style="text-align:center;">schema_replication_factor</td><td style="text-align:center;">Number of metadata replicas, set to 1 for the standalone version here</td><td style="text-align:center;">1</td><td style="text-align:center;">1</td><td style="text-align:center;">Default 1, cannot be modified after the first startup</td></tr><tr><td style="text-align:center;">data_replication_factor</td><td style="text-align:center;">Number of data replicas, set to 1 for the standalone version here</td><td style="text-align:center;">1</td><td style="text-align:center;">1</td><td style="text-align:center;">Default 1, cannot be modified after the first startup</td></tr></tbody></table><h4 id="confignode-configuration" tabindex="-1"><a class="header-anchor" href="#confignode-configuration"><span>ConfigNode Configuration</span></a></h4><p>Open the ConfigNode configuration file (./conf/iotdb configure. properties file) and set the following parameters:</p><table><thead><tr><th style="text-align:center;"><strong>Configuration</strong></th><th style="text-align:center;"><strong>Description</strong></th><th style="text-align:center;"><strong>Default</strong></th><th style="text-align:center;"><strong>Recommended value</strong></th><th style="text-align:center;">Note</th></tr></thead><tbody><tr><td style="text-align:center;">cn_internal_address</td><td style="text-align:center;">The address used by ConfigNode for communication within the cluster</td><td style="text-align:center;">127.0.0.1</td><td style="text-align:center;">The IPV4 address or host name of the server where it is located, and it is recommended to use host name</td><td style="text-align:center;">Cannot be modified after initial startup</td></tr><tr><td style="text-align:center;">cn_internal_port</td><td style="text-align:center;">The port used by ConfigNode for communication within the cluster</td><td style="text-align:center;">10710</td><td style="text-align:center;">10710</td><td style="text-align:center;">Cannot be modified after initial startup</td></tr><tr><td style="text-align:center;">cn_consensus_port</td><td style="text-align:center;">The port used for ConfigNode replica group consensus protocol communication</td><td style="text-align:center;">10720</td><td style="text-align:center;">10720</td><td style="text-align:center;">Cannot be modified after initial startup</td></tr><tr><td style="text-align:center;">cn_seed_config_node</td><td style="text-align:center;">The address of the ConfigNode that the node connects to when registering to join the cluster, cn_internal_address:cn_internal_port</td><td style="text-align:center;">127.0.0.1:10710</td><td style="text-align:center;">cn_internal_address:cn_internal_port</td><td style="text-align:center;">Cannot be modified after initial startup</td></tr></tbody></table><h4 id="datanode-configuration" tabindex="-1"><a class="header-anchor" href="#datanode-configuration"><span>DataNode Configuration</span></a></h4><p>Open the DataNode configuration file/ conf/iotdb-system.properties Set the following parameters:</p><table><thead><tr><th style="text-align:left;"><strong>Configuration</strong></th><th style="text-align:left;"><strong>Description</strong></th><th style="text-align:left;"><strong>Default</strong></th><th style="text-align:left;"><strong>Recommended value</strong></th><th style="text-align:left;"><strong>Note</strong></th></tr></thead><tbody><tr><td style="text-align:left;">dn_rpc_address</td><td style="text-align:left;">The address of the client RPC service</td><td style="text-align:left;">0.0.0.0</td><td style="text-align:left;">The IPV4 address or host name of the server where it is located, and it is recommended to use host name</td><td style="text-align:left;">Restarting the service takes effect</td></tr><tr><td style="text-align:left;">dn_rpc_port</td><td style="text-align:left;">The port of the client RPC service</td><td style="text-align:left;">6667</td><td style="text-align:left;">6667</td><td style="text-align:left;">Restarting the service takes effect</td></tr><tr><td style="text-align:left;">dn_internal_address</td><td style="text-align:left;">The address used by DataNode for communication within the cluster</td><td style="text-align:left;">127.0.0.1</td><td style="text-align:left;">The IPV4 address or host name of the server where it is located, and it is recommended to use host name</td><td style="text-align:left;">Cannot be modified after initial startup</td></tr><tr><td style="text-align:left;">dn_internal_port</td><td style="text-align:left;">The port used by DataNode for communication within the cluster</td><td style="text-align:left;">10730</td><td style="text-align:left;">10730</td><td style="text-align:left;">Cannot be modified after initial startup</td></tr><tr><td style="text-align:left;">dn_mpp_data_exchange_port</td><td style="text-align:left;">The port used by DataNode to receive data streams</td><td style="text-align:left;">10740</td><td style="text-align:left;">10740</td><td style="text-align:left;">Cannot be modified after initial startup</td></tr><tr><td style="text-align:left;">dn_data_region_consensus_port</td><td style="text-align:left;">The port used by DataNode for data replica consensus protocol communication</td><td style="text-align:left;">10750</td><td style="text-align:left;">10750</td><td style="text-align:left;">Cannot be modified after initial startup</td></tr><tr><td style="text-align:left;">dn_schema_region_consensus_port</td><td style="text-align:left;">The port used by DataNode for metadata replica consensus protocol communication</td><td style="text-align:left;">10760</td><td style="text-align:left;">10760</td><td style="text-align:left;">Cannot be modified after initial startup</td></tr><tr><td style="text-align:left;">dn_seed_config_node</td><td style="text-align:left;">The ConfigNode address that the node connects to when registering to join the cluster, i.e. cn_internal-address: cn_internal_port</td><td style="text-align:left;">127.0.0.1:10710</td><td style="text-align:left;">cn_internal_address:cn_internal_port</td><td style="text-align:left;">Cannot be modified after initial startup</td></tr></tbody></table><h3 id="_3、start-confignode" tabindex="-1"><a class="header-anchor" href="#_3、start-confignode"><span>3、Start ConfigNode</span></a></h3><p>Enter the sbin directory of iotdb and start confignode</p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code>./start-confignode.sh <span class="token parameter variable">-d</span> <span class="token comment">#The &quot;- d&quot; parameter will start in the background </span>
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><h3 id="_4、activate-database" tabindex="-1"><a class="header-anchor" href="#_4、activate-database"><span>4、Activate Database</span></a></h3><h4 id="method-1-activate-file-copy-activation" tabindex="-1"><a class="header-anchor" href="#method-1-activate-file-copy-activation"><span>Method 1: Activate file copy activation</span></a></h4><ul><li>After starting the confignode node, enter the activation folder and copy the systeminfo file to the Timecho staff</li><li>Received the license file returned by the staff</li><li>Place the license file in the activation folder of the corresponding node;</li></ul><h4 id="method-2-activate-script-activation" tabindex="-1"><a class="header-anchor" href="#method-2-activate-script-activation"><span>Method 2: Activate Script Activation</span></a></h4><ul><li>Obtain the required machine code for activation, enter the sbin directory of the installation directory, and execute the activation script:</li></ul><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code> <span class="token builtin class-name">cd</span> sbin
./start-activate.sh
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div></div></div><ul><li>The following information is displayed. Please copy the machine code (i.e. the string of characters) to the Timecho staff:</li></ul><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code>Please copy the system_info&#39;s content and send it to Timecho:
<span class="token assign-left variable">Y17hFA0xRCE1TmkVxILuCIEPc7uJcr5bzlXWiptw8uZTmTX5aThfypQdLUIhMljw075hNRSicyvyJR9JM7QaNm1gcFZPHVRWVXIiY5IlZkXdxCVc1erXMsbCqUYsR2R2Mw4PSpFJsUF5jHWSoFIIjQ2bmJFW5P52KCccFMVeHTc</span><span class="token operator">=</span>
Please enter license:
</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></div><ul><li>Enter the activation code returned by the staff into the previous command line prompt &#39;Please enter license:&#39;, as shown below:</li></ul><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code>Please enter license:
Jw+MmF+AtexsfgNGOFgTm83Bxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxm6pF+APW1CiXLTSijK9Qh3nsLgzrW8OJPh26Vl6ljKUpCvpTiw<span class="token operator">==</span>
License has been stored to sbin/<span class="token punctuation">..</span>/activation/license
Import completed. Please start cluster and excute <span class="token string">&#39;show cluster&#39;</span> to verify activation status
</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></div><h3 id="_5、start-datanode" tabindex="-1"><a class="header-anchor" href="#_5、start-datanode"><span>5Start DataNode</span></a></h3><p>Enter the sbin directory of iotdb and start datanode:</p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code><span class="token builtin class-name">cd</span> sbin
./start-datanode.sh <span class="token parameter variable">-d</span> <span class="token comment"># The &quot;- d&quot; parameter will start in the background</span>
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div></div></div><h3 id="_6、verify-deployment" tabindex="-1"><a class="header-anchor" href="#_6、verify-deployment"><span>6Verify Deployment</span></a></h3><p>Can be executed directly/ Cli startup script in sbin directory:</p><div class="language-bash line-numbers-mode" data-ext="sh" data-title="sh"><pre class="language-bash"><code>./start-cli.sh <span class="token parameter variable">-h</span> ip<span class="token punctuation">(</span>local IP or domain name<span class="token punctuation">)</span> <span class="token parameter variable">-p</span> port<span class="token punctuation">(</span><span class="token number">6667</span><span class="token punctuation">)</span>
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div></div></div><p>After successful startup, the following interface will appear displaying successful installation of IOTDB.</p><figure><img src="https://alioss.timecho.com/docs/img/启动成功.png" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure><p>After the installation success interface appears, continue to check if the activation is successful and use the <code>show cluster</code>command</p><p>When you see the display &quot;Activated&quot; on the far right, it indicates successful activation</p><figure><img src="https://alioss.timecho.com/docs/img/show cluster.png" alt="" tabindex="0" loading="lazy"><figcaption></figcaption></figure>`,33);function A(I,S){const a=o("ExternalLinkIcon");return l(),r("div",null,[c,h,p,t("ol",null,[g,t("li",null,[t("p",null,[e("It is recommended to deploy a monitoring panel, which can monitor important operational indicators and keep track of database operation status at any time. The monitoring panel can be obtained by contacting the business department, and the steps for deploying the monitoring panel can be referred to"),t("a",u,[e("Monitoring Board Install and Deploy"),i(a)]),e("")])])]),m,t("ul",null,[t("li",null,[e("./conf/confignode "),t("a",f,[e("env.sh"),i(a)]),e(" (./conf/confignode env.bat) configuration")])]),y,t("ul",null,[t("li",null,[e("./conf/datanode-env.sh(./conf/datanode-env.batconfiguration"),x,t("a",b,[e("env.sh"),i(a)]),v,e(" | "),_,e(" | "),k,e(" | "),D,e(" | "),C,e(" | Note |"),T,e(" | :---------------: | :----------------------------------------------------------: | :---------: | :----------------------------------------------------------: | :---------------------------------: |"),w,e(" | MEMORY_SIZE | The total amount of memory that IoTDB DataNode nodes can use | empty | Can be filled in as needed, and the system will allocate memory based on the filled in values | Restarting the service takes effect |")])]),N])}const M=s(d,[["render",A],["__file","Stand-Alone-Deployment_timecho.html.vue"]]),E=JSON.parse('{"path":"/UserGuide/latest/Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.html","title":"Stand-Alone Deployment","lang":"en-US","frontmatter":{"description":"Stand-Alone Deployment This chapter will introduce how to start an IoTDB standalone instance, which includes 1 ConfigNode and 1 DataNode (commonly known as 1C1D). Matters Needin...","head":[["link",{"rel":"alternate","hreflang":"zh-cn","href":"https://iotdb.apache.org/zh/UserGuide/latest/Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.html"}],["meta",{"property":"og:url","content":"https://iotdb.apache.org/UserGuide/latest/Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.html"}],["meta",{"property":"og:site_name","content":"IoTDB Website"}],["meta",{"property":"og:title","content":"Stand-Alone Deployment"}],["meta",{"property":"og:description","content":"Stand-Alone Deployment This chapter will introduce how to start an IoTDB standalone instance, which includes 1 ConfigNode and 1 DataNode (commonly known as 1C1D). Matters Needin..."}],["meta",{"property":"og:type","content":"article"}],["meta",{"property":"og:image","content":"https://alioss.timecho.com/docs/img/%E5%90%AF%E5%8A%A8%E6%88%90%E5%8A%9F.png"}],["meta",{"property":"og:locale","content":"en-US"}],["meta",{"property":"og:locale:alternate","content":"zh-CN"}],["meta",{"property":"og:updated_time","content":"2024-07-31T03:30:33.000Z"}],["meta",{"property":"article:modified_time","content":"2024-07-31T03:30:33.000Z"}],["script",{"type":"application/ld+json"},"{\\"@context\\":\\"https://schema.org\\",\\"@type\\":\\"Article\\",\\"headline\\":\\"Stand-Alone Deployment\\",\\"image\\":[\\"https://alioss.timecho.com/docs/img/%E5%90%AF%E5%8A%A8%E6%88%90%E5%8A%9F.png\\",\\"https://alioss.timecho.com/docs/img/show%20cluster.png\\"],\\"dateModified\\":\\"2024-07-31T03:30:33.000Z\\",\\"author\\":[]}"]]},"headers":[{"level":2,"title":"Matters Needing Attention","slug":"matters-needing-attention","link":"#matters-needing-attention","children":[]},{"level":2,"title":"Installation Steps","slug":"installation-steps","link":"#installation-steps","children":[{"level":3,"title":"1、Unzip the installation package and enter the installation directory","slug":"_1、unzip-the-installation-package-and-enter-the-installation-directory","link":"#_1、unzip-the-installation-package-and-enter-the-installation-directory","children":[]},{"level":3,"title":"2、Parameter Configuration","slug":"_2、parameter-configuration","link":"#_2、parameter-configuration","children":[]},{"level":3,"title":"3、Start ConfigNode","slug":"_3、start-confignode","link":"#_3、start-confignode","children":[]},{"level":3,"title":"4、Activate Database","slug":"_4、activate-database","link":"#_4、activate-database","children":[]},{"level":3,"title":"5、Start DataNode","slug":"_5、start-datanode","link":"#_5、start-datanode","children":[]},{"level":3,"title":"6、Verify Deployment","slug":"_6、verify-deployment","link":"#_6、verify-deployment","children":[]}]}],"git":{"createdTime":1718979523000,"updatedTime":1722396633000,"contributors":[{"name":"majialin","email":"107627937+mal117@users.noreply.github.com","commits":2},{"name":"shuwenwei","email":"55970239+shuwenwei@users.noreply.github.com","commits":1}]},"readingTime":{"minutes":3.95,"words":1184},"filePathRelative":"UserGuide/latest/Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md","localizedDate":"June 21, 2024","autoDesc":true}');export{M as comp,E as data};