DevOps自动化三：简单完整的模板案例

案例说明

• 模拟场景：模拟common、user、大数据代码扫描
• 基本流程：下载代码 -> 执行扫描命令
• 目标：用最简单的方式演示完整模板功能

实现思路

分三步：

1. 编写project.yaml：描述项目、运行环境、编排模板、环境配置等信息
2. 定义模块：定义扫描代码的执行脚本
3. 执行：构造请求参数和执行

应用模板的所有配置文件如下图：

编写project.yaml

包含内容如图

project.yaml内容（编排模板另建文件编写，核心且较复杂）：

kind: Project
apiVersion: api/v1
metadata:
  name: sonar # 项目名称
spec:
  engine:
    sonar: |  # 定义编排模板（一般较复杂且核心，因此另建文件管理）
      %{readText "_projects/sonar.engine.yaml" | indent 6}%
  default:  # 设置全局的默认属性
    env:
      info:
        sonar:  # 设置所有环境的默认sonar地址和token
          url: http://xxx:9090
          token: xxx
  envs:
    prod:
      code:
        branch: master # 按环境设置默认分支
      mvn:
        profile: prod  # maven管理代码 设置profile为prod

编排模板(_projects/sonar.engine.yaml)内容：

first: &first # 扫描的第一部分代码
  sonar:
  - name: common

second: &second # 扫描的第二部分代码
  sonar:
    - name: user

metadata:
  annotations:
    notify-types: "group,personal"
    template: 'sonar:latest'
spec:
  global:
    workflow: # 定义工作流信息
      parallelism: 256  # 并发任务数
      ttlStrategy:
        secondsAfterCompletion: 86400 # 结束工作流保留1天时间
        secondsAfterSuccess: 86400  # 结束工作流保留1天时间
        secondsAfterFailure: 172800 # 失败工作流保留2天时间
    kube: # 定义k8s的运行环境信息
      affinity:
        nodeAffinity:
          requiredDuringSchedulingIgnoredDuringExecution:
            nodeSelectorTerms:
              - matchExpressions:
                  - key: app
                    operator: In
                    values:
                      - ops
      tolerations:
        - key: cattle.io/os
          operator: Equal
          value: linux
          effect: "NoSchedule"
        - key: app
          operator: Equal
          value: ops
          effect: "NoSchedule"
  @{- $part := $.params.annotations.part }@
  stages:
    - name: "sonar"
      desc: "代码质量扫描"
      modules:
        @{- if eq $part "first" }@
        <<: *first  # 当代码仓库数量很多，而资源又有限时分开扫描
        @{- else if eq $part "second" }@
        <<: *second # 当代码仓库数量很多，而资源又有限时分开扫描
        @{- else if eq $part "bigdata" }@ # 分类扫描：为大数据独立构建工作流
        sonar:
          - name: bigdata
        @{- end }@

定义模块

包含内容如图：

模板内容如下（执行脚本较复杂，也另建文件管理）：

sonar:
  __global__: # 模块层的全局配置
    execTmpl: |
      %{readText "code/sca.yaml" | indent 34}%
    default:  # 模块级的默认配置
      type: git # 类型都为git
      config: ""  # 表示不需要生成配置文件
  common:
    labels:
      package: true # 表示公共库
    settings:
      repo: http://xxx/common.git
      mvn:
        api: # 只上传jar包 不打包和构建镜像
          dir: ""
      sonar:
        exclusions: 'src/main/java/xxx/protobuf/**'  # sonar扫描排除pb代码
  user:
    labels:
      role: user  # 属于用户中心；默认（和不填）为公共模块，服务于所有部门；支持多个归属
    settings:
      repo: http://xxx/user.git
      mvn:
        api:
          dir: user-api
        service:
          dir: user-service
  bigdata:
    labels:
      role: bigdata  # 属于大数据中心；默认（和不填）为公共模块，服务于所有部门；支持多个归属
    settings:
      repo: http://xxx/bigdata.git
      branch: dev
      mvn:
        api:
          dir: flink-stream
      sonar:
        exclusions: 'src/main/**/proto/**'

执行脚本模板（code/sca.yaml）如下：

# 分两步：
# 1. 下载代码
# 2. 扫描代码
@{- $env := .env -}@
@{- $repoName := repoName .settings.repo}@
@{- $parent := . }@

- name: git
  image: busybox
  command: [/bin/sh, -c]
  args:
    - |
      echo 下载代码 @{.settings.repo}@ branch:@{ or .settings.tag .settings.branch (render $env.code.branch .) }@

