将Docker Scout与GitHub Actions集成

目录

以下示例演示如何使用GitHub Actions设置Docker Scout工作流程。由拉取请求触发，该操作构建镜像并使用Docker Scout将新版本与生产环境中运行的该镜像版本进行比较。

此工作流程使用docker/scout-action GitHub Action运行docker scout compare命令，以可视化拉取请求的镜像与您在生产环境中运行的镜像的堆叠方式。

先决条件

  • 此示例假设您在Docker Hub或其他注册表中拥有现有的镜像仓库，并且您已在其中启用Docker Scout。
  • 此示例使用环境，将拉取请求中构建的镜像与名为production的环境中相同镜像的不同版本进行比较。

步骤

首先，设置GitHub Action工作流程以构建镜像。此处并非特定于Docker Scout，但您需要构建镜像才能进行比较。

将以下内容添加到GitHub Actions YAML文件

name: Docker

on:
  push:
    tags: ["*"]
    branches:
      - "main"
  pull_request:
    branches: ["**"]

env:
  # Hostname of your registry
  REGISTRY: docker.io
  # Image repository, without hostname and tag
  IMAGE_NAME: ${{ github.repository }}
  SHA: ${{ github.event.pull_request.head.sha || github.event.after }}

jobs:
  build:
    runs-on: ubuntu-latest
    permissions:
      pull-requests: write

    steps:
      # Authenticate to the container registry
      - name: Authenticate to registry ${{ env.REGISTRY }}
        uses: docker/login-action@v3
        with:
          registry: ${{ env.REGISTRY }}
          username: ${{ secrets.REGISTRY_USER }}
          password: ${{ secrets.REGISTRY_TOKEN }}
      
      - name: Setup Docker buildx
        uses: docker/setup-buildx-action@v3

      # Extract metadata (tags, labels) for Docker
      - name: Extract Docker metadata
        id: meta
        uses: docker/metadata-action@v5
        with:
          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
          labels: |
            org.opencontainers.image.revision=${{ env.SHA }}            
          tags: |
            type=edge,branch=$repo.default_branch
            type=semver,pattern=v{{version}}
            type=sha,prefix=,suffix=,format=short            

      # Build and push Docker image with Buildx
      # (don't push on PR, load instead)
      - name: Build and push Docker image
        id: build-and-push
        uses: docker/build-push-action@v6
        with:
          sbom: ${{ github.event_name != 'pull_request' }}
          provenance: ${{ github.event_name != 'pull_request' }}
          push: ${{ github.event_name != 'pull_request' }}
          load: ${{ github.event_name == 'pull_request' }}
          tags: ${{ steps.meta.outputs.tags }}
          labels: ${{ steps.meta.outputs.labels }}
          cache-from: type=gha
          cache-to: type=gha,mode=max

这将创建用于执行以下操作的工作流程步骤：

  1. 设置Docker buildx。
  2. 对注册表进行身份验证。
  3. 从Git引用和GitHub事件中提取元数据。
  4. 构建并将Docker镜像推送到注册表。

注意

此CI工作流程运行对您的镜像的本地分析和评估。要本地评估镜像，您必须确保镜像已加载到运行器的本地镜像存储区。

如果您将镜像推送到注册表，或者您构建的镜像无法加载到运行器的本地镜像存储区，则此比较不起作用。例如，多平台镜像或带有SBOM或来源证明的镜像无法加载到本地镜像存储区。

完成此设置后，您可以添加以下步骤来运行镜像比较

      # You can skip this step if Docker Hub is your registry
      # and you already authenticated before
      - name: Authenticate to Docker
        uses: docker/login-action@v3
        with:
          username: ${{ secrets.DOCKER_USER }}
          password: ${{ secrets.DOCKER_PAT }}

      # Compare the image built in the pull request with the one in production
      - name: Docker Scout
        id: docker-scout
        if: ${{ github.event_name == 'pull_request' }}
        uses: docker/scout-action@v1
        with:
          command: compare
          image: ${{ steps.meta.outputs.tags }}
          to-env: production
          ignore-unchanged: true
          only-severities: critical,high
          github-token: ${{ secrets.GITHUB_TOKEN }}

compare命令分析镜像并评估策略合规性，并将结果与production环境中相应的镜像进行交叉引用。此示例仅包含严重性和高危漏洞，并排除两个镜像中都存在的漏洞，仅显示更改的内容。

GitHub Action默认情况下会在拉取请求评论中输出比较结果。

A screenshot showing the results of Docker Scout output in a GitHub Action

展开**策略**部分，查看两个镜像之间策略合规性的差异。请注意，虽然此示例中的新镜像并非完全符合要求，但输出显示与基线相比，新镜像的状态有所改善。

GHA policy evaluation output