基于工作流集群构建Golang项目的CI Pipeline -

工作流集群基于开源Argo Workflows项目构建，全托管Argo Workflows，具有极致弹性、自动扩展、无运维成本等优势，可以快速实现更简单、低成本、高效率的CI流水线。本文介绍如何基于工作流集群构建Golang项目的CI Pipeline。

方案介绍

工作流集群构建CI Pipeline时，主要使用BuildKit实现容器镜像的构建和推送，并使用BuildKit Cache加速镜像的构建。使用NAS存储Go mod cache，可加速go test和go build运行过程，最终大幅加速CI Pipeline的流程。

预置工作流模板说明

工作流集群中默认已经预置了名为ci-go-v1的CI工作流模板（ClusterWorkflowTemplate），其使用BuildKit Cache和NAS存储Go mod cache，可大幅加速CI Pipeline的流程。

可以直接使用预置模板，也可以基于预置模板自定义自己的CI工作流模板。

预置的CI工作流模板中包含以下流程：

Git Clone & Checkout
- 用于Clone Git仓库，将Git仓库Checkout到目标分支。
- 获取Commit ID，在构建镜像时根据Commit ID追加Tag后缀。
Run Go Test
- 默认运行Git Repo（Go项目）中的所有测试用例。
- 可通过工作流参数enable_test控制是否运行该步骤。
- 其中Go mod cache存储在NAS的/pkg/mod目录，用于go test和后续的go build的加速。
Build & Push Image
- 使用BuildKit构建和推送容器镜像，并使用BuildKit Cache中registry类型的cache来加速镜像构建。
- 镜像Tag默认使用{container_tag}-{commit_id}格式，可在提交工作流时通过参数控制是否追加Commit ID。
- 推送镜像的同时，也会推送覆盖对应版本的镜像。

预置的CI工作流模板完整内容

apiVersion: argoproj.io/v1alpha1
kind: ClusterWorkflowTemplate
metadata:
  name: ci-go-v1
