基于 Gitlab Runner 构建 Gin-Vue-Admin 后端 server 服务CI/CD

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

   GitLab
     ↓
 push / merge 到 master
     ↓
 GitLab Runner（安装在 192.168.1.100）
     ↓
 Docker build 镜像
     ↓
 Docker push 镜像只Harbor仓库
     ↓
 kubectl apply -f deployment.yaml
     ↓
 访问 NodePort 端口

1
2
3
4
5
6
7

开发者 push 代码
       ↓
GitLab 触发 Pipeline
       ↓
Runner 拉取代码执行 Job
       ↓
返回执行日志和状态给 GitLab

 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

# ubuntu 在线安装
sudo apt update
# 配置 runner 仓库
curl -L https://packages.gitlab.com/install/repositories/runner/gitlab-runner/script.deb.sh | sudo bash
sudo apt install gitlab-runner -y

# Redhat 在线安装
# 配置 runner 仓库
curl -s https://packages.gitlab.com/install/repositories/runner/gitlab-runner/script.rpm.sh | sudo bash
sudo yum install gitlab-runner-18.4.0 -y

# 检查版本
gitlab-runner --version

# 在线安装后会创建了gitlab-runner用户，但是gitlab-runner用户权限有限
grep gitlab-runner /etc/passwd

# 启动建议使用 root 用户,不然在流水线脚本中引用了其它命令会提示权限问题(否则联系运维进行提权)
sudo gitlab-runner install --user=root --working-directory=/home/gitlab-runner

# 启动
gitlab-runner start

# 卸载
gitlab-runner uninstall

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

# 下载二进制文件
sudo curl -L --output /usr/local/bin/gitlab-runner \
https://gitlab-runner-downloads.s3.amazonaws.com/latest/binaries/gitlab-runner-linux-amd64

# 赋予执行权限
sudo chmod +x /usr/local/bin/gitlab-runner

# 创建运行用户
sudo useradd --comment 'GitLab Runner' --create-home gitlab-runner --shell /bin/bash

# 安装，这里还是使用root 权限
sudo gitlab-runner install --user=root --working-directory=/home/gitlab-runner
sudo gitlab-runner start

# 检查版本
gitlab-runner --version

1
2

# 直接配置，通过gitlab 获取runner token
sudo gitlab-runner register --url http://192.168.1.10/ --registration-token bixxxxxxhj8-xQ4V4

 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
29

Please enter the gitlab-ci coordinator URL: https://gitlab.example.com/
Please enter the gitlab-ci token: <项目中显示的 Runner Token>
Please enter the gitlab-ci description: my-runner
Please enter the gitlab-ci tags: gva
Please enter the executor: docker
Please enter the default Docker image: docker:24.0.2

# 交互式配置
[root@master gitlab-runner]# gitlab-runner register
Runtime platform            arch=amd64 os=linux pid=4168532 revision=139a0ac0 version=18.4.0
Running in system-mode.                            
                                                   
