使用模板构建 Java 流水线
该流水线旨在自动化 Java 应用的完整 CI/CD 工作流。
它具有可重用性和灵活性,支持自定义构建参数、多工作区以及步骤的条件执行。
主要特性:
- ✅ 灵活的代码来源
- ⚙️ 可定制的 Maven 配置
- 🚀 支持 Maven 本地仓库缓存
- 🔌 通过参数实现可插拔任务
- 🛠️ 动态镜像构建与推送
- ☁️ 通过 kubectl 更新工作负载镜像
目录
使用 hub 解析器指定
以下示例 PipelineRun 引用了目录中的流水线:
参数
Git Clone
-
git-url
- type: string
- default:
"" - description: 要克隆的仓库 URL。
-
git-revision
- type: string
- default:
"" - description: 要检出的修订版本(分支、标签、sha、ref 等)。
-
skip-git-clone
- type: string
- default:
"false" - description: 跳过执行 git clone 任务。仅当对应代码仓库已存在于工作区时可启用。
-
git-crt-file-name
- type: string
- default:
"ca-bundle.crt" - description: 使用 ssl-ca-directory 工作区挂载的 crt 文件名,默认值为 ca-bundle.crt。
Maven
-
maven-subdirectory
- type: string
- default:
. - description: Maven 项目的上下文目录。
-
maven-goals
- type: array
- default:
["package"] - description: 要执行的 Maven 目标。
-
maven-mirror-url
- type: string
- default:
"" - description: Maven 仓库镜像 URL。
SonarQube Scanner
-
sonar-url
- type: string
- default:
"" - description: SonarQube 服务器实例的 URL。未指定时将跳过 sonarqube scanner 任务。
-
sonar-project-key
- type: string
- default:
"" - description: SonarQube 项目的唯一键。
-
sonar-properties
- type: array
- default:
["sonar.sources=.", "sonar.java.binaries=target/classes"] - description: 传递给 SonarQube 的额外属性。详情请参考 Configuration of SonarQube properties。
构建镜像
-
images
- type: array
- description: buildah 将生成的镜像引用。可包含多个以逗号分隔的镜像地址。例如:
- busybox:latest
- busybox:v1 .30.1
-
dockerfile-path
- type: string
- default: ./Dockerfile
- description: 用于构建的 Dockerfile 路径。
-
build-extra-args
- type: string
- default: ""
- description: 构建镜像时传递给构建命令的额外参数。警告 - 必须进行安全过滤以避免命令注入(例如 --build-arg key=value --label key=value)。
-
build-args
- type: array
- default: [""]
- description: 指定构建参数及其值,会在 Dockerfile 指令中进行插值,但不会加入最终镜像配置的环境变量列表。例如 HTTP_PROXY=http://10.10.10.10:8080。
-
build-context
- type: string
- default: .
- description: 用作构建上下文的目录路径。
-
push-extra-args
- type: string
- default: ""
- description: 推送镜像时传递给 push 命令的额外参数。警告 - 必须进行安全过滤以避免命令注入(例如 --creds=username:password )。
Trivy Scanner
-
skip-trivy-scan
- type: string
- default: "false"
- description: 设置为跳过构建后 Trivy 镜像扫描。
-
trivy-extra-args
- type: string
- default: ""
- description: 扫描镜像时传递给 trivy 命令的额外参数。警告 - 必须进行安全过滤以避免命令注入(例如 --insecure)。可使用
--skip-db-update和--skip-java-db-update跳过漏洞数据库更新。
部署或升级工作负载
-
workload-name
- type: string
- default: ""
- description: 要部署或升级的工作负载名称。未指定时将跳过
deploy-or-upgrade任务。
-
workload-kind
- type: string
- default: Deployment
- description: 要部署或升级的工作负载类型,如 Deployment、StatefulSet 等。
-
workload-namespace
- type: string
- default: ""
- description: 要部署或升级的工作负载所在命名空间。未指定时使用当前 TaskRun 的命名空间。
-
workload-container
- type: string
- default: []
- description: 指定需要更新镜像的工作负载内容器。默认更新工作负载中所有容器的镜像。
-
workload-rollout-timeout
- type: string
- default: "0"
- description: 等待工作负载就绪的超时时间,
0表示永不超时。其他值需包含时间单位(例如 1s、2m、3h)。
-
workload-manifests-dir
- type: string
- default: ""
- description: 要部署的工作负载清单目录。未指定时仅更新集群中已有工作负载的镜像。可使用
source工作区中清单目录的相对路径,例如 "manifests"。
工作区
- source:任务间共享信息的工作区。
- git-basic-auth:一个可选工作区,包含 .gitconfig 和 .git-credentials 文件,执行 git 命令前会复制到用户主目录。其他文件会被忽略。强烈建议优先使用 ssh-directory 并绑定 Secret。
- git-ssh-directory:一个可选工作区,包含私钥、known_hosts、config 等,执行 git 命令前复制到用户主目录,用于远程认证。强烈建议绑定 Secret。
- git-ssl-ca-directory:一个可选工作区,包含 CA 证书,用于 Git 通过 HTTPS 验证对端。
- maven-settings:一个可选工作区,包含自定义 Maven 配置。
- maven-local-repo:一个可选工作区,用于 Maven 本地仓库。
- maven-server-secret:一个可选工作区,包含服务器凭据。
- maven-trust-store:一个可选工作区,包含 Maven 使用的私有 CA 的 JKS 信任库。
- sonar-settings:一个可选工作区,用于挂载 SonarQube 属性。
- sonar-credentials:一个可选工作区,包含 SonarQube 使用的凭据。
- dockerconfig:一个可选工作区,用于分发注册表配置文件,如
config.json或.dockerconfigjson,用于推送镜像时的认证。 - kubeconfig:一个可选工作区,包含 kubeconfig 文件,文件名应为
kubeconfig。若无该文件,则忽略此工作区。
平台
该任务支持在 linux/amd64 和 linux/arm64 平台运行。
使用方法
最小配置:使用最少参数运行端到端流水线
未设置或省略的可选任务(如 sonarqube-scanner、deploy-or-upgrade 等)将被自动跳过。
使用 Maven Settings.xml
可以挂载 maven-settings 工作区以应用 Maven 构建的 settings.xml。
也可以使用 maven-mirror-url 参数设置 Maven 仓库镜像,该参数会作为 settings.xml 中 <mirror> 的 URL。
使用构建缓存加速 CI
挂载持久化的 maven-local-repo 工作区缓存 .m2/repository 内容,跨流水线运行复用依赖,显著减少 Maven 依赖解析时间,极大缩短构建时长。
SonarQube 属性配置
可以挂载 sonar-settings 工作区或使用 sonar-properties 参数应用 sonar-project.properties 文件的属性。
默认属性为:sonar.sources=.,sonar.java.binaries=target/classes。
SonarQube 属性的用法详见 analysis parameters 和 Java 语言属性。
以下是部分可设置的属性:
部署或升级工作负载
可以使用流水线中 build-image 任务构建的镜像部署或升级工作负载。
通过设置 workload-manifests-dir 参数,可从指定目录应用 Kubernetes 清单以创建或更新工作负载。
支持 JSON 和 YAML 格式。指定目录下的所有清单将通过 kubectl apply 处理。注意 kubectl apply 不会递归子目录。
若目录包含 Kustomize 配置文件(如 kustomization.yaml、kustomization.yml 或 Kustomization),将使用 kubectl kustomize 处理。
以下是 workload-manifests-dir 的示例结构:
可配置以下参数:
如果不想使用清单部署工作负载,只需将 workload-manifests-dir 参数留空。此时任务仅更新集群中已有工作负载的镜像。
需要自行管理工作负载的镜像拉取密钥。如果新镜像托管在不同的注册表,请确保为工作负载创建并配置相应的拉取密钥。
通过参数跳过任务
流水线支持通过参数跳过任务:
全任务示例
该示例演示如何使用流水线中的所有任务,包括:
- 克隆源代码
- 使用 Maven 构建代码
- 构建镜像并推送到注册表
- 使用 Trivy 扫描镜像
- 使用 SonarQube 扫描代码
- 部署或升级工作负载