spec:
  entrypoint: main
  volumes:
  - name: run-test
    emptyDir: {}
  - name: workdir
    persistentVolumeClaim:
      claimName: pvc-nas
  - name: docker-config
    secret:
      secretName: docker-config
  arguments:
    parameters:
    - name: repo_url
      value: ""
    - name: repo_name
      value: ""
    - name: target_branch
      value: "main"
    - name: container_image
      value: ""
    - name: container_tag
      value: "v1.0.0"
    - name: dockerfile
      value: "./Dockerfile"
    - name: enable_suffix_commitid
      value: "true"
    - name: enable_test
      value: "true"
  templates:
    - name: main
      dag:
        tasks:
          - name: git-checkout-pr
            inline:
              container:
                image: alpine:latest
                command:
                  - sh
                  - -c
                  - |
                    set -eu
                    
                    apk --update add git
          
                    cd /workdir
                    echo "Start to Clone " {{workflow.parameters.repo_url}}
                    git -C "{{workflow.parameters.repo_name}}" pull || git clone {{workflow.parameters.repo_url}} 
                    cd {{workflow.parameters.repo_name}}
          
                    echo "Start to Checkout target branch" {{workflow.parameters.target_branch}}
                    git checkout --track origin/{{workflow.parameters.target_branch}} || git checkout {{workflow.parameters.target_branch}}
                    git pull
                    
                    echo "Get commit id" 
                    git rev-parse --short origin/{{workflow.parameters.target_branch}} > /workdir/{{workflow.parameters.repo_name}}-commitid.txt
                    commitId=$(cat /workdir/{{workflow.parameters.repo_name}}-commitid.txt)
                    echo "Commit id is got: "$commitId
                                        
                    echo "Git Clone and Checkout Complete."
                volumeMounts:
                - name: "workdir"
                  mountPath: /workdir
                resources:
                  requests:
                    memory: 1Gi
                    cpu: 1
              activeDeadlineSeconds: 1200
          - name: run-test
            when: "{{workflow.parameters.enable_test}} == true"
            inline: 
              container:
                image: golang:1.22-alpine
                command:
                  - sh
                  - -c
                  - |
                    set -eu
                    
                    if [ ! -d "/workdir/pkg/mod" ]; then
                      mkdir -p /workdir/pkg/mod
                      echo "GOMODCACHE Directory /pkg/mod is created"
                    fi
                    
                    export GOMODCACHE=/workdir/pkg/mod
                    
                    cp -R /workdir/{{workflow.parameters.repo_name}} /test/{{workflow.parameters.repo_name}} 
                    echo "Start Go Test..."
                    
                    cd /test/{{workflow.parameters.repo_name}}
                    go test -v ./...
                    
                    echo "Go Test Complete."
                volumeMounts:
                - name: "workdir"
                  mountPath: /workdir
                - name: run-test
                  mountPath: /test
                resources:
                  requests:
                    memory: 4Gi
                    cpu: 2
              activeDeadlineSeconds: 1200
            depends: git-checkout-pr    
          - name: build-push-image
            inline: 
              container:
                image: moby/buildkit:v0.13.0-rootless
                command:
                  - sh
                  - -c
                  - |         
                    set -eu
                     
                    tag={{workflow.parameters.container_tag}}
                    if [ {{workflow.parameters.enable_suffix_commitid}} == "true" ]
                    then
                      commitId=$(cat /workdir/{{workflow.parameters.repo_name}}-commitid.txt)
                      tag={{workflow.parameters.container_tag}}-$commitId
                    fi
                    
                    echo "Image Tag is: "$tag
                    echo "Start to Build And Push Container Image"
                    
                    cd /workdir/{{workflow.parameters.repo_name}}
                    
                    buildctl-daemonless.sh build \
                    --frontend \
                    dockerfile.v0 \
                    --local \
                    context=. \
                    --local \
                    dockerfile=. \
                    --opt filename={{workflow.parameters.dockerfile}} \
                    --opt build-arg:GOPROXY=http://goproxy.cn,direct \
                    --output \
                    type=image,\"name={{workflow.parameters.container_image}}:${tag},{{workflow.parameters.container_image}}:latest\",push=true,registry.insecure=true \
                    --export-cache mode=max,type=registry,ref={{workflow.parameters.container_image}}:buildcache \
                    --import-cache type=registry,ref={{workflow.parameters.container_image}}:buildcache
                    
                    echo "Build And Push Container Image {{workflow.parameters.container_image}}:${tag} and {{workflow.parameters.container_image}}:latest Complete."
                env:
                  - name: BUILDKITD_FLAGS
                    value: --oci-worker-no-process-sandbox
                  - name: DOCKER_CONFIG
                    value: /.docker
                volumeMounts:
                  - name: workdir
                    mountPath: /workdir
                  - name: docker-config
                    mountPath: /.docker
                securityContext:
                  seccompProfile:
                    type: Unconfined
                  runAsUser: 1000
                  runAsGroup: 1000
                resources:
                  requests:
                    memory: 4Gi
                    cpu: 2
              activeDeadlineSeconds: 1200
            depends: run-test

模板中配置的参数如下：

参数	说明	示例值
entrypoint	定义入口模板。	main
repo_url	Git仓库的URL。	https://github.com/ivan-cai/echo-server.git
repo_name	仓库名称。	echo-server
target_branch	仓库的目标分支。默认为main。	main
container_image	要构建的镜像。格式如下： <ACR EE Domain>/<ACR EE命名空间>/<仓库名>。	test-registry.cn-hongkong.cr.aliyuncs.com/acs/echo-server
container_tag	要构建的镜像Tag。默认为v1.0.0。	v1.0.0
dockerfile	Dockerfile目录和文件名。项目根目录下的相对路径，默认为`./Dockerfile`。	`./Dockerfile`
enable_suffix_commitid	是否在镜像Tag后追加Commit ID。 true：追加 false：不追加默认值为true。	true
enable_test	是否开启运行Go Test步骤。 true：开启 false：不开启默认值为true。	true

准备工作

创建Argo工作流集群。
创建NAS文件系统。
创建容器镜像服务企业版实例（ACR EE）。
如果在工作流的CI Pipeline中使用的是私有Git仓库，则需在CI Pipeline中Clone私有Git仓库。

