Créer des fonctions

Les fonctions créées pour Cloud Run peuvent être compilées à l'aide des buildpacks de Google Cloud.

Cette page présente deux façons de créer vos fonctions pour les déployer dans Cloud Run:

• Utiliser la CLI pack
• Utiliser 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 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 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 des variables d'environnement avec des fonctions Cloud Run, consultez la section Configurer les services Cloud Run Functions.

Compilateurs

Les fonctions 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"). Les compilateurs servent à 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.

Compiler 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 créer 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.

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

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

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.

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

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 .
   

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

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.

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

Preview — Cloud Run automatic base image updates

Cette fonctionnalité est soumise aux "Conditions des offres de pré-DG" dans la section "Conditions d'utilisation générales" des Conditions spécifiques au service. Les fonctionnalités pré-DG sont disponibles "en l'état" et peuvent avoir une assistance limitée. Pour en savoir plus, consultez les descriptions des étapes de lancement.

Les conteneurs de fonctions peuvent également être créés sur scratch, ce qui leur permet d'être utilisés avec les mises à jour de sécurité automatiques de Cloud Run.

CLI pack

pack build IMAGE_NAME \
  --builder LOCATION.pkg.dev/serverless-runtimes/google-22-full/builder/LANGUAGE:latest
  --run-image LOCATION-docker.pkg.dev/serverless-runtimes/google-22/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 la langue de votre fonction, par exemple nodejs.
• RUNTIME_ID par l'ID d'exécution, par exemple nodejs22.

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

Étape suivante

• Une fois votre conteneur créé, vous pouvez effectuer des tests en local avant de le déployer sur Cloud Run. Pour en savoir plus, consultez la section Tester un service Cloud Run localement.
• Pour comprendre les exigences et les comportements clés des conteneurs dans Cloud Run, consultez la page Contrat concernant les conteneurs.
• 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, configurez le déploiement continu.
• Pour optimiser la création de conteneurs pour une application Java, consultez la page Créer des conteneurs Java avec Jib.