You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@iotdb.apache.org by GitBox <gi...@apache.org> on 2022/11/22 12:04:28 UTC

[GitHub] [iotdb] CRZbulabula commented on a diff in pull request #8091: [IOTDB-5012] Update Deployment and User doc for cluster V1.0

CRZbulabula commented on code in PR #8091:
URL: https://github.com/apache/iotdb/pull/8091#discussion_r1029241502


##########
docs/zh/UserGuide/Maintenance-Tools/Maintenance-Command.md:
##########
@@ -146,44 +146,39 @@ Msg: The statement is executed successfully.
 IoTDB> create timeseries root.ln.d1.s1 with datatype=BOOLEAN,encoding=PLAIN
 Msg: The statement is executed successfully.
 IoTDB> show regions
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
-|RegionId|        Type|Status|Database|Series Slots|Time Slots|DataNodeId|     Host|RpcPort|  Role|
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
-|       0|SchemaRegion|    Up|      root.sg|           2|         0|         1|127.0.0.1|   6667|Leader|
-|       1|SchemaRegion|    Up|      root.ln|           1|         0|         2|127.0.0.1|   6668|Leader|
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
++--------+------------+------+--------+------------+----------+----------+----------+-------+------+
+|RegionId|        Type|Status|Database|Series Slots|Time Slots|DataNodeId|RpcAddress|RpcPort|  Role|
++--------+------------+------+--------+------------+----------+----------+----------+-------+------+
+|       0|SchemaRegion|    Up| root.sg|           2|         0|         1| 127.0.0.1|   6667|Leader|
+|       1|SchemaRegion|    Up| root.ln|           1|         0|         2| 127.0.0.1|   6668|Leader|
++--------+------------+------+--------+------------+----------+----------+----------+-------+------+
 Total line number = 2
 It costs 0.013s
 
 IoTDB> show datanodes
-+------+-------+---------+-------+-------------+---------------+
-|NodeID| Status|     Host|RpcPort|DataRegionNum|SchemaRegionNum|
-+------+-------+---------+-------+-------------+---------------+
-|     1|Running|127.0.0.1|   6667|            0|              1|
-|     2|Running|127.0.0.1|   6668|            0|              1|
-+------+-------+---------+-------+-------------+---------------+
+
 Total line number = 2
 It costs 0.007s
 
 IoTDB> insert into root.ln.d1(timestamp,s1) values(1,true)
 Msg: The statement is executed successfully.
 IoTDB> show regions
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
-|RegionId|        Type|Status|Database|Series Slots|Time Slots|DataNodeId|     Host|RpcPort|  Role|
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
-|       0|SchemaRegion|    Up|      root.sg|           2|         0|         1|127.0.0.1|   6667|Leader|
-|       1|SchemaRegion|    Up|      root.ln|           1|         0|         2|127.0.0.1|   6668|Leader|
-|       2|  DataRegion|    Up|      root.ln|           1|         1|         1|127.0.0.1|   6667|Leader|
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
++--------+------------+------+--------+------------+----------+----------+----------+-------+------+
+|RegionId|        Type|Status|Database|Series Slots|Time Slots|DataNodeId|RpcAddress|RpcPort|  Role|
++--------+------------+------+--------+------------+----------+----------+----------+-------+------+
+|       0|SchemaRegion|    Up| root.sg|           2|         0|         1| 127.0.0.1|   6667|Leader|
+|       1|SchemaRegion|    Up| root.ln|           1|         0|         2| 127.0.0.1|   6668|Leader|
+|       2|  DataRegion|    Up| root.ln|           1|         1|         1| 127.0.0.1|   6667|Leader|
++--------+------------+------+--------+------------+----------+----------+----------+-------+------+

Review Comment:
   This example can be moved into SHOW REGION?



##########
docs/zh/UserGuide/Cluster/Cluster-Setup.md:
##########
@@ -61,13 +61,16 @@ mvn clean package -pl distribution -am -DskipTests
 
 ## 安装包说明
 
-| **目录**                  | **说明**                                  |
-|-------------------------|-----------------------------------------|
-| confignode              | 包含 ConfigNode 的启停移除脚本、配置文件、日志、数据        |
-| datanode                | 包含 DataNode 的启停移除脚本、配置文件、日志、数据;Cli的启动脚本 |
-| grafana-metrics-example | Grafana 监控界面模板                          |
-| lib                     | 库文件目录                                   |
-| tools                   | 系统工具目录                                  |
+| **目录**                  | **说明**                                               |
+|-------------------------|------------------------------------------------------|
+| conf                    | 配置文件目录,包含 ConfigNode 和 DataNode 的配置文件。               |
+| data                    | 数据文件目录,包含 ConfigNode 和 DataNode 的数据文件。               |
+| grafana-metrics-example | Grafana 监控界面模板                                       |
+| lib                     | 库文件目录                                                |
+| licenses                | 证书文件目录                                               |
+| logs                    | 日志文件目录,包含 ConfigNode 和 DataNode 的日志文件。               |
+| sbin                    | 脚本目录,包含 ConfigNode 和 DataNode 的启停移除脚本目录,以及 Cli 的启动脚本 |
+| tools                   | 系统工具目录                                               |

Review Comment:
   ```suggestion
   | **目录**                  | **说明**                                               |
   |-------------------------|------------------------------------------------------|
   | conf                    | 配置文件目录,包含 ConfigNode 和 DataNode 的配置文件               |
   | data                    | 数据文件目录,包含 ConfigNode 和 DataNode 的数据文件               |
   | grafana-metrics-example | Grafana 监控界面模板                                       |
   | lib                     | 库文件目录                                                |
   | licenses                | 证书文件目录                                               |
   | logs                    | 日志文件目录,包含 ConfigNode 和 DataNode 的日志文件               |
   | sbin                    | 脚本目录,包含 ConfigNode 和 DataNode 的启停移除脚本目录,以及 Cli 的启动脚本 |
   | tools                   | 系统工具目录                                               |
   ```



