DevOps GitLab CICD 实践3——CI文件编写

释放双眼,带上耳机,听听看~!

前置步骤:

  • DevOps GitLab CICD 实践1——GitLab 部署
  • DevOps GitLab CICD 实践2——Runner 部署

官方文档

编写结构类似Jenkins pineline流水线

GitLab CI/CD Pipeline Configuration Reference

GitLab CI/CD Pipeline Configuration Reference

GitLab CI/CD pipelines are configured using a YAML file called .gitlab-ci.yml within each project.

The .gitlab-ci.yml file defines the structure and order of the pipelines and determines:

  • What to execute using GitLab Runner.
  • What decisions to make when specific conditions are encountered. For example, when a process succeeds or fails.

This topic covers CI/CD pipeline configuration. For other CI/CD configuration information, see:

  • GitLab CI/CD Variables, for configuring the environment the pipelines run in.
  • GitLab Runner advanced configuration, for configuring GitLab Runner.

We have complete examples of configuring pipelines:

  • For a quick introduction to GitLab CI, follow our quick start guide.
  • For a collection of examples, see GitLab CI/CD Examples.
  • To see a large .gitlab-ci.yml file used in an enterprise, see the .gitlab-ci.yml file for gitlab-ce.

目标

  • maven项目自动打包
  • 自动测试
  • 自动镜像构建并上传

官方参数表列出了作业的可用参数:

script
由Runner执行的Shell脚本。
image
使用泊坞窗图像。也可用:image:name和image:entrypoint。
services
使用docker services图像。也可用:services:name,services:alias,services:entrypoint,和services:command。
before_script
覆盖在作业之前执行的一组命令。
after_script
覆盖作业后执行的一组命令。
stages
定义管道中的阶段。
stage
定义作业阶段(默认值:) test。
only
创建作业时限制。也可用:only:refs,only:kubernetes,only:variables,和only:changes。
except
在未创建作业时限制。也可用:except:refs,except:kubernetes,except:variables,和except:changes。
tags
用于选择Runner的标签列表。
allow_failure
让工作失败。失败的作业无助于提交状态。
when
什么时候开始工作。也可用:when:manual和when:delayed。
environment
作业部署到的环境的名称。也可用:environment:name,environment:url,environment:on_stop,和environment:action。
cache
后续运行之间应缓存的文件列表。也可用:cache:paths,cache:key,cache:untracked,和cache:policy。
artifacts
成功附加到作业的文件和目录列表。也可用:artifacts:paths,artifacts:name,artifacts:untracked,artifacts:when,artifacts:expire_in,artifacts:reports,和artifacts:reports:junit。 在GitLab 企业版,这些都是可供选择:artifacts:reports:codequality,artifacts:reports:sast,artifacts:reports:dependency_scanning,artifacts:reports:container_scanning,artifacts:reports:dast,artifacts:reports:license_management,和artifacts:reports:performance。
dependencies
作业所依赖的其他作业,以便您可以在它们之间传递工件。
coverage
给定作业的代码覆盖率设置。
retry
在发生故障的情况下,可以自动重试作业的次数和次数。
parallel
应该并行运行多少个作业实例。
trigger
定义下游管道触发器。
include
允许此作业包含外部YAML文件。也可用:include:local,include:file,include:template,和include:remote。
extends
此作业将继承的配置条目。
pages
上传作业结果以用于GitLab Pages。
variables
在作业级别定义作业变量。

注: 参数types和type被弃用。

参考

官方构建案例

Deploy a Spring Boot application to Cloud Foundry with GitLab CI/CD

参考其脚本

Configure GitLab CI/CD to deploy your application

Now we need to add the GitLab CI/CD configuration file (.gitlab-ci.yml) to our project’s root. This is how GitLab figures out what commands need to be run whenever code is pushed to our repository. We will add the following .gitlab-ci.yml file to the root directory of the repository, GitLab will detect it automatically and run the steps defined once we push our code:


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
1image: java:8
2
3stages:
4  - build
5  - deploy
6
7build:
8  stage: build
9  script: ./mvnw package
10  artifacts:
11    paths:
12      - target/demo-0.0.1-SNAPSHOT.jar
13
14production:
15  stage: deploy
16  script:
17  - curl --location "https://cli.run.pivotal.io/stable?release=linux64-binary&source=github" | tar zx
18  - ./cf login -u $CF_USERNAME -p $CF_PASSWORD -a api.run.pivotal.io
19  - ./cf push
20  only:
21  - master
22复制代码
23

配置

全局变量

进入工程CI设置配置全局变量脚本,包含镜像仓库登陆名称、密码、打包名称等

配置全局变量目的在于配置脚本中不应该包含密码等敏感信息

若希望使用GitLab内置环境变量,可参考官方表格

GitLab CI/CD environment variables

CI脚本

结合可用参数和样例配置,根据已经存在的SpringBoot项目编写响应的CI脚本.gitlab-ci.yml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
1image: docker:stable
2services:
3  - docker:dind
4
5variables:
6  DOCKER_DRIVER: overlay
7  SPRING_PROFILES_ACTIVE: gitlab-ci
8
9stages:
10  - build
11  - package
12
13maven-build:
14  image: maven:3-jdk-8
15  stage: build
16  script: "mvn package -B"
17  artifacts:
18    paths:
19      - target/*.jar
20
21docker-build:
22  stage: package
23  script:
24    - docker build -t $CONTAINER_IMAGE:latest .
25    - docker login -u $DOCKER_HUB_USER -p $DOCKER_HUB_PASS
26    - docker push $CONTAINER_IMAGE:latest
27复制代码
28

该脚本对于满足脚本目标的工程都可复用,若需要测试,则增加相关的测试步骤即可

此处由于工程包含外部依赖关系,不在构建时测试

自动构建

默认的触发构建事件为commit等

触发后会自动执行任务

Maven自动触发构建

自动镜像打包

自动上传(推送)镜像

执行结果

若执行失败则会发送邮件给开发人员

CICD全套流程目标实现!

总结

不管使用GitLab CICD或者是使用Jenkins+Ansible的方式,目标都在于践行DevOps,打通开发与运维流程,一旦配置好CICD流程,往后开发人员便不再操心打包、构建等操作,可以专注开发

给TA打赏
共{{data.count}}人
人已打赏
安全运维

故障复盘的简洁框架-黄金三问

2021-9-30 19:18:23

安全运维

OpenSSH-8.7p1离线升级修复安全漏洞

2021-10-23 10:13:25

个人中心
购物车
优惠劵
今日签到
有新私信 私信列表
搜索