You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@doris.apache.org by mo...@apache.org on 2022/05/01 09:54:41 UTC
[incubator-doris] branch master updated: [doc] update doris manager doc (#9319)
This is an automated email from the ASF dual-hosted git repository.
morningman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-doris.git
The following commit(s) were added to refs/heads/master by this push:
new b655ba8768 [doc] update doris manager doc (#9319)
b655ba8768 is described below
commit b655ba8768adcf4da48da15c173d52ca4747f530
Author: wudi <67...@qq.com>
AuthorDate: Sun May 1 17:54:37 2022 +0800
[doc] update doris manager doc (#9319)
---
.../ecosystem/doris-manager/compiling-deploying.md | 43 ++++++++++++++++------
docs/en/ecosystem/doris-manager/space-list.md | 21 ++++++-----
.../ecosystem/doris-manager/compiling-deploying.md | 38 +++++++++++++++----
docs/zh-CN/ecosystem/doris-manager/space-list.md | 18 +++++----
4 files changed, 84 insertions(+), 36 deletions(-)
diff --git a/docs/en/ecosystem/doris-manager/compiling-deploying.md b/docs/en/ecosystem/doris-manager/compiling-deploying.md
index 1062cfd728..a6f242d8f4 100644
--- a/docs/en/ecosystem/doris-manager/compiling-deploying.md
+++ b/docs/en/ecosystem/doris-manager/compiling-deploying.md
@@ -28,18 +28,37 @@ under the License.
## Compile
-Running the build.sh script under the manager path directly will generate the installation and running package -- output under the manager path, including:
-1. Doris Manager's running package doris-manager.jar
-2. The running configuration folder conf
-3. Start the script start_manager.sh
-4. Stop the script stop_manager.sh
-
+The build.sh script directly under the manager path
+```shell
+cd incubator-doris-manager
+sh build.sh
+````
+After the compilation is completed, the output directory of the installation package will be generated under the manager path. The directory structure is as follows
+````text
+├── agent //agent directory
+│ ├── bin
+│ │ ├── agent_start.sh
+│ │ ├── agent_stop.sh
+│ │ └── download_doris.sh
+│ ├── config
+│ │ └── application.properties
+│ └── lib
+│ └── dm-agent.jar
+└── server //server directory
+ ├── bin
+ │ ├── start_manager.sh //Doris Manager startup script
+ │ └── stop_manager.sh //Doris Manager stop script
+ ├── conf
+ │ └── manager.conf //Doris Manager configuration file
+ ├── lib
+ │ └── doris-manager.jar //Doris Manager's running package doris-manager.jar
+ └── web-resource
+````
## Run
### 1 Configuration
-Enter the generated installation and running package, view the configuration file conf path, and open the configuration file manager.conf in the path. The configuration items to focus on are as follows:
-
+Modify the configuration file `server/conf/manager.conf`, and focus on the following configuration items:
````$xslt
The service's startup http port
STUDIO_PORT=8080
@@ -92,10 +111,10 @@ DB_MIN_IDLE=10
### 2 Start
-After the configuration modification is completed, go back to the installation and run package and run the following command directly
-
-````$xslt
-nohup sh ./start_manager.sh > start.log 2>&1 &
+After the configuration modification is completed, start doris manger
+````shell
+cd server
+sh bin/start_manager.sh
````
Check the logs in the logs to determine whether the program started successfully
diff --git a/docs/en/ecosystem/doris-manager/space-list.md b/docs/en/ecosystem/doris-manager/space-list.md
index 543cb80973..68c3647a36 100644
--- a/docs/en/ecosystem/doris-manager/space-list.md
+++ b/docs/en/ecosystem/doris-manager/space-list.md
@@ -88,28 +88,30 @@ cat ~/id_rsa.pub >> .ssh/authorized_keys
#5. After doing this, we can log in to agent01 without password on the doris manger machine
ssh agent01@xx.xxx.xx.xx
````
+For details, please refer to: https://blog.csdn.net/universe_hao/article/details/52296811
In addition, it should be noted that the permissions of the .ssh directory are 700, and the permissions of the authorized_keys and private keys under it are 600. Otherwise, you will not be able to log in without a password due to permission issues. We can see that the known_hosts file will be generated after logging in. At the same time, when starting doris, you need to use a password-free login account.
-When installing a cluster in Doris Manager, just use the private key of the doris manager machine, ie ~/.ssh/id_rsa
-For details, please refer to: https://blog.csdn.net/universe_hao/article/details/52296811
+When adding nodes in the second step of the Doris Manager installation cluster, use the private key of the doris manager machine, that is, ~/.ssh/id_rsa (note: including the head and tail of the key file)
#### Host list
-
Enter the host IP to add a new host, or add it in batches.
### 3 Installation options
#### Get the installation package
-When deploying a cluster through Doris Manager, you need to provide the compiled Doris installation package. You can compile it yourself from the Doris source code, or use the official binary version.
+1. Code package path
+
+ When deploying a cluster through Doris Manager, you need to provide the compiled Doris installation package. You can compile it yourself from the Doris source code, or use the officially provided [binary version](https://doris.apache.org/zh-CN/ downloads/downloads.html).
-Doris Manager will pull the installation package through http. If you need to build your own http service, please refer to the bottom of the document - Self-built http service.
+`Doris Manager will pull the Doris installation package through http. If you need to build your own http service, please refer to the bottom of the document - Self-built http service`.
#### Specify the installation path
-Doris and Doris Manger Agent will be installed in this directory. Make sure this directory is dedicated to Doirs and related components.
+1. Doris and Doris Manger Agent will be installed in this directory. Make sure this directory is dedicated to Doirs and related components.
+2. Specify the Agent startup port, the default is 8001, if there is a conflict, you can customize it.
### 4 Verify the host
@@ -125,7 +127,7 @@ Click the Assign Node button to plan FE/BE/Broker nodes for the host.
### 6 Configuration Parameters
-Configure parameters for the nodes planned in the previous step. You can use the default values or turn on the custom configuration switch to customize the configuration.
+Configure parameters for the nodes planned in the previous step. You can use the default values or turn on the custom configuration switch to customize the configuration.
### 7 Deploy the cluster
@@ -186,7 +188,8 @@ For details, please refer to: https://blog.csdn.net/universe_hao/article/details
#### Specify the installation path
-Doris and Doris Manger Agent will be installed in this directory. Make sure this directory is dedicated to Doirs and related components.
+1. Doris and Doris Manger Agent will be installed in this directory. Make sure this directory is dedicated to Doirs and related components.
+2. Specify the Agent startup port, the default is 8001, if there is a conflict, you can customize it.
### 4 Verify the host
@@ -231,4 +234,4 @@ location /download {
````
Restart ngxin access after modification:
-https://host:port/download/PALO-0.15.1-rc03-binary.tar.gz
\ No newline at end of file
+https://host:port/download/PALO-0.15.1-rc03-binary.tar.gz
diff --git a/docs/zh-CN/ecosystem/doris-manager/compiling-deploying.md b/docs/zh-CN/ecosystem/doris-manager/compiling-deploying.md
index 04bbdba2b4..9ca82cc8df 100644
--- a/docs/zh-CN/ecosystem/doris-manager/compiling-deploying.md
+++ b/docs/zh-CN/ecosystem/doris-manager/compiling-deploying.md
@@ -27,15 +27,36 @@ under the License.
# 编译与部署
## 编译
-直接运行manager路径下的build.sh脚本，会在manager路径下生成安装运行包——output，其中包括:
-1、Doris Manager的运行包doris-manager.jar
-2、运行的配置文件夹conf
-3、启动脚本start_manager.sh
-4、停止脚本stop_manager.sh
+直接在manager路径下的build.sh脚本
+```shell
+cd incubator-doris-manager
+sh build.sh
+```
+编译完成后会在manager路径下生成安装包output目录，目录结构如下
+```text
+├── agent //agent 目录
+│ ├── bin
+│ │ ├── agent_start.sh
+│ │ ├── agent_stop.sh
+│ │ └── download_doris.sh
+│ ├── config
+│ │ └── application.properties
+│ └── lib
+│ └── dm-agent.jar
+└── server //server 目录
+ ├── bin
+ │ ├── start_manager.sh //Doris Manager启动脚本
+ │ └── stop_manager.sh //Doris Manager停止脚本
+ ├── conf
+ │ └── manager.conf //Doris Manager配置文件
+ ├── lib
+ │ └── doris-manager.jar //Doris Manager的运行包doris-manager.jar
+ └── web-resource
+```
## 运行
### 1 配置
-进入生成的安装运行包，查看配置文件conf路径，打开路径中的配置文件manager.conf，重点关注的配置项内容如下：
+修改配置文件`server/conf/manager.conf`，重点关注的配置项内容如下：
```$xslt
服务的启动http端口
STUDIO_PORT=8080
@@ -87,9 +108,10 @@ DB_MIN_IDLE=10
```
### 2 启动
-配置修改完成后，回到安装运行包，直接运行如下命令
+配置修改完成后，启动doris manger
```$xslt
-nohup sh ./start_manager.sh > start.log 2>&1 &
+cd server
+sh bin/start_manager.sh
```
查看logs中的日志即可判断程序是否启动成功
diff --git a/docs/zh-CN/ecosystem/doris-manager/space-list.md b/docs/zh-CN/ecosystem/doris-manager/space-list.md
index 27f61ce5c3..78abf4e980 100644
--- a/docs/zh-CN/ecosystem/doris-manager/space-list.md
+++ b/docs/zh-CN/ecosystem/doris-manager/space-list.md
@@ -88,12 +88,12 @@ cat ~/id_rsa.pub >> .ssh/authorized_keys
#5.这样做完之后我们就可以在doris manger机器免密码登录agent01
ssh agent01@xx.xxx.xx.xx
```
+详细可参考：https://blog.csdn.net/universe_hao/article/details/52296811
另外需要注意，.ssh目录的权限为700，其下文件authorized_keys和私钥的权限为600。否则会因为权限问题导致无法免密码登录。我们可以看到登陆后会有known_hosts文件生成。同时启动doris时需要使用免密码登录的账号。
-在Doris Manager 安装集群时，使用部署doris manager机器的私钥即可，即~/.ssh/id_rsa
-详细可参考：https://blog.csdn.net/universe_hao/article/details/52296811
+在Doris Manager 安装集群第二步添加节点时，使用部署doris manager机器的私钥即可，即~/.ssh/id_rsa(注意：包括密钥文件的头尾)
#### 主机列表
输入主机IP添加新的主机，也可通过批量添加。
@@ -102,13 +102,16 @@ ssh agent01@xx.xxx.xx.xx
#### 获取安装包
-通过 Doris Manager 进行集群部署时，需要提供已编译好的 Doris 安装包，您可以通过 Doris 源码自行编译，或使用官方提供的二进制版本。
+1. 代码包路径
+
+ 通过Doris Manager 进行集群部署时，需要提供已编译好的 Doris 安装包，您可以通过 Doris 源码自行编译，或使用官方提供的[二进制版本](https://doris.apache.org/zh-CN/downloads/downloads.html)。
-Doris Manager 将通过 http 方式拉取安装包，若您需要自建 http 服务，请参考文档底部-自建http服务。
+`Doris Manager 将通过 http 方式拉取Doris安装包，若您需要自建 http 服务，请参考文档底部-自建http服务`。
#### 指定安装路径
-Doris与Doris Manger Agent将安装至该目录下。请确保该目录为Doirs以及相关组件专用。
+1. Doris与Doris Manger Agent将安装至该目录下。请确保该目录为Doirs以及相关组件专用。
+2. 指定Agent启动端口，默认为8001，若有冲突，可自定义。
### 4 校验主机
@@ -185,7 +188,8 @@ ssh agent01@xx.xxx.xx.xx
#### 指定安装路径
-Doris与Doris Manger Agent将安装至该目录下。请确保该目录为Doirs以及相关组件专用。
+1. Doris与Doris Manger Agent将安装至该目录下。请确保该目录为Doirs以及相关组件专用。
+2. 指定Agent启动端口，默认为8001，若有冲突，可自定义。
### 4 校验主机
@@ -224,4 +228,4 @@ location /download {
}
```
修改后重启ngxin访问 ：
-https://host:port/download/PALO-0.15.1-rc03-binary.tar.gz
\ No newline at end of file
+https://host:port/download/PALO-0.15.1-rc03-binary.tar.gz
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@doris.apache.org
For additional commands, e-mail: commits-help@doris.apache.org