@{- range $type,$val := .settings.mvn}@
- name: mvn-sast-@{$type}@
  depends: [git]
  image: busybox
  command: [/bin/sh, -c]
  args:
    - |
      echo 代码扫描 
      @{- $projName := $repoName }@
      @{- if $val.dir }@
      @{- $projName = concat $projName ":" $val.dir }@
      @{- end}@
      @{- $projName = replace $projName "/" ":" -1 }@
      
      echo 'mvn clean package sonar:sonar -DskipTests -U -P @{$env.mvn.profile}@  \
        @{- if (or $parent.settings.sonar.exclusions "") }@
        -Dsonar.exclusions=@{ $parent.settings.sonar.exclusions }@ \
        @{- end}@
        -Dsonar.projectKey=SAST:@{$projName}@ \
        -Dsonar.projectName=SAST:@{$projName}@ \
        -Dsonar.host.url=@{$env.info.sonar.url}@ \
        -Dsonar.login=@{$env.info.sonar.token}@'

@{- end }@

执行编排

分两步：

1. yaml定义参数
2. cli执行

完整的执行脚本(Makefile)如下：

server=http://localhost:8888

# OPS_USER需设置环境变量，eg：export OPS_USER=xxx
apply-sonar:
    ops apply -p sonar -s ${server} -u ${OPS_USER} -f sonar/project.yaml
    ops apply -p sonar -s ${server} -u ${OPS_USER} -f sonar/definitions/main.yaml
    #扫描common代码
    ops apply -p sonar -s ${server} -u ${OPS_USER} -f sonar/engines/params-common.yaml
    #扫描user代码
    ops apply -p sonar -s ${server} -u ${OPS_USER} -f sonar/engines/params-user.yaml
    #扫描大数据代码
    ops apply -p sonar -s ${server} -u ${OPS_USER} -f sonar/engines/params-bigdata.yaml

扫描第一部分代码(common)

参数定义：

kind: Engine
apiVersion: api/v1
metadata:
  name: sonar-1      # 编排名称：用于编排任务分类
  cron: "0 20 * * *" # 定时任务：每天晚上8点执行一次
  envs:
    - prod           # 指定环境：应用环境定义的属性
  engine: sonar      # 指定项目编排的模板：应用 `project.spec.engine.sonar`编排模板
  annotations:       # 扩展属性：用于编排模板渲染
    part: first
    branch: master

执行

ops apply -p sonar -s ${server} -u ${OPS_USER} -f sonar/engines/params-common.yaml

扫描第二部分代码(user)

参数定义：

kind: Engine
apiVersion: api/v1
metadata:
  name: sonar-2      # 编排名称：用于编排任务分类
  cron: "0 20 * * *" # 定时任务：每天晚上8点执行一次
  envs:
    - prod           # 指定环境：应用环境定义的属性
  engine: sonar      # 指定项目编排的模板：应用 `project.spec.engine.sonar`编排模板
  annotations:       # 扩展属性：用于编排模板渲染
    part: second
    branch: master

执行

ops apply -p sonar -s ${server} -u ${OPS_USER} -f sonar/engines/params-user.yaml

扫描大数据代码(bigdata)

参数定义：

kind: Engine
apiVersion: api/v1
metadata:
  name: sonar-bigdata # 编排名称：用于编排任务分类
  cron: "0 20 * * *" # 定时任务：每天晚上8点执行一次
  envs:
    - prod           # 指定环境：应用环境定义的属性
  engine: sonar      # 指定项目编排的模板：应用 `project.spec.engine.sonar`编排模板
  annotations:       # 扩展属性：用于编排模板渲染
    part: bigdata
    branch: dev

执行

ops apply -p sonar -s ${server} -u ${OPS_USER} -f sonar/engines/params-bigdata.yaml

效果展示

扫描第一部分代码（common）

工作流任务

工作流日志1（下载代码）：

工作流日志2（代码扫描）：

扫描第二部分代码(user)

工作流任务

工作流日志1（下载代码）：

工作流日志2（代码扫描）：

扫描大数据代码(bigdata)

工作流任务（有api和service两个个代码扫描任务）

工作流日志1（下载代码）：

工作流日志2（扫描代码api）：

工作流日志2（扫描代码service）：

结语

只需写模板文件和配置文件就可以构建自己的工作流，保证了<font style="color:red;font-weight:bold">良好的扩展性</font>。

请用微信扫码关注下🙏 ，持续更新云原生DevOps最佳实践。

本文由mdnice多平台发布