Enter the GitLab instance URL (for example, https://gitlab.com/):
http://192.168.1.10/
Enter the registration token:
bixxxxxxhj8-xQ4V4
Enter a description for the runner:
[master]: cloudbackend
Enter tags for the runner (comma-separated):
gva
Enter optional maintenance note for the runner:
gavin
WARNING: Support for registration tokens and runner parameters in the 'register' command has been deprecated in GitLab Runner 15.6 and will be replaced with support for authentication tokens. For more information, see https://docs.gitlab.com/ci/runners/new_creation_workflow/ 
Registering runner... succeeded                     correlation_id=01K7R3R2FPKS1RPQGWR4G9DZWQ runner=biixrApv2
Enter an executor: parallels, docker, docker+machine, kubernetes, instance, shell, virtualbox, docker-windows, docker-autoscaler, custom, ssh:
shell
Runner registered successfully. Feel free to start it, but if it's running already the config should be automatically reloaded!
 
Configuration (with the authentication token) was saved in "/etc/gitlab-runner/config.toml" 

1
2
3
4

sudo systemctl enable gitlab-runner
sudo systemctl start gitlab-runner
sudo systemctl status gitlab-runner
sudo gitlab-runner status

1

gitlab-runner list

1
2
3
4
5
6

build:
  stage: build
  tags:
    - gva       # Runner 标签（匹配 Runner）
  script:
    - echo "Build project"

  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
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200

stages:
  - prepare     # 定义JOB全局环境变量
  - build     # 编译
  - push      # 镜像推送
  - deploy    # 部署
  - notify    # 通知


# 全局变量定义
variables:
  PROJECT_NAME: gin-vue-admin
  IMAGE_NAME: harbor.example.net/library/cloudbackend       # 修改为你的 Harbor 项目地址
  K8S_DEPLOY_FILE: deploy/cloudbackend-deployment.yaml        # k8s 部署文件路径
  K8S_DEPLOY_CM_FILE: deploy/cloudbackend-configmap.yaml
  K8S_DEPLOY_SERVICE_FILE: deploy/cloudbackend-service.yaml
  K8S_NAMESPACE: default
  DOCKER_DRIVER: overlay2
  TIMEOUT: "90s"
  BACKUP_DIR: /opt/deploy/csg-cloud/backend/release       # ✅ 镜像备份路径
  KEEP_VERSIONS: 5                            # ✅ 保留最近5个版本


# ==========================================
# 定义 JOB 全局变量，生成时间戳并保存为 artifact (一次生成，全局共享)
# ==========================================
prepare:
  stage: prepare
  tags:
    - gva
  script:
    - echo "IMAGE_TAG=$(date '+%Y%m%d%H%M%S')" > image_tag.env
    - cat image_tag.env
  artifacts:
    reports:
      dotenv: image_tag.env     # ✅ GitLab 会把这里的变量注入后续 Job 环境中
  only:
    - master

# ==========================================
# Stage 1: 构建镜像
# ==========================================
build:
  stage: build
  tags:
    - gva
  before_script:
    - docker info
  script:
    - 'echo "开始时间: $(date)"'
    - 'echo "=== Step 1: 开始构建镜像 ==="'
    - docker build --network=host -t $IMAGE_NAME:$IMAGE_TAG .
    - docker image prune -f    # ✅ 构建后清理 无标签dangling 镜像，节省空间
    - echo "=== 镜像构建完成 $IMAGE_NAME:$IMAGE_TAG ==="
    - 'echo "结束时间: $(date)"'
  only:
    - master

# ==========================================
# Stage 2: 推送镜像到 Harbor
# ==========================================
push:
  stage: push
  tags:
    - gva
  before_script:
    - echo "=== 登录 Harbor 仓库 ==="
    - echo $HARBOR_PASSWORD | docker login $HARBOR_IP  -u $HARBOR_USER --password-stdin
  script:
    - 'echo "开始时间： $(date)"'
    - 'echo "=== Step 2: 推送镜像 ==="'
    - docker push $IMAGE_NAME:$IMAGE_TAG
    - echo "=== 镜像推送成功 $IMAGE_NAME:$IMAGE_TAG ==="
    - 'echo "结束时间： $(date)"'
  only:
    - master

# ==========================================
# Stage 3: 部署到 k8s 并支持自动回滚
# ==========================================
deploy:
  stage: deploy
  tags:
    - gva
  before_script:
    - echo "=== 准备 K8s 环境 ==="
    - echo "当前命名空间 $K8S_NAMESPACE"
    - kubectl version --client
  script:
    - 'echo "开始时间： $(date)"'
    - 'echo "=== Step 3: 记录当前镜像版本 ==="'
    # ✅ 判断 deployment 是否存在
    - |
      if kubectl get deploy cloudbackend -n $K8S_NAMESPACE >/dev/null 2>&1; then
        OLD_IMAGE=$(kubectl get deploy cloudbackend -n $K8S_NAMESPACE -o jsonpath='{.spec.template.spec.containers[0].image}')
        echo "上一个版本镜像: $OLD_IMAGE"
      else
        echo "⚠️ 当前命名空间中未找到 Deployment: cloudbackend，推测为首次部署"
        OLD_IMAGE=""
      fi

    - 'echo "=== Step 4: 更新 Deployment 镜像 ==="'
    # - kubectl apply -f $K8S_DEPLOY_CM_FILE -n $K8S_NAMESPACE
    - kubectl apply -f $K8S_DEPLOY_FILE -n $K8S_NAMESPACE
    - kubectl apply -f $K8S_DEPLOY_SERVICE_FILE -n $K8S_NAMESPACE
    - 'echo "New 镜像名称为: $IMAGE_NAME:$IMAGE_TAG"'
    - kubectl set image deployment/cloudbackend cloudbackend=$IMAGE_NAME:$IMAGE_TAG  -n $K8S_NAMESPACE

    - 'echo "=== Step 5: 等待新版本 Pod 启动 ==="'
    - |
      # 如果是首次部署（OLD_IMAGE 为空），不要直接 rollback
      if [ -z "$OLD_IMAGE" ]; then
        echo "⚙️ 首次部署，跳过回滚逻辑，仅等待 Pod 启动"
        kubectl rollout status deployment/cloudbackend -n $K8S_NAMESPACE --timeout=$TIMEOUT || true
      else
        # 非首次部署则正常监控回滚
        kubectl rollout status deployment/cloudbackend -n $K8S_NAMESPACE --timeout=$TIMEOUT || ROLLBACK=true
      fi

    - |
      if [ "$ROLLBACK" = "true" ] && [ -n "$OLD_IMAGE" ]; then
        echo "❌ 部署失败，自动回滚到上一个版本: $OLD_IMAGE"
        kubectl set image deployment/cloudbackend cloudbackend=$OLD_IMAGE -n $K8S_NAMESPACE
        kubectl rollout status deployment/cloudbackend -n $K8S_NAMESPACE --timeout=$TIMEOUT
        DEPLOY_STATUS=failed
        echo "DEPLOY_STATUS=failed" > deploy_status.env
        exit 1
      else
        echo "✅ 部署成功，新版本镜像: $IMAGE_NAME:$IMAGE_TAG"
        kubectl get pods -n $K8S_NAMESPACE -o wide
        DEPLOY_STATUS=success
        echo "DEPLOY_STATUS=success" > deploy_status.env
      fi
    - 'echo "结束时间： $(date)"'
  artifacts:
    reports:
      dotenv: deploy_status.env
  only:
    - master


# ==========================================
# 通知阶段 (不影响主流程),并且提供钉钉稳健通知方案，
# 避免偶发性网络问题
# ==========================================
notify:
  stage: notify
  tags:
    - gva
  needs:
    - job: prepare
      artifacts: true
    - job: deploy
      artifacts: true
  script:
    - 'echo "构建完成通知： $(date)"'
  after_script:
    - echo "当前 Job 状态  $CI_JOB_STATUS"
    - echo "当前 部署状态  $DEPLOY_STATUS"
    - |
      if [ "$DEPLOY_STATUS" = "failed" ]; then
        STATUS="❌ 部署失败（已自动回滚）"
      elif [ "$CI_JOB_STATUS" = "success" ]; then
        STATUS="✅ 成功"
      else
        STATUS="❌ 失败"
      fi
      
      MESSAGE="{
        \"msgtype\": \"markdown\",
        \"markdown\": {
          \"title\": \"[${CI_PROJECT_NAME}] 构建${STATUS}\",
          \"text\": \"### 🚀 ${CI_PROJECT_NAME}  CI/CD cloud通知\n
          > **Pipeline ID:** ${CI_PIPELINE_ID}\n
          > **分支:** ${CI_COMMIT_REF_NAME}\n
          > **镜像:** ${IMAGE_NAME}:${IMAGE_TAG}\n
          > **提交:** ${CI_COMMIT_SHORT_SHA}\n
          > **执行人:** ${GITLAB_USER_NAME}\n
          > **状态:** ${STATUS}\n
          > **时间:** $(date '+%Y-%m-%d %H:%M:%S')\n
          > [查看详情](${CI_PIPELINE_URL})\"
        }
      }"
      
      MAX_RETRY=3
      for i in $(seq 1 $MAX_RETRY); do
        echo "尝试发送第 $i 次通知..."
        RESPONSE=$(curl -s -w "%{http_code}" -o /tmp/ding.log \
          -H "Content-Type: application/json" \
          -d "$MESSAGE" "$DINGTALK_WEBHOOK")
        if [ "$RESPONSE" = "200" ]; then
          echo "✅ 钉钉通知成功"
          break
        else
          echo "⚠️ 第 $i 次失败，等待 5 秒重试"
          sleep 5
        fi
      done
  when: always   # ✅ 无论成功或失败都执行
  only:
    - master

 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
