Créer des fonctions dans des conteneurs

Cloud Run est compatible avec le déploiement direct de fonctions. Toutefois, vous pouvez également créer votre fonction dans une image de conteneur à l'aide des buildpacks de Google Cloud, puis déployer cette image de conteneur dans Cloud Run.

Voici quelques cas d'utilisation courants de la création de fonctions dans un conteneur :

• Intégration et livraison continues : les développeurs créent et envoient le code de la fonction à un dépôt source. Un système CI/CD crée automatiquement la fonction dans un conteneur, exécute des tests et la déploie automatiquement dans un environnement de préproduction.
• Infrastructure en tant que code : les ressources Cloud Run gérées à l'aide de YAML ou de Terraform font référence à une URL d'image de conteneur. Le code de la fonction écrit par les développeurs doit être créé dans une image de conteneur.

Cette page explique comment reproduire le processus de compilation exact des fonctions Cloud Run de deux manières :

• À l'aide de la CLI pack
• À l'aide de Cloud Build comme système de compilation à distance

Point d'entrée de la fonction

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

• Incluez la bibliothèque Framework des fonctions.

• 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 en savoir plus sur l'utilisation des variables d'environnement avec les fonctions Cloud Run, consultez Configurer les services de fonctions Cloud Run.

Compilateurs

Les fonctions Cloud Run sont basées sur des images de base gérées et publiées dans les buildpacks de Google Cloud.

Les compilateurs sont des images composées de buildpacks et de packages de système d'exploitation (également appelés piles). Ils sont utilisés pour convertir le code source de votre fonction en conteneur en cours d'exécution.

Vous pouvez faire votre choix parmi la liste des compilateurs des buildpacks Google Cloud compatibles.

Compiler avec pack

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

Utilisez la commande pack build et spécifiez le compilateur par défaut --builder=gcr.io/buildpacks/builder pour créer vos images de conteneurs 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 créer un exemple en local.

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.

Compiler avec un système de compilation à distance

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

Connectez-vous à votre Google Cloud compte. Si vous n'avez jamais utilisé Google Cloud, créez un compte pour évaluer les performances de nos produits dans des scénarios réels. Les nouveaux clients bénéficient également de 300 $de crédits sans frais pour exécuter, tester et déployer des charges de travail.

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

Installez la Google Cloud CLI.

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.

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

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

Installez la Google Cloud CLI.

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.

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

gcloud init

Si vous avez déjà installé Google Cloud CLI, assurez-vous de disposer de la dernière version disponible en exécutant la commande gcloud components update.

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

   Pour configurer l'accès à un dépôt Docker dans Artifact Registry :

   1. Créez un dépôt Docker au même emplacement que votre Google Cloud projet.

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

      Remplacez :
      • 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 Google Cloud projet 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.

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 Google Cloud projet.
• 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. 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
      - --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
   

   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 Google Cloud projet.
   • REPO_NAME par le nom de votre dépôt Docker.
   • IMAGE_NAME par le nom de votre image de conteneur

2. Compiler l'application

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

   gcloud builds submit .
   

   Conseil : Si vous utilisez un nom unique pour votre fichier de configuration, utilisez l' --config option.

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 Google Cloud projet.
   • 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 Google Cloud projet.
   • REPO_NAME par le nom de votre dépôt Docker.

Créer une fonction pour les mises à jour automatiques des images de base

Les conteneurs de fonctions peuvent également être créés sur scratch, ce qui permet de les utiliser en combinaison avec les mises à jour de sécurité automatiques de Cloud Run.

Dockerfile

Vous pouvez utiliser votre chaîne d'outils de compilation existante pour créer une image de conteneur de fonction compatible avec les mises à jour automatiques des images de base. Consultez les instructions pour créer un conteneur sur scratch.

CLI pack

pack build IMAGE_NAME \
  --builder LOCATION-docker.pkg.dev/serverless-runtimes/google-24-full/builder/LANGUAGE:latest
  --run-image LOCATION-docker.pkg.dev/serverless-runtimes/google-24/scratch/RUNTIME_ID:latest

Remplacez :

• LOCATION par le nom de la région de votre dépôt de conteneurs, par exemple us-west2.
• IMAGE_NAME par le nom de votre image de conteneur
• LANGUAGE par le langage de votre fonction, par exemple nodejs.
• RUNTIME_ID par l'ID de l'environnement d'exécution, par exemple nodejs24.

Cloud Build

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
  - LOCATION-docker.pkg.dev/serverless-runtimes/google-24-full/builder/LANGUAGE:latest
  - --run-image
  - LOCATION-docker.pkg.dev/serverless-runtimes/google-24/scratch/RUNTIME_ID: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 Google Cloud projet.
• REPO_NAME par le nom de votre dépôt Docker.
• IMAGE_NAME par le nom de votre image de conteneur
• LANGUAGE par le langage de votre fonction, par exemple nodejs.
• RUNTIME_ID par l'ID de l'environnement d'exécution, par exemple nodejs24.

Étape suivante

• Une fois votre fonction créée dans un conteneur, testez-la en local avant de la déployer sur Cloud Run. Pour en savoir plus, consultez la section Tester un service Cloud Run localement.
• Pour déployer vos conteneurs créés sur Cloud Run, suivez les consignes Déployer des services.
• Pour automatiser les versions et les déploiements de vos services Cloud Run à l'aide des déclencheurs Cloud Build, consultez configurer le déploiement continu.