diff --git a/docs/DevOps引擎/代码流水线.md b/docs/DevOps引擎/代码流水线.md index 574fc96..671fcd3 100644 --- a/docs/DevOps引擎/代码流水线.md +++ b/docs/DevOps引擎/代码流水线.md @@ -1,4 +1,12 @@ --- sidebar_label: '代码流水线' sidebar_position: 5 ---- \ No newline at end of file +--- +# 代码流水线 + 可以通过代码的形式(YAML格式)来配置流水线，首先选择代码流水线和对应的分支： + + ![code_workflow1](../../static/img/engine/code_workflow1.jpg) + + 编辑流水线代码，其流水线名称描述、触发器、全局参数、执行串行/并发和流水线编排等概念同图形流水线，具体描述如下： + +![code_workflow2](../../static/img/engine/code_workflow2.png) \ No newline at end of file diff --git a/docs/DevOps引擎/参数配置.md b/docs/DevOps引擎/参数配置.md index 379e264..493ea0e 100644 --- a/docs/DevOps引擎/参数配置.md +++ b/docs/DevOps引擎/参数配置.md @@ -1,4 +1,15 @@ --- sidebar_label: '参数配置' sidebar_position: 2 ---- \ No newline at end of file +--- + + # 参数配置 + + 可在流水线中使用，实现动态参数配置；有字符串、数字、布尔三种类型。 + + ![parameter1](../../static/img/engine/parameter1.png) + + +在流水线的配置中通过如下方式获取参数： + + ![parameter2](../../static/img/engine/parameter2.png) \ No newline at end of file diff --git a/docs/DevOps引擎/图形流水线.md b/docs/DevOps引擎/图形流水线.md index e6ae447..1c6cdbe 100644 --- a/docs/DevOps引擎/图形流水线.md +++ b/docs/DevOps引擎/图形流水线.md @@ -1,4 +1,50 @@ --- sidebar_label: '图形流水线' sidebar_position: 4 ---- \ No newline at end of file +--- + + # 图形流水线 + ## 基本信息 +可以编辑流水线的名称、描述 + +同一仓库下的流水线名称不能重复 + +![vis_workflow1](../../static/img/engine/vis_workflow1.png) + +## 触发器 +注：流水线编排时，触发器要放在开始节点之前；目前一条流水线仅添加支持一个触发器 + +* 定时触发器cron：可通过填写cron表达式设置触发的具体时间 +![vis_workflow2](../../static/img/engine/vis_workflow2.png) + +* 事件触发器GitLink_Webhook：给出了常见的代码变更事件触发，包括推送代码、合并请求、创建标签 +![vis_workflow3](../../static/img/engine/vis_workflow3.png) + +## 全局参数 + +添加后可在当前流水线中使用 + +![vis_workflow4](../../static/img/engine/vis_workflow4.png) + +使用实例 + +![vis_workflow5](../../static/img/engine/vis_workflow5.png) + +## 并发执行 + +![vis_workflow6](../../static/img/engine/vis_workflow6.png) + +开启后，同一流水线可同时并发执行n个流水线实例（每触发一次我们得到一个流水线实例）； + +![vis_workflow7](../../static/img/engine/vis_workflow7.png) + +若未开启，则当前流水线实例执行中，后面的实例处于排队状态（最多可排队5个实例）。当前实例执行完成，下一个实例开始执行。 + +![vis_workflow8](../../static/img/engine/vis_workflow8.png) + + +## 流水线编排 + +每条流水线必须要有一个开始节点、结束节点，至少一个任务节点。支持串行编排和并行编排。 + + diff --git a/docs/DevOps引擎/密钥设置.md b/docs/DevOps引擎/密钥设置.md index d8c0987..b28b953 100644 --- a/docs/DevOps引擎/密钥设置.md +++ b/docs/DevOps引擎/密钥设置.md @@ -1,4 +1,16 @@ --- sidebar_label: '密钥设置' sidebar_position: 3 ---- \ No newline at end of file +--- + + # 密钥设置 + +将账号密码、密钥、证书等存放到密钥管理里，配置后可直接在流水线中使用，避免因直接填写引起的泄露风险。 + +![secret1](../../static/img/engine/secret1.png) + +使用示例 + +注：节点输入参数中，下拉选项为密钥类型，需要提前配置好密钥在流水线中选择使用 + +![secret2](../../static/img/engine/secret2.png) \ No newline at end of file diff --git a/docs/DevOps引擎/引擎简介.md b/docs/DevOps引擎/引擎简介.md index ef12216..e63549a 100644 --- a/docs/DevOps引擎/引擎简介.md +++ b/docs/DevOps引擎/引擎简介.md @@ -1,4 +1,13 @@ --- sidebar_label: '引擎简介' sidebar_position: 1 ---- \ No newline at end of file +--- + + # 引擎 + +引擎(Engine)是GitLink提供的一款DevOps工具，通过简单的节点编排来构建开发、测试、部署流水线，从而创建自动化的软件交付流程。 +它可以实现持续的代码集成，让开发者能尽早发现质量问题，快速定位修复，提升软件开发效率和质量；自动化的代码扫描、编译打包、单元测试，把研发团队从重复的工作中解放出来，聚焦到更有价值的事情上。 + +![engine_intro](../../static/img/engine/engine_intro.jpg) + +在引擎页面中，用户可以创建和编辑图形流水线或代码流水线、设置外部参数、管理密钥等操作。 \ No newline at end of file diff --git a/docs/DevOps引擎/执行记录查询.md b/docs/DevOps引擎/执行记录查询.md index 874b532..30ca593 100644 --- a/docs/DevOps引擎/执行记录查询.md +++ b/docs/DevOps引擎/执行记录查询.md @@ -1,4 +1,10 @@ --- sidebar_label: '执行记录查询' sidebar_position: 6 ---- \ No newline at end of file +--- + + # 执行记录查询 + + 用户可以查看流水线的运行状态 + + ![result](../../static/img/engine/result.png) \ No newline at end of file diff --git a/static/img/engine/code_workflow1.jpg b/static/img/engine/code_workflow1.jpg new file mode 100644 index 0000000..4a8b3c2 Binary files /dev/null and b/static/img/engine/code_workflow1.jpg differ diff --git a/static/img/engine/code_workflow2.png b/static/img/engine/code_workflow2.png new file mode 100644 index 0000000..07af173 Binary files /dev/null and b/static/img/engine/code_workflow2.png differ diff --git a/static/img/engine/engine_intro.jpg b/static/img/engine/engine_intro.jpg new file mode 100644 index 0000000..954f1cd Binary files /dev/null and b/static/img/engine/engine_intro.jpg differ diff --git a/static/img/engine/parameter1.png b/static/img/engine/parameter1.png new file mode 100644 index 0000000..d8b6a66 Binary files /dev/null and b/static/img/engine/parameter1.png differ diff --git a/static/img/engine/parameter2.png b/static/img/engine/parameter2.png new file mode 100644 index 0000000..72dfc31 Binary files /dev/null and b/static/img/engine/parameter2.png differ diff --git a/static/img/engine/result.png b/static/img/engine/result.png new file mode 100644 index 0000000..71a8e02 Binary files /dev/null and b/static/img/engine/result.png differ diff --git a/static/img/engine/secret1.png b/static/img/engine/secret1.png new file mode 100644 index 0000000..b4d850e Binary files /dev/null and b/static/img/engine/secret1.png differ diff --git a/static/img/engine/secret2.png b/static/img/engine/secret2.png new file mode 100644 index 0000000..208bfb6 Binary files /dev/null and b/static/img/engine/secret2.png differ diff --git a/static/img/engine/vis_workflow1.png b/static/img/engine/vis_workflow1.png new file mode 100644 index 0000000..abc964d Binary files /dev/null and b/static/img/engine/vis_workflow1.png differ diff --git a/static/img/engine/vis_workflow2.png b/static/img/engine/vis_workflow2.png new file mode 100644 index 0000000..ba3f9b2 Binary files /dev/null and b/static/img/engine/vis_workflow2.png differ diff --git a/static/img/engine/vis_workflow3.png b/static/img/engine/vis_workflow3.png new file mode 100644 index 0000000..b2b4704 Binary files /dev/null and b/static/img/engine/vis_workflow3.png differ diff --git a/static/img/engine/vis_workflow4.png b/static/img/engine/vis_workflow4.png new file mode 100644 index 0000000..8e8e63e Binary files /dev/null and b/static/img/engine/vis_workflow4.png differ diff --git a/static/img/engine/vis_workflow5.png b/static/img/engine/vis_workflow5.png new file mode 100644 index 0000000..bdcec1e Binary files /dev/null and b/static/img/engine/vis_workflow5.png differ diff --git a/static/img/engine/vis_workflow6.png b/static/img/engine/vis_workflow6.png new file mode 100644 index 0000000..57d51c7 Binary files /dev/null and b/static/img/engine/vis_workflow6.png differ diff --git a/static/img/engine/vis_workflow7.png b/static/img/engine/vis_workflow7.png new file mode 100644 index 0000000..09d9bf1 Binary files /dev/null and b/static/img/engine/vis_workflow7.png differ diff --git a/static/img/engine/vis_workflow8.png b/static/img/engine/vis_workflow8.png new file mode 100644 index 0000000..c7c5f29 Binary files /dev/null and b/static/img/engine/vis_workflow8.png differ