修改dn_target_config_node_list为dn_seed_config_node;增加修改内存配置的说明

apache · Jan 2, 2024 · a5fec67 · a5fec67
1 parent f114f5a
commit a5fec67
Show file tree

Hide file tree

Showing 4 changed files with 62 additions and 48 deletions.
diff --git a/src/UserGuide/Master/Deployment-and-Maintenance/Docker-Install.md b/src/UserGuide/Master/Deployment-and-Maintenance/Docker-Install.md
@@ -28,7 +28,7 @@ Add environments of docker to update the configurations of Apache IoTDB.
 
 ```shell
 # get IoTDB official image
-docker pull apache/iotdb:1.1.0-standalone
+docker pull apache/iotdb:1.3.0-standalone
 # create docker bridge network
 docker network create --driver=bridge --subnet=172.18.0.0/16 --gateway=172.18.0.1 iotdb
 # create docker container
@@ -38,17 +38,17 @@ docker run -d --name iotdb-service \
               --ip 172.18.0.6 \
               -p 6667:6667 \
               -e cn_internal_address=iotdb-service \
-              -e cn_target_config_node_list=iotdb-service:10710 \
+              -e cn_seed_config_node=iotdb-service:10710 \
               -e cn_internal_port=10710 \
               -e cn_consensus_port=10720 \
               -e dn_rpc_address=iotdb-service \
               -e dn_internal_address=iotdb-service \
-              -e dn_target_config_node_list=iotdb-service:10710 \
+              -e dn_seed_config_node=iotdb-service:10710 \
               -e dn_mpp_data_exchange_port=10740 \
               -e dn_schema_region_consensus_port=10750 \
               -e dn_data_region_consensus_port=10760 \
               -e dn_rpc_port=6667 \
-              apache/iotdb:1.1.0-standalone              
+              apache/iotdb:1.3.0-standalone              
 # execute SQL
 docker exec -ti iotdb-service /iotdb/sbin/start-cli.sh -h iotdb-service
 ```
@@ -67,7 +67,7 @@ Notice：The confignode service would fail when restarting this container if the
 version: "3"
 services:
   iotdb-service:
-    image: apache/iotdb:1.1.0-standalone
+    image: apache/iotdb:1.3.0-standalone
     hostname: iotdb-service
     container_name: iotdb-service
     ports:
@@ -76,14 +76,14 @@ services:
       - cn_internal_address=iotdb-service
       - cn_internal_port=10710
       - cn_consensus_port=10720
-      - cn_target_config_node_list=iotdb-service:10710
+      - cn_seed_config_node=iotdb-service:10710
       - dn_rpc_address=iotdb-service
       - dn_internal_address=iotdb-service
       - dn_rpc_port=6667
       - dn_mpp_data_exchange_port=10740
       - dn_schema_region_consensus_port=10750
       - dn_data_region_consensus_port=10760
-      - dn_target_config_node_list=iotdb-service:10710
+      - dn_seed_config_node=iotdb-service:10710
     volumes:
         - ./data:/iotdb/data
         - ./logs:/iotdb/logs
