Skip to content

Commit

Permalink
Merge pull request #3896 from jzhupup/amamba-outdated-docs
Browse files Browse the repository at this point in the history 
update amamaba outdated docs
  • Loading branch information
@windsonsea
windsonsea authored Feb 23, 2024
2 parents 4ca9329 + fa21f45 commit d4a6dd0
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 16 deletions.
13 changes: 0 additions & 13 deletions docs/zh/docs/amamba/user-guide/pipeline/config/agent.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,19 +87,6 @@ __Jenkins Agent Label: go__
| Kubectl | v1.22.0 |
| 内置工具 | unzip、which、make(GNU Make 3.82)、wget、zip、bzip2、git (2.9.5) |

__Jenkins Agent Label: go16__

| 名称 | 类型/版本 |
| -------- | ------------------------------------------------------------ |
| 容器名称 | go |
| 操作系统 | centos-7 (7.9.2009) |
| Go | 1.16.8 |
| GOPATH | /home/jenkins/go |
| GOROOT | /usr/local/go |
| podman | podman version 3.0.1 |
| Kubectl | v1.22.0 |
| 内置工具 | unzip、which、make(GNU Make 3.82)、wget、zip、bzip2、git (2.9.5) |

__Jenkins Agent Label: node.js__

| 名称 | 类型/版本 |
Expand Down
31 changes: 28 additions & 3 deletions docs/zh/docs/amamba/user-guide/pipeline/config/step.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,9 @@
| 项目 | 本次扫描在 SonaQube 中对应的项目名称 |
| 扫描文件 | 需要扫描代码仓库中文件目录地址 |

## 代码质量检查结果
## 代码质量门禁

此步骤需要配合 __SonarQube 配置__ 步骤一起使用，定义该步骤后会暂停流水线执行，等待 SonarQube 代码扫描分析完成后返回质量门襟状态，来判断是否终止运行当前流水线。
此步骤需要配合 __SonarQube 配置__ 步骤一起使用，定义该步骤后会暂停流水线执行，等待 SonarQube 代码扫描分析完成后返回质量门禁状态，来判断是否终止运行当前流水线。

另外实际使用过程中，需要定义 __超时__ 步骤共同使用，以等待 SonarQube 代码扫描的返回结果，如下：

Expand All @@ -103,4 +103,29 @@ steps {

| 参数 | 说明 |
| -------------------------- | ------------------------------------------------------------ |
| 等待检查结果是否暂停流水线 | 支持 true/fasle 两个选项，如果设置为true，当 SonarQube 代码扫描分析完成后返回质量门襟状态为不健康时，将会终止流水线 |
| 等待检查结果是否暂停流水线 | 支持 true/fasle 两个选项，如果设置为true，当 SonarQube 代码扫描分析完成后返回质量门襟状态为不健康时，将会终止流水线 |

## 更新应用

新版本支持了对当前租户下的工作负载的镜像进行更新。

| 参数 | 说明 |
| -------------- | ------------------------------------------------------------ |
| 集群 | 选择需要更新应用所在的集群 |
| 命名空间 | 选择需要更新应用所在的命名空间 |
| 集群凭证 | 需要事先创建后 kubeconfig 类型的凭证用于连接集群 |
| 工作负载类型 | 支持 Deployment、StatefulSet 、DaemonSet |
| 工作负载名称 | 选择需要更新的工作负载 |
| 容器名称 | 选择当前负载下的容器信息 |
| 镜像地址 | 选择或输入镜像地址 |

## 部署应用

新版本支持了应用的部署，前提条件是需要准备一个 git 仓库，并且仓库中包含了应用的清单文件。该步骤需要与 `Git Clone` 组合进行使用。

| 参数 | 说明 |
| -------------- | ------------------------------------------------------------ |
| 集群 | 选择需要更新应用所在的集群 |
| 命名空间 | 选择需要更新应用所在的命名空间 |
| 集群凭证 | 需要事先创建后 kubeconfig 类型的凭证用于连接集群 |
| 清单文件路径 | 应用的清单文件所在代码仓库的绝对路径 |

0 comments on commit d4a6dd0

Please sign in to comment.