使用 Buildpack 构建函数

本指南介绍了如何将 Buildpack 与函数源代码搭配使用来创建容器映像。例如，使用 Buildpack 构建要部署到 Cloud Run 上的 Cloud Run 函数。

您可以通过以下两种方法使用 Buildpack 构建容器映像：

• 使用 pack CLI 在本地构建，以便在本地测试您的函数并在部署前快速对更改进行原型设计。
• 使用 Cloud Build 远程构建。使用 Cloud Build 进行构建适合具有资源密集型构建流程的函数，还有助于保护您的软件供应链。

配置项目以构建函数

如需使用 Buildpack 构建函数，请执行以下操作：

• 添加 Functions 框架库。

• 将 GOOGLE_FUNCTION_TARGET 环境变量设置为用作入口点的函数的名称。为此，您可以在源代码所在的文件夹中添加 project.toml。project.toml 文件必须具有以下配置：

[[build.env]]
    name = "GOOGLE_FUNCTION_TARGET"
    value =  "ENTRY_POINT"

将 ENTRY_POINT 替换为函数方法。

如需详细了解如何将环境变量与 Cloud Run 函数搭配使用，请参阅配置 Cloud Run 函数服务。

本地构建

Pack 是由 CNB 项目维护的 CLI 工具，用于为 Buildpack 的使用提供支持。使用 pack CLI 可在本地将函数构建到容器映像中。

准备工作

1. 在工作站上安装 Docker 社区版 (CE)。pack 会将 Docker 用作 OCI 映像构建器。
2. 安装 Pack CLI。
3. 安装 Git 源代码控制工具以从 GitHub 获取示例应用。

在本地构建函数

您可以使用 pack build 命令并指定默认构建器 --builder=gcr.io/buildpacks/builder，以在本地构建容器映像。

pack build --builder=gcr.io/buildpacks/builder IMAGE_NAME

将 IMAGE_NAME 替换为容器映像的名称。

您还可以通过扩展构建来自定义容器映像并运行映像。

在本地构建示例函数

以下示例演示了如何在本地构建示例。

1. 将示例代码库克隆到本地计算机：

   git clone https://github.com/GoogleCloudPlatform/buildpack-samples.git

2. 切换到包含应用示例代码的目录：

   Go

   cd buildpack-samples/sample-functions-framework-go

   Java

   cd buildpack-samples/sample-functions-framework-java-mvn

   Node.js

   cd buildpack-samples/sample-functions-framework-node

   Python

   cd buildpack-samples/sample-functions-framework-python

   Ruby

   cd buildpack-samples/sample-functions-framework-ruby

3. 使用 pack 构建示例函数：

   Go

   pack build --builder=gcr.io/buildpacks/builder sample-functions-framework-go

   Java

   pack build --builder gcr.io/buildpacks/builder:v1 sample-functions-java-mvn

   Node.js

   pack build --builder=gcr.io/buildpacks/builder sample-functions-framework-node

   Python

   pack build --builder=gcr.io/buildpacks/builder sample-functions-framework-python

   Ruby

   pack build --builder=gcr.io/buildpacks/builder sample-functions-framework-ruby

4. 使用 docker 运行映像：

   Go

   docker run -p8080:8080 sample-functions-framework-go

   Java

   docker run -it -ePORT=8080 -p8080:8080 sample-functions-java-mvn

   Node.js

   docker run -it -ePORT=8080 -p8080:8080 sample-functions-framework-node

   Python

   docker run -it -ePORT=8080 -p8080:8080 sample-functions-framework-python

   Ruby

   docker run -it -ePORT=8080 -p8080:8080 sample-functions-framework-ruby

5. 通过浏览到 localhost:8080 来访问正在运行的函数。

远程构建

使用 Cloud Build 可将函数构建到容器映像中，并使用 Artifact Registry 作为存储和部署每个映像的容器仓库。

准备工作

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Cloud Build and Artifact Registry APIs.

   Enable the APIs

5. Install the Google Cloud CLI.

6. To initialize the gcloud CLI, run the following command:

   gcloud init

7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

8. Make sure that billing is enabled for your Google Cloud project.

9. Enable the Cloud Build and Artifact Registry APIs.

   Enable the APIs

10. Install the Google Cloud CLI.

11. To initialize the gcloud CLI, run the following command:

    gcloud init

如果您之前已经安装了 Google Cloud CLI，请运行 gcloud components update 以确保您拥有最新版本。

