From 8eafbdace6626bbb7b8cb2e842c72464d5c716a5 Mon Sep 17 00:00:00 2001 From: Jialin Ma <281648921@qq.com> Date: Tue, 14 Jan 2025 12:18:14 +0800 Subject: [PATCH] Modify the English documentation for both standalone and cluster versions --- .../Cluster-Deployment_timecho.md | 462 ++++++++++-------- .../Stand-Alone-Deployment_timecho.md | 288 ++++++----- .../Cluster-Deployment_timecho.md | 462 ++++++++++-------- .../Stand-Alone-Deployment_timecho.md | 288 ++++++----- 4 files changed, 812 insertions(+), 688 deletions(-) diff --git a/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md b/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md index 08579e8a7..cf9658ff9 100644 --- a/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md +++ b/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md @@ -20,239 +20,244 @@ --> # Cluster Deployment -This section describes how to manually deploy an instance that includes 3 ConfigNodes and 3 DataNodes, commonly known as a 3C3D cluster. +This guide describes how to manually deploy a cluster instance consisting of 3 ConfigNodes and 3 DataNodes (commonly referred to as a 3C3D cluster).
-## Note -1. Before installation, ensure that the system is complete by referring to [System configuration](./Environment-Requirements.md) -2. 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 the `cn_internal_address` and `dn_internal_address` of IoTDB using the host name. +## Prerequisites + +1. [System configuration](./Environment-Requirements.md):Ensure the system has been configured according to the preparation guidelines. + +2. **IP Configuration**: It is recommended to use hostnames for IP configuration to prevent issues caused by IP address changes. Configure the `/etc/hosts` file on each server. For example, if the local IP is `11.101.17.224` and the hostname is `iotdb-1`, use the following command to set the hostname: + ``` shell echo "192.168.1.3 iotdb-1" >> /etc/hosts ``` -3. Some parameters cannot be modified after the first startup. Please refer to the "Parameter Configuration" section below for settings. + Use the hostname for `cn_internal_address` and `dn_internal_address` in IoTDB configuration. + +3. **Unmodifiable Parameters**: Some parameters cannot be changed after the first startup. Refer to the Parameter Configuration section. + +4. **Installation Path**: Ensure the installation path contains no spaces or non-ASCII characters to prevent runtime issues. -4. Whether in linux or windows, ensure that the IoTDB installation path does not contain Spaces and Chinese characters to avoid software exceptions. +5. **User Permissions**: Choose one of the following permissions during installation and deployment: -5. Please note that when installing and deploying IoTDB (including activating and using software), 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, activation, 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. + - **Root User (Recommended)**: This avoids permission-related issues. + - **Non-Root User**: + - Use the same user for all operations, including starting, activating, and stopping services. + - Avoid using `sudo`, which can cause permission conflicts. -6. 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,The steps for deploying a monitoring panel can refer to:[Monitoring Panel Deployment](./Monitoring-panel-deployment.md) +6. **Monitoring Panel**: Deploy a monitoring panel to track key performance metrics. Contact the Timecho team for access and refer to the "[Monitoring Panel Deployment](./Monitoring-panel-deployment.md)" guide. -## Preparation Steps +## Preparation -1. Prepare the IoTDB database installation package: iotdb enterprise- {version}-bin.zip（The installation package can be obtained from:[IoTDB-Package](../Deployment-and-Maintenance/IoTDB-Package_timecho.md)） -2. Configure the operating system environment according to environmental requirements（The system environment configuration can be found in:[Environment Requirement](https://www.timecho.com/docs/UserGuide/latest/Deployment-and-Maintenance/Environment-Requirements.html)） +1. Obtain the TimechoDB installation package: `timechodb-{version}-bin.zip` following[IoTDB-Package](../Deployment-and-Maintenance/IoTDB-Package_timecho.md) +2. Configure the operating system environment according to [Environment Requirement](./Environment-Requirements.md) ## Installation Steps -Assuming there are three Linux servers now, the IP addresses and service roles are assigned as follows: +Taking a cluster with three Linux servers with the following information as example: -| Node IP | Host Name | Service | -| ----------- | --------- | -------------------- | -| 192.168.1.3 | iotdb-1 | ConfigNode、DataNode | -| 192.168.1.4 | iotdb-2 | ConfigNode、DataNode | -| 192.168.1.5 | iotdb-3 | ConfigNode、DataNode | +| Node IP | Host Name | Service | +| ------------- | --------- | -------------------- | +| 11.101.17.224 | iotdb-1 | ConfigNode、DataNode | +| 11.101.17.225 | iotdb-2 | ConfigNode、DataNode | +| 11.101.17.226 | iotdb-3 | ConfigNode、DataNode | -### Set Host Name +### 1.Configure Hostnames -On three machines, configure the host names separately. To set the host names, configure `/etc/hosts` on the target server. Use the following command: +On all three servers, configure the hostnames by editing the `/etc/hosts` file. Use the following commands: ```Bash -echo "192.168.1.3 iotdb-1" >> /etc/hosts -echo "192.168.1.4 iotdb-2" >> /etc/hosts -echo "192.168.1.5 iotdb-3" >> /etc/hosts +echo "11.101.17.224 iotdb-1" >> /etc/hosts +echo "11.101.17.225 iotdb-2" >> /etc/hosts +echo "11.101.17.226 iotdb-3" >> /etc/hosts ``` -### Configuration +### 2. Extract Installation Package -Unzip the installation package and enter the installation directory +Unzip the installation package and enter the installation directory: ```Plain -unzip iotdb-enterprise-{version}-bin.zip -cd iotdb-enterprise-{version}-bin +unzip timechodb-{version}-bin.zip +cd timechodb-{version}-bin ``` -#### Environment script configuration +### 3. Parameters Configuration -- `./conf/confignode-env.sh` configuration +- #### Memory Configuration - | **Configuration** | **Description** | **Default** | **Recommended value** | **Note** | - | :---------------- | :----------------------------------------------------------- | :---------- | :----------------------------------------------------------- | :---------------------------------- | - | MEMORY_SIZE | The total amount of memory that IoTDB ConfigNode nodes can use | - | Can be filled in as needed, and the system will allocate memory based on the filled in values | Restarting the service takes effect | + Edit the following files for memory allocation: -- `./conf/datanode-env.sh` configuration + - **ConfigNode**: `./conf/confignode-env.sh` (or `.bat` for Windows) + - **DataNode**: `./conf/datanode-env.sh` (or `.bat` for Windows) - | **Configuration** | **Description** | **Default** | **Recommended value** | **Note** | - | :---------------- | :----------------------------------------------------------- | :---------- | :----------------------------------------------------------- | :---------------------------------- | - | MEMORY_SIZE | The total amount of memory that IoTDB DataNode nodes can use | - | Can be filled in as needed, and the system will allocate memory based on the filled in values | Restarting the service takes effect | + | **Parameter** | **Description** | **Default** | **Recommended** | **Notes** | + | :------------ | :--------------------------------- | :---------- | :-------------- | :-------------------------------------- | + | MEMORY_SIZE | Total memory allocated to the node | Empty | As needed | Effective after restarting the service. | -#### General Configuration +**General Configuration** -Open the general configuration file `./conf/iotdb-system.properties`,The following parameters can be set according to the deployment method: +Set the following parameters in `./conf/iotdb-system.properties`. Refer to `./conf/iotdb-system.properties.template` for a complete list. -| **Configuration** | **Description** | 192.168.1.3 | 192.168.1.4 | 192.168.1.5 | -| ------------------------- | ------------------------------------------------------------ | -------------- | -------------- | -------------- | -| cluster_name | Cluster Name | defaultCluster | defaultCluster | defaultCluster | -| schema_replication_factor | The number of metadata replicas, the number of DataNodes should not be less than this number | 3 | 3 | 3 | -| data_replication_factor | The number of data replicas should not be less than this number of DataNodes | 2 | 2 | 2 | +**Cluster-Level Parameters**: -#### ConfigNode Configuration +| **Parameter** | **Description** | **11.101.17.224** | **11.101.17.225** | **11.101.17.226** | +| :------------------------ | :----------------------------------------------------------- | :---------------- | :---------------- | :---------------- | +| cluster_name | Name of the cluster | defaultCluster | defaultCluster | defaultCluster | +| schema_replication_factor | Metadata replication factor; DataNode count shall not be fewer than this value | 3 | 3 | 3 | +| data_replication_factor | Data replication factor; DataNode count shall not be fewer than this value | 2 | 2 | 2 | -Open the ConfigNode configuration file `./conf/iotdb-system.properties`,Set the following parameters +#### ConfigNode Parameters -| **Configuration** | **Description** | **Default** | **Recommended value** | 192.168.1.3 | 192.168.1.4 | 192.168.1.5 | 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 | iotdb-1 | iotdb-2 | iotdb-3 | Cannot be modified after initial startup | -| cn_internal_port | The port used by ConfigNode for communication within the cluster | 10710 | 10710 | 10710 | 10710 | 10710 | Cannot be modified after initial startup | -| cn_consensus_port | The port used for ConfigNode replica group consensus protocol communication | 10720 | 10720 | 10720 | 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 | The first CongfigNode's `cn_internal-address: cn_internal_port` | iotdb-1:10710 | iotdb-1:10710 | iotdb-1:10710 | Cannot be modified after initial startup | +| **Parameter** | **Description** | **Default** | **Recommended** | **11.101.17.224** | **11.101.17.225** | **11.101.17.226** | **Notes** | +| :------------------ | :----------------------------------------------------------- | :-------------- | :----------------------------------------------------------- | :---------------- | :---------------- | :---------------- | :--------------------------------------------------------- | +| cn_internal_address | Address used for internal communication within the cluster | 127.0.0.1 | Server's IPv4 address or hostname. Use hostname to avoid issues when the IP changes. | iotdb-1 | iotdb-2 | iotdb-3 | This parameter cannot be modified after the first startup. | +| cn_internal_port | Port used for internal communication within the cluster | 10710 | 10710 | 10710 | 10710 | 10710 | This parameter cannot be modified after the first startup. | +| cn_consensus_port | Port used for consensus protocol communication among ConfigNode replicas | 10720 | 10720 | 10720 | 10720 | 10720 | This parameter cannot be modified after the first startup. | +| cn_seed_config_node | Address of the ConfigNode for registering and joining the cluster. (e.g.,`cn_internal_address:cn_internal_port`) | 127.0.0.1:10710 | Address and port of the seed ConfigNode (e.g., `cn_internal_address:cn_internal_port`) | iotdb-1:10710 | iotdb-1:10710 | iotdb-1:10710 | This parameter cannot be modified after the first startup. | -#### DataNode Configuration +#### DataNode Parameters -Open DataNode Configuration File `./conf/iotdb-system.properties`,Set the following parameters: +| **Parameter** | **Description** | **Default** | **Recommended** | **11.101.17.224** | **11.101.17.225** | **11.101.17.226** | **Notes** | +| :------------------------------ | :----------------------------------------------------------- | :-------------- | :----------------------------------------------------------- | :---------------- | :---------------- | :---------------- | :--------------------------------------------------------- | +| dn_rpc_address | Address for the client RPC service | 0.0.0.0 | 0.0.0.0 | 0.0.0.0 | 0.0.0.0 | 0.0.0.0 | Effective after restarting the service. | +| dn_rpc_port | Port for the client RPC service | 6667 | 6667 | 6667 | 6667 | 6667 | Effective after restarting the service. | +| dn_internal_address | Address used for internal communication within the cluster | 127.0.0.1 | Server's IPv4 address or hostname. Use hostname to avoid issues when the IP changes. | iotdb-1 | iotdb-2 | iotdb-3 | This parameter cannot be modified after the first startup. | +| dn_internal_port | Port used for internal communication within the cluster | 10730 | 10730 | 10730 | 10730 | 10730 | This parameter cannot be modified after the first startup. | +| dn_mpp_data_exchange_port | Port used for receiving data streams | 10740 | 10740 | 10740 | 10740 | 10740 | This parameter cannot be modified after the first startup. | +| dn_data_region_consensus_port | Port used for data replica consensus protocol communication | 10750 | 10750 | 10750 | 10750 | 10750 | This parameter cannot be modified after the first startup. | +| dn_schema_region_consensus_port | Port used for metadata replica consensus protocol communication | 10760 | 10760 | 10760 | 10760 | 10760 | This parameter cannot be modified after the first startup. | +| dn_seed_config_node | Address of the ConfigNode for registering and joining the cluster.(e.g.,`cn_internal_address:cn_internal_port`) | 127.0.0.1:10710 | Address of the first ConfigNode | iotdb-1:10710 | iotdb-1:10710 | iotdb-1:10710 | This parameter cannot be modified after the first startup. | -| **Configuration** | **Description** | **Default** | **Recommended value** | 192.168.1.3 | 192.168.1.4 | 192.168.1.5 | Note | -| ------------------------------- | ------------------------------------------------------------ | --------------- | ------------------------------------------------------------ | ------------- | ------------- | ------------- | ---------------------------------------- | -| dn_rpc_address | The address of the client RPC service | 127.0.0.1 | Recommend using the **IPV4 address or hostname** of the server where it is located | iotdb-1 |iotdb-2 | iotdb-3 | Restarting the service takes effect | -| dn_rpc_port | The port of the client RPC service | 6667 | 6667 | 6667 | 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 | iotdb-1 | iotdb-2 | iotdb-3 | Cannot be modified after initial startup | -| dn_internal_port | The port used by DataNode for communication within the cluster | 10730 | 10730 | 10730 | 10730 | 10730 | Cannot be modified after initial startup | -| dn_mpp_data_exchange_port | The port used by DataNode to receive data streams | 10740 | 10740 | 10740 | 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 | 10750 | 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 | 10760 | 10760 | 10760 | Cannot be modified after initial startup | -| dn_seed_config_node | The address of the ConfigNode that the node connects to when registering to join the cluster, i.e. `cn_internal-address: cn_internal_port` | 127.0.0.1:10710 | The first CongfigNode's cn_internal-address: cn_internal_port | iotdb-1:10710 | iotdb-1:10710 | iotdb-1:10710 | Cannot be modified after initial startup | +**Note:** Ensure files are saved after editing. Tools like VSCode Remote do not save changes automatically. -> ❗️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 +### 4. Start ConfigNode Instances -### Start ConfigNode - -Start the first confignode of IoTDB-1 first, ensuring that the seed confignode node starts first, and then start the second and third confignode nodes in sequence +1. Start the first ConfigNode (`iotdb-1`) as the seed node ```Bash cd sbin ./start-confignode.sh -d #"- d" parameter will start in the background ``` -If the startup fails, please refer to [Common Questions](#common-questions). +2. Start the remaining ConfigNodes (`iotdb-2` and `iotdb-3`) in sequence. + If the startup fails, refer to the [Common Questions](#common-questions) section below for troubleshooting. -### Activate Database +### 5.Start DataNode Instances -#### Method 1: Activate file copy activation +On each server, navigate to the `sbin` directory and start the DataNode: -- After starting three confignode nodes in sequence, copy the `activation` folder of each machine and the `system_info` file of each machine to the Timecho staff; -- The staff will return the license files for each ConfigNode node, where 3 license files will be returned; -- Put the three license files into the `activation` folder of the corresponding ConfigNode node; +```Go +cd sbin +./start-datanode.sh -d #"- d" parameter will start in the background +``` -#### Method 2: Activate Script Activation +### 6.Activate Database -- Obtain the machine codes of three machines in sequence, enter the `sbin` directory of the installation directory, and execute the activation script `start activate.sh`: +#### Option 1: File-Based Activation - ```Bash - cd sbin - ./start-activate.sh - ``` +1. Start all ConfigNodes and DataNodes. +2. Copy the `system_info` file from the `activation` directory on each server and send them to the Timecho team. +3. Place the license files provided by the Timecho team into the corresponding `activation` folder for each node. -- The following information is displayed, where the machine code of one machine is displayed: +#### Option 2: Command-Based Activation - ```Bash - Please copy the system_info's content and send it to Timecho: - 01-KU5LDFFN-PNBEHDRH - Please enter license: - ``` +1. Enter the IoTDB CLI for each node: -- The other two nodes execute the activation script `start activate.sh` in sequence, and then copy the machine codes of the three machines obtained to the Timecho staff -- The staff will return 3 activation codes, which normally correspond to the order of the provided 3 machine codes. Please paste each activation code into the previous command line prompt `Please enter license:`, as shown below: +- **For Table Model**: - ```Bash - Please enter license: - Jw+MmF+Atxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx5bAOXNeob5l+HO5fEMgzrW8OJPh26Vl6ljKUpCvpTiw== - License has been stored to sbin/../activation/license - Import completed. Please start cluster and excute 'show cluster' to verify activation status - ``` + ```SQL + # For Linux or macOS + ./start-cli.sh -sql_dialect table + + # For Windows + ./start-cli.bat -sql_dialect table + ``` -### Start DataNode +- **For Tree Model**: - Enter the `sbin` directory of iotdb and start three datanode nodes in sequence: + ```SQL + # For Linux or macOS + ./start-cli.sh + + # For Windows + ./start-cli.bat + ``` -```Bash -cd sbin -./start-datanode.sh -d #"- d" parameter will start in the background -``` +2. Run the following command to retrieve the machine code required for activation: -### Verify Deployment + ```Bash + show system info + ``` -Can be executed directly Cli startup script in `./sbin` directory: + **Note**: Activation is currently supported only in the Tree Model. -```Plain -./start-cli.sh -h ip(local IP or domain name) -p port(6667) -``` +3. Copy the returned machine code of each server (displayed as a green string) and send it to the Timecho team: - After successful startup, the following interface will appear displaying successful installation of IOTDB. + ```Bash + +--------------------------------------------------------------+ + | SystemInfo| + +--------------------------------------------------------------+ + |01-TE5NLES4-UDDWCMYE,01-GG5NLES4-XXDWCMYE,01-FF5NLES4-WWWWCMYE| + +--------------------------------------------------------------+ + Total line number = 1 + It costs 0.030s + ``` + +4. Enter the activation codes provided by the Timecho team in the CLI in sequence using the following format. Wrap the activation code in single quotes ('): + + ```Bash + IoTDB> activate '01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOMN7-NB2E4BHI-7ZKGFVK6-GCIFXA4T-UG3XJTTD-SHJV6F2P-Q27B4OMJ-R47ZDIM3-UUASUXG2-OQXGVZCO-MMYKICZU-TWFQYYAO-ZOAGOKJA-NYHQTA5U-EWAR4EP5-MRC6R2CI-PKUTKRCT-7UDGRH3F-7BYV4P5D-6KKIA===,01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOMN7-NB2E4BHI-7ZKGFVK6-GCIFXA4T-UG3XJTTD-SHJV6F2P-Q27B4OMJ-R47ZDIM3-UUASUXG2-OQXGVZCO-MMYKICZU-TWFQYYAO-ZOAGOKJA-NYHQTA5U-EWAR4EP5-MRC6R2CI-PKUTKRCT-7UDGRH3F-7BYV4P5D-6KKIA===,01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOMN7-NB2E4BHI-7ZKGFVK6-GCIFXA4T-UG3XJTTD-SHJV6F2P-Q27B4OMJ-R47ZDIM3-UUASUXG2-OQXGVZCO-MMYKICZU-TWFQYYAO-ZOAGOKJA-NYHQTA5U-EWAR4EP5-MRC6R2CI-PKUTKRCT-7UDGRH3F-7BYV4P5D-6KKIA===' + ``` -![](https://alioss.timecho.com/docs/img/%E4%BC%81%E4%B8%9A%E7%89%88%E6%88%90%E5%8A%9F.png) +### 7.Verify Activation -After the installation success interface appears, continue to check if the activation is successful and use the `show cluster` command. +Check the `ClusterActivationStatus` field. If it shows `ACTIVATED`, the database has been successfully activated. -When you see the display of `Activated` on the far right, it indicates successful activation. +![](https://alioss.timecho.com/docs/img/%E9%9B%86%E7%BE%A4-%E9%AA%8C%E8%AF%81.png) -![](https://alioss.timecho.com/docs/img/%E4%BC%81%E4%B8%9A%E7%89%88%E6%BF%80%E6%B4%BB.png) +## Maintenance -> The appearance of `ACTIVATED (W)` indicates passive activation, which means that this Configurable Node does not have a license file (or has not issued the latest license file with a timestamp), and its activation depends on other Activated Configurable Nodes in the cluster. 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 Maintenance -## Node Maintenance Steps +ConfigNode maintenance includes adding and removing ConfigNodes. Common use cases include: -### ConfigNode Node Maintenance +- **Cluster Expansion:** If the cluster contains only 1 ConfigNode, adding 2 more ConfigNodes enhances high availability, resulting in a total of 3 ConfigNodes. +- **Cluster Fault Recovery:** If a ConfigNode's machine fails and it cannot function normally, remove the faulty ConfigNode and add a new one to the cluster. -ConfigNode node maintenance is divided into two types of operations: adding and removing ConfigNodes, with two common use cases: -- Cluster expansion: For example, when there is only one ConfigNode in the cluster, and you want to increase the high availability of ConfigNode nodes, you can add two ConfigNodes, making a total of three ConfigNodes in the cluster. -- Cluster failure recovery: When the machine where a ConfigNode is located fails, making the ConfigNode unable to run normally, you can remove this ConfigNode and then add a new ConfigNode to the cluster. +**Note:** After completing ConfigNode maintenance, ensure that the cluster contains either 1 or 3 active ConfigNodes. Two ConfigNodes do not provide high availability, and more than three ConfigNodes can degrade performance. -> ❗️Note, after completing ConfigNode node maintenance, you need to ensure that there are 1 or 3 ConfigNodes running normally in the cluster. Two ConfigNodes do not have high availability, and more than three ConfigNodes will lead to performance loss. +#### Adding a ConfigNode -#### Adding ConfigNode Nodes +**Linux /** **MacOS**: -Script command: -```shell -# Linux / MacOS -# First switch to the IoTDB root directory +```Plain sbin/start-confignode.sh +``` + +**Windows:** -# Windows -# First switch to the IoTDB root directory +```Plain sbin/start-confignode.bat ``` -Parameter introduction: +#### Removing a ConfigNode -| Parameter | Description | Is it required | -| :--- | :--------------------------------------------- | :----------- | -| -v | Show version information | No | -| -f | Run the script in the foreground, do not put it in the background | No | -| -d | Start in daemon mode, i.e. run in the background | No | -| -p | Specify a file to store the process ID for process management | No | -| -c | Specify the path to the configuration file folder, the script will load the configuration file from here | No | -| -g | Print detailed garbage collection (GC) information | No | -| -H | Specify the path of the Java heap dump file, used when JVM memory overflows | No | -| -E | Specify the path of the JVM error log file | No | -| -D | Define system properties, in the format key=value | No | -| -X | Pass -XX parameters directly to the JVM | No | -| -h | Help instruction | No | +1. Connect to the cluster using the CLI and confirm the internal address and port of the ConfigNode to be removed: -#### Removing ConfigNode Nodes + ```Plain + show confignodes; + ``` -First connect to the cluster through the CLI and confirm the internal address and port number of the ConfigNode you want to remove by using `show confignodes`: +Example output: -```Bash +```Plain IoTDB> show confignodes +------+-------+---------------+------------+--------+ |NodeID| Status|InternalAddress|InternalPort| Role| @@ -265,63 +270,60 @@ Total line number = 3 It costs 0.030s ``` -Then use the script to remove the DataNode. Script command: +2. Remove the ConfigNode using the script: + +**Linux /** **MacOS**: ```Bash -# Linux / MacOS sbin/remove-confignode.sh [confignode_id] +# Or: +sbin/remove-confignode.sh [cn_internal_address:cn_internal_port] +``` -#Windows -sbin/remove-confignode.bat [confignode_id] +**Windows:** +```Bash +sbin/remove-confignode.bat [confignode_id] +# Or: +sbin/remove-confignode.bat [cn_internal_address:cn_internal_port] ``` -### DataNode Node Maintenance +### DataNode Maintenance -There are two common scenarios for DataNode node maintenance: +DataNode maintenance includes adding and removing DataNodes. Common use cases include: -- Cluster expansion: For the purpose of expanding cluster capabilities, add new DataNodes to the cluster -- Cluster failure recovery: When a machine where a DataNode is located fails, making the DataNode unable to run normally, you can remove this DataNode and add a new DataNode to the cluster +- **Cluster Expansion:** Add new DataNodes to increase cluster capacity. +- **Cluster Fault Recovery:** If a DataNode's machine fails and it cannot function normally, remove the faulty DataNode and add a new one to the cluster. -> ❗️Note, in order for the cluster to work normally, during the process of DataNode node maintenance and after the maintenance is completed, the total number of DataNodes running normally should not be less than the number of data replicas (usually 2), nor less than the number of metadata replicas (usually 3). +**Note:** During and after DataNode maintenance, ensure that the number of active DataNodes is not fewer than the data replication factor (usually 2) or the schema replication factor (usually 3). -#### Adding DataNode Nodes +#### Adding a DataNode -Script command: +**Linux /** **MacOS**: -```Bash -# Linux / MacOS -# First switch to the IoTDB root directory +```Plain sbin/start-datanode.sh +``` + +**Windows:** -# Windows -# First switch to the IoTDB root directory +```Plain sbin/start-datanode.bat ``` -Parameter introduction: +**Note:** After adding a DataNode, the cluster load will gradually balance across all nodes as new writes arrive and old data expires (if TTL is set). -| Abbreviation | Description | Is it required | -| :--- | :--------------------------------------------- | :----------- | -| -v | Show version information | No | -| -f | Run the script in the foreground, do not put it in the background | No | -| -d | Start in daemon mode, i.e. run in the background | No | -| -p | Specify a file to store the process ID for process management | No | -| -c | Specify the path to the configuration file folder, the script will load the configuration file from here | No | -| -g | Print detailed garbage collection (GC) information | No | -| -H | Specify the path of the Java heap dump file, used when JVM memory overflows | No | -| -E | Specify the path of the JVM error log file | No | -| -D | Define system properties, in the format key=value | No | -| -X | Pass -XX parameters directly to the JVM | No | -| -h | Help instruction | No | +#### Removing a DataNode -Note: After adding a DataNode, as new writes arrive (and old data expires, if TTL is set), the cluster load will gradually balance towards the new DataNode, eventually achieving a balance of storage and computation resources on all nodes. +1. Connect to the cluster using the CLI and confirm the RPC address and port of the DataNode to be removed: -#### Removing DataNode Nodes +```Plain +show datanodes; +``` -First connect to the cluster through the CLI and confirm the RPC address and port number of the DataNode you want to remove with `show datanodes`: +Example output: -```Bash +```Plain IoTDB> show datanodes +------+-------+----------+-------+-------------+---------------+ |NodeID| Status|RpcAddress|RpcPort|DataRegionNum|SchemaRegionNum| @@ -334,51 +336,77 @@ Total line number = 3 It costs 0.110s ``` -Then use the script to remove the DataNode. Script command: +2. Remove the DataNode using the script: -```Bash -# Linux / MacOS -sbin/remove-datanode.sh [datanode_id] +**Linux / MacOS:** -#Windows -sbin/remove-datanode.bat [datanode_id] +```Bash +sbin/remove-datanode.sh [dn_rpc_address:dn_rpc_port] ``` -## Common Questions -1. Multiple prompts indicating activation failure during deployment process - - Use the `ls -al` command: Use the `ls -al` command to check if the owner information of the installation package root directory is the current user. - - Check activation directory: Check all files in the `./activation` directory and whether the owner information is the current user. - -2. Confignode failed to start +**Windows:** - 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. +```Bash +sbin/remove-datanode.bat [dn_rpc_address:dn_rpc_port] +``` - Step 4: Clean up the environment: +## Common Questions - a. Terminate all ConfigNode Node and DataNode processes. - ```Bash - # 1. Stop the ConfigNode and DataNode services +1. Activation Fails Repeatedly + - Use the `ls -al` command to verify that the ownership of the installation directory matches the current user. + - Check the ownership of all files in the `./activation` directory to ensure they belong to the current user. +2. ConfigNode Fails to Start + - Review the startup logs to check if any parameters, which cannot be modified after the first startup, were changed. + - Check the logs for any other errors. If unresolved, contact technical support for assistance. + - If the deployment is fresh or data can be discarded, clean the environment and redeploy using the following steps: + **Clean the Environment** + + - Stop all ConfigNode and DataNode processes: + ```Bash sbin/stop-standalone.sh - - # 2. Check for any remaining processes - jps - # Or - ps -ef|gerp iotdb - - # 3. If there are any remaining processes, manually kill the - kill -9 - # 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. - - ```Bash - cd /data/iotdb - rm -rf data logs - ``` \ No newline at end of file + ``` + + - Check for any remaining processes: + ```Bash + jps + # or + ps -ef | grep iotdb + ``` + + - If processes remain, terminate them manually: + ```Bash + kill -9 + + #For systems with a single IoTDB instance, you can clean up residual processes with: + ps -ef | grep iotdb | grep -v grep | tr -s ' ' ' ' | cut -d ' ' -f2 | xargs kill -9 + ``` + + - Delete the `data` and `logs` directories: + ```Bash + cd /data/iotdb + rm -rf data logs + ``` + +## Appendix + +### ConfigNode Parameters + +| Parameter | Description | Is it required | +| :-------- | :---------------------------------------------------------- | :------------- | +| -d | Starts the process in daemon mode (runs in the background). | No | + +### DataNode Parameters + +| Parameter | Description | Required | +| :-------- | :----------------------------------------------------------- | :------- | +| -v | Displays version information. | No | +| -f | Runs the script in the foreground without backgrounding it. | No | +| -d | Starts the process in daemon mode (runs in the background). | No | +| -p | Specifies a file to store the process ID for process management. | No | +| -c | Specifies the path to the configuration folder; the script loads configuration files from this location. | No | +| -g | Prints detailed garbage collection (GC) information. | No | +| -H | Specifies the path for the Java heap dump file, used during JVM memory overflow. | No | +| -E | Specifies the file for JVM error logs. | No | +| -D | Defines system properties in the format `key=value`. | No | +| -X | Passes `-XX` options directly to the JVM. | No | +| -h | Displays the help instructions. | No | \ No newline at end of file diff --git a/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md b/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md index a4e3e3c59..cf3ed80a6 100644 --- a/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md +++ b/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md @@ -20,201 +20,235 @@ --> # 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). +This guide introduces how to set up a standalone TimechoDB instance, which includes one ConfigNode and one DataNode (commonly referred to as 1C1D). -## Matters Needing Attention +## Prerequisites -1. Before installation, ensure that the system is complete by referring to [System configuration](./Environment-Requirements.md). +1. [System configuration](./Environment-Requirements.md)： Ensure the system has been configured according to the preparation guidelines. -2. 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。 +2. **IP Configuration**: It is recommended to use hostnames for IP configuration to prevent issues caused by IP address changes. Set the hostname by editing the `/etc/hosts` file. For example, if the local IP is `192.168.1.3` and the hostname is `iotdb-1`, run: ```shell echo "192.168.1.3 iotdb-1" >> /etc/hosts ``` -3. Some parameters cannot be modified after the first startup. Please refer to the "Parameter Configuration" section below for settings. + Use the hostname for `cn_internal_address` and `dn_internal_address` in IoTDB configuration. -4. Whether in linux or windows, ensure that the IoTDB installation path does not contain Spaces and Chinese characters to avoid software exceptions. +3. **Unmodifiable Parameters**: Some parameters cannot be changed after the first startup. Refer to the Parameter Configuration section. -5. Please note that when installing and deploying IoTDB (including activating and using software), 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, activation, 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. +4. **Installation Path**: Ensure the installation path contains no spaces or non-ASCII characters to prevent runtime issues. -6. 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 Deploy](./Monitoring-panel-deployment.md). +5. - **User Permissions**: Choose one of the following permissions during installation and deployment: + - **Root User (Recommended)**: This avoids permission-related issues. + - **Non-Root User**: + - Use the same user for all operations, including starting, activating, and stopping services. + - Avoid using `sudo`, which can cause permission conflicts. + +6. **Monitoring Panel**: Deploy a monitoring panel to track key performance metrics. Contact the Timecho team for access and refer to the "[Monitoring Board Install and Deploy](./Monitoring-panel-deployment.md)" guide. ## Installation Steps -### 1、Unzip the installation package and enter the installation directory +### 1、Extract Installation Package + +Unzip the installation package and navigate to the directory: -```shell -unzip iotdb-enterprise-{version}-bin.zip -cd iotdb-enterprise-{version}-bin +```Plain +unzip timechodb-{version}-bin.zip +cd timechodb-{version}-bin ``` ### 2、Parameter Configuration -#### Environment Script Configuration +#### Memory Configuration -- ./conf/confignode-env.sh (./conf/confignode-env.bat) configuration +Edit the following files for memory allocation: -| **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 | Restarting the service takes effect | +- **ConfigNode**: `conf/confignode-env.sh` (or `.bat` for Windows) +- **DataNode**: `conf/datanode-env.sh` (or `.bat` for Windows) -- ./conf/datanode-env.sh (./conf/datanode-env.bat) configuration +| **Parameter** | **Description** | **Default** | **Recommended** | **Notes** | +| :------------ | :---------------------------------- | :---------- | :-------------- | :---------------------- | +| MEMORY_SIZE | Total memory allocated for the node | Empty | As needed | Effective after restart | -| **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 | +#### General Configuration -#### System General Configuration +Set the following parameters in `conf/iotdb-system.properties`. Refer to `conf/iotdb-system.properties.template` for a complete list. -Open the general configuration file (./conf/iotdb-system. properties file) and set the following parameters: +**Cluster-Level 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 | Cannot be modified after initial startup | -| 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 | +| **Parameter** | **Description** | **Default** | **Recommended** | **Notes** | +| :------------------------ | :-------------------------- | :------------- | :-------------- | :----------------------------------------------------------- | +| cluster_name | Name of the cluster | defaultCluster | Customizable | If there is no specific requirement, keep the default value. | +| schema_replication_factor | Number of metadata replicas | 1 | 1 | In standalone mode, set this to 1. This value cannot be modified after the first startup. | +| data_replication_factor | Number of data replicas | 1 | 1 | In standalone mode, set this to 1. This value cannot be modified after the first startup. | -#### ConfigNode Configuration +**ConfigNode Parameters**: -Open the ConfigNode configuration file (./conf/iotdb-system. properties file) and set the following parameters: +| **Parameter** | **Description** | **Default** | **Recommended** | **Notes** | +| :------------------ | :----------------------------------------------------------- | :-------------- | :----------------------------------------------------------- | :--------------------------------------------------------- | +| cn_internal_address | Address used for internal communication within the cluster | 127.0.0.1 | Server's IPv4 address or hostname. Use hostname to avoid issues when the IP changes. | This parameter cannot be modified after the first startup. | +| cn_internal_port | Port used for internal communication within the cluster | 10710 | 10710 | This parameter cannot be modified after the first startup. | +| cn_consensus_port | Port used for consensus protocol communication among ConfigNode replicas | 10720 | 10720 | This parameter cannot be modified after the first startup. | +| cn_seed_config_node | Address of the ConfigNode for registering and joining the cluster. (e.g.,`cn_internal_address:cn_internal_port`) | 127.0.0.1:10710 | Use `cn_internal_address:cn_internal_port` | This parameter cannot be modified after the first startup. | -| **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 | +**DataNode** **Parameters**: -#### DataNode Configuration +| **Parameter** | **Description** | **Default** | **Recommended** | **Notes** | +| :------------------------------ | :----------------------------------------------------------- | :-------------- | :----------------------------------------------------------- | :--------------------------------------------------------- | +| dn_rpc_address | Address for the client RPC service | 0.0.0.0 | 0.0.0.0 | Effective after restarting the service. | +| dn_rpc_port | Port for the client RPC service | 6667 | 6667 | Effective after restarting the service. | +| dn_internal_address | Address used for internal communication within the cluster | 127.0.0.1 | Server's IPv4 address or hostname. Use hostname to avoid issues when the IP changes. | This parameter cannot be modified after the first startup. | +| dn_internal_port | Port used for internal communication within the cluster | 10730 | 10730 | This parameter cannot be modified after the first startup. | +| dn_mpp_data_exchange_port | Port used for receiving data streams | 10740 | 10740 | This parameter cannot be modified after the first startup. | +| dn_data_region_consensus_port | Port used for data replica consensus protocol communication | 10750 | 10750 | This parameter cannot be modified after the first startup. | +| dn_schema_region_consensus_port | Port used for metadata replica consensus protocol communication | 10760 | 10760 | This parameter cannot be modified after the first startup. | +| dn_seed_config_node | Address of the ConfigNode for registering and joining the cluster. (e.g.,`cn_internal_address:cn_internal_port`) | 127.0.0.1:10710 | Use `cn_internal_address:cn_internal_port` | This parameter cannot be modified after the first startup. | -Open the DataNode configuration file (./conf/iotdb-system. properties file) and set the following parameters: +### 3、Start ConfigNode -| **Configuration** | **Description** | **Default** | **Recommended value** | **Note** | -| :------------------------------ | :----------------------------------------------------------- | :-------------- | :----------------------------------------------------------- | :--------------------------------------- | -| dn_rpc_address | The address of the client RPC service | 0.0.0.0 | The IPV4 address or host name of the server where it is located, and it is recommended to use host name | 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 | +Navigate to the `sbin` directory and start ConfigNode: -> ❗️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 +```Bash +./sbin/start-confignode.sh -d # The "-d" flag starts the process in the background. +``` -### 3、Start ConfigNode + If the startup fails, refer to the [**Common Problem**](#Common Problem) section below for troubleshooting. -Enter the sbin directory of iotdb and start confignode +### 4、Start DataNode -```shell -./start-confignode.sh -d #The "- d" parameter will start in the background -``` -If the startup fails, please refer to [Common Questions](#common-questions). +Navigate to the `sbin` directory of IoTDB and start the DataNode: -### 4、Activate Database +````shell +./sbin/start-datanode.sh -d # The "-d" flag starts the process in the background. +```` -#### Method 1: Activate file copy activation +### 5、Activate Database -- 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; +#### Option 1: File-Based Activation -#### Method 2: Activate Script Activation +1. Start both the ConfigNode and DataNode. +2. Navigate to the `activation` folder and copy the `system_info` file. +3. Send the `system_info` file to the Timecho team. +4. Place the license file provided by the Timecho team into the corresponding `activation` folder for each node. -- Obtain the required machine code for activation, enter the sbin directory of the installation directory, and execute the activation script: +#### Option 2: Command-Based Activation -```shell - cd sbin -./start-activate.sh -``` +1. Enter the IoTDB CLI. + +- **For Table Model**: -- The following information is displayed. Please copy the machine code (i.e. the string of characters) to the Timecho staff: +```SQL +# For Linux or macOS +./start-cli.sh -sql_dialect table -```shell -Please copy the system_info's content and send it to Timecho: -01-KU5LDFFN-PNBEHDRH -Please enter license: +# For Windows +./start-cli.bat -sql_dialect table ``` -- Enter the activation code returned by the staff into the previous command line prompt 'Please enter license:', as shown below: +- **For Tree Model**: -```shell -Please enter license: -JJw+MmF+AtexsfgNGOFgTm83Bxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxm6pF+APW1CiXLTSijK9Qh3nsLgzrW8OJPh26Vl6ljKUpCvpTiw== -License has been stored to sbin/../activation/license -Import completed. Please start cluster and excute 'show cluster' to verify activation status +```SQL +# For Linux or macOS +./start-cli.sh + +# For Windows +./start-cli.bat ``` -### 5、Start DataNode +2. Run the following command to retrieve the machine code required for activation: + + ```Bash + show system info + ``` -Enter the sbin directory of iotdb and start datanode: + **Note**: Activation is currently supported only in the Tree Model. -```shell -cd sbin -./start-datanode.sh -d # The "- d" parameter will start in the background -``` +3. Copy the returned machine code (displayed as a green string) and send it to the Timecho team: -### 6、Verify Deployment +```Bash ++--------------------------------------------------------------+ +| SystemInfo| ++--------------------------------------------------------------+ +| 01-TE5NLES4-UDDWCMYE| ++--------------------------------------------------------------+ +Total line number = 1 +It costs 0.030s +``` -Can be executed directly/ Cli startup script in sbin directory: +4. Enter the activation code provided by the Timecho team in the CLI using the following format. Wrap the activation code in single quotes ('): -```shell -./start-cli.sh -h ip(local IP or domain name) -p port(6667) +```Bash +IoTDB> activate '01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOMN7-NB2E4BHI-7ZKGFVK6-GCIFXA4T-UG3XJTTD-SHJV6F2P-Q27B4OMJ-R47ZDIM3-UUASUXG2-OQXGVZCO-MMYKICZU-TWFQYYAO-ZOAGOKJA-NYHQTA5U-EWAR4EP5-MRC6R2CI-PKUTKRCT-7UDGRH3F-7BYV4P5D-6KKIA===' ``` -After successful startup, the following interface will appear displaying successful installation of IOTDB. +### 6、Verify Activation -![](https://alioss.timecho.com/docs/img/%E5%90%AF%E5%8A%A8%E6%88%90%E5%8A%9F.png) +Check the `ClusterActivationStatus` field. If it shows `ACTIVATED`, the database has been successfully activated. -After the installation success interface appears, continue to check if the activation is successful and use the `show cluster`command +![](https://alioss.timecho.com/docs/img/%E5%8D%95%E6%9C%BA-%E9%AA%8C%E8%AF%81.png) -When you see the display "Activated" on the far right, it indicates successful activation +## Common Problem -![](https://alioss.timecho.com/docs/img/show%20cluster.png) +1. Activation Fails Repeatedly + 1. Use the `ls -al` command to verify that the ownership of the installation directory matches the current user. + 2. Check the ownership of all files in the `./activation` directory to ensure they belong to the current user. +2. ConfigNode Fails to Start + 1. Review the startup logs to check if any parameters, which cannot be modified after the first startup, were changed. + 2. Check the logs for any other errors. If unresolved, contact technical support for assistance. + 3. If the deployment is fresh or data can be discarded, clean the environment and redeploy using the following steps: + **Clean the Environment** -> 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. +1. Stop all ConfigNode and DataNode processes: -## Common Problem -1. Multiple prompts indicating activation failure during deployment process - - Use the `ls -al` command: Use the `ls -al` command to check if the owner information of the installation package root directory is the current user. - - Check activation directory: Check all files in the `./activation` directory and whether the owner information is the current user. +```Bash +sbin/stop-standalone.sh +``` -2. Confignode failed to start +2. Check for any remaining processes: - Step 1: Please check the startup log to see if any parameters that cannot be changed after the first startup have been modified. +```Bash +jps +# or +ps -ef | grep iotdb +``` - 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. +3. If processes remain, terminate them manually: - 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. +```Bash +kill -9 - Step 4: Clean up the environment: +#For systems with a single IoTDB instance, you can clean up residual processes with: +ps -ef | grep iotdb | grep -v grep | tr -s ' ' ' ' | cut -d ' ' -f2 | xargs kill -9 +``` - a. Terminate all ConfigNode Node and DataNode processes. - ```Bash - # 1. Stop the ConfigNode and DataNode services - sbin/stop-standalone.sh +4. Delete the `data` and `logs` directories: - # 2. Check for any remaining processes - jps - # Or - ps -ef|gerp iotdb +```Bash +cd /data/iotdb +rm -rf data logs +``` - # 3. If there are any remaining processes, manually kill the - kill -9 - # 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. - - ```Bash - cd /data/iotdb - rm -rf data logs - ``` \ No newline at end of file +## Appendix + +### ConfigNode Parameters + +| Parameter | Description | **Is it required** | +| :-------- | :---------------------------------------------------------- | :----------------- | +| -d | Starts the process in daemon mode (runs in the background). | No | + +### DataNode Parameters + +| Parameter | Description | Required | +| :-------- | :----------------------------------------------------------- | :------- | +| -v | Displays version information. | No | +| -f | Runs the script in the foreground without backgrounding it. | No | +| -d | Starts the process in daemon mode (runs in the background). | No | +| -p | Specifies a file to store the process ID for process management. | No | +| -c | Specifies the path to the configuration folder; the script loads configuration files from this location. | No | +| -g | Prints detailed garbage collection (GC) information. | No | +| -H | Specifies the path for the Java heap dump file, used during JVM memory overflow. | No | +| -E | Specifies the file for JVM error logs. | No | +| -D | Defines system properties in the format `key=value`. | No | +| -X | Passes `-XX` options directly to the JVM. | No | +| -h | Displays the help instructions. | No | \ No newline at end of file diff --git a/src/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md b/src/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md index 08579e8a7..cf9658ff9 100644 --- a/src/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md +++ b/src/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md @@ -20,239 +20,244 @@ --> # Cluster Deployment -This section describes how to manually deploy an instance that includes 3 ConfigNodes and 3 DataNodes, commonly known as a 3C3D cluster. +This guide describes how to manually deploy a cluster instance consisting of 3 ConfigNodes and 3 DataNodes (commonly referred to as a 3C3D cluster).
-## Note -1. Before installation, ensure that the system is complete by referring to [System configuration](./Environment-Requirements.md) -2. 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 the `cn_internal_address` and `dn_internal_address` of IoTDB using the host name. +## Prerequisites + +1. [System configuration](./Environment-Requirements.md):Ensure the system has been configured according to the preparation guidelines. + +2. **IP Configuration**: It is recommended to use hostnames for IP configuration to prevent issues caused by IP address changes. Configure the `/etc/hosts` file on each server. For example, if the local IP is `11.101.17.224` and the hostname is `iotdb-1`, use the following command to set the hostname: + ``` shell echo "192.168.1.3 iotdb-1" >> /etc/hosts ``` -3. Some parameters cannot be modified after the first startup. Please refer to the "Parameter Configuration" section below for settings. + Use the hostname for `cn_internal_address` and `dn_internal_address` in IoTDB configuration. + +3. **Unmodifiable Parameters**: Some parameters cannot be changed after the first startup. Refer to the Parameter Configuration section. + +4. **Installation Path**: Ensure the installation path contains no spaces or non-ASCII characters to prevent runtime issues. -4. Whether in linux or windows, ensure that the IoTDB installation path does not contain Spaces and Chinese characters to avoid software exceptions. +5. **User Permissions**: Choose one of the following permissions during installation and deployment: -5. Please note that when installing and deploying IoTDB (including activating and using software), 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, activation, 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. + - **Root User (Recommended)**: This avoids permission-related issues. + - **Non-Root User**: + - Use the same user for all operations, including starting, activating, and stopping services. + - Avoid using `sudo`, which can cause permission conflicts. -6. 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,The steps for deploying a monitoring panel can refer to:[Monitoring Panel Deployment](./Monitoring-panel-deployment.md) +6. **Monitoring Panel**: Deploy a monitoring panel to track key performance metrics. Contact the Timecho team for access and refer to the "[Monitoring Panel Deployment](./Monitoring-panel-deployment.md)" guide. -## Preparation Steps +## Preparation -1. Prepare the IoTDB database installation package: iotdb enterprise- {version}-bin.zip（The installation package can be obtained from:[IoTDB-Package](../Deployment-and-Maintenance/IoTDB-Package_timecho.md)） -2. Configure the operating system environment according to environmental requirements（The system environment configuration can be found in:[Environment Requirement](https://www.timecho.com/docs/UserGuide/latest/Deployment-and-Maintenance/Environment-Requirements.html)） +1. Obtain the TimechoDB installation package: `timechodb-{version}-bin.zip` following[IoTDB-Package](../Deployment-and-Maintenance/IoTDB-Package_timecho.md) +2. Configure the operating system environment according to [Environment Requirement](./Environment-Requirements.md) ## Installation Steps -Assuming there are three Linux servers now, the IP addresses and service roles are assigned as follows: +Taking a cluster with three Linux servers with the following information as example: -| Node IP | Host Name | Service | -| ----------- | --------- | -------------------- | -| 192.168.1.3 | iotdb-1 | ConfigNode、DataNode | -| 192.168.1.4 | iotdb-2 | ConfigNode、DataNode | -| 192.168.1.5 | iotdb-3 | ConfigNode、DataNode | +| Node IP | Host Name | Service | +| ------------- | --------- | -------------------- | +| 11.101.17.224 | iotdb-1 | ConfigNode、DataNode | +| 11.101.17.225 | iotdb-2 | ConfigNode、DataNode | +| 11.101.17.226 | iotdb-3 | ConfigNode、DataNode | -### Set Host Name +### 1.Configure Hostnames -On three machines, configure the host names separately. To set the host names, configure `/etc/hosts` on the target server. Use the following command: +On all three servers, configure the hostnames by editing the `/etc/hosts` file. Use the following commands: ```Bash -echo "192.168.1.3 iotdb-1" >> /etc/hosts -echo "192.168.1.4 iotdb-2" >> /etc/hosts -echo "192.168.1.5 iotdb-3" >> /etc/hosts +echo "11.101.17.224 iotdb-1" >> /etc/hosts +echo "11.101.17.225 iotdb-2" >> /etc/hosts +echo "11.101.17.226 iotdb-3" >> /etc/hosts ``` -### Configuration +### 2. Extract Installation Package -Unzip the installation package and enter the installation directory +Unzip the installation package and enter the installation directory: ```Plain -unzip iotdb-enterprise-{version}-bin.zip -cd iotdb-enterprise-{version}-bin +unzip timechodb-{version}-bin.zip +cd timechodb-{version}-bin ``` -#### Environment script configuration +### 3. Parameters Configuration -- `./conf/confignode-env.sh` configuration +- #### Memory Configuration - | **Configuration** | **Description** | **Default** | **Recommended value** | **Note** | - | :---------------- | :----------------------------------------------------------- | :---------- | :----------------------------------------------------------- | :---------------------------------- | - | MEMORY_SIZE | The total amount of memory that IoTDB ConfigNode nodes can use | - | Can be filled in as needed, and the system will allocate memory based on the filled in values | Restarting the service takes effect | + Edit the following files for memory allocation: -- `./conf/datanode-env.sh` configuration + - **ConfigNode**: `./conf/confignode-env.sh` (or `.bat` for Windows) + - **DataNode**: `./conf/datanode-env.sh` (or `.bat` for Windows) - | **Configuration** | **Description** | **Default** | **Recommended value** | **Note** | - | :---------------- | :----------------------------------------------------------- | :---------- | :----------------------------------------------------------- | :---------------------------------- | - | MEMORY_SIZE | The total amount of memory that IoTDB DataNode nodes can use | - | Can be filled in as needed, and the system will allocate memory based on the filled in values | Restarting the service takes effect | + | **Parameter** | **Description** | **Default** | **Recommended** | **Notes** | + | :------------ | :--------------------------------- | :---------- | :-------------- | :-------------------------------------- | + | MEMORY_SIZE | Total memory allocated to the node | Empty | As needed | Effective after restarting the service. | -#### General Configuration +**General Configuration** -Open the general configuration file `./conf/iotdb-system.properties`,The following parameters can be set according to the deployment method: +Set the following parameters in `./conf/iotdb-system.properties`. Refer to `./conf/iotdb-system.properties.template` for a complete list. -| **Configuration** | **Description** | 192.168.1.3 | 192.168.1.4 | 192.168.1.5 | -| ------------------------- | ------------------------------------------------------------ | -------------- | -------------- | -------------- | -| cluster_name | Cluster Name | defaultCluster | defaultCluster | defaultCluster | -| schema_replication_factor | The number of metadata replicas, the number of DataNodes should not be less than this number | 3 | 3 | 3 | -| data_replication_factor | The number of data replicas should not be less than this number of DataNodes | 2 | 2 | 2 | +**Cluster-Level Parameters**: -#### ConfigNode Configuration +| **Parameter** | **Description** | **11.101.17.224** | **11.101.17.225** | **11.101.17.226** | +| :------------------------ | :----------------------------------------------------------- | :---------------- | :---------------- | :---------------- | +| cluster_name | Name of the cluster | defaultCluster | defaultCluster | defaultCluster | +| schema_replication_factor | Metadata replication factor; DataNode count shall not be fewer than this value | 3 | 3 | 3 | +| data_replication_factor | Data replication factor; DataNode count shall not be fewer than this value | 2 | 2 | 2 | -Open the ConfigNode configuration file `./conf/iotdb-system.properties`,Set the following parameters +#### ConfigNode Parameters -| **Configuration** | **Description** | **Default** | **Recommended value** | 192.168.1.3 | 192.168.1.4 | 192.168.1.5 | 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 | iotdb-1 | iotdb-2 | iotdb-3 | Cannot be modified after initial startup | -| cn_internal_port | The port used by ConfigNode for communication within the cluster | 10710 | 10710 | 10710 | 10710 | 10710 | Cannot be modified after initial startup | -| cn_consensus_port | The port used for ConfigNode replica group consensus protocol communication | 10720 | 10720 | 10720 | 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 | The first CongfigNode's `cn_internal-address: cn_internal_port` | iotdb-1:10710 | iotdb-1:10710 | iotdb-1:10710 | Cannot be modified after initial startup | +| **Parameter** | **Description** | **Default** | **Recommended** | **11.101.17.224** | **11.101.17.225** | **11.101.17.226** | **Notes** | +| :------------------ | :----------------------------------------------------------- | :-------------- | :----------------------------------------------------------- | :---------------- | :---------------- | :---------------- | :--------------------------------------------------------- | +| cn_internal_address | Address used for internal communication within the cluster | 127.0.0.1 | Server's IPv4 address or hostname. Use hostname to avoid issues when the IP changes. | iotdb-1 | iotdb-2 | iotdb-3 | This parameter cannot be modified after the first startup. | +| cn_internal_port | Port used for internal communication within the cluster | 10710 | 10710 | 10710 | 10710 | 10710 | This parameter cannot be modified after the first startup. | +| cn_consensus_port | Port used for consensus protocol communication among ConfigNode replicas | 10720 | 10720 | 10720 | 10720 | 10720 | This parameter cannot be modified after the first startup. | +| cn_seed_config_node | Address of the ConfigNode for registering and joining the cluster. (e.g.,`cn_internal_address:cn_internal_port`) | 127.0.0.1:10710 | Address and port of the seed ConfigNode (e.g., `cn_internal_address:cn_internal_port`) | iotdb-1:10710 | iotdb-1:10710 | iotdb-1:10710 | This parameter cannot be modified after the first startup. | -#### DataNode Configuration +#### DataNode Parameters -Open DataNode Configuration File `./conf/iotdb-system.properties`,Set the following parameters: +| **Parameter** | **Description** | **Default** | **Recommended** | **11.101.17.224** | **11.101.17.225** | **11.101.17.226** | **Notes** | +| :------------------------------ | :----------------------------------------------------------- | :-------------- | :----------------------------------------------------------- | :---------------- | :---------------- | :---------------- | :--------------------------------------------------------- | +| dn_rpc_address | Address for the client RPC service | 0.0.0.0 | 0.0.0.0 | 0.0.0.0 | 0.0.0.0 | 0.0.0.0 | Effective after restarting the service. | +| dn_rpc_port | Port for the client RPC service | 6667 | 6667 | 6667 | 6667 | 6667 | Effective after restarting the service. | +| dn_internal_address | Address used for internal communication within the cluster | 127.0.0.1 | Server's IPv4 address or hostname. Use hostname to avoid issues when the IP changes. | iotdb-1 | iotdb-2 | iotdb-3 | This parameter cannot be modified after the first startup. | +| dn_internal_port | Port used for internal communication within the cluster | 10730 | 10730 | 10730 | 10730 | 10730 | This parameter cannot be modified after the first startup. | +| dn_mpp_data_exchange_port | Port used for receiving data streams | 10740 | 10740 | 10740 | 10740 | 10740 | This parameter cannot be modified after the first startup. | +| dn_data_region_consensus_port | Port used for data replica consensus protocol communication | 10750 | 10750 | 10750 | 10750 | 10750 | This parameter cannot be modified after the first startup. | +| dn_schema_region_consensus_port | Port used for metadata replica consensus protocol communication | 10760 | 10760 | 10760 | 10760 | 10760 | This parameter cannot be modified after the first startup. | +| dn_seed_config_node | Address of the ConfigNode for registering and joining the cluster.(e.g.,`cn_internal_address:cn_internal_port`) | 127.0.0.1:10710 | Address of the first ConfigNode | iotdb-1:10710 | iotdb-1:10710 | iotdb-1:10710 | This parameter cannot be modified after the first startup. | -| **Configuration** | **Description** | **Default** | **Recommended value** | 192.168.1.3 | 192.168.1.4 | 192.168.1.5 | Note | -| ------------------------------- | ------------------------------------------------------------ | --------------- | ------------------------------------------------------------ | ------------- | ------------- | ------------- | ---------------------------------------- | -| dn_rpc_address | The address of the client RPC service | 127.0.0.1 | Recommend using the **IPV4 address or hostname** of the server where it is located | iotdb-1 |iotdb-2 | iotdb-3 | Restarting the service takes effect | -| dn_rpc_port | The port of the client RPC service | 6667 | 6667 | 6667 | 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 | iotdb-1 | iotdb-2 | iotdb-3 | Cannot be modified after initial startup | -| dn_internal_port | The port used by DataNode for communication within the cluster | 10730 | 10730 | 10730 | 10730 | 10730 | Cannot be modified after initial startup | -| dn_mpp_data_exchange_port | The port used by DataNode to receive data streams | 10740 | 10740 | 10740 | 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 | 10750 | 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 | 10760 | 10760 | 10760 | Cannot be modified after initial startup | -| dn_seed_config_node | The address of the ConfigNode that the node connects to when registering to join the cluster, i.e. `cn_internal-address: cn_internal_port` | 127.0.0.1:10710 | The first CongfigNode's cn_internal-address: cn_internal_port | iotdb-1:10710 | iotdb-1:10710 | iotdb-1:10710 | Cannot be modified after initial startup | +**Note:** Ensure files are saved after editing. Tools like VSCode Remote do not save changes automatically. -> ❗️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 +### 4. Start ConfigNode Instances -### Start ConfigNode - -Start the first confignode of IoTDB-1 first, ensuring that the seed confignode node starts first, and then start the second and third confignode nodes in sequence +1. Start the first ConfigNode (`iotdb-1`) as the seed node ```Bash cd sbin ./start-confignode.sh -d #"- d" parameter will start in the background ``` -If the startup fails, please refer to [Common Questions](#common-questions). +2. Start the remaining ConfigNodes (`iotdb-2` and `iotdb-3`) in sequence. + If the startup fails, refer to the [Common Questions](#common-questions) section below for troubleshooting. -### Activate Database +### 5.Start DataNode Instances -#### Method 1: Activate file copy activation +On each server, navigate to the `sbin` directory and start the DataNode: -- After starting three confignode nodes in sequence, copy the `activation` folder of each machine and the `system_info` file of each machine to the Timecho staff; -- The staff will return the license files for each ConfigNode node, where 3 license files will be returned; -- Put the three license files into the `activation` folder of the corresponding ConfigNode node; +```Go +cd sbin +./start-datanode.sh -d #"- d" parameter will start in the background +``` -#### Method 2: Activate Script Activation +### 6.Activate Database -- Obtain the machine codes of three machines in sequence, enter the `sbin` directory of the installation directory, and execute the activation script `start activate.sh`: +#### Option 1: File-Based Activation - ```Bash - cd sbin - ./start-activate.sh - ``` +1. Start all ConfigNodes and DataNodes. +2. Copy the `system_info` file from the `activation` directory on each server and send them to the Timecho team. +3. Place the license files provided by the Timecho team into the corresponding `activation` folder for each node. -- The following information is displayed, where the machine code of one machine is displayed: +#### Option 2: Command-Based Activation - ```Bash - Please copy the system_info's content and send it to Timecho: - 01-KU5LDFFN-PNBEHDRH - Please enter license: - ``` +1. Enter the IoTDB CLI for each node: -- The other two nodes execute the activation script `start activate.sh` in sequence, and then copy the machine codes of the three machines obtained to the Timecho staff -- The staff will return 3 activation codes, which normally correspond to the order of the provided 3 machine codes. Please paste each activation code into the previous command line prompt `Please enter license:`, as shown below: +- **For Table Model**: - ```Bash - Please enter license: - Jw+MmF+Atxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx5bAOXNeob5l+HO5fEMgzrW8OJPh26Vl6ljKUpCvpTiw== - License has been stored to sbin/../activation/license - Import completed. Please start cluster and excute 'show cluster' to verify activation status - ``` + ```SQL + # For Linux or macOS + ./start-cli.sh -sql_dialect table + + # For Windows + ./start-cli.bat -sql_dialect table + ``` -### Start DataNode +- **For Tree Model**: - Enter the `sbin` directory of iotdb and start three datanode nodes in sequence: + ```SQL + # For Linux or macOS + ./start-cli.sh + + # For Windows + ./start-cli.bat + ``` -```Bash -cd sbin -./start-datanode.sh -d #"- d" parameter will start in the background -``` +2. Run the following command to retrieve the machine code required for activation: -### Verify Deployment + ```Bash + show system info + ``` -Can be executed directly Cli startup script in `./sbin` directory: + **Note**: Activation is currently supported only in the Tree Model. -```Plain -./start-cli.sh -h ip(local IP or domain name) -p port(6667) -``` +3. Copy the returned machine code of each server (displayed as a green string) and send it to the Timecho team: - After successful startup, the following interface will appear displaying successful installation of IOTDB. + ```Bash + +--------------------------------------------------------------+ + | SystemInfo| + +--------------------------------------------------------------+ + |01-TE5NLES4-UDDWCMYE,01-GG5NLES4-XXDWCMYE,01-FF5NLES4-WWWWCMYE| + +--------------------------------------------------------------+ + Total line number = 1 + It costs 0.030s + ``` + +4. Enter the activation codes provided by the Timecho team in the CLI in sequence using the following format. Wrap the activation code in single quotes ('): + + ```Bash + IoTDB> activate '01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOMN7-NB2E4BHI-7ZKGFVK6-GCIFXA4T-UG3XJTTD-SHJV6F2P-Q27B4OMJ-R47ZDIM3-UUASUXG2-OQXGVZCO-MMYKICZU-TWFQYYAO-ZOAGOKJA-NYHQTA5U-EWAR4EP5-MRC6R2CI-PKUTKRCT-7UDGRH3F-7BYV4P5D-6KKIA===,01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOMN7-NB2E4BHI-7ZKGFVK6-GCIFXA4T-UG3XJTTD-SHJV6F2P-Q27B4OMJ-R47ZDIM3-UUASUXG2-OQXGVZCO-MMYKICZU-TWFQYYAO-ZOAGOKJA-NYHQTA5U-EWAR4EP5-MRC6R2CI-PKUTKRCT-7UDGRH3F-7BYV4P5D-6KKIA===,01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOMN7-NB2E4BHI-7ZKGFVK6-GCIFXA4T-UG3XJTTD-SHJV6F2P-Q27B4OMJ-R47ZDIM3-UUASUXG2-OQXGVZCO-MMYKICZU-TWFQYYAO-ZOAGOKJA-NYHQTA5U-EWAR4EP5-MRC6R2CI-PKUTKRCT-7UDGRH3F-7BYV4P5D-6KKIA===' + ``` -![](https://alioss.timecho.com/docs/img/%E4%BC%81%E4%B8%9A%E7%89%88%E6%88%90%E5%8A%9F.png) +### 7.Verify Activation -After the installation success interface appears, continue to check if the activation is successful and use the `show cluster` command. +Check the `ClusterActivationStatus` field. If it shows `ACTIVATED`, the database has been successfully activated. -When you see the display of `Activated` on the far right, it indicates successful activation. +![](https://alioss.timecho.com/docs/img/%E9%9B%86%E7%BE%A4-%E9%AA%8C%E8%AF%81.png) -![](https://alioss.timecho.com/docs/img/%E4%BC%81%E4%B8%9A%E7%89%88%E6%BF%80%E6%B4%BB.png) +## Maintenance -> The appearance of `ACTIVATED (W)` indicates passive activation, which means that this Configurable Node does not have a license file (or has not issued the latest license file with a timestamp), and its activation depends on other Activated Configurable Nodes in the cluster. 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 Maintenance -## Node Maintenance Steps +ConfigNode maintenance includes adding and removing ConfigNodes. Common use cases include: -### ConfigNode Node Maintenance +- **Cluster Expansion:** If the cluster contains only 1 ConfigNode, adding 2 more ConfigNodes enhances high availability, resulting in a total of 3 ConfigNodes. +- **Cluster Fault Recovery:** If a ConfigNode's machine fails and it cannot function normally, remove the faulty ConfigNode and add a new one to the cluster. -ConfigNode node maintenance is divided into two types of operations: adding and removing ConfigNodes, with two common use cases: -- Cluster expansion: For example, when there is only one ConfigNode in the cluster, and you want to increase the high availability of ConfigNode nodes, you can add two ConfigNodes, making a total of three ConfigNodes in the cluster. -- Cluster failure recovery: When the machine where a ConfigNode is located fails, making the ConfigNode unable to run normally, you can remove this ConfigNode and then add a new ConfigNode to the cluster. +**Note:** After completing ConfigNode maintenance, ensure that the cluster contains either 1 or 3 active ConfigNodes. Two ConfigNodes do not provide high availability, and more than three ConfigNodes can degrade performance. -> ❗️Note, after completing ConfigNode node maintenance, you need to ensure that there are 1 or 3 ConfigNodes running normally in the cluster. Two ConfigNodes do not have high availability, and more than three ConfigNodes will lead to performance loss. +#### Adding a ConfigNode -#### Adding ConfigNode Nodes +**Linux /** **MacOS**: -Script command: -```shell -# Linux / MacOS -# First switch to the IoTDB root directory +```Plain sbin/start-confignode.sh +``` + +**Windows:** -# Windows -# First switch to the IoTDB root directory +```Plain sbin/start-confignode.bat ``` -Parameter introduction: +#### Removing a ConfigNode -| Parameter | Description | Is it required | -| :--- | :--------------------------------------------- | :----------- | -| -v | Show version information | No | -| -f | Run the script in the foreground, do not put it in the background | No | -| -d | Start in daemon mode, i.e. run in the background | No | -| -p | Specify a file to store the process ID for process management | No | -| -c | Specify the path to the configuration file folder, the script will load the configuration file from here | No | -| -g | Print detailed garbage collection (GC) information | No | -| -H | Specify the path of the Java heap dump file, used when JVM memory overflows | No | -| -E | Specify the path of the JVM error log file | No | -| -D | Define system properties, in the format key=value | No | -| -X | Pass -XX parameters directly to the JVM | No | -| -h | Help instruction | No | +1. Connect to the cluster using the CLI and confirm the internal address and port of the ConfigNode to be removed: -#### Removing ConfigNode Nodes + ```Plain + show confignodes; + ``` -First connect to the cluster through the CLI and confirm the internal address and port number of the ConfigNode you want to remove by using `show confignodes`: +Example output: -```Bash +```Plain IoTDB> show confignodes +------+-------+---------------+------------+--------+ |NodeID| Status|InternalAddress|InternalPort| Role| @@ -265,63 +270,60 @@ Total line number = 3 It costs 0.030s ``` -Then use the script to remove the DataNode. Script command: +2. Remove the ConfigNode using the script: + +**Linux /** **MacOS**: ```Bash -# Linux / MacOS sbin/remove-confignode.sh [confignode_id] +# Or: +sbin/remove-confignode.sh [cn_internal_address:cn_internal_port] +``` -#Windows -sbin/remove-confignode.bat [confignode_id] +**Windows:** +```Bash +sbin/remove-confignode.bat [confignode_id] +# Or: +sbin/remove-confignode.bat [cn_internal_address:cn_internal_port] ``` -### DataNode Node Maintenance +### DataNode Maintenance -There are two common scenarios for DataNode node maintenance: +DataNode maintenance includes adding and removing DataNodes. Common use cases include: -- Cluster expansion: For the purpose of expanding cluster capabilities, add new DataNodes to the cluster -- Cluster failure recovery: When a machine where a DataNode is located fails, making the DataNode unable to run normally, you can remove this DataNode and add a new DataNode to the cluster +- **Cluster Expansion:** Add new DataNodes to increase cluster capacity. +- **Cluster Fault Recovery:** If a DataNode's machine fails and it cannot function normally, remove the faulty DataNode and add a new one to the cluster. -> ❗️Note, in order for the cluster to work normally, during the process of DataNode node maintenance and after the maintenance is completed, the total number of DataNodes running normally should not be less than the number of data replicas (usually 2), nor less than the number of metadata replicas (usually 3). +**Note:** During and after DataNode maintenance, ensure that the number of active DataNodes is not fewer than the data replication factor (usually 2) or the schema replication factor (usually 3). -#### Adding DataNode Nodes +#### Adding a DataNode -Script command: +**Linux /** **MacOS**: -```Bash -# Linux / MacOS -# First switch to the IoTDB root directory +```Plain sbin/start-datanode.sh +``` + +**Windows:** -# Windows -# First switch to the IoTDB root directory +```Plain sbin/start-datanode.bat ``` -Parameter introduction: +**Note:** After adding a DataNode, the cluster load will gradually balance across all nodes as new writes arrive and old data expires (if TTL is set). -| Abbreviation | Description | Is it required | -| :--- | :--------------------------------------------- | :----------- | -| -v | Show version information | No | -| -f | Run the script in the foreground, do not put it in the background | No | -| -d | Start in daemon mode, i.e. run in the background | No | -| -p | Specify a file to store the process ID for process management | No | -| -c | Specify the path to the configuration file folder, the script will load the configuration file from here | No | -| -g | Print detailed garbage collection (GC) information | No | -| -H | Specify the path of the Java heap dump file, used when JVM memory overflows | No | -| -E | Specify the path of the JVM error log file | No | -| -D | Define system properties, in the format key=value | No | -| -X | Pass -XX parameters directly to the JVM | No | -| -h | Help instruction | No | +#### Removing a DataNode -Note: After adding a DataNode, as new writes arrive (and old data expires, if TTL is set), the cluster load will gradually balance towards the new DataNode, eventually achieving a balance of storage and computation resources on all nodes. +1. Connect to the cluster using the CLI and confirm the RPC address and port of the DataNode to be removed: -#### Removing DataNode Nodes +```Plain +show datanodes; +``` -First connect to the cluster through the CLI and confirm the RPC address and port number of the DataNode you want to remove with `show datanodes`: +Example output: -```Bash +```Plain IoTDB> show datanodes +------+-------+----------+-------+-------------+---------------+ |NodeID| Status|RpcAddress|RpcPort|DataRegionNum|SchemaRegionNum| @@ -334,51 +336,77 @@ Total line number = 3 It costs 0.110s ``` -Then use the script to remove the DataNode. Script command: +2. Remove the DataNode using the script: -```Bash -# Linux / MacOS -sbin/remove-datanode.sh [datanode_id] +**Linux / MacOS:** -#Windows -sbin/remove-datanode.bat [datanode_id] +```Bash +sbin/remove-datanode.sh [dn_rpc_address:dn_rpc_port] ``` -## Common Questions -1. Multiple prompts indicating activation failure during deployment process - - Use the `ls -al` command: Use the `ls -al` command to check if the owner information of the installation package root directory is the current user. - - Check activation directory: Check all files in the `./activation` directory and whether the owner information is the current user. - -2. Confignode failed to start +**Windows:** - 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. +```Bash +sbin/remove-datanode.bat [dn_rpc_address:dn_rpc_port] +``` - Step 4: Clean up the environment: +## Common Questions - a. Terminate all ConfigNode Node and DataNode processes. - ```Bash - # 1. Stop the ConfigNode and DataNode services +1. Activation Fails Repeatedly + - Use the `ls -al` command to verify that the ownership of the installation directory matches the current user. + - Check the ownership of all files in the `./activation` directory to ensure they belong to the current user. +2. ConfigNode Fails to Start + - Review the startup logs to check if any parameters, which cannot be modified after the first startup, were changed. + - Check the logs for any other errors. If unresolved, contact technical support for assistance. + - If the deployment is fresh or data can be discarded, clean the environment and redeploy using the following steps: + **Clean the Environment** + + - Stop all ConfigNode and DataNode processes: + ```Bash sbin/stop-standalone.sh - - # 2. Check for any remaining processes - jps - # Or - ps -ef|gerp iotdb - - # 3. If there are any remaining processes, manually kill the - kill -9 - # 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. - - ```Bash - cd /data/iotdb - rm -rf data logs - ``` \ No newline at end of file + ``` + + - Check for any remaining processes: + ```Bash + jps + # or + ps -ef | grep iotdb + ``` + + - If processes remain, terminate them manually: + ```Bash + kill -9 + + #For systems with a single IoTDB instance, you can clean up residual processes with: + ps -ef | grep iotdb | grep -v grep | tr -s ' ' ' ' | cut -d ' ' -f2 | xargs kill -9 + ``` + + - Delete the `data` and `logs` directories: + ```Bash + cd /data/iotdb + rm -rf data logs + ``` + +## Appendix + +### ConfigNode Parameters + +| Parameter | Description | Is it required | +| :-------- | :---------------------------------------------------------- | :------------- | +| -d | Starts the process in daemon mode (runs in the background). | No | + +### DataNode Parameters + +| Parameter | Description | Required | +| :-------- | :----------------------------------------------------------- | :------- | +| -v | Displays version information. | No | +| -f | Runs the script in the foreground without backgrounding it. | No | +| -d | Starts the process in daemon mode (runs in the background). | No | +| -p | Specifies a file to store the process ID for process management. | No | +| -c | Specifies the path to the configuration folder; the script loads configuration files from this location. | No | +| -g | Prints detailed garbage collection (GC) information. | No | +| -H | Specifies the path for the Java heap dump file, used during JVM memory overflow. | No | +| -E | Specifies the file for JVM error logs. | No | +| -D | Defines system properties in the format `key=value`. | No | +| -X | Passes `-XX` options directly to the JVM. | No | +| -h | Displays the help instructions. | No | \ No newline at end of file diff --git a/src/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md b/src/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md index a4e3e3c59..cf3ed80a6 100644 --- a/src/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md +++ b/src/UserGuide/V2.0.1/Tree/Deployment-and-Maintenance/Stand-Alone-Deployment_timecho.md @@ -20,201 +20,235 @@ --> # 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). +This guide introduces how to set up a standalone TimechoDB instance, which includes one ConfigNode and one DataNode (commonly referred to as 1C1D). -## Matters Needing Attention +## Prerequisites -1. Before installation, ensure that the system is complete by referring to [System configuration](./Environment-Requirements.md). +1. [System configuration](./Environment-Requirements.md)： Ensure the system has been configured according to the preparation guidelines. -2. 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。 +2. **IP Configuration**: It is recommended to use hostnames for IP configuration to prevent issues caused by IP address changes. Set the hostname by editing the `/etc/hosts` file. For example, if the local IP is `192.168.1.3` and the hostname is `iotdb-1`, run: ```shell echo "192.168.1.3 iotdb-1" >> /etc/hosts ``` -3. Some parameters cannot be modified after the first startup. Please refer to the "Parameter Configuration" section below for settings. + Use the hostname for `cn_internal_address` and `dn_internal_address` in IoTDB configuration. -4. Whether in linux or windows, ensure that the IoTDB installation path does not contain Spaces and Chinese characters to avoid software exceptions. +3. **Unmodifiable Parameters**: Some parameters cannot be changed after the first startup. Refer to the Parameter Configuration section. -5. Please note that when installing and deploying IoTDB (including activating and using software), 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, activation, 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. +4. **Installation Path**: Ensure the installation path contains no spaces or non-ASCII characters to prevent runtime issues. -6. 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 Deploy](./Monitoring-panel-deployment.md). +5. - **User Permissions**: Choose one of the following permissions during installation and deployment: + - **Root User (Recommended)**: This avoids permission-related issues. + - **Non-Root User**: + - Use the same user for all operations, including starting, activating, and stopping services. + - Avoid using `sudo`, which can cause permission conflicts. + +6. **Monitoring Panel**: Deploy a monitoring panel to track key performance metrics. Contact the Timecho team for access and refer to the "[Monitoring Board Install and Deploy](./Monitoring-panel-deployment.md)" guide. ## Installation Steps -### 1、Unzip the installation package and enter the installation directory +### 1、Extract Installation Package + +Unzip the installation package and navigate to the directory: -```shell -unzip iotdb-enterprise-{version}-bin.zip -cd iotdb-enterprise-{version}-bin +```Plain +unzip timechodb-{version}-bin.zip +cd timechodb-{version}-bin ``` ### 2、Parameter Configuration -#### Environment Script Configuration +#### Memory Configuration -- ./conf/confignode-env.sh (./conf/confignode-env.bat) configuration +Edit the following files for memory allocation: -| **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 | Restarting the service takes effect | +- **ConfigNode**: `conf/confignode-env.sh` (or `.bat` for Windows) +- **DataNode**: `conf/datanode-env.sh` (or `.bat` for Windows) -- ./conf/datanode-env.sh (./conf/datanode-env.bat) configuration +| **Parameter** | **Description** | **Default** | **Recommended** | **Notes** | +| :------------ | :---------------------------------- | :---------- | :-------------- | :---------------------- | +| MEMORY_SIZE | Total memory allocated for the node | Empty | As needed | Effective after restart | -| **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 | +#### General Configuration -#### System General Configuration +Set the following parameters in `conf/iotdb-system.properties`. Refer to `conf/iotdb-system.properties.template` for a complete list. -Open the general configuration file (./conf/iotdb-system. properties file) and set the following parameters: +**Cluster-Level 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 | Cannot be modified after initial startup | -| 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 | +| **Parameter** | **Description** | **Default** | **Recommended** | **Notes** | +| :------------------------ | :-------------------------- | :------------- | :-------------- | :----------------------------------------------------------- | +| cluster_name | Name of the cluster | defaultCluster | Customizable | If there is no specific requirement, keep the default value. | +| schema_replication_factor | Number of metadata replicas | 1 | 1 | In standalone mode, set this to 1. This value cannot be modified after the first startup. | +| data_replication_factor | Number of data replicas | 1 | 1 | In standalone mode, set this to 1. This value cannot be modified after the first startup. | -#### ConfigNode Configuration +**ConfigNode Parameters**: -Open the ConfigNode configuration file (./conf/iotdb-system. properties file) and set the following parameters: +| **Parameter** | **Description** | **Default** | **Recommended** | **Notes** | +| :------------------ | :----------------------------------------------------------- | :-------------- | :----------------------------------------------------------- | :--------------------------------------------------------- | +| cn_internal_address | Address used for internal communication within the cluster | 127.0.0.1 | Server's IPv4 address or hostname. Use hostname to avoid issues when the IP changes. | This parameter cannot be modified after the first startup. | +| cn_internal_port | Port used for internal communication within the cluster | 10710 | 10710 | This parameter cannot be modified after the first startup. | +| cn_consensus_port | Port used for consensus protocol communication among ConfigNode replicas | 10720 | 10720 | This parameter cannot be modified after the first startup. | +| cn_seed_config_node | Address of the ConfigNode for registering and joining the cluster. (e.g.,`cn_internal_address:cn_internal_port`) | 127.0.0.1:10710 | Use `cn_internal_address:cn_internal_port` | This parameter cannot be modified after the first startup. | -| **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 | +**DataNode** **Parameters**: -#### DataNode Configuration +| **Parameter** | **Description** | **Default** | **Recommended** | **Notes** | +| :------------------------------ | :----------------------------------------------------------- | :-------------- | :----------------------------------------------------------- | :--------------------------------------------------------- | +| dn_rpc_address | Address for the client RPC service | 0.0.0.0 | 0.0.0.0 | Effective after restarting the service. | +| dn_rpc_port | Port for the client RPC service | 6667 | 6667 | Effective after restarting the service. | +| dn_internal_address | Address used for internal communication within the cluster | 127.0.0.1 | Server's IPv4 address or hostname. Use hostname to avoid issues when the IP changes. | This parameter cannot be modified after the first startup. | +| dn_internal_port | Port used for internal communication within the cluster | 10730 | 10730 | This parameter cannot be modified after the first startup. | +| dn_mpp_data_exchange_port | Port used for receiving data streams | 10740 | 10740 | This parameter cannot be modified after the first startup. | +| dn_data_region_consensus_port | Port used for data replica consensus protocol communication | 10750 | 10750 | This parameter cannot be modified after the first startup. | +| dn_schema_region_consensus_port | Port used for metadata replica consensus protocol communication | 10760 | 10760 | This parameter cannot be modified after the first startup. | +| dn_seed_config_node | Address of the ConfigNode for registering and joining the cluster. (e.g.,`cn_internal_address:cn_internal_port`) | 127.0.0.1:10710 | Use `cn_internal_address:cn_internal_port` | This parameter cannot be modified after the first startup. | -Open the DataNode configuration file (./conf/iotdb-system. properties file) and set the following parameters: +### 3、Start ConfigNode -| **Configuration** | **Description** | **Default** | **Recommended value** | **Note** | -| :------------------------------ | :----------------------------------------------------------- | :-------------- | :----------------------------------------------------------- | :--------------------------------------- | -| dn_rpc_address | The address of the client RPC service | 0.0.0.0 | The IPV4 address or host name of the server where it is located, and it is recommended to use host name | 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 | +Navigate to the `sbin` directory and start ConfigNode: -> ❗️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 +```Bash +./sbin/start-confignode.sh -d # The "-d" flag starts the process in the background. +``` -### 3、Start ConfigNode + If the startup fails, refer to the [**Common Problem**](#Common Problem) section below for troubleshooting. -Enter the sbin directory of iotdb and start confignode +### 4、Start DataNode -```shell -./start-confignode.sh -d #The "- d" parameter will start in the background -``` -If the startup fails, please refer to [Common Questions](#common-questions). +Navigate to the `sbin` directory of IoTDB and start the DataNode: -### 4、Activate Database +````shell +./sbin/start-datanode.sh -d # The "-d" flag starts the process in the background. +```` -#### Method 1: Activate file copy activation +### 5、Activate Database -- 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; +#### Option 1: File-Based Activation -#### Method 2: Activate Script Activation +1. Start both the ConfigNode and DataNode. +2. Navigate to the `activation` folder and copy the `system_info` file. +3. Send the `system_info` file to the Timecho team. +4. Place the license file provided by the Timecho team into the corresponding `activation` folder for each node. -- Obtain the required machine code for activation, enter the sbin directory of the installation directory, and execute the activation script: +#### Option 2: Command-Based Activation -```shell - cd sbin -./start-activate.sh -``` +1. Enter the IoTDB CLI. + +- **For Table Model**: -- The following information is displayed. Please copy the machine code (i.e. the string of characters) to the Timecho staff: +```SQL +# For Linux or macOS +./start-cli.sh -sql_dialect table -```shell -Please copy the system_info's content and send it to Timecho: -01-KU5LDFFN-PNBEHDRH -Please enter license: +# For Windows +./start-cli.bat -sql_dialect table ``` -- Enter the activation code returned by the staff into the previous command line prompt 'Please enter license:', as shown below: +- **For Tree Model**: -```shell -Please enter license: -JJw+MmF+AtexsfgNGOFgTm83Bxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxm6pF+APW1CiXLTSijK9Qh3nsLgzrW8OJPh26Vl6ljKUpCvpTiw== -License has been stored to sbin/../activation/license -Import completed. Please start cluster and excute 'show cluster' to verify activation status +```SQL +# For Linux or macOS +./start-cli.sh + +# For Windows +./start-cli.bat ``` -### 5、Start DataNode +2. Run the following command to retrieve the machine code required for activation: + + ```Bash + show system info + ``` -Enter the sbin directory of iotdb and start datanode: + **Note**: Activation is currently supported only in the Tree Model. -```shell -cd sbin -./start-datanode.sh -d # The "- d" parameter will start in the background -``` +3. Copy the returned machine code (displayed as a green string) and send it to the Timecho team: -### 6、Verify Deployment +```Bash ++--------------------------------------------------------------+ +| SystemInfo| ++--------------------------------------------------------------+ +| 01-TE5NLES4-UDDWCMYE| ++--------------------------------------------------------------+ +Total line number = 1 +It costs 0.030s +``` -Can be executed directly/ Cli startup script in sbin directory: +4. Enter the activation code provided by the Timecho team in the CLI using the following format. Wrap the activation code in single quotes ('): -```shell -./start-cli.sh -h ip(local IP or domain name) -p port(6667) +```Bash +IoTDB> activate '01-D4EYQGPZ-EAUJJODW-NUKRDR6F-TUQS3B75-EDZFLK3A-6BOKJFFZ-ALDHOMN7-NB2E4BHI-7ZKGFVK6-GCIFXA4T-UG3XJTTD-SHJV6F2P-Q27B4OMJ-R47ZDIM3-UUASUXG2-OQXGVZCO-MMYKICZU-TWFQYYAO-ZOAGOKJA-NYHQTA5U-EWAR4EP5-MRC6R2CI-PKUTKRCT-7UDGRH3F-7BYV4P5D-6KKIA===' ``` -After successful startup, the following interface will appear displaying successful installation of IOTDB. +### 6、Verify Activation -![](https://alioss.timecho.com/docs/img/%E5%90%AF%E5%8A%A8%E6%88%90%E5%8A%9F.png) +Check the `ClusterActivationStatus` field. If it shows `ACTIVATED`, the database has been successfully activated. -After the installation success interface appears, continue to check if the activation is successful and use the `show cluster`command +![](https://alioss.timecho.com/docs/img/%E5%8D%95%E6%9C%BA-%E9%AA%8C%E8%AF%81.png) -When you see the display "Activated" on the far right, it indicates successful activation +## Common Problem -![](https://alioss.timecho.com/docs/img/show%20cluster.png) +1. Activation Fails Repeatedly + 1. Use the `ls -al` command to verify that the ownership of the installation directory matches the current user. + 2. Check the ownership of all files in the `./activation` directory to ensure they belong to the current user. +2. ConfigNode Fails to Start + 1. Review the startup logs to check if any parameters, which cannot be modified after the first startup, were changed. + 2. Check the logs for any other errors. If unresolved, contact technical support for assistance. + 3. If the deployment is fresh or data can be discarded, clean the environment and redeploy using the following steps: + **Clean the Environment** -> 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. +1. Stop all ConfigNode and DataNode processes: -## Common Problem -1. Multiple prompts indicating activation failure during deployment process - - Use the `ls -al` command: Use the `ls -al` command to check if the owner information of the installation package root directory is the current user. - - Check activation directory: Check all files in the `./activation` directory and whether the owner information is the current user. +```Bash +sbin/stop-standalone.sh +``` -2. Confignode failed to start +2. Check for any remaining processes: - Step 1: Please check the startup log to see if any parameters that cannot be changed after the first startup have been modified. +```Bash +jps +# or +ps -ef | grep iotdb +``` - 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. +3. If processes remain, terminate them manually: - 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. +```Bash +kill -9 - Step 4: Clean up the environment: +#For systems with a single IoTDB instance, you can clean up residual processes with: +ps -ef | grep iotdb | grep -v grep | tr -s ' ' ' ' | cut -d ' ' -f2 | xargs kill -9 +``` - a. Terminate all ConfigNode Node and DataNode processes. - ```Bash - # 1. Stop the ConfigNode and DataNode services - sbin/stop-standalone.sh +4. Delete the `data` and `logs` directories: - # 2. Check for any remaining processes - jps - # Or - ps -ef|gerp iotdb +```Bash +cd /data/iotdb +rm -rf data logs +``` - # 3. If there are any remaining processes, manually kill the - kill -9 - # 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. - - ```Bash - cd /data/iotdb - rm -rf data logs - ``` \ No newline at end of file +## Appendix + +### ConfigNode Parameters + +| Parameter | Description | **Is it required** | +| :-------- | :---------------------------------------------------------- | :----------------- | +| -d | Starts the process in daemon mode (runs in the background). | No | + +### DataNode Parameters + +| Parameter | Description | Required | +| :-------- | :----------------------------------------------------------- | :------- | +| -v | Displays version information. | No | +| -f | Runs the script in the foreground without backgrounding it. | No | +| -d | Starts the process in daemon mode (runs in the background). | No | +| -p | Specifies a file to store the process ID for process management. | No | +| -c | Specifies the path to the configuration folder; the script loads configuration files from this location. | No | +| -g | Prints detailed garbage collection (GC) information. | No | +| -H | Specifies the path for the Java heap dump file, used during JVM memory overflow. | No | +| -E | Specifies the file for JVM error logs. | No | +| -D | Defines system properties in the format `key=value`. | No | +| -X | Passes `-XX` options directly to the JVM. | No | +| -h | Displays the help instructions. | No | \ No newline at end of file