This is an automated email from the ASF dual-hosted git repository. jiafengzheng 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 5511d43 [Doris Manager][Doc]Basic User Documents for Doris Manager (#8609) 5511d43 is described below commit 5511d435dee869c225d10cdd4cf56bb90a075419 Author: Justice Gong <justice.g...@hotmail.com> AuthorDate: Thu Mar 24 21:34:49 2022 +0800 [Doris Manager][Doc]Basic User Documents for Doris Manager (#8609) --- .../images/doris-manager/clustermanagenent-1.png | Bin 0 -> 811985 bytes .../images/doris-manager/clustermanagenent-2.png | Bin 0 -> 303574 bytes .../images/doris-manager/clustermanagenent-3.png | Bin 0 -> 729999 bytes .../images/doris-manager/clustermanagenent-4.png | Bin 0 -> 277173 bytes .../images/doris-manager/clustermanagenent-5.png | Bin 0 -> 396001 bytes .../public/images/doris-manager/initializing-1.png | Bin 0 -> 72708 bytes .../images/doris-manager/initializing-10.png | Bin 0 -> 651452 bytes .../images/doris-manager/initializing-11.png | Bin 0 -> 456628 bytes .../images/doris-manager/initializing-12.png | Bin 0 -> 611762 bytes .../images/doris-manager/initializing-13.png | Bin 0 -> 426572 bytes .../images/doris-manager/initializing-14.png | Bin 0 -> 422438 bytes .../images/doris-manager/initializing-15.png | Bin 0 -> 44133 bytes .../images/doris-manager/initializing-16.png | Bin 0 -> 380961 bytes .../images/doris-manager/initializing-17.png | Bin 0 -> 128710 bytes .../images/doris-manager/initializing-18.png | Bin 0 -> 323719 bytes .../images/doris-manager/initializing-19.png | Bin 0 -> 589860 bytes .../public/images/doris-manager/initializing-2.png | Bin 0 -> 328269 bytes .../public/images/doris-manager/initializing-3.png | Bin 0 -> 651452 bytes .../public/images/doris-manager/initializing-4.png | Bin 0 -> 809366 bytes .../public/images/doris-manager/initializing-5.png | Bin 0 -> 704258 bytes .../public/images/doris-manager/initializing-6.png | Bin 0 -> 565328 bytes .../public/images/doris-manager/initializing-7.png | Bin 0 -> 602699 bytes .../public/images/doris-manager/initializing-8.png | Bin 0 -> 564646 bytes .../public/images/doris-manager/initializing-9.png | Bin 0 -> 609950 bytes .../images/doris-manager/spacemanagement-1.png | Bin 0 -> 459251 bytes .../images/doris-manager/spacemanagement-10.png | Bin 0 -> 391499 bytes .../images/doris-manager/spacemanagement-2.png | Bin 0 -> 329131 bytes .../images/doris-manager/spacemanagement-3.png | Bin 0 -> 315978 bytes .../images/doris-manager/spacemanagement-4.png | Bin 0 -> 319956 bytes .../images/doris-manager/spacemanagement-5.png | Bin 0 -> 361250 bytes .../images/doris-manager/spacemanagement-6.png | Bin 0 -> 303275 bytes .../images/doris-manager/spacemanagement-7.png | Bin 0 -> 403391 bytes .../images/doris-manager/spacemanagement-8.png | Bin 0 -> 351331 bytes .../images/doris-manager/spacemanagement-9.png | Bin 0 -> 330859 bytes .../images/doris-manager/systemsettings-1.png | Bin 0 -> 561497 bytes .../images/doris-manager/systemsettings-10.png | Bin 0 -> 551044 bytes .../images/doris-manager/systemsettings-11.png | Bin 0 -> 353040 bytes .../images/doris-manager/systemsettings-2.png | Bin 0 -> 449987 bytes .../images/doris-manager/systemsettings-3.png | Bin 0 -> 2219701 bytes .../images/doris-manager/systemsettings-4.png | Bin 0 -> 2196473 bytes .../images/doris-manager/systemsettings-5.png | Bin 0 -> 432792 bytes .../images/doris-manager/systemsettings-6.png | Bin 0 -> 2192074 bytes .../images/doris-manager/systemsettings-7.png | Bin 0 -> 381154 bytes .../images/doris-manager/systemsettings-8.png | Bin 0 -> 2189352 bytes .../images/doris-manager/systemsettings-9.png | Bin 0 -> 347617 bytes docs/.vuepress/sidebar/zh-CN.js | 11 + .../doris-manager/cluster-managenent.md | 69 +++++ .../doris-manager/compiling-deploying.md | 102 ++++++++ .../extending-doris/doris-manager/initializing.md | 277 +++++++++++++++++++++ .../doris-manager/space-management.md | 101 ++++++++ .../doris-manager/system-settings.md | 82 ++++++ 51 files changed, 642 insertions(+) diff --git a/docs/.vuepress/public/images/doris-manager/clustermanagenent-1.png b/docs/.vuepress/public/images/doris-manager/clustermanagenent-1.png new file mode 100644 index 0000000..50185ef Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/clustermanagenent-1.png differ diff --git a/docs/.vuepress/public/images/doris-manager/clustermanagenent-2.png b/docs/.vuepress/public/images/doris-manager/clustermanagenent-2.png new file mode 100644 index 0000000..e7e0383 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/clustermanagenent-2.png differ diff --git a/docs/.vuepress/public/images/doris-manager/clustermanagenent-3.png b/docs/.vuepress/public/images/doris-manager/clustermanagenent-3.png new file mode 100644 index 0000000..d149dbb Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/clustermanagenent-3.png differ diff --git a/docs/.vuepress/public/images/doris-manager/clustermanagenent-4.png b/docs/.vuepress/public/images/doris-manager/clustermanagenent-4.png new file mode 100644 index 0000000..bb0ed41 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/clustermanagenent-4.png differ diff --git a/docs/.vuepress/public/images/doris-manager/clustermanagenent-5.png b/docs/.vuepress/public/images/doris-manager/clustermanagenent-5.png new file mode 100644 index 0000000..9066c9e Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/clustermanagenent-5.png differ diff --git a/docs/.vuepress/public/images/doris-manager/initializing-1.png b/docs/.vuepress/public/images/doris-manager/initializing-1.png new file mode 100644 index 0000000..4f4b9c6 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/initializing-1.png differ diff --git a/docs/.vuepress/public/images/doris-manager/initializing-10.png b/docs/.vuepress/public/images/doris-manager/initializing-10.png new file mode 100644 index 0000000..232eff4 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/initializing-10.png differ diff --git a/docs/.vuepress/public/images/doris-manager/initializing-11.png b/docs/.vuepress/public/images/doris-manager/initializing-11.png new file mode 100644 index 0000000..29db47a Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/initializing-11.png differ diff --git a/docs/.vuepress/public/images/doris-manager/initializing-12.png b/docs/.vuepress/public/images/doris-manager/initializing-12.png new file mode 100644 index 0000000..a29e2c1 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/initializing-12.png differ diff --git a/docs/.vuepress/public/images/doris-manager/initializing-13.png b/docs/.vuepress/public/images/doris-manager/initializing-13.png new file mode 100644 index 0000000..b761687 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/initializing-13.png differ diff --git a/docs/.vuepress/public/images/doris-manager/initializing-14.png b/docs/.vuepress/public/images/doris-manager/initializing-14.png new file mode 100644 index 0000000..bf8999e Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/initializing-14.png differ diff --git a/docs/.vuepress/public/images/doris-manager/initializing-15.png b/docs/.vuepress/public/images/doris-manager/initializing-15.png new file mode 100644 index 0000000..e49f1f9 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/initializing-15.png differ diff --git a/docs/.vuepress/public/images/doris-manager/initializing-16.png b/docs/.vuepress/public/images/doris-manager/initializing-16.png new file mode 100644 index 0000000..1714bc5 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/initializing-16.png differ diff --git a/docs/.vuepress/public/images/doris-manager/initializing-17.png b/docs/.vuepress/public/images/doris-manager/initializing-17.png new file mode 100644 index 0000000..45e55e9 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/initializing-17.png differ diff --git a/docs/.vuepress/public/images/doris-manager/initializing-18.png b/docs/.vuepress/public/images/doris-manager/initializing-18.png new file mode 100644 index 0000000..5b39bd9 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/initializing-18.png differ diff --git a/docs/.vuepress/public/images/doris-manager/initializing-19.png b/docs/.vuepress/public/images/doris-manager/initializing-19.png new file mode 100644 index 0000000..15b4638 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/initializing-19.png differ diff --git a/docs/.vuepress/public/images/doris-manager/initializing-2.png b/docs/.vuepress/public/images/doris-manager/initializing-2.png new file mode 100644 index 0000000..bf506b4 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/initializing-2.png differ diff --git a/docs/.vuepress/public/images/doris-manager/initializing-3.png b/docs/.vuepress/public/images/doris-manager/initializing-3.png new file mode 100644 index 0000000..232eff4 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/initializing-3.png differ diff --git a/docs/.vuepress/public/images/doris-manager/initializing-4.png b/docs/.vuepress/public/images/doris-manager/initializing-4.png new file mode 100644 index 0000000..3ce57a1 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/initializing-4.png differ diff --git a/docs/.vuepress/public/images/doris-manager/initializing-5.png b/docs/.vuepress/public/images/doris-manager/initializing-5.png new file mode 100644 index 0000000..6c5b0ce Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/initializing-5.png differ diff --git a/docs/.vuepress/public/images/doris-manager/initializing-6.png b/docs/.vuepress/public/images/doris-manager/initializing-6.png new file mode 100644 index 0000000..069483f Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/initializing-6.png differ diff --git a/docs/.vuepress/public/images/doris-manager/initializing-7.png b/docs/.vuepress/public/images/doris-manager/initializing-7.png new file mode 100644 index 0000000..d0f9c03 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/initializing-7.png differ diff --git a/docs/.vuepress/public/images/doris-manager/initializing-8.png b/docs/.vuepress/public/images/doris-manager/initializing-8.png new file mode 100644 index 0000000..94c7c21 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/initializing-8.png differ diff --git a/docs/.vuepress/public/images/doris-manager/initializing-9.png b/docs/.vuepress/public/images/doris-manager/initializing-9.png new file mode 100644 index 0000000..d187bb4 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/initializing-9.png differ diff --git a/docs/.vuepress/public/images/doris-manager/spacemanagement-1.png b/docs/.vuepress/public/images/doris-manager/spacemanagement-1.png new file mode 100644 index 0000000..431c731 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/spacemanagement-1.png differ diff --git a/docs/.vuepress/public/images/doris-manager/spacemanagement-10.png b/docs/.vuepress/public/images/doris-manager/spacemanagement-10.png new file mode 100644 index 0000000..f15e816 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/spacemanagement-10.png differ diff --git a/docs/.vuepress/public/images/doris-manager/spacemanagement-2.png b/docs/.vuepress/public/images/doris-manager/spacemanagement-2.png new file mode 100644 index 0000000..3687d40 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/spacemanagement-2.png differ diff --git a/docs/.vuepress/public/images/doris-manager/spacemanagement-3.png b/docs/.vuepress/public/images/doris-manager/spacemanagement-3.png new file mode 100644 index 0000000..0491bc1 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/spacemanagement-3.png differ diff --git a/docs/.vuepress/public/images/doris-manager/spacemanagement-4.png b/docs/.vuepress/public/images/doris-manager/spacemanagement-4.png new file mode 100644 index 0000000..111e9b3 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/spacemanagement-4.png differ diff --git a/docs/.vuepress/public/images/doris-manager/spacemanagement-5.png b/docs/.vuepress/public/images/doris-manager/spacemanagement-5.png new file mode 100644 index 0000000..e8be9ad Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/spacemanagement-5.png differ diff --git a/docs/.vuepress/public/images/doris-manager/spacemanagement-6.png b/docs/.vuepress/public/images/doris-manager/spacemanagement-6.png new file mode 100644 index 0000000..295fd6f Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/spacemanagement-6.png differ diff --git a/docs/.vuepress/public/images/doris-manager/spacemanagement-7.png b/docs/.vuepress/public/images/doris-manager/spacemanagement-7.png new file mode 100644 index 0000000..96ebdbf Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/spacemanagement-7.png differ diff --git a/docs/.vuepress/public/images/doris-manager/spacemanagement-8.png b/docs/.vuepress/public/images/doris-manager/spacemanagement-8.png new file mode 100644 index 0000000..107f631 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/spacemanagement-8.png differ diff --git a/docs/.vuepress/public/images/doris-manager/spacemanagement-9.png b/docs/.vuepress/public/images/doris-manager/spacemanagement-9.png new file mode 100644 index 0000000..acbaadc Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/spacemanagement-9.png differ diff --git a/docs/.vuepress/public/images/doris-manager/systemsettings-1.png b/docs/.vuepress/public/images/doris-manager/systemsettings-1.png new file mode 100644 index 0000000..1656987 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/systemsettings-1.png differ diff --git a/docs/.vuepress/public/images/doris-manager/systemsettings-10.png b/docs/.vuepress/public/images/doris-manager/systemsettings-10.png new file mode 100644 index 0000000..780413e Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/systemsettings-10.png differ diff --git a/docs/.vuepress/public/images/doris-manager/systemsettings-11.png b/docs/.vuepress/public/images/doris-manager/systemsettings-11.png new file mode 100644 index 0000000..0de217e Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/systemsettings-11.png differ diff --git a/docs/.vuepress/public/images/doris-manager/systemsettings-2.png b/docs/.vuepress/public/images/doris-manager/systemsettings-2.png new file mode 100644 index 0000000..84b23f8 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/systemsettings-2.png differ diff --git a/docs/.vuepress/public/images/doris-manager/systemsettings-3.png b/docs/.vuepress/public/images/doris-manager/systemsettings-3.png new file mode 100644 index 0000000..53a0027 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/systemsettings-3.png differ diff --git a/docs/.vuepress/public/images/doris-manager/systemsettings-4.png b/docs/.vuepress/public/images/doris-manager/systemsettings-4.png new file mode 100644 index 0000000..7e5a312 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/systemsettings-4.png differ diff --git a/docs/.vuepress/public/images/doris-manager/systemsettings-5.png b/docs/.vuepress/public/images/doris-manager/systemsettings-5.png new file mode 100644 index 0000000..2e847b9 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/systemsettings-5.png differ diff --git a/docs/.vuepress/public/images/doris-manager/systemsettings-6.png b/docs/.vuepress/public/images/doris-manager/systemsettings-6.png new file mode 100644 index 0000000..2376d53 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/systemsettings-6.png differ diff --git a/docs/.vuepress/public/images/doris-manager/systemsettings-7.png b/docs/.vuepress/public/images/doris-manager/systemsettings-7.png new file mode 100644 index 0000000..ba30628 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/systemsettings-7.png differ diff --git a/docs/.vuepress/public/images/doris-manager/systemsettings-8.png b/docs/.vuepress/public/images/doris-manager/systemsettings-8.png new file mode 100644 index 0000000..6e7d118 Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/systemsettings-8.png differ diff --git a/docs/.vuepress/public/images/doris-manager/systemsettings-9.png b/docs/.vuepress/public/images/doris-manager/systemsettings-9.png new file mode 100644 index 0000000..0d180ea Binary files /dev/null and b/docs/.vuepress/public/images/doris-manager/systemsettings-9.png differ diff --git a/docs/.vuepress/sidebar/zh-CN.js b/docs/.vuepress/sidebar/zh-CN.js index 9aa4107..30c5fc2 100644 --- a/docs/.vuepress/sidebar/zh-CN.js +++ b/docs/.vuepress/sidebar/zh-CN.js @@ -260,6 +260,17 @@ module.exports = [ "flink-doris-connector", "datax", { + title: "Doris Manager", + directoryPath: "doris-manager/", + children: [ + "compiling-deploying", + "initializing", + "space-management", + "cluster-managenent", + "system-settings" + ], + }, + { title: "Seatunnel", directoryPath: "seatunnel/", initialOpenGroupIndex: -1, diff --git a/docs/zh-CN/extending-doris/doris-manager/cluster-managenent.md b/docs/zh-CN/extending-doris/doris-manager/cluster-managenent.md new file mode 100644 index 0000000..01d2467 --- /dev/null +++ b/docs/zh-CN/extending-doris/doris-manager/cluster-managenent.md @@ -0,0 +1,69 @@ +--- +{ + "title": "集群管理", + "language": "zh-CN" +} +--- + +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> + +# 集群管理 + +超级管理员和空间管理员在集群模块下主要可进行如下操作: + +- 查看集群概览 +- 查看节点列表 +- 编辑参数配置 + +## 集群概览 + +### 查看集群基本信息 + +集群功能,展示以集群为粒度的监控面板。 + +进入首页,点击导航栏中的“集群”,进入集群功能。 + + + +运维监控面板提供集群的各类性能监控指标,供用户洞察集群状态。用户可以在右上角通过按钮控制集群的启动和停止操作。 + +### 查看集群资源使用量 + +用户可以通过饼图查看磁盘使用率,以及查看数据库的数量等。 + +## 节点列表 + +展示集群中FE节点、BE节点和Broker相关信息。 +提供包括节点ID、节点类型、主机IP以及节点状态字段。 + + + +## 参数配置 + +参数配置提供参数名称、参数类型、参数值类型、热生效和操作字段。 + + + +- **操作**:点击“编辑”按钮,可编辑修改对应配置值,可以选择对应的生效方式;点击“查看当前值”按钮,可查看主机IP对应当前值 + + + + + diff --git a/docs/zh-CN/extending-doris/doris-manager/compiling-deploying.md b/docs/zh-CN/extending-doris/doris-manager/compiling-deploying.md new file mode 100644 index 0000000..04bbdba --- /dev/null +++ b/docs/zh-CN/extending-doris/doris-manager/compiling-deploying.md @@ -0,0 +1,102 @@ +--- +{ + "title": "编译与部署", + "language": "zh-CN" +} +--- + +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> + +# 编译与部署 + +## 编译 +直接运行manager路径下的build.sh脚本,会在manager路径下生成安装运行包——output,其中包括: +1、Doris Manager的运行包doris-manager.jar +2、运行的配置文件夹conf +3、启动脚本start_manager.sh +4、停止脚本stop_manager.sh + +## 运行 +### 1 配置 +进入生成的安装运行包,查看配置文件conf路径,打开路径中的配置文件manager.conf,重点关注的配置项内容如下: +```$xslt +服务的启动http端口 +STUDIO_PORT=8080 + +后端数据存放的数据库的类型,包括mysql/h2/postgresql.默认是支持mysql +MB_DB_TYPE=mysql + +数据库连接信息 +如果是配置的h2类型数据库,就不需要配置这些信息,会把数据以本地文件存放在本地 +h2数据文件存放路径,默认直接存放在当前路径 +H2_FILE_PATH= + +如果是mysql/postgresql就需要配置如下连接信息 +数据库地址 +MB_DB_HOST= + +数据库端口 +MB_DB_PORT=3306 + +数据库访问端口 +MB_DB_USER= + +数据库访问密码 +MB_DB_PASS= + +数据库的database名称 +MB_DB_DBNAME= + +服务运行的路径,默认直接存放在当前运行路径的log文件夹中 +LOG_PATH= + +web容器的等待队列长度,默认100。队列也做缓冲池用,但也不能无限长,不但消耗内存,而且出队入队也消耗CPU +WEB_ACCEPT_COUNT=100 + +Web容器的最大工作线程数,默认200。(一般是CPU核数*200) +WEB_MAX_THREADS=200 + +Web容器的最小工作空闲线程数,默认10。(适当增大一些,以便应对突然增长的访问量) +WEB_MIN_SPARE_THREADS=10 + +Web容器的最大连接数,默认10000。(适当增大一些,以便应对突然增长的访问量) +WEB_MAX_CONNECTIONS=10000 + +访问数据库连接池最大连接数量,默认为10 +DB_MAX_POOL_SIZE=20 + +访问数据库连接池最小空闲连接数,默认为10 +DB_MIN_IDLE=10 +``` + +### 2 启动 +配置修改完成后,回到安装运行包,直接运行如下命令 +```$xslt +nohup sh ./start_manager.sh > start.log 2>&1 & +``` +查看logs中的日志即可判断程序是否启动成功 + +### 3 使用 +Doris Manager预设了一个超级管理员用户,信息如下: +```$xslt +用户名: Admin +密码: Admin@123 +``` +为确保使用安全,登陆后请修改密码! diff --git a/docs/zh-CN/extending-doris/doris-manager/initializing.md b/docs/zh-CN/extending-doris/doris-manager/initializing.md new file mode 100644 index 0000000..550347e --- /dev/null +++ b/docs/zh-CN/extending-doris/doris-manager/initializing.md @@ -0,0 +1,277 @@ +--- +{ + "title": "初始化", + "language": "zh-CN" +} +--- + +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> + +# 初始化 +完成部署之后,系统管理员需要完成本地初始化。 + +初始化分成两步,选择用户认证方式和新建空间连接集群。 + +## 管理用户 + +初始化第一步为管理用户,主要完成对认证方式的选择和配置。目前Doris Manger支持本地用户认证。 + + + + +### 本地用户认证 + +本地用户认证是Doris Manger自带的用户系统。通过填入用户名、邮箱和密码可完成用户注册,用户的新增、信息修改、删除和权限关系均在本地内完成。 + +初始化时超级管理员选择后,无需配置任何信息,直接进行初始化的第二步,创建空间连接集群。 + + + +## 新建空间 + +新建空间包括新建集群和集群托管两种方式。 + +### 新建Doirs集群 + +#### 1 注册空间 + +空间信息包括空间名称、空间简介、选择空间管理员。 + +空间名称、管理员为必填/选字段。 + + + +#### 2 添加主机 + + + +##### 配置SSH免登陆 + +Doris Manager 在安装时需要分发Agent安装包,故需要在待安装Doris的服务器(agent01)配置SSH免登陆。 + +```shell +#1.登录服务器,需要使用manger和agent账号保持一致 +su - xxx +pwd +#2.在部署doris manager机器上生成密钥对 +ssh-keygen -t rsa -P '' -f ~/.ssh/id_rsa + +#3.将公钥拷贝到机器agent01上 +scp ~/.ssh/id_rsa.pub root@agent01:~ + +#4.登录agent01,将公钥追加到authorized_keys +cat ~/id_rsa.pub >> .ssh/authorized_keys + +#5.这样做完之后我们就可以在doris manger机器免密码登录agent01 +ssh agen...@xx.xxx.xx.xx +``` + +另外需要注意,.ssh目录的权限为700,其下文件authorized_keys和私钥的权限为600。否则会因为权限问题导致无法免密码登录。我们可以看到登陆后会有known_hosts文件生成。同时启动doris时需要使用免密码登录的账号。 + +在Doris Manager 安装集群时,使用部署doris manager机器的私钥即可,即~/.ssh/id_rsa + +详细可参考:https://blog.csdn.net/universe_hao/article/details/52296811 + +##### 主机列表 +输入主机IP添加新的主机,也可通过批量添加。 + +#### 3 安装选项 + + + +##### 获取安装包 +###### 1 源码部署 +您可以通过以下连接下载对应版本的 Doris 源码进行编译和部署 +http://doris.incubator.apache.org/zh-CN/downloads/downloads.html 源码部署根据不同版本的环境要求也不同。 +Doris 0.14.0 之前的版本依赖如下: + + GCC 7.3+, Oracle JDK 1.8+, Python 2.7+, Apache Maven 3.5+, CMake 3.11+ Bison 3.0+ + +Doris 0.14.0 之后的依赖版本如下: + + GCC 10+, Oracle JDK 1.8+, Python 2.7+, Apache Maven 3.5+, CMake 3.19.2+ Bison 3.0+ + + + +###### 2 预编译部署 + +使用预编译版本进行安装 +http://palo.baidu.com/docs/%E4%B8%8B%E8%BD%BD%E4%B8%93%E5%8C%BA/%E9%A2%84%E7%BC%96%E8%AF%91%E7%89%88%E6%9C%AC%E4%B8%8B%E8%BD%BD/ +这里提供的预编译二进制文件仅在 CentOS 7.3, Intel(R) Xeon(R) Gold 6148 CPU @ 2.40GHz 上执行通过。在其他系统或 CPU 型号下,可能会因为 glibc 版本或者 CPU 支持的指令集不同,而导致程序无法运行。 + +部署时需要确保从output下copy的fe和be目录处于同一级。 +列: +``` +doris/fe +doris/be +doris/broker +``` + +##### 搭建本地web服务器 +在Doris Manager上安装集群时,需要提供Doris 的安装包,可以直接使用官网地址或将已有安装包放到自己的web服务器上。 +###### 1 yum源安装 +1.安装 +yum install -y nginx +2.启动 +systemctl start nginx +###### 2 源码安装 +可参考:https://www.runoob.com/linux/nginx-install-setup.html + +###### 3 配置 + +1.将doris安装包放置nginx根目录 +mv PALO-0.15.1-rc03-binary.tar.gz /usr/share/nginx/html + +2.修改ngixn.conf +``` +location /download { + alias /home/work/nginx/nginx/html/; + } +``` +修改后重启ngxin访问 : +https://host:port/download/PALO-0.15.1-rc03-binary.tar.gz + +##### 指定安装路径 + +Doris与Doris Manger Agent将安装至该目录下。请确保该目录为Doirs以及相关组件专用。 + +#### 4 校验主机 + +系统会根据主机状态自动进行校验,当校验完成时既Agent启动回传心跳,可点击进行下一步。 + + + +#### 5 规划节点 + +点击分配节点按钮,对主机进行FE/BE/Broker节点的规划。 + + + +#### 6 配置参数 + +对上一步规划的节点进行配置参数,可以使用默认值也可以打开自定义配置开关对配置进行自定义。 + + + +#### 7 部署集群 + +系统会根据主机安装进度状态自动进行校验,当校验完成时既启动节点并回传心跳,可点击进行下一步。 + + + +#### 8 完成创建 + +完成以上步骤即可完成新建集群。 + + + +### 集群托管 + +#### 1 注册空间 + +空间信息包括空间名称、空间简介、选择空间管理员。 + +空间名称、管理员为必填/选字段。 + + + + +#### 2 连接集群 + +集群信息包括集群地址、HTTP端口、JDBC端口、集群用户名和集群密码。用户可根据自身集群信息进行填写。 + +点击链接测试按钮进行测试。 + + + +#### 3 托管选项 + + + +##### 配置SSH免登陆 + +Doris Manager 在安装时需要分发Agent安装包,故需要在待安装Doris的服务器(agent01)配置SSH免登陆。 + +```shell +#1.登录服务器,需要使用manger和agent账号保持一致 +su - xxx +pwd +#2.在部署doris manager机器上生成密钥对 +ssh-keygen -t rsa -P '' -f ~/.ssh/id_rsa + +#3.将公钥拷贝到机器agent01上 +scp ~/.ssh/id_rsa.pub root@agent01:~ + +#4.登录agent01,将公钥追加到authorized_keys +cat ~/id_rsa.pub >> .ssh/authorized_keys + +#5.这样做完之后我们就可以在doris manger机器免密码登录agent01 +ssh agen...@xx.xxx.xx.xx +``` + +另外需要注意,.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与Doris Manger Agent将安装至该目录下。请确保该目录为Doirs以及相关组件专用。 + +#### 4 校验主机 + +系统会根据主机状态自动进行校验,当校验完成时既Agent启动回传心跳,可点击进行下一步。 + + + +#### 5 校验集群 +校验集群分位实例安装校验、实例依赖校验、实例启动校验,校验成功后点击下一步即可完成创建。 + + + +#### 6 完成接入 +完成以上步骤即可完成集群托管。 + + + +### 空间列表 + +点击左侧导航栏进入空间列表页,空间列表页用于展示用户拥有权限的空间名称。 + +空间列表分为已完成空间和未完成空间,已完成空间可以对其进行操作如进入空间、删除和编辑。 +注意:仅空间管理员有权限进行删除和编辑权限 + + + +点击编辑按钮后可以对空间名称、空间简介、空间管理员进行相应编辑。 + + + +点击删除按钮后弹窗是否删除,点击确定删除成功。 + + + +点击上方二级导航栏进入未完成空间列表,未完成空间列表记录上次创建空间但未完成的操作,空间管理员可以继续对未完成空间进行恢复或者删除操作。 + + + +此时已经完成了本地初始化过程。空间管理员可以进入空间,进行空间管理,邀请用户进入空间进行数据分析等工作。 + diff --git a/docs/zh-CN/extending-doris/doris-manager/space-management.md b/docs/zh-CN/extending-doris/doris-manager/space-management.md new file mode 100644 index 0000000..b0fff1b --- /dev/null +++ b/docs/zh-CN/extending-doris/doris-manager/space-management.md @@ -0,0 +1,101 @@ +--- +{ + "title": "空间管理", + "language": "zh-CN" +} +--- + +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> + +# 空间管理 + +## 空间 + +空间管理员在空间模块下主要可进行如下操作: + + +- 查看已经保存的空间信息 + + +### 查看空间信息 + +如果空间信息已经完备,空间管理员可以在此查看空间相关信息,包括空间名称、空间简介、空间管理员等等。空间管理员也可修改空间简介。 + + + +## 成员 + +若您为Doris Manger的空间管理员,您将有权限对于空间、空间成员、角色等进行设置或管理。 + + +在“空间管理”界面的二级导航栏中选择“成员”,进入成员管理页面。此页面可以查看当前空间下的所有用户。 + + + +## 角色 + +空间管理员可以通过单击导航栏“角色”按钮,对空间内成员的角色进行管理。新成员默认属于"空间成员"角色。默认角色有"空间管理员"和"空间成员"且不可被其他管理员更改。 + + + + + +### 创建角色 + +Doris Manger默认角色为“空间管理员”和“空间成员”。 + +- **空间管理员**:这是一个特殊的角色,该角色成员可以查看本空间内实例中的所有内容,可以访问和更改管理面板中的设置,包括更改权限! 因此,请小心地将人员添加到该组。为了防止Doris Manger被锁,需确保该群组中至少有一个用户。 +- **空间成员**:所有属于“空间成员”角色的用户,并且不能从该群组中被移除。为该角色设置许可权限是一个确保你知道Doris Manger新用户将会能够看到什么的好办法。 + +点击角色信息页面右侧的“创建角色”,可以根据需要将用户添加到对应角色,将用户权限设定为对应角色的统一权限。 + + + +点击角色信息最右侧的相应操作,可以在对群组信息编辑的操作。 + + + +### 编辑角色 + +点击角色名称对应的操作,可以对角色信息编辑的操作,包括编辑角色名称、添加/移除角色成员、删除角色等操作。 + + + +##### 编辑角色名称 + +在对应的角色名称选择“编辑”操作可以修改角色名称。 + + + +##### 添加/移除角色成员 + +点击对应的角色名称,查看角色详情信息,可以将空间内用户进行添加和移除至本角色。用户不能将本人移除角色外。 + + + + + +##### 删除角色 + +在对应的角色名称选择“删除”操作可以删除角色。 + + + + diff --git a/docs/zh-CN/extending-doris/doris-manager/system-settings.md b/docs/zh-CN/extending-doris/doris-manager/system-settings.md new file mode 100644 index 0000000..4a3a193 --- /dev/null +++ b/docs/zh-CN/extending-doris/doris-manager/system-settings.md @@ -0,0 +1,82 @@ +--- +{ + "title": "系统设置", + "language": "zh-CN" +} +--- + +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> + +# 系统设置 + +超级管理员管理员在平台模块下主要可进行如下操作: + + +- 对平台用户进行相关操作 + +## 用户 + +### 本地认证下用户管理 + +单击页面右侧“添加用户”按钮,可以输入用户名、邮箱。新用户默认不属于"超级管理员"。 + +Palo Studio将会为新用户分配临时密码,新用户需要使用所设定的用户名/邮箱和临时密码登录,登录后可在“账户设置”中创建新密码。 + + + + + + +### 编辑用户 + +点击用户账号信息最右侧的三个按钮,可以对用户信息编辑的操作,包括编辑用户信息、重置用户密码、停用用户等操作。用户不能对本人进行“停用用户”的操作。 + + + +##### 编辑用户信息 + +点击选择选择“编辑”可以修改用户名、邮箱。若更新用户邮箱,则用户需要使用更新后的邮箱进行登录,密码不会被更新。 + + + + + +##### 重置用户密码 + +点击选择“重置密码”,确认执行此操作后,Doris Manger将会为该用户重新分配临时密码,用户需要使用所设定的邮箱和新的临时密码登录,登录后可在“账户设置”中创建新密码。 + + + + + +##### 停用/激活用户 + +点击选择“停用用户”,确认停用该用户后,该用户状态将由“启用”变更为“停用”。已停用用户将无法登录Doris Manger。 + + + + + +点击用户右侧的激活用户,可以“重新激活”该用户。该用户状态将重新变更为“启用”,能够再次登录Doris Manger,并且将被放回到被停用之前所在的角色中。 + + + + + --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org For additional commands, e-mail: commits-h...@doris.apache.org