Funktion mit Buildpacks erstellen

In dieser Anleitung erfahren Sie, wie Sie mit Buildpacks mit dem Quellcode Ihrer Funktion ein Container-Image erstellen. Beispiel: Verwenden Sie Buildpacks, um die Cloud Run Functions-Funktion zu erstellen, die Sie in Cloud Run bereitstellen möchten.

Es gibt zwei Methoden zum Erstellen von Container-Images mit Buildpacks:

• Erstellen Sie einen lokalen Build mit der pack-Befehlszeile, um Ihre Funktion lokal zu testen und vor der Bereitstellung schnell Prototypen für Änderungen zu erstellen.
• Build per Remotezugriff ausführen mit Cloud Build. Das Erstellen mit Cloud Build ist nützlich für Funktionen, die ressourcenintensive Build-Prozesse haben und kann auch zum Schutz Ihrer Softwarelieferkette beitragen.

Projekt zum Erstellen von Funktionen konfigurieren

So erstellen Sie Funktionen mit Buildpacks:

• Fügen Sie die Functions Framework-Bibliothek hinzu.

• Legen Sie die Umgebungsvariable GOOGLE_FUNCTION_TARGET auf den Namen der Funktion fest, die Sie als Einstiegspunkt verwenden. Dazu fügen Sie eine project.toml-Datei in demselben Ordner wie den Quellcode ein. Die project.toml-Datei muss die folgende Konfiguration haben:

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

Ersetzen Sie ENTRY_POINT durch die Funktionsmethode.

Weitere Informationen zur Verwendung von Umgebungsvariablen mit Cloud Run Functions finden Sie unter Cloud Run Functions-Dienste konfigurieren.

Lokale Builds

Pack ist ein Befehlszeilentool, das vom CNB-Projekt verwaltet wird, um die Verwendung von Buildpacks zu unterstützen. Verwenden Sie die pack-Befehlszeile, um Ihre Funktionen lokal in einem Container-Image zu erstellen.

Vorbereitung

1. Installieren Sie die Docker Community Edition (CE) auf Ihrer Workstation. Docker wird von pack als OCI-Image-Builder verwendet.
2. Installieren Sie die Pack-Befehlszeile.
3. Installieren Sie das Tool Git Source Control, um die Beispielanwendung von GitHub herunterzuladen.

Funktion lokal erstellen

Verwenden Sie den pack build-Befehl und geben Sie den Standard-Builder --builder=gcr.io/buildpacks/builder an, um Ihre Container-Images lokal zu erstellen.

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

Ersetzen Sie IMAGE_NAME durch den Namen Ihres Container-Images.

Sie können das Container-Image anpassen. Dazu erweitern Sie die Build- und Ausführungs-Images.

Beispielfunktion lokal erstellen

In den folgenden Beispielen wird gezeigt, wie Sie ein Beispiel lokal erstellen.

1. Klonen Sie das Beispiel-Repository auf Ihren lokalen Computer:

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

2. Wechseln Sie in das Verzeichnis, das den Workflows-Beispielcode enthält:

   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. Erstellen Sie die Beispielfunktion mit 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. Führen Sie das Image mit docker aus:

   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. Um die ausgeführte Funktion auszuführen, rufen Sie localhost:8080 auf.

Remote-Builds

Verwenden Sie Cloud Build, um Ihre Funktion in einem Container Image zu erstellen, und Artifact Registry als Container-Repository, um die einzelnen Images zu speichern und bereitzustellen.

Vorbereitung

Melden Sie sich in Ihrem Google Cloud Konto an. Wenn Sie noch kein Konto bei Google Cloudhaben, erstellen Sie ein Konto, um die Leistung unserer Produkte in der Praxis sehen und bewerten zu können. Neukunden erhalten außerdem ein Guthaben von 300 $, um Arbeitslasten auszuführen, zu testen und bereitzustellen.

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Build and Artifact Registry APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

Installieren Sie die Google Cloud CLI.

Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

Führen Sie den folgenden Befehl aus, um die gcloud CLI zu initialisieren:

gcloud init

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

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

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

Verify that billing is enabled for your Google Cloud project.

Enable the Cloud Build and Artifact Registry APIs.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the APIs

Installieren Sie die Google Cloud CLI.

Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

Führen Sie den folgenden Befehl aus, um die gcloud CLI zu initialisieren:

gcloud init

Wenn Sie die Google Cloud CLI bereits installiert haben, prüfen Sie, ob Sie die neueste verfügbare Version nutzen. Führen Sie dazu gcloud components update aus.

