This is an automated email from the ASF dual-hosted git repository.
haonan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iotdb.git
The following commit(s) were added to refs/heads/master by this push:
new c5dd57e66a Add cluster setup command in UserGuide (#6502)
c5dd57e66a is described below
commit c5dd57e66aeca31f36d4db81050e5e5c5b643077
Author: Jialin Qiao <[email protected]>
AuthorDate: Wed Jun 29 11:52:17 2022 +0800
Add cluster setup command in UserGuide (#6502)
Co-authored-by: Haonan <[email protected]>
---
docs/UserGuide/Cluster/Cluster-Setup.md | 50 ++++++++++++++++++++++++++++--
docs/zh/UserGuide/Cluster/Cluster-Setup.md | 49 +++++++++++++++++++++++++++--
site/src/main/.vuepress/config.js | 8 ++---
3 files changed, 98 insertions(+), 9 deletions(-)
diff --git a/docs/UserGuide/Cluster/Cluster-Setup.md
b/docs/UserGuide/Cluster/Cluster-Setup.md
index e6b3ef0d20..f3a7b20b6e 100644
--- a/docs/UserGuide/Cluster/Cluster-Setup.md
+++ b/docs/UserGuide/Cluster/Cluster-Setup.md
@@ -82,7 +82,7 @@ The total process are three steps:
### Start the first ConfigNode
-Important parameters in iotdb-confignode.properties:
+Please set the important parameters in iotdb-confignode.properties:
| **Configuration** | **Description** |
| -------- | -------------------------------------------- |
@@ -95,17 +95,33 @@ Important parameters in iotdb-confignode.properties:
| schema\_replication\_factor | Schema replication factor, no more than
DataNode number |
| schema\_region\_consensus\_protocol\_class | Consensus protocol of schema
replicas |
+Start on Linux
+```
+# Foreground
+./confignode/sbin/start-confignode.sh
+
+# Background
+nohup ./confignode/sbin/start-confignode.sh >/dev/null 2>&1 &
+```
+
+Start on Windows
+```
+confignode\sbin\start-confignode.bat
+```
+
More details [ConfigNode
Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/ConfigNode-Config-Manual.html)
### Add ConfigNode (Optional)
This will add the replication factor of ConfigNode, except for the port
couldn't conflict, make sure other configurations are the same with existing
ConfigNode in Cluster.
+The adding ConfigNode also use the start-confignode.sh/bat.
+
### Start DataNode
You could add any number of DataNode.
-Important parameters in iotdb-datanode.properties
+Please set the important parameters in iotdb-datanode.properties
| **Configuration** | **Description** |
| -------- | -------------------------------------------- |
@@ -118,4 +134,32 @@ Important parameters in iotdb-datanode.properties
| schema\_region\_consensus\_port | Schema replicas communication port for
consensus |
| target\_config\_nodes | Running ConfigNode of the Cluster |
-More details [DataNode
Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/DataNode-Config-Manual.html)
\ No newline at end of file
+Start on Linux
+```
+# Foreground
+./datanode/sbin/start-datanode.sh
+
+# Background
+nohup ./datanode/sbin/start-datanode.sh >/dev/null 2>&1 &
+```
+
+Start on Windows
+```
+datanode\sbin\start-datanode.bat
+```
+
+More details [DataNode
Configurations](https://iotdb.apache.org/UserGuide/Master/Reference/DataNode-Config-Manual.html)
+
+### Start Cli
+
+Cli is in datanode/sbin folder
+
+Start on Linux
+```
+./datanode/sbin/start-cli.sh
+```
+
+Start on Windows
+```
+datanode\sbin\start-cli.bat
+```
\ No newline at end of file
diff --git a/docs/zh/UserGuide/Cluster/Cluster-Setup.md
b/docs/zh/UserGuide/Cluster/Cluster-Setup.md
index 625bbb28fc..b82cf51f88 100644
--- a/docs/zh/UserGuide/Cluster/Cluster-Setup.md
+++ b/docs/zh/UserGuide/Cluster/Cluster-Setup.md
@@ -82,7 +82,7 @@ mvn clean package -pl distribution -am -DskipTests
### 启动种子 ConfigNode
-启动种子 ConfigNode，iotdb-confignode.properties 中的重要配置如下
+对 confignode/conf/iotdb-confignode.properties 中的重要参数进行配置：
| **配置项** | **说明** |
| -------- | -------------------------------------------- |
@@ -95,12 +95,28 @@ mvn clean package -pl distribution -am -DskipTests
| schema\_replication\_factor | 元数据副本数，DataNode 数量不应少于此数目 |
| schema\_region\_consensus\_protocol\_class | 元数据副本组的共识协议 |
+Linux 启动方式
+```
+# 前台启动
+./confignode/sbin/start-confignode.sh
+
+# 后台启动
+nohup ./confignode/sbin/start-confignode.sh >/dev/null 2>&1 &
+```
+
+Windows 启动方式
+```
+confignode\sbin\start-confignode.bat
+```
+
具体参考
[ConfigNode配置参数](https://iotdb.apache.org/zh/UserGuide/Master/Reference/ConfigNode-Config-Manual.html)
### 增加 ConfigNode（可选）
增加 ConfigNode 是一个扩容操作，除端口不能冲突外，其他参数需要与集群已有的 ConfigNode 保持一致，并将 config\_nodes
配置为集群已有节点。
+启动方式同上。
+
### 增加 DataNode
可以像集群中添加任意个 DataNode。
@@ -118,4 +134,33 @@ iotdb-datanode.properties 中的重要配置如下
| schema\_region\_consensus\_port | DataNode 的元数据副本间共识协议通信的端口 |
| target\_config\_nodes | 集群中正在运行的 ConfigNode 地址 |
-具体参考
[DataNode配置参数](https://iotdb.apache.org/zh/UserGuide/Master/Reference/DataNode-Config-Manual.html)
\ No newline at end of file
+
+Linux 启动方式
+```
+# 前台启动
+./datanode/sbin/start-datanode.sh
+
+# 后台启动
+nohup ./datanode/sbin/start-datanode.sh >/dev/null 2>&1 &
+```
+
+Windows 启动方式
+```
+datanode\sbin\start-datanode.bat
+```
+
+具体参考
[DataNode配置参数](https://iotdb.apache.org/zh/UserGuide/Master/Reference/DataNode-Config-Manual.html)
+
+### 启动 Cli
+
+Cli 启动脚本在 datanode/sbin 目录
+
+Linux 启动方式
+```
+./datanode/sbin/start-cli.sh
+```
+
+Windows 启动方式
+```
+datanode\sbin\start-cli.bat
+```
\ No newline at end of file
diff --git a/site/src/main/.vuepress/config.js
b/site/src/main/.vuepress/config.js
index 7687757aa0..17227862ec 100644
--- a/site/src/main/.vuepress/config.js
+++ b/site/src/main/.vuepress/config.js
@@ -971,7 +971,7 @@ var config = {
]
},
{
- title: 'Cluster Setup',
+ title: 'Cluster',
children: [
['Cluster/Cluster-Concept','Cluster Concept'],
['Cluster/Cluster-Setup','Cluster Setup']
@@ -1895,10 +1895,10 @@ var config = {
]
},
{
- title: '集群搭建',
+ title: '分布式',
children: [
-
['Cluster/Cluster-Concept','集群基本概念'],
-
['Cluster/Cluster-Setup','集群搭建']
+
['Cluster/Cluster-Concept','基本概念'],
+
['Cluster/Cluster-Setup','分布式部署']
]
},
{
