Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix the doc of deployment guide and quick start #142

Merged
merged 1 commit into from
Jan 5, 2024
Merged

fix the doc of deployment guide and quick start #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions src/zh/UserGuide/V1.3.x/Deployment-and-Maintenance/Deployment-Guide_timecho.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Windows 系统启动命令如下：
IoTDB 集群管理工具是一款易用的运维工具（企业版工具）。旨在解决 IoTDB 分布式系统多节点的运维难题，主要包括集群部署、集群启停、弹性扩容、配置更新、数据导出等功能，从而实现对复杂数据库集群的一键式指令下发，
极大降低管理难度。本文档将说明如何用集群管理工具远程部署、配置、启动和停止 IoTDB 集群实例。

### Environmental preparation
### 环境准备

本工具为 IoTDB 企业版配套工具，您可以联系您的销售获取工具下载方式。

Expand Down Expand Up @@ -753,8 +753,8 @@ iotdbctl cluster activate default_cluster -N confignode1 -op license_path
#### 下载二进制文件

1. 打开官网[Download Page](https://iotdb.apache.org/Download/)。
2. 下载 IoTDB 1.0.0 版本的二进制文件。
3. 解压得到 apache-iotdb-1.0.0-all-bin 目录。
2. 下载 IoTDB 1.3.0 版本的二进制文件。
3. 解压得到 apache-iotdb-1.3.0-all-bin 目录。

#### 使用源码编译

Expand All @@ -764,14 +764,14 @@ iotdbctl cluster activate default_cluster -N confignode1 -op license_path

```
git clone https://github.com/apache/iotdb.git
git checkout v1.0.0
git checkout v1.3.0
```

**官网下载**

1. 打开官网[Download Page](https://iotdb.apache.org/Download/)。
2. 下载 IoTDB 1.0.0 版本的源码。
3. 解压得到 apache-iotdb-1.0.0 目录。
3. 解压得到 apache-iotdb-1.3.0 目录。

##### 编译源码

Expand All @@ -782,12 +782,12 @@ mvn clean package -pl distribution -am -DskipTests
```

编译成功后，可在目录
**distribution/target/apache-iotdb-1.0.0-SNAPSHOT-all-bin/apache-iotdb-1.0.0-SNAPSHOT-all-bin**
**distribution/target/apache-iotdb-1.3.0-SNAPSHOT-all-bin/apache-iotdb-1.3.0-SNAPSHOT-all-bin**
找到集群版本的二进制文件。

### 安装包说明

打开 apache-iotdb-1.0.0-SNAPSHOT-all-bin，可见以下目录：
打开 apache-iotdb-1.3.0-SNAPSHOT-all-bin，可见以下目录：

| **目录** | **说明** |
| -------- | ------------------------------------------------------------ |
Expand All @@ -803,7 +803,7 @@ mvn clean package -pl distribution -am -DskipTests

#### 集群安装

`apache-iotdb-1.0.0-SNAPSHOT-all-bin` 包含 ConfigNode 和 DataNode，
`apache-iotdb-1.3.0-SNAPSHOT-all-bin` 包含 ConfigNode 和 DataNode，
请将安装包部署于你目标集群的所有机器上，推荐将安装包部署于所有服务器的相同目录下。

如果你希望先在一台服务器上尝试部署 IoTDB 集群，请参考
Expand All @@ -812,7 +812,7 @@ mvn clean package -pl distribution -am -DskipTests
#### 集群配置

接下来需要修改每个服务器上的配置文件，登录服务器，
并将工作路径切换至 `apache-iotdb-1.0.0-SNAPSHOT-all-bin`，
并将工作路径切换至 `apache-iotdb-1.3.0-SNAPSHOT-all-bin`，
配置文件在 `./conf` 目录内。

对于所有部署 ConfigNode 的服务器，需要修改通用配置（见 5.2.1）和 ConfigNode 配置（见 5.2.2）。
Expand Down
16 changes: 9 additions & 7 deletions src/zh/UserGuide/V1.3.x/QuickStart/ClusterQuickStart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@
[FAQ](../FAQ/Frequently-asked-questions.md)

## 1. 安装部署


我们将以最小的改动，启动一个含有3个 ConfigNode 和3个DataNode(3C3D)集群：
- 数据/元数据副本数为1
- 集群名称为defaultCluster
Expand Down Expand Up @@ -68,18 +70,18 @@ IP地址和服务角色分配如下：
| 配置| 配置项 | IP:192.168.132.10 | IP:192.168.132.11 | IP:192.168.132.12 |
|------------|:-------------------------------|----------------------|----------------------|:---------------------|
| iotdb-confignode.properties | cn\_internal\_address | 192.168.132.10 | 192.168.132.11 | 192.168.132.12 |
| | cn\_target\_config\_node\_list | 192.168.132.10:10710 | 192.168.132.10:10710 | 192.168.132.10:10710 |
| | cn_seed_config_node | 192.168.132.10:10710 | 192.168.132.10:10710 | 192.168.132.10:10710 |
| iotdb-datanode.properties | dn\_rpc\_address | 192.168.132.10 | 192.168.132.11 | 192.168.132.12 |
| | dn\_internal\_address | 192.168.132.10 | 192.168.132.11 | 192.168.132.12 |
| | dn\_target\_config\_node\_list | 192.168.132.10:10710 | 192.168.132.10:10710 | 192.168.132.10:10710 |
| | dn_seed_config_node | 192.168.132.10:10710 | 192.168.132.10:10710 | 192.168.132.10:10710 |

**注意：**
我们推荐所有节点的 iotdb-common.properties 和 JVM 的内存配置是一致的。

### 1.3. 启动集群
启动集群前，需保证配置正确，保证 IoTDB 安装目录下没有数据(`data`目录)。
#### 1.3.1. 启动第一个节点
即上面表格中`cn_target_config_node_list`配置的节点。
即上面表格中`cn_seed_config_node`配置的节点。
登录该节点 192.168.132.10，执行下面命令：
```shell
cd /data/iotdb
Expand All @@ -95,7 +97,7 @@ tail -f logs/log_datanode_all.log
如果没有看到上面所说的日志或者看到了 Exception，那么代表启动失败了。请查看 `/data/iotdb/logs` 目录内的`log_confignode_all.log` 和 `log_datanode_all.log` 日志文件。

**注意**：
- 要保证第一个节点启动成功后，再启动其他节点。确切的说，要先保证第一个 ConfigNode 服务启动成功，即`cn_target_config_node_list`配置的节点。
- 要保证第一个节点启动成功后，再启动其他节点。确切的说，要先保证第一个 ConfigNode 服务启动成功，即`cn_seed_config_node`配置的节点。
- 如果启动失败，需要[清理环境](#【附录】清理环境)后，再次启动。
- ConfigNode 和 DataNode 服务都可以单独启动:
```shell
Expand Down Expand Up @@ -167,7 +169,7 @@ rm -rf data logs
**注意：**
- 扩容的节点必须是干净的节点，不能有数据(也就是`data`目录)
- iotdb-common.properties中的`cluster_name`的配置必须和已有集群一致。
- `cn_target_config_node_list` 和 `dn_target_config_node_list`的配置必须和已有集群一致。
- `cn_seed_config_node` 和 `dn_seed_config_node`的配置必须和已有集群一致。
- 原有数据不会移动到新节点，新创建的元数据分区和数据分区很可能在新的节点。

### 2.1. 修改配置
Expand All @@ -176,10 +178,10 @@ rm -rf data logs
| 配置 | 配置项 | IP:192.168.132.13 |
|------------|:-------------------------------|:---------------------|
| iotdb-confignode.properties | cn\_internal\_address | 192.168.132.13 |
| | cn\_target\_config\_node\_list | 192.168.132.10:10710 |
| | cn_seed_config_node | 192.168.132.10:10710 |
| iotdb-datanode.properties | dn\_rpc\_address | 192.168.132.13 |
| | dn\_internal\_address | 192.168.132.13 |
| | dn\_target\_config\_node\_list | 192.168.132.10:10710 |
| | dn_seed_config_node | 192.168.132.10:10710 |

### 2.2. 扩容
在新增节点`192.168.132.13`上，执行：
Expand Down