聊聊gitlab ci如何构建以时间为版本号的docker镜像

前言

最近朋友他们部门有部分内部项目，打算用gitlab ci来做项目持续集成部署，他们有个需求，构建docker镜像的时候，版本需要是以当前时间作为版本。其格式为yyyymmddhhmm

一开始朋友翻阅官方文档，发现gitlab ci有个变量CI_COMMIT_TIMESTAMP，可以生成时间戳，他默认生成的格式是ISO-8601。就是类似2022-01-31T16:47:55Z这种，很显然和朋友他们的需求不符合。于是他就想用如下方式进行转换

before_script:
 - IMAGE_TAG="$(date -d @$CI_COMMIT_TIMESTAMP +"%Y%m%d%H%M%S")"
 - export  BUILD_IMAGE=$REGISTRY/lybgeek/$CI_COMMIT_REF_NAME/$SVC_NAME:$IMAGE_TAG

结果报如下错

date: invalid date '2024-02-20T14:18:50+08:00'

后面他调整为如下方式，即直接用date命令输出当前时间戳

variables:
  IMAGE_TAG: $(date +%Y%m%d%H%M)
 BUILD_IMAGE=$REGISTRY/lybgeek/$CI_COMMIT_REF_NAME/$SVC_NAME:$IMAGE_TAG

结果这种方式输出来的镜像形如下

192.168.0.2/lybgeek/develop/hello: date +%Y%m%d%H%M

很明显$(date +%Y%m%d%H%M)被认为是普通字符串。后面他就找我探讨。今天这篇文章主要就是分享如何构建以时间为版本号的docker镜像

如何在gitlab ci构建以时间为版本的镜像

注： 朋友他们的gitlab版本为14.10。gitlab-runner的executor的类型是docker

1、gitlab ci如何获取当前时间

基本上搜索出来的资料，获取当前时间的方式，都是

$(date +%Y%m%d%H%M)

朋友试了以后，一直都是以字符串显示，于是就怀疑是不是朋友他们装的gitlab-runner，不支持date命令，后来我们就直接在构建docker镜像的job里面，执行

$(date +%Y%m%d%H%M)相关指令

示例如下

docker_build_push:
  stage: 构建镜像并推送
  tags:
    - devops
  image: $REGISTRY/devops/docker:20.10.6-dind
  script:
    - IMAGE_TAG="$(date +%Y%m%d%H%M)"
    - echo $IMAGE_TAG

结果可以正常拿到时间。

2、构建并推送镜像

拿到时间后，我们就可以很容易构建出镜像了。构建镜像并推送的示例形如下

docker_build_push:
  stage: 构建镜像并推送
  tags:
    - devops
  image: $REGISTRY/devops/docker:20.10.6-dind
  script:
    - IMAGE_TAG="$(date +%Y%m%d%H%M)"
    - echo $IMAGE_TAG
    - BUILD_IMAGE=$REGISTRY/lybgeek/$CI_COMMIT_REF_NAME/$SVC_NAME:$IMAGE_TAG
    - docker build --build-arg REGISTRY=$REGISTRY --build-arg BUILD_TARGET_DIR=$BUILD_TARGET_DIR --build-arg GIT_COMMIT_SHA=$CI_COMMIT_SHA -t $BUILD_IMAGE .
    - if [ "$REGISTRY_USER" != "" ]; then docker login $REGISTRY -u $REGISTRY_USER -p $REGISTRY_PASSWORD; fi
    - docker push $BUILD_IMAGE
    - echo $BUILD_IMAGE
  cache:
    key: maven_target_cache
    paths:
      - $BUILD_TARGET_DIR
    policy: pull

结果可以成功构建出形如下镜像

192.168.0.2/lybgeek/develop/hello:202402210317

镜像成功后，如何利用gitlab将容器推送到k8s?

朋友他们公司是用rancher来管理k8s，因此他们原来的将容器推送到k8s，是利用rancher-cli。示例如下

deploy_to_rancher:
  stage: 部署到开发环境
  tags:
    - devops
  image: $REGISTRY/devops/rancher-cli:2.6.3
  script:
    - rancher login $RANCHER_SERVER_URL --token $RANCHER_DEPLOY_TOKEN --skip-verify --context $RANCHER_PROJECT_ID
    - rancher kubectl set image deployment $k8S_DEPLOYMENT$K8S_DEPLOYMENT_VERSION $k8S_DEPLOYMENT=$BUILD_IMAGE -n $K8S_DEPLOYMENT_NAMESPACE

可是执行后发现$BUILD_IMAGE值是空的，为空的原因是pipeline中定义在job中的变量，是不能在不同的job中进行传递。

官方提供了artifacts功能。通过artifacts可以实现不同job之间的变量传递，其本质就是通过artifacts，生成制品。其他job下载该制品，然后引用制品里面的内容，从而达到变量传递的效果

不同job间变量传递

1、生成制品

核心样例

docker_build_push:
  stage: 构建镜像并推送
  tags:
    - devops
  image: $REGISTRY/devops/docker:20.10.6-dind
  script:
    - IMAGE_TAG="$(date +%Y%m%d%H%M)"
    - echo $IMAGE_TAG
    - BUILD_IMAGE=$REGISTRY/lybgeek/$CI_COMMIT_REF_NAME/$SVC_NAME:$IMAGE_TAG #docker镜像完整地址
    - echo $BUILD_IMAGE > docker_images_version.env
  artifacts:
    paths:
      - docker_images_version.env
    expire_in: 15 min

该样例就是将$BUILD_IMAGE内容写入到docker_images_version.env文件，并通过artifacts功能生成制品，同时设置制品的有效期为15分钟

2、其他job引用制品

deploy_to_rancher:
  stage: 部署到开发环境
  tags:
    - devops
  image: $REGISTRY/devops/rancher-cli:2.6.3
  script:
    - BUILD_IMAGE=$(cat docker_images_version.env)
    - rancher login $RANCHER_SERVER_URL --token $RANCHER_DEPLOY_TOKEN --skip-verify --context $RANCHER_PROJECT_ID
    - rancher kubectl set image deployment $k8S_DEPLOYMENT$K8S_DEPLOYMENT_VERSION $k8S_DEPLOYMENT=$BUILD_IMAGE -n $K8S_DEPLOYMENT_NAMESPACE

核心就是通过形如下

BUILD_IMAGE=$(cat docker_images_version.env)

进行引用

注： 官方也有相应示例，它是利用needs或者dependencies进行制品引用

官方示例如下

build-job1:
  stage: build
  script:
    - echo "BUILD_VERSION=v1.0.0" >> build.env
  artifacts:
    reports:
      dotenv: build.env

build-job2:
  stage: build
  needs: []
  script:
    - echo "This job has no dotenv artifacts"

test-job1:
  stage: test
  script:
    - echo "$BUILD_VERSION"  # Output is: 'v1.0.0'
  dependencies:
    - build

不过因为可能是朋友gitlab的版本比较低，识别不出needs属性，报错了。如果用官方提供如下配置

 artifacts:
    reports:
      dotenv: build.env

进行制品上报，其变量属性格式必须是

VARIABLE_NAME=ANY VALUE HERE

其详细介绍可以查看官方文档
https://docs.gitlab.cn/jh/ci/variables/

总结

写这篇文章的初衷，是我和朋友查了一些资料，比如如何在gitlab ci生成时间戳以及如何在job之间进行变量传递，好像没查到比较完整的资料，尤其官方的job之间变量传递，他适配的方式是比较高版本。因此就写这篇文章记录下，看能不能帮到有遇到类似场景的朋友