-
Before installation, ensure that the system is complete by referring to System configuration.
-
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
-
Some parameters cannot be modified after the first startup. Please refer to the "Parameter Configuration" section below for settings.
-
Whether in linux or windows, ensure that the IoTDB installation path does not contain Spaces and Chinese characters to avoid software exceptions.
-
Please note that when installing and deploying IoTDB, it is necessary to use the same user for operations. You can:
- Using root user (recommended): Using root user can avoid issues such as permissions.
- Using a fixed non root user:
- Using the same user operation: Ensure that the same user is used for start, stop and other operations, and do not switch users.
- Avoid using sudo: Try to avoid using sudo commands as they execute commands with root privileges, which may cause confusion or security issues.
- Before installation, the health check tool can help inspect the operating environment of IoTDB nodes and obtain detailed inspection results. The usage method of the IoTDB health check tool can be found in:Health Check Tool.
To ensure the IoTDB installation package you obtained is complete and valid, we recommend performing an SHA512 verification before proceeding with the installation and deployment.
- Obtain the officially released SHA512 checksum: Visit the Release Versions page on the IoTDB open-source official website to get it.
- Open the terminal and navigate to the directory where the installation package is stored (e.g., /data/iotdb):
cd /data/iotdb - Execute the following command to calculate the hash value:
sha512sum apache-iotdb-{version}-all-bin.zip - The terminal will output a result (the left part is the SHA512 checksum, and the right part is the file name):
- Compare the output result with the official SHA512 checksum. Once confirmed that they match, you can proceed with the installation and deployment of IoTDB as per the procedures below.
- If the verification results do not match, please re-obtain the installation package.
- If a "file not found" prompt appears during verification, check whether the file path is correct or if the installation package has been fully downloaded.
unzip apache-iotdb-{version}-all-bin.zip
cd apache-iotdb-{version}-all-bin- ./conf/confignode-env.sh (./conf/confignode-env.bat) configuration
| Configuration | Description | Default | Recommended value | Note |
|---|---|---|---|---|
| MEMORY_SIZE | The total amount of memory that IoTDB ConfigNode nodes can use | empty | Can be filled in as needed, and the system will allocate memory based on the filled in values | Save changes without immediate execution; modifications take effect after service restart. |
- ./conf/datanode-env.sh (./conf/datanode-env.bat) configuration
| 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 | Save changes without immediate execution; modifications take effect after service restart. |
Open the general configuration file (./conf/iotdb-system. properties file) and set the following parameters:
| Configuration | Description | Default | Recommended value | Note |
|---|---|---|---|---|
| cluster_name | Cluster Name | defaultCluster | The cluster name can be set as needed, and if there are no special needs, the default can be kept | Support hot loading, but it is not recommended to change the cluster name by manually modifying the configuration file |
| schema_replication_factor | Number of metadata replicas, set to 1 for the standalone version here | 1 | 1 | Default 1, cannot be modified after the first startup |
| data_replication_factor | Number of data replicas, set to 1 for the standalone version here | 1 | 1 | Default 1, cannot be modified after the first startup |
Open the ConfigNode configuration file (./conf/iotdb-system. properties file) and set the following parameters:
| Configuration | Description | Default | Recommended value | Note |
|---|---|---|---|---|
| cn_internal_address | The address used by ConfigNode for communication within the cluster | 127.0.0.1 | The IPV4 address or host name of the server where it is located, and it is recommended to use host name | Cannot be modified after initial startup |
| cn_internal_port | The port used by ConfigNode for communication within the cluster | 10710 | 10710 | Cannot be modified after initial startup |
| cn_consensus_port | The port used for ConfigNode replica group consensus protocol communication | 10720 | 10720 | Cannot be modified after initial startup |
| cn_seed_config_node | The address of the ConfigNode that the node connects to when registering to join the cluster, cn_internal_address:cn_internal_port | 127.0.0.1:10710 | cn_internal_address:cn_internal_port | Cannot be modified after initial startup |
Open the DataNode configuration file (./conf/iotdb-system. properties file) and set the following parameters:
| Configuration | Description | Default | Recommended value | Note |
|---|---|---|---|---|
| dn_rpc_address | The address of the client RPC service | 127.0.0.1 | By default, the local machine can directly access it. For non-local access, please modify this configuration item to the IPv4 address or hostname of the server where it is located. It is recommended to use the IPv4 address of the server where it is located. | Restarting the service takes effect |
| dn_rpc_port | The port of the client RPC service | 6667 | 6667 | Restarting the service takes effect |
| dn_internal_address | The address used by DataNode for communication within the cluster | 127.0.0.1 | The IPV4 address or host name of the server where it is located, and it is recommended to use host name | Cannot be modified after initial startup |
| dn_internal_port | The port used by DataNode for communication within the cluster | 10730 | 10730 | Cannot be modified after initial startup |
| dn_mpp_data_exchange_port | The port used by DataNode to receive data streams | 10740 | 10740 | Cannot be modified after initial startup |
| dn_data_region_consensus_port | The port used by DataNode for data replica consensus protocol communication | 10750 | 10750 | Cannot be modified after initial startup |
| dn_schema_region_consensus_port | The port used by DataNode for metadata replica consensus protocol communication | 10760 | 10760 | Cannot be modified after initial startup |
| dn_seed_config_node | The ConfigNode address that the node connects to when registering to join the cluster, i.e. cn_internal-address: cn_internal_port | 127.0.0.1:10710 | cn_internal_address:cn_internal_port | Cannot be modified after initial startup |
❗️Attention: Editors such as VSCode Remote do not have automatic configuration saving function. Please ensure that the modified files are saved persistently, otherwise the configuration items will not take effect
Enter the sbin directory of iotdb and start confignode
./start-confignode.sh -d #The "- d" parameter will start in the background If the startup fails, please refer to Common Questions.
Enter the sbin directory of iotdb and start datanode:
cd sbin
./start-datanode.sh -d #The "- d" parameter will start in the background 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 successful installation interface appears, use the show cluster command to check the service running status
When the status is all running, it indicates that the service has started successfully
The appearance of 'Activated (W)' indicates passive activation, indicating that this Config Node does not have a license file (or has not issued the latest license file with a timestamp). At this point, it is recommended to check if the license file has been placed in the license folder. If not, please place the license file. If a license file already exists, it may be due to inconsistency between the license file of this node and the information of other nodes. Please contact Timecho staff to reapply.
-
Confignode failed to start
Step 1: Please check the startup log to see if any parameters that cannot be changed after the first startup have been modified.
Step 2: Please check the startup log for any other abnormalities. If there are any abnormal phenomena in the log, please contact Timecho Technical Support personnel for consultation on solutions.
Step 3: If it is the first deployment or data can be deleted, you can also clean up the environment according to the following steps, redeploy, and restart.
Step 4: Clean up the environment:
a. Terminate all ConfigNode Node and DataNode processes.
# 1. Stop the ConfigNode and DataNode services sbin/stop-standalone.sh # 2. Check for any remaining processes jps # Or ps -ef|grep iotdb # 3. If there are any remaining processes, manually kill the kill -9 <pid> # If you are sure there is only one iotdb on the machine, you can use the following command to clean up residual processes ps -ef|grep iotdb|grep -v grep|tr -s ' ' ' ' |cut -d ' ' -f2|xargs kill -9
b. Delete the data and logs directories.
Explanation: Deleting the data directory is necessary, deleting the logs directory is for clean logs and is not mandatory.
cd /data/iotdb rm -rf data logs