1. Prüfen Sie, ob Ihr Google Cloud Projekt Zugriff auf ein Container-Image-Repository hat.

   So konfigurieren Sie den Zugriff auf ein Docker-Repository in Artifact Registry:

   1. Erstellen Sie ein neues Docker-Repository am selben Speicherort wie Ihr Google Cloud Projekt.

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

      Ersetzen Sie:
      • REPO_NAME durch den Namen, den Sie für Ihr Docker-Repository wählen.
      • REGION durch einen Standort direkt im oder maximal nahe am Google Cloud Projekt.
      • DESCRIPTION durch eine Beschreibung Ihrer Wahl.

      Beispiel: Um ein docker-Repository in us-west2 mit der Beschreibung "Docker repository" zu erstellen, führen Sie folgenden Befehl aus:

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

   2. Prüfen Sie, ob das Repository erstellt wurde:

      gcloud artifacts repositories list

      Der Name, den Sie für Ihr Docker-Repository wählen, sollte in der Liste angezeigt werden.

Funktion per Remotezugriff erstellen

Mit dem gcloud builds submit-Befehl können Sie Ihr Container-Image erstellen und in Ihr Repository hochladen.

Sie können Ihr Container-Image entweder im Befehl selbst angeben oder eine Konfigurationsdatei verwenden.

Mit Befehl erstellen

Für die Erstellung ohne Konfigurationsdatei geben Sie das image-Flag an:

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

Ersetzen Sie:

• LOCATION durch den Namen der Region Ihres Container-Repositorys, z. B. us-west2.
• PROJECT_ID durch die ID Ihres Google Cloud Projekts.
• REPO_NAME durch den Namen des Docker-Repositorys.
• IMAGE_NAME durch den Namen Ihres Container-Images

Beispiel:

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

Mit Konfigurationsdateien erstellen

Sie können eine Konfigurationsdatei verwenden, um die Konfigurationsdetails Ihres Image-Repositorys zu definieren. Die Konfigurationsdatei verwendet das YAML-Dateiformat und muss einen Build-Schritt enthalten, der die pack-Befehlszeile verwendet.

1. Erstellen Sie eine YAML-Datei mit dem Namen cloudbuild.yaml, die den URI Ihres Container-Image-Repositorys enthält.

    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
      - --publish
    - name: gcr.io/cloud-builders/docker
      entrypoint: pack
      args:
      - pull
      - LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/IMAGE_NAME
    images:
    - LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/IMAGE_NAME
   

   Ersetzen Sie:

   • LOCATION durch den Namen der Region Ihres Container-Repositorys, z. B. us-west2.
   • PROJECT_ID durch die ID Ihres Google Cloud Projekts.
   • REPO_NAME durch den Namen des Docker-Repositorys.
   • IMAGE_NAME durch den Namen Ihres Container-Images

2. Erstellen Sie die Anwendung.

   Wenn Sie Ihre Konfigurationsdatei cloudbuild.yaml genannt haben, führen Sie folgenden Befehl aus:

   gcloud builds submit .
   

   Tipp: Wenn Sie für die Konfigurationsdatei einen eindeutigen Namen nutzen, verwenden Sie das --config Flag.

Beispiel: Beispielfunktion per Remotezugriff erstellen

In folgenden Beispielen wird gezeigt, wie Sie ein Beispiel für einen Remote-Build erstellen und dann prüfen, ob das Container-Image per Push in Ihr Repository in Artifact Registry übertragen wurde.

1. Klonen Sie das Beispiel-Repository auf Ihren lokalen Computer:

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

2. Wechseln Sie in das Verzeichnis, das den Workflows-Beispielcode enthält:

   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. Verwenden Sie gcloud, um den Anwendungsquellcode an Cloud Build zu senden:

   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

   Ersetzen Sie:

   • LOCATION durch den Namen der Region Ihres Container-Repositorys. Beispiel: us-west2-docker.pkg.dev
   • PROJECT_ID durch die ID Ihres Google Cloud Projekts.
   • REPO_NAME durch den Namen des Docker-Repositorys.

4. Prüfen Sie, ob die Beispielfunktion erfolgreich in REPO_NAME veröffentlicht wurde:

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

   Ersetzen Sie:

   • LOCATION durch den Namen der Region Ihres Container-Repositorys, z. B. us-west2.
   • PROJECT_ID durch die ID Ihres Google Cloud Projekts.
   • REPO_NAME durch den Namen des Docker-Repositorys.

Weitere Informationen

• Funktions-Image in Cloud Run bereitstellen.
• Umgebungsvariablen festlegen
• Build-Images konfigurieren
• Builds mit Cache-Images beschleunigen