Cache Cloud Native Buildpacks/Paketo.io pack CLI 在 GitHub Actions 上构建例如使用 Spring Boot/Java/Maven buildpacks?

问题描述

我正在研究 a Spring Boot application,它应该使用 Cloud Native Build Packs / Paketo.io 打包到 OCI 容器中。我使用 GitHub Actions 构建它,其中我的工作流程 build.yml 如下所示:

name: build

on: [push]

jobs:
  build-with-paketo-push-2-dockerhub:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2

      - name: Login to dockerhub Container Registry
        run: echo $DOCKER_HUB_TOKEN | docker login -u jonashackt --password-stdin
        env:
          DOCKER_HUB_TOKEN: ${{ secrets.DOCKER_HUB_TOKEN }}

      - name: Install pack CLI via apt. See https://buildpacks.io/docs/tools/pack/#pack-cli
        run: |
          sudo add-apt-repository ppa:cncf-buildpacks/pack-cli
          sudo apt-get update
          sudo apt-get install pack-cli

      - name: Build app with pack CLI
        run: pack build spring-boot-buildpack --path . --builder paketobuildpacks/builder:base

      - name: Tag & publish to Docker Hub
        run: |
          docker tag spring-boot-buildpack jonashackt/spring-boot-buildpack:latest
          docker push jonashackt/spring-boot-buildpack:latest

现在 Build app with pack CLI 步骤花费的时间相对较长,因为它总是下载 Paketo 构建器 Docker 映像,然后进行全新的构建。这意味着下载 JDK 和每个 Maven 依赖项。有没有办法在 GitHub Actions 上缓存 Paketo 构建?

解决方法

在 GitHub Actions 上缓存 Docker 图像可能是一个选项 - doesn't seem to be that easy。另一种选择是利用 Docker 官方 docker/build-push-action Action,它可以 to cache the buildx-cache。但是我没有让 pack CLI 和 buildx-caching 的组合起作用(请参阅 this build for example)。

最后我偶然发现了the general Cloud Native Buildpacks approach on how to cache in the docs

缓存图像是一种保留构建优化层的方法 不同的主机。这些图像可以在以下情况下提高性能 在 CI/CD 管道等临时环境中使用 pack。

我发现这个概念非常好,因为它使用第二个缓存映像,该映像发布到您选择的容器注册表。此映像仅用于在您附加 --cache-image 参数的每台机器上构建的所有 Paketo pack CLI - 无论是您的本地桌面还是任何 CI/CD 平台(如 GitHub Actions)。

为了使用 --cache-image 参数,我们还必须使用 --publish 标志(因为缓存映像需要发布到您的容器注册表!)。这也意味着我们需要先登录容器注册表,然后才能运行我们的 pack CLI 命令。使用 Docker Hub 就像这样:

echo $DOCKER_HUB_TOKEN | docker login -u YourUserNameHere --password-stdin

此外,Paketo 构建器映像必须为 a trusted one。作为the docs state

默认情况下,pack builder suggest 建议的任何构建器都是 被认为是可信的。

由于我使用了建议的构建器,因此我无需在此处执行任何操作。如果您想使用默认情况下不受信任的其他构建器,请在最后的 pack CLI 命令之前you need to run a pack config trusted-builders add your/builder-to-trust:bionic command

这是 pack CLI 命令,如果您想构建 Spring Boot 应用程序并使用 Docker Hub 作为容器注册表,它会启用缓存:

      pack build index.docker.io/yourApplicationImageNameHere:latest \
          --builder paketobuildpacks/builder:base \
          --path . \
          --cache-image index.docker.io/yourCacheImageNameHere:latest \
          --publish

最终,用于构建和发布示例 Spring Boot 应用程序 https://github.com/jonashackt/spring-boot-buildpack 的 GitHub Action 工作流程如下所示:

name: build

on: [push]

jobs:
  build-with-paketo-push-2-dockerhub:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2

      - name: Login to DockerHub Container Registry
        run: echo $DOCKER_HUB_TOKEN | docker login -u jonashackt --password-stdin
        env:
          DOCKER_HUB_TOKEN: ${{ secrets.DOCKER_HUB_TOKEN }}

      - name: Install pack CLI via the official buildpack Action https://github.com/buildpacks/github-actions#setup-pack-cli-action
        uses: buildpacks/github-actions/setup-pack@v4.1.0

      - name: Build app with pack CLI using Buildpack Cache image (see https://buildpacks.io/docs/app-developer-guide/using-cache-image/) & publish to Docker Hub
        run: |
          pack build index.docker.io/jonashackt/spring-boot-buildpack:latest \
              --builder paketobuildpacks/builder:base \
              --path . \
              --cache-image index.docker.io/jonashackt/spring-boot-buildpack-paketo-cache-image:latest \
              --publish

请注意,通过使用 pack CLI 的 --publish 标志,我们也不再需要额外的步骤 Tag & publish to Docker Hub。因为这已经由 Pack CLI 为我们完成了。