Browse Source

[doc] Remove flink call docs (#10122)

Flink call docs is only teld users
how to use flink task in dolphinscheduler
and it should be including in task/flink
3.1.0-release
Jiajie Zhong 3 years ago committed by GitHub
parent
commit
94c515555e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 8
      docs/configs/docsdev.js
  2. 123
      docs/docs/en/guide/flink-call.md
  3. 150
      docs/docs/zh/guide/flink-call.md
  4. BIN
      docs/img/api-documentation-en.png
  5. BIN
      docs/img/api-documentation.png
  6. BIN
      docs/img/api/create_queue.png
  7. BIN
      docs/img/api/create_tenant.png
  8. BIN
      docs/img/api/create_user.png
  9. BIN
      docs/img/api/create_workflow1.png
  10. BIN
      docs/img/api/create_workflow2.png
  11. BIN
      docs/img/api/create_workflow3.png
  12. BIN
      docs/img/api/create_workflow4.png
  13. BIN
      docs/img/api/execution_result.png
  14. BIN
      docs/img/api/log.png
  15. BIN
      docs/img/api/upload_resource.png
  16. BIN
      docs/img/api/user_authorization.png
  17. BIN
      docs/img/api/user_login.png
  18. BIN
      docs/img/create-token-en1.png
  19. BIN
      docs/img/create-token.png
  20. BIN
      docs/img/test-api.png
  21. BIN
      docs/img/token-management-en.png
  22. BIN
      docs/img/token-management.png

8
docs/configs/docsdev.js

@ -288,10 +288,6 @@ export default {
title: 'Data Quality',
link: '/en-us/docs/dev/user_doc/guide/data-quality.html',
},
{
title: 'Flink',
link: '/en-us/docs/dev/user_doc/guide/flink-call.html',
},
{
title: 'Upgrade',
link: '/en-us/docs/dev/user_doc/guide/upgrade.html',
@ -656,10 +652,6 @@ export default {
title: '数据质量',
link: '/zh-cn/docs/dev/user_doc/guide/data-quality.html',
},
{
title: 'Flink调用',
link: '/zh-cn/docs/dev/user_doc/guide/flink-call.html',
},
{
title: '升级',
link: '/zh-cn/docs/dev/user_doc/guide/upgrade.html',

123
docs/docs/en/guide/flink-call.md

@ -1,123 +0,0 @@
# Flink Calls Operating Steps
## Create a Queue
1. Log in to the scheduling system, click `Security`, then click `Queue manage` on the left, and click `Create queue` to create a queue.
2. Fill in the name and value of the queue, and click "Submit"
<p align="center">
<img src="/img/api/create_queue.png" width="80%" />
</p>
## Create a Tenant
```
1. The tenant corresponds to a Linux user, which the user worker uses to submit jobs. If the Linux OS environment does not have this user, the worker will create this user when executing the script.
2. Both the tenant and the tenant code are unique and cannot be repeated, just like a person only has one name and one ID number.
3. After creating a tenant, there will be a folder in the HDFS relevant directory.
```
<p align="center">
<img src="/img/api/create_tenant.png" width="80%" />
</p>
## Create a User
<p align="center">
<img src="/img/api/create_user.png" width="80%" />
</p>
## Create a Token
1. Log in to the scheduling system, click `Security`, then click `Token manage` on the left, and click `Create token` to create a token.
<p align="center">
<img src="/img/token-management-en.png" width="80%" />
</p>
2. Select the `Expiration time` (token validity time), select `User` (choose the specified user to perform the API operation), click "Generate token", copy the `Token` string, and click "Submit".
<p align="center">
<img src="/img/create-token-en1.png" width="80%" />
</p>
## Token Usage
1. Open the API documentation page
> Address:http://{api server ip}:12345/dolphinscheduler/doc.html?language=en_US&lang=en
<p align="center">
<img src="/img/api-documentation-en.png" width="80%" />
</p>
2. Select a test API, the API selected for this test is `queryAllProjectList`
> projects/query-project-list
3. Open `Postman`, fill in the API address, and enter the `Token` in `Headers`, and then send the request to view the result:
```
token: The Token just generated
```
<p align="center">
<img src="/img/test-api.png" width="80%" />
</p>
## User Authorization
<p align="center">
<img src="/img/api/user_authorization.png" width="80%" />
</p>
## User Login
```
http://192.168.1.163:12345/dolphinscheduler/ui/#/monitor/servers/master
```
<p align="center">
<img src="/img/api/user_login.png" width="80%" />
</p>
## Upload the Resource
<p align="center">
<img src="/img/api/upload_resource.png" width="80%" />
</p>
## Create a Workflow
<p align="center">
<img src="/img/api/create_workflow1.png" width="80%" />
</p>
<p align="center">
<img src="/img/api/create_workflow2.png" width="80%" />
</p>
<p align="center">
<img src="/img/api/create_workflow3.png" width="80%" />
</p>
<p align="center">
<img src="/img/api/create_workflow4.png" width="80%" />
</p>
## View the Execution Result
<p align="center">
<img src="/img/api/execution_result.png" width="80%" />
</p>
## View Log
<p align="center">
<img src="/img/api/log.png" width="80%" />
</p>

150
docs/docs/zh/guide/flink-call.md

@ -1,150 +0,0 @@
# 调用 flink 操作步骤
### 创建队列
1. 登录调度系统,点击 "安全中心",再点击左侧的 "队列管理",点击 "队列管理" 创建队列
2. 填写队列名称和队列值,然后点击 "提交"
<p align="center">
<img src="/img/api/create_queue.png" width="80%" />
</p>
### 创建租户
```
1.租户对应的是 linux 用户, 用户 worker 提交作业所使用的的用户, 如果 linux 没有这个用户, worker 会在执行脚本的时候创建这个用户
2.租户和租户编码都是唯一不能重复,好比一个人有名字有身份证号。
3.创建完租户会在 hdfs 对应的目录上有相关的文件夹。
```
<p align="center">
<img src="/img/api/create_tenant.png" width="80%" />
</p>
### 创建用户
<p align="center">
<img src="/img/api/create_user.png" width="80%" />
</p>
### 创建 Token
1. 登录调度系统,点击 "安全中心",再点击左侧的 "令牌管理",点击 "令牌管理" 创建令牌
<p align="center">
<img src="/img/token-management.png" width="80%" />
</p>
2. 选择 "失效时间" (Token有效期),选择 "用户" (以指定的用户执行接口操作),点击 "生成令牌" ,拷贝 Token 字符串,然后点击 "提交"
<p align="center">
<img src="/img/create-token.png" width="80%" />
</p>
### 使用 Token
1. 打开 API文档页面
> 地址:http://{api server ip}:12345/dolphinscheduler/doc.html?language=zh_CN&lang=cn
<p align="center">
<img src="/img/api-documentation.png" width="80%" />
</p>
2. 选一个测试的接口,本次测试选取的接口是:查询所有项目
> projects/query-project-list
3. 打开 Postman,填写接口地址,并在 Headers 中填写 Token,发送请求后即可查看结果
```
token: 刚刚生成的 Token
```
<p align="center">
<img src="/img/test-api.png" width="80%" />
</p>
### 用户授权
<p align="center">
<img src="/img/api/user_authorization.png" width="80%" />
</p>
### 用户登录
```
http://192.168.1.163:12345/dolphinscheduler/ui/#/monitor/servers/master
```
<p align="center">
<img src="/img/api/user_login.png" width="80%" />
</p>
### 资源上传
<p align="center">
<img src="/img/api/upload_resource.png" width="80%" />
</p>
### 创建工作流
<p align="center">
<img src="/img/api/create_workflow1.png" width="80%" />
</p>
<p align="center">
<img src="/img/api/create_workflow2.png" width="80%" />
</p>
<p align="center">
<img src="/img/api/create_workflow3.png" width="80%" />
</p>
<p align="center">
<img src="/img/api/create_workflow4.png" width="80%" />
</p>
### 查看执行结果
<p align="center">
<img src="/img/api/execution_result.png" width="80%" />
</p>
### 查看日志结果
<p align="center">
<img src="/img/api/log.png" width="80%" />
</p>

BIN
docs/img/api-documentation-en.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

BIN
docs/img/api-documentation.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 60 KiB

BIN
docs/img/api/create_queue.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 72 KiB

BIN
docs/img/api/create_tenant.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 81 KiB

BIN
docs/img/api/create_user.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 91 KiB

BIN
docs/img/api/create_workflow1.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 54 KiB

BIN
docs/img/api/create_workflow2.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 94 KiB

BIN
docs/img/api/create_workflow3.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 209 KiB

BIN
docs/img/api/create_workflow4.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 68 KiB

BIN
docs/img/api/execution_result.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 73 KiB

BIN
docs/img/api/log.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 151 KiB

BIN
docs/img/api/upload_resource.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 67 KiB

BIN
docs/img/api/user_authorization.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 38 KiB

BIN
docs/img/api/user_login.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 181 KiB

BIN
docs/img/create-token-en1.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.6 KiB

BIN
docs/img/create-token.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.5 KiB

BIN
docs/img/test-api.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

BIN
docs/img/token-management-en.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

BIN
docs/img/token-management.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

Loading…
Cancel
Save