Skip to main content

...About 4 min

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 Needing Attention

  1. It is recommended to prioritize using 'hostname' 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's host name and configure IoTDB's' cn_internal-address' using the host name dn_internal_address、dn_rpc_address。

    echo "192.168.1.3  iotdb-1" >> /etc/hosts 
    
  2. Some parameters cannot be modified after the first startup. Please refer to the "Parameter Configuration" section below for settings

  3. 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:Monitoring Board Install and Deployopen in new window

Installation Steps

1、Unzip the installation package and enter the installation directory

unzip  iotdb-enterprise-{version}-bin.zip
cd  iotdb-enterprise-{version}-bin

2、Parameter Configuration

Environment Script Configuration

ConfigurationDescriptionDefaultRecommended valueNote
MEMORY_SIZEThe total amount of memory that IoTDB ConfigNode nodes can useemptyCan be filled in as needed, and the system will allocate memory based on the filled in valuesRestarting the service takes effect
  • ./conf/datanode-env.sh(./conf/datanode-env.bat)configuration
    env.shopen in new window
    | Configuration | Description | Default | Recommended value | Note |
    | :---------------: | :----------------------------------------------------------: | :---------: | :----------------------------------------------------------: | :---------------------------------: |
    | 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 |

System General Configuration

Open the general configuration file (./conf/iotdb common. properties file) and set the following parameters:

ConfigurationDescriptionDefaultRecommended valueNote
cluster_nameCluster NamedefaultClusterThe cluster name can be set as needed, and if there are no special needs, the default can be keptCannot be modified after initial startup
schema_replication_factorNumber of metadata replicas, set to 1 for the standalone version here11Default 1, cannot be modified after the first startup
data_replication_factorNumber of data replicas, set to 1 for the standalone version here11Default 1, cannot be modified after the first startup

ConfigNode Configuration

Open the ConfigNode configuration file (./conf/iotdb configure. properties file) and set the following parameters:

ConfigurationDescriptionDefaultRecommended valueNote
cn_internal_addressThe address used by ConfigNode for communication within the cluster127.0.0.1The IPV4 address or host name of the server where it is located, and it is recommended to use host nameCannot be modified after initial startup
cn_internal_portThe port used by ConfigNode for communication within the cluster1071010710Cannot be modified after initial startup
cn_consensus_portThe port used for ConfigNode replica group consensus protocol communication1072010720Cannot be modified after initial startup
cn_seed_config_nodeThe address of the ConfigNode that the node connects to when registering to join the cluster, cn_internal_address:cn_internal_port127.0.0.1:10710cn_internal_address:cn_internal_portCannot be modified after initial startup

DataNode Configuration

Open the DataNode configuration file/ conf/iotdb-datanode.properties, Set the following parameters:

ConfigurationDescriptionDefaultRecommended valueNote
dn_rpc_addressThe address of the client RPC service0.0.0.0The IPV4 address or host name of the server where it is located, and it is recommended to use host nameRestarting the service takes effect
dn_rpc_portThe port of the client RPC service66676667Restarting the service takes effect
dn_internal_addressThe address used by DataNode for communication within the cluster127.0.0.1The IPV4 address or host name of the server where it is located, and it is recommended to use host nameCannot be modified after initial startup
dn_internal_portThe port used by DataNode for communication within the cluster1073010730Cannot be modified after initial startup
dn_mpp_data_exchange_portThe port used by DataNode to receive data streams1074010740Cannot be modified after initial startup
dn_data_region_consensus_portThe port used by DataNode for data replica consensus protocol communication1075010750Cannot be modified after initial startup
dn_schema_region_consensus_portThe port used by DataNode for metadata replica consensus protocol communication1076010760Cannot be modified after initial startup
dn_seed_config_nodeThe ConfigNode address that the node connects to when registering to join the cluster, i.e. cn_internal-address: cn_internal_port127.0.0.1:10710cn_internal_address:cn_internal_portCannot be modified after initial startup

3、Start ConfigNode

Enter the sbin directory of iotdb and start confignode

./start-confignode.sh    -d      #The "- d" parameter will start in the background 

4、Activate Database

Method 1: Activate file copy activation

  • After starting the confignode node, enter the activation folder and copy the systeminfo file to the Timecho staff
  • Received the license file returned by the staff
  • Place the license file in the activation folder of the corresponding node;

Method 2: Activate Script Activation

  • Obtain the required machine code for activation, enter the sbin directory of the installation directory, and execute the activation script:
 cd sbin
./start-activate.sh
  • The following information is displayed. Please copy the machine code (i.e. the string of characters) to the Timecho staff:
Please copy the system_info's content and send it to Timecho:
Y17hFA0xRCE1TmkVxILuCIEPc7uJcr5bzlXWiptw8uZTmTX5aThfypQdLUIhMljw075hNRSicyvyJR9JM7QaNm1gcFZPHVRWVXIiY5IlZkXdxCVc1erXMsbCqUYsR2R2Mw4PSpFJsUF5jHWSoFIIjQ2bmJFW5P52KCccFMVeHTc=
Please enter license:
  • Enter the activation code returned by the staff into the previous command line prompt 'Please enter license:', as shown below:
Please enter license:
Jw+MmF+AtexsfgNGOFgTm83Bxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxm6pF+APW1CiXLTSijK9Qh3nsLgzrW8OJPh26Vl6ljKUpCvpTiw==
License has been stored to sbin/../activation/license
Import completed. Please start cluster and excute 'show cluster' to verify activation status

5、Start DataNode

Enter the sbin directory of iotdb and start datanode:

cd sbin
./start-datanode.sh   -d   # The "- d" parameter will start in the background

6、Verify Deployment

Can be executed directly/ Cli startup script in sbin directory:

./start-cli.sh  -h  ip(local IP or domain name)  -p  port(6667)

After successful startup, the following interface will appear displaying successful installation of IOTDB.

After the installation success interface appears, continue to check if the activation is successful and use the show clustercommand

When you see the display "Activated" on the far right, it indicates successful activation

Copyright © 2024 The Apache Software Foundation.
Apache IoTDB, IoTDB, Apache, the Apache feather logo, and the Apache IoTDB project logo are either registered trademarks or trademarks of The Apache Software Foundation in all countries

Have a question? Connect with us on QQ, WeChat, or Slack. Join the community now.