29
30
31
32
33
34
35
36
37
38
39
40
41
42

FROM golang:alpine as builder

WORKDIR /app
# 优化：先复制 go.mod / go.sum 仅用于依赖缓存
COPY go.mod go.sum ./


# 配置 Go 环境和国内代理
RUN go env -w GO111MODULE=on \
    && go env -w GOPROXY=https://goproxy.cn,https://proxy.golang.com.cn,https://goproxy.io,https://goproxy.tencentcloudapi.com,direct \
    && go env -w CGO_ENABLED=0 \
    && go mod download

# 再复制源代码（这样 go mod download 有缓存）
COPY . .

# 编译阶段：只编译 server，不运行 tidy（tidy 可在本地执行）
RUN go build -trimpath -ldflags="-s -w" -o server .

FROM alpine:latest

LABEL MAINTAINER="SliverHorn@sliver_horn@qq.com"
# 设置时区
ENV TZ=Asia/Shanghai

RUN sed -i 's/dl-cdn.alpinelinux.org/mirrors.aliyun.com/g' /etc/apk/repositories \
    && apk add --no-cache tzdata openntpd \
    && ln -sf /usr/share/zoneinfo/$TZ /etc/localtime \
    && echo $TZ > /etc/timezone

WORKDIR /go/src/github.com/flipped-aurora/gin-vue-admin/server