12. 确保您的 Google Cloud 项目有权访问容器映像仓库。

    如需配置对 Artifact Registry 中的 Docker 仓库的访问权限，请执行以下操作：

    1. 在 Google Cloud 项目的同一位置创建新的 Docker 仓库。

       gcloud artifacts repositories create REPO_NAME \
       --repository-format=docker \
       --location=REGION --description="DESCRIPTION"

       您需要进行如下替换：
       • 将 REPO_NAME 替换为您为 Docker 仓库选择的名称。
       • 将 REGION 替换为 Google Cloud 项目的位置或最接近该位置的位置。
       • 将 DESCRIPTION 替换为您选择的说明。

       例如，如需在 us-west2 中创建具有说明“Docker 仓库”的 docker 仓库，请运行以下命令：

       gcloud artifacts repositories create buildpacks-docker-repo --repository-format=docker \
       --location=us-west2 --description="Docker repository"

    2. 验证您的代码库已创建：

       gcloud artifacts repositories list

       您应该会在列表中看到您为 Docker 仓库选择的名称。

远程构建函数

您可以使用 gcloud builds submit 命令构建容器映像并将其上传到仓库。

您可以选择在命令本身中指定容器映像或是使用配置文件。

使用命令进行构建

如需在不使用配置文件的情况下进行构建，请指定 image 标志：

gcloud builds submit --pack image=LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/IMAGE_NAME

您需要进行如下替换：

• 将 LOCATION 替换为容器仓库的区域名称，例如 us-west2
• 将 PROJECT_ID 替换为您的 Google Cloud 项目的 ID。
• 将 REPO_NAME 替换为 Docker 仓库的名称。
• 将 IMAGE_NAME 替换为容器映像的名称。

示例：

gcloud builds submit --pack image=us-west2-docker.pkg.dev/my-project-id/my-buildpacks-docker-repo

使用配置文件进行构建

您可以使用配置文件来定义映像仓库配置详细信息，以便仅包含构建命令。配置文件使用 YAML 文件格式，并且必须包含使用 pack CLI 的构建步骤。

1. 创建一个名为 cloudbuild.yaml 的 YAML 文件，其中包含容器映像仓库的 URI。

  options:
    logging: CLOUD_LOGGING_ONLY
    pool: {}
  projectId: PROJECT_ID
  steps:
  - name: gcr.io/k8s-skaffold/pack
    entrypoint: pack
    args:
    - build
    - LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/IMAGE_NAME
    - --builder
    - gcr.io/buildpacks/builder:latest
    - --network
    - cloudbuild
  images:
  - LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/IMAGE_NAME

您需要进行如下替换：

• 将 LOCATION 替换为容器仓库的区域名称，例如 us-west2。
• 将 PROJECT_ID 替换为您的 Google Cloud 项目的 ID。
• 将 REPO_NAME 替换为 Docker 仓库的名称。
• 将 IMAGE_NAME 替换为容器映像的名称。

1. 构建应用。

   如果您将配置文件命名为 cloudbuild.yaml，则可以运行以下命令：

   gcloud builds submit .
   

   提示：如果您为配置文件使用唯一名称，则可以使用 --config 标志。

示例：远程构建示例函数

以下示例演示了如何远程构建示例，并验证容器映像是否已推送到 Artifact Registry 中的仓库。

1. 将示例代码库克隆到本地计算机：

   git clone https://github.com/GoogleCloudPlatform/buildpack-samples.git

2. 切换到包含应用示例代码的目录：

   Go

   cd buildpack-samples/sample-functions-framework-go

   Java

   cd buildpack-samples/sample-functions-framework-java-mvn

   Node.js

   cd buildpack-samples/sample-functions-framework-node

   Python

   cd buildpack-samples/sample-functions-framework-python

   Ruby

   cd buildpack-samples/sample-functions-framework-ruby

3. 使用 gcloud 将应用源代码提交到 Cloud Build：

   Go

   gcloud builds submit --pack image=LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/sample-functions-framework-go

   Java

   gcloud builds submit --pack image=LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/sample-functions-framework-gradle

   Node.js

   gcloud builds submit --pack image=LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/sample-functions-framework-node

   Python

   gcloud builds submit --pack image=LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/sample-functions-framework-python

   Ruby

   gcloud builds submit --pack image=LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/sample-functions-framework-ruby

   您需要进行如下替换：

   • 将 LOCATION 替换为容器仓库的区域名称。示例：us-west2-docker.pkg.dev
   • 将 PROJECT_ID 替换为您的 Google Cloud 项目的 ID。
   • 将 REPO_NAME 替换为 Docker 仓库的名称。

4. 验证示例函数是否已成功发布到 REPO_NAME：

   gcloud artifacts docker images list LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME

   您需要进行如下替换：

   • 将 LOCATION 替换为容器仓库的区域名称，例如 us-west2。
   • 将 PROJECT_ID 替换为您的 Google Cloud 项目的 ID。
   • 将 REPO_NAME 替换为 Docker 仓库的名称。

后续步骤

• 将函数映像部署到 Cloud Run。
• 设置环境变量。
• 配置构建映像。
• 使用缓存映像加速构建。