步骤一：在工作流集群中创建ACR企业版实例访问凭证

获取集群KubeConfig并通过kubectl工具连接集群。
为ACR企业版实例配置访问凭证。如果使用VPC域名访问，请确保集群与ACR仓库在同一个VPC网络内，如果通过公网域名访问，请配置公网的访问控制。
替换下方命令中的USER_NAME:PASSWORD为ACR企业版实例的访问凭证，然后执行命令，在工作流集群中创建Secret，供BuildKit使用。
Secret、挂载的NAS存储卷都需要与最终提交的工作流处于同一命名空间。
```
kubectl create secret generic docker-config --from-literal="config.json={\"auths\": {\"$repositoryDomain\": {\"auth\": \"$(echo -n USER_NAME:PASSWORD|base64)\"}}}"
```

步骤二：在工作流集群中挂载NAS存储卷

使用NAS存储卷在工作流的各任务之间共享数据，如Clone的代码仓库信息等，并存储Go mod cache，用于加速CI Pipeline中的go test和go build过程。

登录NAS控制台。
在左侧导航栏，选择文件系统 > 文件系统列表。
在页面左侧顶部，选择目标文件系统所在的资源组和地域。
在文件系统列表页面，单击目标文件系统操作列的管理。
在文件系统详情页面，单击左侧的挂载使用页签，然后在挂载点区域，查看并记录NAS的挂载点。

将下方示例保存到pv-nas.yaml，将MOUNT_POINT替换为NAS挂载点地址，然后执行kubectl apply -f pv-nas.yaml创建存储卷。

apiVersion: v1
kind: PersistentVolume
metadata:
  name: pv-nas
  labels:
    alicloud-pvname: pv-nas
spec:
  capacity:
    storage: 100Gi
  accessModes:
    - ReadWriteMany
  csi:
    driver: nasplugin.csi.alibabacloud.com
    volumeHandle: pv-nas   # 必须与PV Name保持一致。
    volumeAttributes:
      server: MOUNT_POINT
      path: "/"
  mountOptions:
  - nolock,tcp,noresvport
  - vers=3
---
kind: PersistentVolumeClaim
apiVersion: v1
metadata:
  name: pvc-nas
spec:
  accessModes:
    - ReadWriteMany
  resources:
    requests:
      storage: 100Gi
  selector:
    matchLabels:
      alicloud-pvname: pv-nas

步骤三：基于预置模板启动工作流

通过控制台提交工作流

登录容器Argo工作流集群控制台。
在集群信息页面，单击基础信息页签，然后在下方常用操作区域，单击工作流控制台（Argo）。
在Argo工作台左侧导航栏单击Cluster Workflow Templates，然后单击ci-go-v1预置模板名称。
在模板详情页左上角单击+ SUBMIT，然后在弹出的面板中填写相关参数，并在面板下方单击+ SUBMIT。
参数填写请参考模板参数说明将参数值设置为实际使用的参数值。
操作完成后，在Workflows详情页查看工作流运行情况：

通过Argo CLI提交工作流

安装Argo CLI。

将下方示例保存到workflow.yaml，按照模板参数说明将参数值修改为您实际使用的参数值，然后执行argo submit workflow.yaml提交工作流。

apiVersion: argoproj.io/v1alpha1
kind: Workflow
metadata:
  generateName: ci-go-v1-
  labels:
    workflows.argoproj.io/workflow-template: ackone-ci
spec:
  arguments:
    parameters:
    - name: repo_url
      value: https://github.com/ivan-cai/echo-server.git
    - name: repo_name
      value: echo-server
    - name: target_branch
      value: main
    - name: container_image
      value: "test-registry.cn-hongkong.cr.aliyuncs.com/acs/echo-server"
    - name: container_tag
      value: "v1.0.0"
    - name: dockerfile
      value: ./Dockerfile
    - name: enable_suffix_commitid
      value: "true"
    - name: enable_test
      value: "true"
  workflowTemplateRef:
    name: ci-go-v1
    clusterScope: true