Définir des variables d'environnement pour configurer des builds

Vous pouvez configurer des variables d'environnement qui seront définies lors de la compilation de votre image de conteneur.

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

Builds locaux

Pour les builds locaux, vous devez avoir installé la CLI Pack et Docker.

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.

Définir des variables d'environnement

Pour définir des variables d'environnement pour les builds locaux, vous devez ajouter l'option --env à la commande pack pour chaque variable d'environnement.

Vous pouvez utiliser une ou plusieurs des variables d'environnement compatibles avec votre environnement d'exécution.

pack build SERVICE_NAME \
    --env ENVIRONMENT_VARIABLE

Remplacez :

• SERVICE_NAME par le nom du service correspondant à votre application ou fonction ;
• ENVIRONMENT_VARIABLE par la variable d'environnement que vous souhaitez définir lors de la compilation.

Exemple

Pour définir la variable d'environnement GOOGLE_ENTRYPOINT="gunicorn -p :8080 main:app" dans votre image de conteneur, exécutez la commande suivante :

pack build my-app \
    --builder gcr.io/buildpacks/builder:v1 \
    --env GOOGLE_ENTRYPOINT="gunicorn -p :8080 main:app"
    --env MY-LOCAL-ENV-VARIABLE

Builds distants

Pour définir des variables d'environnement pour les builds distants, vous devez utiliser le descripteur de projet project.toml. Ce descripteur de projet project.toml est utilisé par Cloud Build lors de la compilation de votre image de conteneur.

Avant de commencer

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.

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.

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

Install the 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 (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

Install the 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 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.

Facultatif : Télécharger un exemple d'application

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-go

   Java

   cd buildpack-samples/sample-java-gradle

   Node.js

   cd buildpack-samples/sample-node

   PHP

   cd buildpack-samples/sample-php

   Python

   cd buildpack-samples/sample-python

   Ruby

   cd buildpack-samples/sample-ruby

   .NET

   cd buildpack-samples/sample-dotnet

Compiler l'application avec des variables d'environnement

1. Dans le répertoire racine de votre service, créez ou mettez à jour votre descripteur de projet project.toml pour inclure la section [[build.env]] et l'une des variables d'environnement compatibles :

   [[build.env]]
       name = "ENVIRONMENT_VARIABLE_NAME"
       value = "ENVIRONMENT_VARIABLE_VALUE"

   Remplacez :

   • ENVIRONMENT_VARIABLE_NAME par le nom d'une variable d'environnement compatible ;
   • ENVIRONMENT_VARIABLE_VALUE par la valeur correspondante pour la variable d'environnement spécifiée.

   Exemple

   [[build.env]]
       name = "GOOGLE_ENTRYPOINT"
       value = "gunicorn -p :8080 main:app"

2. Utilisez gcloud pour envoyer le code source de l'application à Cloud Build :

   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. 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.
   • IMAGE_NAME par le nom de votre image de conteneur

   Exemples : Si vous avez téléchargé un exemple d'application, vous devez exécuter la commande correspondante :

   Go

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

   Java

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

   Node.js

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

   PHP

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

   Python

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

   Ruby

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

   .NET

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

3. Vérifiez que l'exemple d'application a bien été publié sur 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. 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.