From 9330d6cfcd48910d8add52d1f05ae60d7af9bf68 Mon Sep 17 00:00:00 2001 From: Eric Gao Date: Mon, 15 Aug 2022 17:44:00 +0800 Subject: [PATCH] [Doc][Security] Update instructions on worker groups (#11483) * Update instructions on worker groups --- docs/docs/en/guide/security.md | 23 ++++++++++++------- docs/docs/zh/guide/security.md | 21 ++++++++++------- .../src/main/resources/application.yaml | 6 ++++- 3 files changed, 33 insertions(+), 17 deletions(-) diff --git a/docs/docs/en/guide/security.md b/docs/docs/en/guide/security.md index d7f0d841e8..b9484a1e72 100644 --- a/docs/docs/en/guide/security.md +++ b/docs/docs/en/guide/security.md @@ -118,21 +118,28 @@ public void doPOSTParam()throws Exception{ ## Worker Grouping -Each worker node will belong to its own worker group, and the default group is "default". +Each worker node belongs to some worker groups, and the default group is `default`. -When the task is executed, the task can be assigned to the specified worker group, and finally the worker node in the group will execute the task. +When DolphinScheduler executes a task, it will assign the task to the configured worker group and the worker nodes in the group will execute the task. -### Add or update worker group +### Add or Update Worker Groups -- Open the `conf/worker.properties` configuration file on the worker node where you want to configure the groups and modify the `worker.groups` parameter. -- The `worker.groups` parameter is followed by the name of the group corresponding to the worker node, which is `default`. -- If the worker node corresponds to multiple groups, separate them with commas. Example: +- Open the `worker-server/conf/application.yaml` on the worker node where you want to configure the groups and modify the `groups` parameter in `worker` section. +- The values of the `groups` parameter are the names of the groups where the worker node belong. The default value is `default`. +- If the worker node belongs to multiple groups, list them with hyphens, e.g. ```conf -worker.groups=default,test +worker: +...... + groups: + - default + - group-1 + - group-2 +...... ``` -- You can also change the worker group for the worker during execution, and if the modification is successful, the worker will use the new group and ignore the configuration in `worker.properties`. The step to modify work group as below: `Security Center -> Worker Group Management -> click 'New Worker Group' -> click 'New Worker Group' -> enter 'Group Name' -> Select Exists Worker -> Click Submit`. +- You can add new worker groups for the workers during runtime regardless of the configurations in `application.yaml` as below: +`Security Center` -> `Worker Group Manage` -> `Create Worker Group` -> fill in `Group Name` and `Worker Addresses` -> click `confirm`. ## Environmental Management diff --git a/docs/docs/zh/guide/security.md b/docs/docs/zh/guide/security.md index 0c61672c5b..7c9fc8c797 100644 --- a/docs/docs/zh/guide/security.md +++ b/docs/docs/zh/guide/security.md @@ -112,22 +112,27 @@ ## Worker 分组 -每个 worker 节点都会归属于自己的 worker 分组,默认分组为 default。 +每个 worker 节点都会归属于自己的 worker 分组，默认分组为 `default`。 在任务执行时,可以将任务分配给指定 worker 分组，最终由该组中的 worker 节点执行该任务。 -> 新增/更新 worker 分组 +### 新增 / 更新 worker 分组 -- 打开要设置分组的 worker 节点上的 `conf/worker.properties` 配置文件. 修改 worker.groups 参数. -- worker.groups 参数后面对应的为该 worker 节点对应的分组名称,默认为 default。 -- 如果该 worker 节点对应多个分组,则以逗号隔开。 +- 打开要设置分组的 worker 节点上的 `worker-server/conf/application.yaml` 配置文件. 修改 `worker` 配置下的 `groups` 参数. +- `groups` 参数的值为 worker 节点对应的分组名称，默认为 `default`。 +- 如果该 worker 节点对应多个分组，则用连字符列出，示范如下： ```conf -示例: -worker.groups=default,test +worker: +...... + groups: + - default + - group1 + - group2 +...... ``` -- 也可以在运行中修改 worker 所属的 worker 分组，如果修改成功，worker 就会使用这个新建的分组，忽略 `worker.properties` 中的配置。修改步骤为"安全中心 -> worker分组管理 -> 点击 '新建worker分组' -> 输入'组名称' -> 选择已有worker -> 点击'提交'" +- 也可以在运行中添加 worker 所属的 worker 分组而忽略 `application.yaml` 中的配置。修改步骤为 `安全中心` -> `worker分组管理` -> 点击 `创建worker分组` -> 输入`分组名称`和`worker地址` -> 点击`确定` ## 环境管理 diff --git a/dolphinscheduler-worker/src/main/resources/application.yaml b/dolphinscheduler-worker/src/main/resources/application.yaml index da003e9a4a..fb8a1cb704 100644 --- a/dolphinscheduler-worker/src/main/resources/application.yaml +++ b/dolphinscheduler-worker/src/main/resources/application.yaml @@ -70,7 +70,11 @@ worker: max-cpu-load-avg: -1 # worker reserved memory, only lower than system available memory, worker server can be dispatched tasks. default value 0.3, the unit is G reserved-memory: 0.3 - # default worker groups separated by comma, like 'worker.groups=default,test' + # for multiple worker groups, use hyphen before group name, e.g. + # groups: + # - default + # - group1 + # - group2 groups: - default # alert server listen host