@@ -96,6 +96,10 @@ networks:
     external: true
 ```
 
+If you'd like to limit the memory of IoTDB, follow these steps:
+1. Add another configuration of volumes: `./iotdb-conf:/iotdb/conf` and then start the IoTDB docker container. Thus, there are some configuration files in directory of iotdb-conf.
+2. Change the memory configurations in confignode-env.sh and datanode-env.sh of iotdb-conf, and then restart the IoTDB docker container again.
+
 ## deploy cluster
 
 Until now, we support host and overlay networks but haven't supported bridge networks on multiple computers.
@@ -108,11 +112,11 @@ Here is the docker-compose file of iotdb-2, as the sample:
 version: "3"
 services:
   iotdb-confignode:
-    image: apache/iotdb:1.1.0-confignode
+    image: apache/iotdb:1.3.0-confignode
     container_name: iotdb-confignode
     environment:
       - cn_internal_address=iotdb-2
-      - cn_target_config_node_list=iotdb-1:10710
+      - cn_seed_config_node=iotdb-1:10710
       - cn_internal_port=10710
       - cn_consensus_port=10720
       - schema_replication_factor=3
@@ -127,12 +131,12 @@ services:
     network_mode: "host"
 
   iotdb-datanode:
-    image: apache/iotdb:1.1.0-datanode
+    image: apache/iotdb:1.3.0-datanode
     container_name: iotdb-datanode
     environment:
       - dn_rpc_address=iotdb-2
       - dn_internal_address=iotdb-2
-      - dn_target_config_node_list=iotdb-1:10710
+      - dn_seed_config_node=iotdb-1:10710
       - data_replication_factor=3
       - dn_rpc_port=6667
       - dn_mpp_data_exchange_port=10740
@@ -151,7 +155,7 @@ services:
 
 Notice：
 
-1. The `dn_target_config_node_list` of three nodes must the same and it is the first starting node of `iotdb-1` with the cn_internal_port of 10710。
+1. The `cn_seed_config_node` and `dn_seed_config_node` of three nodes must the same and they are the first starting node of `iotdb-1` with the `cn_internal_port` of 10710。
 2. In this docker-compose file，`iotdb-2` should be replace with the real IP or hostname of each node to generate docker compose files in the other nodes.
 3. The services would talk with each other, so they need map the /etc/hosts file or add the `extra_hosts` to the docker compose file.
 4. We must start the IoTDB services of `iotdb-1` first at the first time of starting.

diff --git a/src/UserGuide/V1.3.x/Deployment-and-Maintenance/Docker-Install.md b/src/UserGuide/V1.3.x/Deployment-and-Maintenance/Docker-Install.md
@@ -28,7 +28,7 @@ Add environments of docker to update the configurations of Apache IoTDB.
 
 ```shell
 # get IoTDB official image
-docker pull apache/iotdb:1.1.0-standalone
+docker pull apache/iotdb:1.3.0-standalone
 # create docker bridge network
 docker network create --driver=bridge --subnet=172.18.0.0/16 --gateway=172.18.0.1 iotdb
 # create docker container
@@ -38,17 +38,17 @@ docker run -d --name iotdb-service \
               --ip 172.18.0.6 \
               -p 6667:6667 \
               -e cn_internal_address=iotdb-service \
-              -e cn_target_config_node_list=iotdb-service:10710 \
+              -e cn_seed_config_node=iotdb-service:10710 \
               -e cn_internal_port=10710 \
               -e cn_consensus_port=10720 \
               -e dn_rpc_address=iotdb-service \
               -e dn_internal_address=iotdb-service \
-              -e dn_target_config_node_list=iotdb-service:10710 \
+              -e dn_seed_config_node=iotdb-service:10710 \
               -e dn_mpp_data_exchange_port=10740 \
               -e dn_schema_region_consensus_port=10750 \
               -e dn_data_region_consensus_port=10760 \
               -e dn_rpc_port=6667 \
-              apache/iotdb:1.1.0-standalone              
+              apache/iotdb:1.3.0-standalone              
 # execute SQL
 docker exec -ti iotdb-service /iotdb/sbin/start-cli.sh -h iotdb-service
 ```
@@ -67,7 +67,7 @@ Notice：The confignode service would fail when restarting this container if the
 version: "3"
 services:
   iotdb-service:
-    image: apache/iotdb:1.1.0-standalone
+    image: apache/iotdb:1.3.0-standalone
     hostname: iotdb-service
     container_name: iotdb-service
     ports:
@@ -76,14 +76,14 @@ services:
       - cn_internal_address=iotdb-service
       - cn_internal_port=10710
       - cn_consensus_port=10720
-      - cn_target_config_node_list=iotdb-service:10710
+      - cn_seed_config_node=iotdb-service:10710
       - dn_rpc_address=iotdb-service
       - dn_internal_address=iotdb-service
       - dn_rpc_port=6667
       - dn_mpp_data_exchange_port=10740
       - dn_schema_region_consensus_port=10750
       - dn_data_region_consensus_port=10760
-      - dn_target_config_node_list=iotdb-service:10710
+      - dn_seed_config_node=iotdb-service:10710
     volumes:
         - ./data:/iotdb/data
         - ./logs:/iotdb/logs
@@ -96,6 +96,10 @@ networks:
     external: true
 ```
 