##########
docs/zh/UserGuide/Maintenance-Tools/Maintenance-Command.md:
##########
@@ -146,44 +146,39 @@ Msg: The statement is executed successfully.
 IoTDB> create timeseries root.ln.d1.s1 with datatype=BOOLEAN,encoding=PLAIN
 Msg: The statement is executed successfully.
 IoTDB> show regions
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
-|RegionId|        Type|Status|Database|Series Slots|Time Slots|DataNodeId|     Host|RpcPort|  Role|
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
-|       0|SchemaRegion|    Up|      root.sg|           2|         0|         1|127.0.0.1|   6667|Leader|
-|       1|SchemaRegion|    Up|      root.ln|           1|         0|         2|127.0.0.1|   6668|Leader|
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
++--------+------------+------+--------+------------+----------+----------+----------+-------+------+
+|RegionId|        Type|Status|Database|Series Slots|Time Slots|DataNodeId|RpcAddress|RpcPort|  Role|
++--------+------------+------+--------+------------+----------+----------+----------+-------+------+
+|       0|SchemaRegion|    Up| root.sg|           2|         0|         1| 127.0.0.1|   6667|Leader|
+|       1|SchemaRegion|    Up| root.ln|           1|         0|         2| 127.0.0.1|   6668|Leader|
++--------+------------+------+--------+------------+----------+----------+----------+-------+------+
 Total line number = 2
 It costs 0.013s
 
 IoTDB> show datanodes
-+------+-------+---------+-------+-------------+---------------+
-|NodeID| Status|     Host|RpcPort|DataRegionNum|SchemaRegionNum|
-+------+-------+---------+-------+-------------+---------------+
-|     1|Running|127.0.0.1|   6667|            0|              1|
-|     2|Running|127.0.0.1|   6668|            0|              1|
-+------+-------+---------+-------+-------------+---------------+
+
 Total line number = 2
 It costs 0.007s

Review Comment:
   These lines should be all deleted or filled~



##########
docs/zh/UserGuide/Cluster/Cluster-Concept.md:
##########
@@ -35,6 +35,21 @@ DataNode 是集群的数据节点,管理多个数据分片、元数据分片
 
 Client 只能通过 DataNode 进行数据读写。
 
+### 名词解释
+
+| 名词                | 类型            | 解释                                   |
+|:------------------|:--------------|:-------------------------------------|
+| ConfigNode        | 节点角色          | 集群配置节点,管理集群节点信息、管理分区信息               |
+| DataNode          | 节点角色          | 数据节点,管理数据、元数据                        |
+| Database          | 元数据           | 数据库,不同数据库的数据物理隔离                     |
+| DeviceId          | 设备名           | 元数据树中从 root 到倒数第二级的全路径表示一个设备名        |
+| SeriesSlot        | 序列分区槽         | 每个 Database会对应固定个数的序列槽,包含其中序列的元数据    |

Review Comment:
   ```suggestion
   | SeriesSlot        | 序列分区槽         | 每个 Database 会对应固定个数的序列槽,包含其中序列的元数据    |
   ```



##########
docs/zh/UserGuide/Cluster/Cluster-Concept.md:
##########
@@ -35,6 +35,21 @@ DataNode 是集群的数据节点,管理多个数据分片、元数据分片
 
 Client 只能通过 DataNode 进行数据读写。
 
+### 名词解释
+
+| 名词                | 类型            | 解释                                   |
+|:------------------|:--------------|:-------------------------------------|
+| ConfigNode        | 节点角色          | 集群配置节点,管理集群节点信息、管理分区信息               |

Review Comment:
   ```suggestion
   | ConfigNode        | 节点角色          | 配置节点,管理集群节点信息、分区信息,监控集群状态、控制负载均衡               |
   ```



##########
docs/zh/UserGuide/Maintenance-Tools/Maintenance-Command.md:
##########
@@ -146,44 +146,39 @@ Msg: The statement is executed successfully.
 IoTDB> create timeseries root.ln.d1.s1 with datatype=BOOLEAN,encoding=PLAIN
 Msg: The statement is executed successfully.
 IoTDB> show regions
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
-|RegionId|        Type|Status|Database|Series Slots|Time Slots|DataNodeId|     Host|RpcPort|  Role|
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
-|       0|SchemaRegion|    Up|      root.sg|           2|         0|         1|127.0.0.1|   6667|Leader|
-|       1|SchemaRegion|    Up|      root.ln|           1|         0|         2|127.0.0.1|   6668|Leader|
-+--------+------------+------+-------------+------------+----------+----------+---------+-------+------+
++--------+------------+------+--------+------------+----------+----------+----------+-------+------+
+|RegionId|        Type|Status|Database|Series Slots|Time Slots|DataNodeId|RpcAddress|RpcPort|  Role|
++--------+------------+------+--------+------------+----------+----------+----------+-------+------+
+|       0|SchemaRegion|    Up| root.sg|           2|         0|         1| 127.0.0.1|   6667|Leader|
+|       1|SchemaRegion|    Up| root.ln|           1|         0|         2| 127.0.0.1|   6668|Leader|
++--------+------------+------+--------+------------+----------+----------+----------+-------+------+
 Total line number = 2
 It costs 0.013s

Review Comment:
   This example can be moved to SHOW REGION?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: reviews-unsubscribe@iotdb.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org