docs: 作业平台文档建设 #3119 #3138
Merged
docs: 作业平台文档建设 #3119 #3138
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
jsonwan
commented
Jul 19, 2024
jsonwan
commented
- 支持根据ESB接口文档自动生成接口文档README.md；
- 添加部署与运维文档；
- 添加问题排查与处理文档。
1. 支持根据ESB接口文档自动生成接口文档README.md
1. 添加部署与运维文档。
1. 添加问题排查与处理文档。
1. 去除调试生成的多余README.md文档。
wangyu096
requested changes
Jul 19, 2024
support-files/tools/docs/README.tpl
Outdated
| @@ -0,0 +1,6 @@ | |||
| ## 作业平台 V3 API 简介 | |||
|
|
|||
| **作业平台（Job）是一套基于蓝鲸智云管控平台 Agent 管道之上的基础操作平台，具备大并发处理能力；除了支持脚本执行、文件拉取/分发、定时任务等一系列可实现的基础运维场景以外，还运用流程化的理念很好的将零碎的单个任务组装成一个作业流程；而每个任务都可做为一个原子节点，提供给其它系统和平台调度，实现调度自动化。** | |||
There was a problem hiding this comment.
“Agent管道”，好像并没有这种说法。可以改成“命令管道”与“文件管道"。
”具备大并发处理能力“在这里有点突兀，删除？
感觉这段描述有点拗口，需要更清晰、简练的表述？
比如：
作业平台（Job）是一套基于蓝鲸管控平台”命令管道“、“文件管道”之上的基础操作平台，提供了运维过程中的“命令执行”与“文件分发”两大核心能力。。。
There was a problem hiding this comment.
最早继承了老版本文档中的描述，已修改。
| # 常量定义 | ||
| apidoc_dir = os.path.join(script_dir, "../../../docs/apidoc") | ||
| docs_dir = os.path.join(apidoc_dir, "esb/jobv3-confapis/apidocs/zh_hans") | ||
| docs_link_prefix = "https://github.com/TencentBlueKing/bk-job/blob/3.9.x/docs/apidoc/esb/jobv3-confapis/apidocs/zh_hans/" |
There was a problem hiding this comment.
这个可以不写死，用的时候传入？避免每个版本都需要修改
docs/overview/operation.md
Outdated
| **监控平台**：作业平台通过Prometheus协议暴露出指标数据，会被其采集器采集，便于在监控平台上配置指标面板与告警，此外，作业平台通过OTEL协议调用其接口向其上报调用链APM数据，便于在监控平台上进行调用链观测与分析； | ||
| **消息通知中心**：作业平台调用其接口获取通知与公告信息并在页面进行展示。 | ||
|
|
||
| 由于依赖众多，仅部署作业平台本身是无法正常工作的，需要首先部署其依赖的底层平台，因此请参考[蓝鲸文档中心](https://bk.tencent.com/docs/)部署维护板块的基础套餐相关内容进行部署。 |
docs/overview/operation.md
Outdated
| 在成功部署作业平台后，随着系统运行时长增加，使用数据随之增加，会导致作业平台占用的资源增加，出于成本与性能考虑，需要对资源占用进行管理，必要时按需清理部分过期数据。 | ||
| #### （1）MySQL数据 | ||
| 作业平台的不同功能模块使用不同的数据库存储数据，其中需要重点关注的是任务执行引擎使用的job_execute库，该库存储了任务执行过程中产生的流水数据，数据量随着任务量的增长而增长，通常在平台运行一段时间后，job_execute库会成为占用存储空间最多的库，需要考虑数据的归档与清理。 | ||
| 作业平台自身支持了任务流水数据的自动归档与清理机制，可通过helm chart values中的backupConfig.archive下的属性进行配置，默认的归档策略为：不备份数据，直接删除30天前的过期数据。如果有备份过期数据的需求，可以将策略配置为先备份数据再删除。 |
There was a problem hiding this comment.
关于归档策略的说明不准确。默认策略是不开启归档，用户需要的要需要通过配置 enable 来开启。这里的表述容易让人误以为是默认开启的
1. 处理Review意见； 2. 添加部署与运维英文文档。
1. 添加首页文档链接，清理已过期的二进制安装部署文档。
1. 完善API文档简介，精简接口描述。
wangyu096
approved these changes
Jul 22, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.