Créer une fonction à l'aide de packs de création

Ce guide explique comment utiliser des buildpacks avec le code source de votre fonction pour créer une image de conteneur. Par exemple, utilisez des buildpacks pour créer une fonction Cloud Function que vous souhaitez déployer sur Cloud Run.

Il existe deux méthodes pour créer des images de conteneurs avec des buildpacks :

  • Créez votre fonction localement avec l'CLI pack pour la tester localement et prototyper rapidement les modifications avant le déploiement.
  • Compilez à distance avec Cloud Build. La compilation avec Cloud Build est utile pour les fonctions qui disposent de processus de compilation gourmands en ressources et qui peuvent également aider à protéger votre chaîne d'approvisionnement logicielle.

Configurer votre projet pour compiler des fonctions

Pour compiler des fonctions avec des buildpacks, procédez comme suit :

  • Incluez la bibliothèque Functions Framework.

  • Définissez la variable d'environnement GOOGLE_FUNCTION_TARGET sur le nom de la fonction que vous utilisez comme point d'entrée. Pour ce faire, incluez un fichier project.toml dans le même dossier que votre code source. Le fichier project.toml doit avoir la configuration suivante :

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

Remplacez ENTRY_POINT par la méthode de la fonction.

Pour savoir comment utiliser les variables d'environnement avec les fonctions Cloud Run, consultez Configurer les services Cloud Run Functions.

Builds locaux

Pack est un outil de CLI géré par le projet CNB pour prendre en charge l'utilisation de buildpacks. Utilisez la CLI pack pour créer vos fonctions en local dans une image de conteneur.

Avant de commencer

  1. Installez Docker Community Edition (CE) sur votre poste de travail. Docker est utilisé par pack en tant que générateur d'images OCI.
  2. Installez la CLI Pack.
  3. Installez l'outil de contrôle de source Git pour récupérer l'exemple d'application depuis GitHub.

Créer une fonction localement

Vous utilisez la commande pack build et spécifiez le compilateur par défaut --builder=gcr.io/buildpacks/builder pour créer vos images de conteneur en local.

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

Remplacez IMAGE_NAME par le nom de votre image de conteneur

Vous pouvez également personnaliser votre image de conteneur en étendant les images de compilation et d'exécution.

Créer un exemple de fonction localement

Les exemples suivants montrent comment compiler un exemple localement.

  1. Clonez l'exemple de dépôt sur votre ordinateur local :
    git clone https://github.com/GoogleCloudPlatform/buildpack-samples.git
  2. Accédez au répertoire contenant l'exemple de code :

    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. Utilisez pack pour créer l'exemple de fonction :

    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. Exécutez l'image à l'aide de 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. Accédez à la fonction en cours d'exécution en vous rendant sur le lien localhost:8080.

Builds distants

Utilisez Cloud Build pour créer votre fonction dans une image de conteneur et Artifact Registry comme dépôt de conteneurs pour stocker et déployer chaque image.

Avant de commencer

  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.

    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 (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. 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

  5. Install the Google Cloud CLI.

  6. Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

  7. Pour initialiser la gcloud CLI, exécutez la commande suivante :

    gcloud init
  8. 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 (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  9. Verify that billing is enabled for your Google Cloud project.

  10. 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

  11. Install the Google Cloud CLI.

  12. Si vous utilisez un fournisseur d'identité (IdP) externe, vous devez d'abord vous connecter à la gcloud CLI avec votre identité fédérée.

  13. Pour initialiser la gcloud CLI, exécutez la commande suivante :

    gcloud init
  14. Assurez-vous que votre projet Google Cloud a accès à un dépôt d'images de conteneurs.

    Pour configurer l'accès à un dépôt Docker dans Artifact Registry, procédez comme suit :

    1. Créez un dépôt Docker au même emplacement que votre projet Google Cloud .
      gcloud artifacts repositories create REPO_NAME \
      --repository-format=docker \
      --location=REGION --description="DESCRIPTION"
      Remplacer:
      • REPO_NAME par le nom que vous avez choisi pour votre dépôt Docker.
      • REGION par la région la plus proche de l'emplacement de votre projet Google Cloud ou celle du projet.
      • DESCRIPTION par la description de votre choix.

      Par exemple, pour créer un dépôt docker dans us-west2 avec la description "Docker repository", exécutez la commande suivante :

      gcloud artifacts repositories create buildpacks-docker-repo --repository-format=docker \
      --location=us-west2 --description="Docker repository"
    2. Vérifiez que votre dépôt a bien été créé :
      gcloud artifacts repositories list

      Le nom que vous avez choisi pour votre dépôt Docker doit s'afficher dans la liste.

  15. Créer une fonction à distance

    Pour créer et importer votre image de conteneur dans votre dépôt, vous devez utiliser la commande gcloud builds submit.

    Vous pouvez choisir de spécifier votre image de conteneur dans la commande elle-même ou d'utiliser un fichier de configuration.

    Compiler avec une commande

    Pour compiler sans fichier de configuration, spécifiez l'option image :

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

    Remplacez :

    • LOCATION par le nom de la région de votre dépôt de conteneurs, par exemple us-west2
    • PROJECT_ID par l'ID de votre projet Google Cloud .
    • REPO_NAME par le nom de votre dépôt Docker.
    • IMAGE_NAME par le nom de votre image de conteneur

    Exemple :

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

    Compiler avec des fichiers de configuration

    Vous pouvez utiliser un fichier de configuration pour définir les détails de configuration de votre dépôt d'images simplement pour la commande de compilation. Le fichier de configuration utilise le format de fichier YAML et doit inclure une étape de compilation utilisant la CLI pack.

    1. Créez un nom de fichier YAML cloudbuild.yaml incluant l'URI de votre dépôt d'images de conteneurs.
      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

    Remplacez :

    • LOCATION par le nom de la région de votre dépôt de conteneurs, par exemple us-west2.
    • PROJECT_ID par l'ID de votre projet Google Cloud .
    • REPO_NAME par le nom de votre dépôt Docker.
    • IMAGE_NAME par le nom de votre image de conteneur
    1. Compiler l'application

      Si vous avez nommé votre fichier de configuration cloudbuild.yaml, vous pouvez exécuter la commande suivante:

      gcloud builds submit .
      

    Exemple: Créer un exemple de fonction à distance

    Les exemples suivants montrent comment créer un exemple à distance, puis vérifier que l'image de conteneur a été transférée vers votre dépôt dans Artifact Registry.

    1. Clonez l'exemple de dépôt sur votre ordinateur local :
      git clone https://github.com/GoogleCloudPlatform/buildpack-samples.git
    2. Accédez au répertoire contenant l'exemple de code :

      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. Utilisez gcloud pour envoyer le code source de l'application à 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

      Remplacez :

      • LOCATION par le nom de la région de votre dépôt de conteneurs. Exemple : us-west2-docker.pkg.dev
      • PROJECT_ID par l'ID de votre projet Google Cloud .
      • REPO_NAME par le nom de votre dépôt Docker.

    4. Vérifiez que l'exemple de fonction a bien été publié dans REPO_NAME :
      gcloud artifacts docker images list LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME

      Remplacez :

      • LOCATION par le nom de la région de votre dépôt de conteneurs, par exemple us-west2.
      • PROJECT_ID par l'ID de votre projet Google Cloud .
      • REPO_NAME par le nom de votre dépôt Docker.

    Étape suivante