+If you'd like to limit the memory of IoTDB, follow these steps:
+1. Add another configuration of volumes: `./iotdb-conf:/iotdb/conf` and then start the IoTDB docker container. Thus, there are some configuration files in directory of iotdb-conf.
+2. Change the memory configurations in confignode-env.sh and datanode-env.sh of iotdb-conf, and then restart the IoTDB docker container again.
+
 ## deploy cluster
 
 Until now, we support host and overlay networks but haven't supported bridge networks on multiple computers.
@@ -108,11 +112,11 @@ Here is the docker-compose file of iotdb-2, as the sample:
 version: "3"
 services:
   iotdb-confignode:
-    image: apache/iotdb:1.1.0-confignode
+    image: apache/iotdb:1.3.0-confignode
     container_name: iotdb-confignode
     environment:
       - cn_internal_address=iotdb-2
-      - cn_target_config_node_list=iotdb-1:10710
+      - cn_seed_config_node=iotdb-1:10710
       - cn_internal_port=10710
       - cn_consensus_port=10720
       - schema_replication_factor=3
@@ -127,12 +131,12 @@ services:
     network_mode: "host"
 
   iotdb-datanode:
-    image: apache/iotdb:1.1.0-datanode
+    image: apache/iotdb:1.3.0-datanode
     container_name: iotdb-datanode
     environment:
       - dn_rpc_address=iotdb-2
       - dn_internal_address=iotdb-2
-      - dn_target_config_node_list=iotdb-1:10710
+      - dn_seed_config_node=iotdb-1:10710
       - data_replication_factor=3
       - dn_rpc_port=6667
       - dn_mpp_data_exchange_port=10740
@@ -151,7 +155,7 @@ services:
 
 Notice：
 
-1. The `dn_target_config_node_list` of three nodes must the same and it is the first starting node of `iotdb-1` with the cn_internal_port of 10710。
+1. The `cn_seed_config_node` and `dn_seed_config_node` of three nodes must the same and they are the first starting node of `iotdb-1` with the `cn_internal_port` of 10710。
 2. In this docker-compose file，`iotdb-2` should be replace with the real IP or hostname of each node to generate docker compose files in the other nodes.
 3. The services would talk with each other, so they need map the /etc/hosts file or add the `extra_hosts` to the docker compose file.
 4. We must start the IoTDB services of `iotdb-1` first at the first time of starting.

diff --git a/src/zh/UserGuide/Master/Deployment-and-Maintenance/Docker-Install.md b/src/zh/UserGuide/Master/Deployment-and-Maintenance/Docker-Install.md
@@ -28,7 +28,7 @@ Apache IoTDB 的配置项以环境变量形式添加到容器内。
 
 ```shell
 # 获取镜像
-docker pull apache/iotdb:1.1.0-standalone
+docker pull apache/iotdb:1.3.0-standalone
 # 创建 docker bridge 网络
 docker network create --driver=bridge --subnet=172.18.0.0/16 --gateway=172.18.0.1 iotdb
 # 创建 docker 容器
@@ -39,17 +39,17 @@ docker run -d --name iotdb-service \
               --ip 172.18.0.6 \
               -p 6667:6667 \
               -e cn_internal_address=iotdb-service \
-              -e cn_target_config_node_list=iotdb-service:10710 \
+              -e cn_seed_config_node=iotdb-service:10710 \
               -e cn_internal_port=10710 \
               -e cn_consensus_port=10720 \
               -e dn_rpc_address=iotdb-service \
               -e dn_internal_address=iotdb-service \
-              -e dn_target_config_node_list=iotdb-service:10710 \
+              -e dn_seed_config_node=iotdb-service:10710 \
               -e dn_mpp_data_exchange_port=10740 \
               -e dn_schema_region_consensus_port=10750 \
               -e dn_data_region_consensus_port=10760 \
               -e dn_rpc_port=6667 \
-              apache/iotdb:1.1.0-standalone              
+              apache/iotdb:1.3.0-standalone              
 # 尝试使用命令行执行SQL
 docker exec -ti iotdb-service /iotdb/sbin/start-cli.sh -h iotdb-service
 ```
