[Improve][Doc] Improve engine deployment doc for skip deploy client (#…

…7723)
apache · Sep 24, 2024 · 71b8b94 · 71b8b94
1 parent 8c833a8
commit 71b8b94
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 10 deletions.
diff --git a/docs/en/seatunnel-engine/hybrid-cluster-deployment.md b/docs/en/seatunnel-engine/hybrid-cluster-deployment.md
@@ -305,10 +305,18 @@ mkdir -p $SEATUNNEL_HOME/logs
 
 The logs will be written to `$SEATUNNEL_HOME/logs/seatunnel-engine-server.log`
 
-## 8. Install The SeaTunnel Engine Client
+## 8. Submit And Manage Jobs
+
+### 8.1 Submit Jobs With The SeaTunnel Engine Client 
+
+#### Install The SeaTunnel Engine Client
 
 You only need to copy the `$SEATUNNEL_HOME` directory on the SeaTunnel Engine node to the client node and configure `SEATUNNEL_HOME` in the same way as the SeaTunnel Engine server node.
 
-## 9. Submit And Manage Jobs
+#### Submitting And Managing Jobs
 
 Now that the cluster is deployed, you can complete the submission and management of jobs through the following tutorials: [Submit And Manage Jobs](user-command.md)
+
+### 8.2 Submit Jobs With The REST API
+
+The SeaTunnel Engine provides a REST API for submitting and managing jobs. For more information, please refer to [REST API](rest-api.md)
diff --git a/docs/en/seatunnel-engine/separated-cluster-deployment.md b/docs/en/seatunnel-engine/separated-cluster-deployment.md
@@ -387,9 +387,13 @@ mkdir -p $SEATUNNEL_HOME/logs
 
 The logs will be written to `$SEATUNNEL_HOME/logs/seatunnel-engine-worker.log`.
 
-## 8. Installing The SeaTunnel Engine Client
+## 8. Submit And Manage Jobs
 
-### 8.1 Setting the `SEATUNNEL_HOME` the same as the server
+### 8.1 Submit Jobs With The SeaTunnel Engine Client
+
+#### Installing The SeaTunnel Engine Client
+
+##### Setting the `SEATUNNEL_HOME` the same as the server
 
 You can configure the `SEATUNNEL_HOME` by adding the `/etc/profile.d/seatunnel.sh` file. The content of `/etc/profile.d/seatunnel.sh` is as follows:
 
@@ -398,7 +402,7 @@ export SEATUNNEL_HOME=${seatunnel install path}
 export PATH=$PATH:$SEATUNNEL_HOME/bin
 ```
 
-### 8.2 Configuring The SeaTunnel Engine Client
+##### Configuring The SeaTunnel Engine Client
 
 All configurations of the SeaTunnel Engine client are in the `hazelcast-client.yaml`.
 
@@ -421,6 +425,10 @@ hazelcast-client:
       - master-node-2:5801
 ```
 
-# 9 Submitting And Managing Jobs
+#### Submitting And Managing Jobs
 
 Now that the cluster has been deployed, you can complete the job submission and management through the following tutorial: [Submitting And Managing Jobs](user-command.md).
+
+### 8.2 Submit Jobs With The REST API
+
+The SeaTunnel Engine provides a REST API for submitting and managing jobs. For more information, please refer to [REST API](rest-api.md)
diff --git a/docs/zh/seatunnel-engine/hybrid-cluster-deployment.md b/docs/zh/seatunnel-engine/hybrid-cluster-deployment.md
@@ -305,10 +305,18 @@ mkdir -p $SEATUNNEL_HOME/logs
 
 日志将写入 `$SEATUNNEL_HOME/logs/seatunnel-engine-server.log`
 
-## 8. 安装 SeaTunnel Engine 客户端
+## 8. 提交作业和管理作业
+
+### 8.1 使用 SeaTunnel Engine 客户端提交作业
+
+#### 安装 SeaTunnel Engine 客户端
 
 您只需将 SeaTunnel Engine 节点上的 `$SEATUNNEL_HOME` 目录复制到客户端节点，并像 SeaTunnel Engine 服务器节点一样配置 `SEATUNNEL_HOME`。
 
-## 9. 提交作业和管理作业
+#### 提交作业和管理作业
 
 现在集群部署完成了，您可以通过以下教程完成作业的提交和管理：[提交和管理作业](user-command.md)
+
+### 8.2 使用 REST API 提交作业
+
+SeaTunnel Engine 提供了 REST API 用于提交作业。有关详细信息，请参阅 [REST API](rest-api.md)
diff --git a/docs/zh/seatunnel-engine/separated-cluster-deployment.md b/docs/zh/seatunnel-engine/separated-cluster-deployment.md
@@ -404,7 +404,22 @@ export SEATUNNEL_HOME=${seatunnel install path}
 export PATH=$PATH:$SEATUNNEL_HOME/bin
 ```
 
-### 8.2 配置 SeaTunnel Engine 客户端
+## 8. 提交作业和管理作业
+
+### 8.1 使用 SeaTunnel Engine 客户端提交作业
+
+#### 安装 SeaTunnel Engine 客户端
+
+##### 设置和服务器一样的`SEATUNNEL_HOME`
+
+您可以通过添加 `/etc/profile.d/seatunnel.sh` 文件来配置 `SEATUNNEL_HOME` 。`/etc/profile.d/seatunnel.sh` 的内容如下：
+
+```
+export SEATUNNEL_HOME=${seatunnel install path}
+export PATH=$PATH:$SEATUNNEL_HOME/bin
+```
+
+##### 配置 SeaTunnel Engine 客户端
 
 所有 SeaTunnel Engine 客户端的配置都在 `hazelcast-client.yaml` 里。
 
@@ -427,6 +442,10 @@ hazelcast-client:
       - master-node-2:5801
 ```
 
-## 9. 提交作业和管理作业
+#### 提交作业和管理作业
 
 现在集群部署完成了，您可以通过以下教程完成作业的提交和管理：[提交和管理作业](user-command.md)
+
+### 8.2 使用 REST API 提交作业
+
+SeaTunnel Engine 提供了 REST API 用于提交作业。有关详细信息，请参阅 [REST API](rest-api.md)