将 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:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          ref: ${{ env.SHA }}

      - name: Setup Docker buildx
        uses: docker/setup-buildx-action@v3

      # 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 }}

      # 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@v5
        with:
          context: .
          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. 查看存储库。
  2. 设置 Docker buildx。
  3. 向注册表进行身份验证。
  4. 从 Git 参考和 GitHub 事件中提取元数据。
  5. 构建 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 }}

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

GitHub Action 默认在拉取请求注释中输出比较结果。

显示 GitHub Action 中 Docker Scout 输出结果的屏幕截图

展开策略部分可查看两个映像之间策略合规性的差异。请注意，虽然此示例中的新图像不完全合规，但输出显示新图像的地位与基线相比有所改善。

GHA政策评估输出