COPY --from=0 /app/server ./
COPY --from=0 /app/resource ./resource/
COPY --from=0 /app/config.docker.yaml ./
COPY --from=0 /app/config.yaml ./

# 挂载目录：如果使用了sqlite数据库，容器命令示例：docker run -d -v /宿主机路径/gva.db:/app/gva.db -p 8888:8888 --name gva-server-v1 gva-server:1.0
# VOLUME ["/app"]

EXPOSE 8888
ENTRYPOINT ["./server", "-c", "config.yaml"]

 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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

apiVersion: v1
kind: ConfigMap
metadata:
  name: cloudbackend-config
data:
  config.yaml: |
    aliyun-oss:
      endpoint: yourEndpoint
      access-key-id: yourAccessKeyId
      access-key-secret: yourAccessKeySecret
     ... 省略
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: cloudbackend
  labels:
    app: cloudbackend
spec:
  replicas: 1
  selector:
    matchLabels:
      app: cloudbackend
  template:
    metadata:
      labels:
        app: cloudbackend
    spec:
      containers:
        - name: cloudbackend
          image: "192.168.1.20/library/cloudbackend:v1"
          imagePullPolicy: IfNotPresent
          ports:
            - name: http
              containerPort: 8888
          env:
            - name: GIN_MODE
              value: "release"
            - name: ENVIRONMENT
              valueFrom:
                fieldRef:
                  fieldPath: metadata.namespace
            - name: TZ
              value: "Asia/Shanghai"
          volumeMounts:
            - name: config-volume
              mountPath: /go/src/github.com/flipped-aurora/gin-vue-admin/server/config.yaml
              subPath: config.yaml
      imagePullSecrets:
        - name: harbor-secret
      volumes:
        - name: config-volume
          configMap:
            name: cloudbackend-config
---
apiVersion: v1
kind: Service
metadata:
  name: cloudbackend
  labels:
    app: cloudbackend
spec:
  type: NodePort
  selector:
    app: cloudbackend
  ports:
    - name: http
      port: 8888
      nodePort: 30088

1
2
3

git add .
git commit -m "test gitlab ci"
git push origin master

1
2

kubectl get pods
kubectl get svc

1

http://k8s_master_vip:30088

1

Syntax is incorrect. CI configuration validated, including all configuration added with the includes keyword

1
2

script:
  - echo "=== Step 1: 开始构建镜像 ==="

1

jobs:build:script config should be a string or a nested array of strings

1
2

script:
  - echo "=== Step 1 开始构建镜像 ==="

1
2

script:
  - 'echo "=== Step 1: 开始构建镜像 ==="'