@@ -66,7 +66,7 @@ $IOTDB_HOME/sbin/start-cli.sh -h <主机IP/hostname> -p 6667
 version: "3"
 services:
   iotdb-service:
-    image: apache/iotdb:1.1.0-standalone
+    image: apache/iotdb:1.3.0-standalone
     hostname: iotdb-service
     container_name: iotdb-service
     ports:
@@ -75,14 +75,14 @@ services:
       - cn_internal_address=iotdb-service
       - cn_internal_port=10710
       - cn_consensus_port=10720
-      - cn_target_config_node_list=iotdb-service:10710
+      - cn_seed_config_node=iotdb-service:10710
       - dn_rpc_address=iotdb-service
       - dn_internal_address=iotdb-service
       - dn_rpc_port=6667
       - dn_mpp_data_exchange_port=10740
       - dn_schema_region_consensus_port=10750
       - dn_data_region_consensus_port=10760
-      - dn_target_config_node_list=iotdb-service:10710
+      - dn_seed_config_node=iotdb-service:10710
     volumes:
         - ./data:/iotdb/data
         - ./logs:/iotdb/logs
@@ -94,6 +94,9 @@ networks:
   iotdb:
     external: true
 ```
+如果需要修改内存配置，需要将 IoTDB 的配置文件夹 conf 映射出来。
+1. 在 volumes 配置内增加一个映射 `./iotdb-conf:/iotdb/conf` 启动 docker 容器。执行后，iotdb-conf 目录下有了 IoTDB 的所有配置。
+2. 修改目录 iotdb-conf 下的 confignode-env.sh 和 datanode-env.sh 内的相关配置。再次启动 docker 容器。
 
 ## docker镜像安装（集群版）
 
@@ -106,11 +109,11 @@ networks:
 version: "3"
 services:
   iotdb-confignode:
-    image: apache/iotdb:1.1.0-confignode
+    image: apache/iotdb:1.3.0-confignode
     container_name: iotdb-confignode
     environment:
       - cn_internal_address=iotdb-2
-      - cn_target_config_node_list=iotdb-1:10710
+      - cn_seed_config_node=iotdb-1:10710
       - schema_replication_factor=3
       - cn_internal_port=10710
       - cn_consensus_port=10720
@@ -125,12 +128,12 @@ services:
     network_mode: "host"
 
   iotdb-datanode:
-    image: apache/iotdb:1.1.0-datanode
+    image: apache/iotdb:1.3.0-datanode
     container_name: iotdb-datanode
     environment:
       - dn_rpc_address=iotdb-2
       - dn_internal_address=iotdb-2
-      - dn_target_config_node_list=iotdb-1:10710
+      - dn_seed_config_node=iotdb-1:10710
       - data_replication_factor=3
       - dn_rpc_port=6667
       - dn_mpp_data_exchange_port=10740
@@ -149,7 +152,7 @@ services:
 
 注意：
 
-1. `dn_target_config_node_list`所有节点配置一样，需要配置第一个启动的节点，这里为`iotdb-1`。
+1. `cn_seed_config_node`和`dn_seed_config_node`所有节点配置一样，需要配置第一个启动的节点，这里为`iotdb-1`。
 2. 上面docker-compose文件中，`iotdb-2`需要替换为每个节点的 hostname、域名或者IP地址。
 3. 需要映射`/etc/hosts`，文件内配置了 iotdb-1、iotdb-2、iotdb-3 与IP的映射。或者可以在 docker-compose 文件中增加 `extra_hosts` 配置。
 4. 首次启动时，必须首先启动 `iotdb-1`。