最佳实践-使用Github Actions来构建跨平台容器镜像

news2024/10/7 14:24:33

概述

GitHub Actions 是一种持续集成和持续交付 (CI/CD) 平台，可用于自动执行生成、测试和部署管道。您可以创建工作流程来构建和测试存储库的每个拉取请求，或将合并的拉取请求部署到生产环境。

GitHub Actions 不仅仅是 DevOps，还允许您在存储库中发生其他事件时运行工作流程。例如，您可以运行工作流程，以便在有人在您的存储库中创建新问题时自动添加相应的标签。

GitHub 提供 Linux、Windows 和 macOS 虚拟机来运行工作流程，或者您可以在自己的数据中心或云基础架构中托管自己的自托管运行器。

以上是GitHub的官方介绍，其实就是有一个类似于Jenkins的pipeline，支持手动或者代码等方式触发，支持pipeline运行在 Linux、Windows 和 macOS等虚拟机中，下面是一个示意图

GitHub的pipeline使用yaml进行维护，同时内置了很多现成的组件，拿来即用，下面就以具体的一个实例进行介绍，如何使用

我们将做什么？

我们会构建一个前端工程的docker镜像，并推送此镜像至DockerHub仓库，同时在k8s中拉取并运行验证

1. 创建一个前端项目

工程已经创建好，地址：https://github.com/dongweizhao/frontend

其中为了方便部署，前端资源都存放在工程的dist目录

2. 编写Dockerfile

引用nginx镜像，同时拷贝dist目录下资源值容器的/frontend,同时拷贝nginx.conf覆盖nginx镜像默认的配置文件,以下文件工程中都已经涵盖nginx.conf

server{
    listen 80;
    server_name localhost;
     root  /frontend;
     index index.html index.htm;

     location /login {
             try_files $uri $uri/ /login.html;
     }
}

Dockerfile

from nginx
copy ./dist /frontend
run chown nginx.nginx /frontend -R
copy nginx.conf /etc/nginx/conf.d/default.conf

3. Actions配置

配置DockerHub账号密码

点击New repository secret按钮，创建对应的变量。

例如，我要创建DOCKER_HUB_USERNAME变量，值为root，配置如下：

创建worfkflow文件点击Actions

Actions内置了很多模版，拿过来配置下即可，这里我们用Publish Docker Container,选择其他也行,最终改成以下下文件

#workflow名称
name: ci
# 触发条件
on:
#github页面手动触发
  workflow_dispatch: 
#打tag触发，必须是v开头的
  push:
    tags:
      - "v*.*"
#变量配置      
env:
  #镜像名称
  IMAGE_NAME: frontend
  #dockerHub仓库名称
  DOCKER_REGISTRY: dweizhao
jobs:
  build-image:
    #运行的环境  
    runs-on: ubuntu-latest
    env:
      TZ: Asia/Shanghai
    outputs:
      tags: ${{ steps.output-id.outputs.v }}
    steps:
      # 拉取代码，同时获取tag，如果获取不到则默认值为edge，并赋值给v变量
      - uses: actions/checkout@v3
      - id: output-id
        run: |
          VERSION=edge
          if [[ $GITHUB_REF == refs/tags/* ]]; then
            VERSION=${GITHUB_REF#refs/tags/v}
          fi
          echo "v=${VERSION}" >> $GITHUB_OUTPUT
     # Docker配置多平台环境
      - name: Set up Docker BuildX
        uses: docker/setup-buildx-action@v2          
      # 登录镜像仓库
      - name: Login Docker Hub
        uses: docker/login-action@v1
        with:
        #这里引用的变量为上一步配置的变量
          username: ${{ secrets.DOCKER_HUB_USERNAME }}
          password: ${{ secrets.DOCKER_HUB_PWD }}     
      # 打包构建并推送
      - name: Build and push
        uses: docker/build-push-action@v4
        with:
          context: .
          file: ./Dockerfile
          platforms: |
            linux/amd64
            linux/arm64
          #推送到镜像仓库  
          push: true
          # 这里会构建两个版本镜像，
          # 1.dweizhao/backend:latest
          # 2.  output-id步骤中获取的v，构建dweizhao/backend:edge或者dweizhao/backend:对应tag值
          tags: |
            ${{ env.DOCKER_REGISTRY }}/${{ env.IMAGE_NAME }}:${{ steps.output-id.outputs.v }}
            ${{ env.DOCKER_REGISTRY }}/${{ env.IMAGE_NAME }}:latest

以上文件创建完成，会在工程目录下创建一个.github的目录，保存有我们配置的文件