Configurer les variables d'environnement

Lorsque vous définissez des variables d'environnement, elles sont injectées dans le conteneur et sont accessibles depuis votre code. Les variables d'environnement sont définies sous forme de paires clé/valeur.

Attention : Vous ne devez pas utiliser de variables d'environnement pour stocker et utiliser des secrets, car ces variables sont visibles par toute personne disposant des autorisations de lecteur de projet ou plus. Utilisez plutôt Secret Manager avec Cloud Run, comme décrit sur la page Utiliser des secrets.

Noms réservés

Les variables d'environnement définies dans le contrat d'exécution du conteneur sont réservées et ne peuvent pas être définies. En particulier, la variable d'environnement PORT est injectée dans votre conteneur par Cloud Run. Vous ne devriez pas la définir vous-même.

Rôles requis

Pour obtenir les autorisations nécessaires pour configurer et déployer des services Cloud Run, demandez à votre administrateur de vous accorder les rôles IAM suivants :

• Développeur Cloud Run (roles/run.developer) sur le service Cloud Run
• Utilisateur du compte de service (roles/iam.serviceAccountUser) sur l'identité du service

Pour obtenir la liste des rôles et des autorisations IAM associés à Cloud Run, consultez les sections Rôles IAM Cloud Run et Autorisations IAM Cloud Run. Si votre service Cloud Run communique avec les API Google Cloud, telles que les bibliothèques clientes Cloud, consultez le guide de configuration de l'identité du service. Pour en savoir plus sur l'attribution de rôles, consultez les sections Autorisations de déploiement et Gérer les accès.

Avertissement : Si votre service Cloud Run utilise l'identité du service pour authentifier l'accès aux API Google Cloud, ne définissez jamais GOOGLE_APPLICATION_CREDENTIALS en tant que variable d'environnement sur un service Cloud Run. Configurez toujours un compte de service géré par l'utilisateur.

Définir des variables d'environnement

Tout changement de configuration entraîne la création d'une révision. Les révisions ultérieures obtiennent aussi automatiquement le même paramètre de configuration, à moins que vous ne le mettiez explicitement à jour.

Vous pouvez définir des variables d'environnement à l'aide de Google Cloud Console, de la ligne de commande gcloud ou d'un fichier YAML lorsque vous créez un service ou que vous déployez une nouvelle révision :

Console

1. Dans la console Google Cloud, accédez à Cloud Run :

   Accédez à Cloud Run

2. Cliquez sur Déployer un conteneur et sélectionnez Service pour configurer un nouveau service. Si vous configurez un service existant, cliquez sur celui-ci puis sur Modifier et déployer la nouvelle révision.

3. Si vous configurez un nouveau service, remplissez la page initiale des paramètres du service, puis cliquez sur Conteneur(s), volumes, mise en réseau et sécurité pour développer la page de configuration du service.

4. Cliquez sur l'onglet Conteneur.

   

   • Procédez comme suit :
     • Si vous ajoutez une variable, cliquez sur Add Variable (Ajouter une variable) et spécifiez le nom souhaité et la valeur de cette variable dans les zones de texte Name (Nom) et Value (Valeur).
     • Si vous modifiez la valeur d'une variable, remplacez la valeur actuelle dans la zone de texte Value (Valeur) par la valeur souhaitée.
     • Si vous supprimez une ou plusieurs variables d'environnement, placez votre curseur à gauche de la zone de texte Value (Valeur) de la variable à supprimer pour afficher l'icône de la corbeille, puis cliquez dessus.

5. Cliquez sur Créer ou Déployer.

gcloud

Pour définir, modifier ou supprimer des variables d'environnement sur un service existant, utilisez la commande gcloud run services update. Vous pouvez utiliser l'une des options suivantes, selon vos besoins :

• --set-env-vars
• --update-env-vars
• --remove-env-vars
• --clear-env-vars

Vous pouvez spécifier des variables d'environnement lors du déploiement d'un service ou les mettre à jour après la création du service :

gcloud run deploy [SERVICE] --image IMAGE_URL --update-env-vars KEY1=VALUE1,KEY2=VALUE2

gcloud run services update SERVICE --update-env-vars KEY1=VALUE1,KEY2=VALUE2

• Remplacez SERVICE par le nom du service.
• Remplacez KEY1=VALUE1,KEY2=VALUE2 par la liste des noms de variables souhaités et de leurs valeurs, séparés par une virgule.
• Remplacez IMAGE_URL par une référence à l'image de conteneur, par exemple us-docker.pkg.dev/cloudrun/container/hello:latest. Si vous utilisez Artifact Registry, le dépôt REPO_NAME doit déjà être créé. L'URL se présente sous la forme suivante : LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG.

YAML

1. Si vous créez un service, ignorez cette étape. Si vous mettez à jour un service existant, téléchargez sa configuration YAML :

   gcloud run services describe SERVICE --format export > service.yaml

2. Modifiez les attributs name et value sous l'attribut env sous containers: :

   apiVersion: serving.knative.dev/v1
   kind: Service
   metadata:
     name: SERVICE
   spec:
     template:
       metadata:
         name: REVISION
       spec:
         containers:
         - image: IMAGE
           env:
           - name: KEY-1
             value: VALUE-1
           - name: KEY-N
             value: VALUE-N

   Remplacer

   • SERVICE par le nom de votre service Cloud Run
   • IMAGE_URL par une référence à l'image de conteneur, par exemple us-docker.pkg.dev/cloudrun/container/hello:latest. Si vous utilisez Artifact Registry, le dépôt REPO_NAME doit déjà être créé. L'URL se présente sous la forme suivante : LOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG
   • KEY-1, VALUE-1 par la variable d'environnement et la valeur. Si vous le souhaitez, vous pouvez ajouter d'autres variables accompagnées de leur valeur.
   • REVISION par un nouveau nom de révision ou supprimez-le (le cas échéant). Si vous indiquez un nouveau nom de révision, il doit répondre aux critères suivants :
     • Commencer par SERVICE-
     • Ne contenir que des lettres minuscules, des chiffres et -
     • Ne pas se terminer par -
     • Ne pas dépasser 63 caractères

3. Créez ou mettez à jour le service à l'aide de la commande suivante :

   gcloud run services replace service.yaml

Terraform

Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez Commandes Terraform de base.

La ressource google_cloud_run_v2_service suivante définit la variable d'environnement foo sur bar et la variable d'environnement baz sur quux. Mettez à jour les variables d'environnement selon vos besoins spécifiques :

resource "google_cloud_run_v2_service" "default" {
  name     = "cloudrun-service-env-var"
  location = "us-central1"

  deletion_protection = false # set to "true" in production

  template {
    containers {
      image = "us-docker.pkg.dev/cloudrun/container/hello"

      # Environment variables
      env {
        name  = "foo"
        value = "bar"
      }
      env {
        name  = "baz"
        value = "quux"
      }
    }
  }
}

Définir de nombreuses variables d'environnement

Si vous avez trop de variables d'environnement qui ne peuvent pas être facilement répertoriées au format KEY1=VALUE1,KEY2=VALUE2, vous pouvez également répéter les options ci-dessus plusieurs fois :

   [...]
   --set-env-vars "KEY1=VALUE1" \
   --set-env-vars "KEY2=VALUE2" \
   --set-env-vars "KEY3=VALUE3"

Échapper les caractères de virgule

Comme la virgule , est utilisée pour séparer les variables d'environnement, si votre variable d'environnement contient des virgules en tant que valeurs, vous devez échapper ces délimiteurs en spécifiant un caractère de délimitation différent, par exemple @ :

--set-env-vars "^@^KEY1=value1,value2,value3@KEY2=..."

Définir des variables d'environnement par défaut dans le conteneur

Vous pouvez utiliser l'instruction ENV dans un fichier Dockerfile pour définir les valeurs par défaut des variables d'environnement :

ENV KEY1=VALUE1,KEY2=VALUE2

Ordre de priorité entre les variables de conteneur et de service ou de tâche

Si vous définissez une variable d'environnement par défaut dans le conteneur et une variable d'environnement portant le même nom sur le service ou le job Cloud Run, la valeur définie au niveau du service est prioritaire.

Afficher les paramètres des variables d'environnement

Pour afficher les paramètres des variables d'environnement actuels de votre service Cloud Run, procédez comme suit :

Console

1. Dans la console Google Cloud, accédez à Cloud Run :

   Accédez à Cloud Run

2. Cliquez sur le service qui vous intéresse pour ouvrir la page Informations sur le service.

3. Cliquez sur l'onglet Révisions.

4. Dans le panneau de détails sur la droite, le paramètre des variables d'environnement est répertorié sous l'onglet Conteneur.

gcloud

1. Exécutez la commande suivante :

   gcloud run services describe SERVICE

2. Recherchez le paramètre de variables d'environnement dans la configuration renvoyée.

Exemple de code

Pour obtenir un exemple de code montrant comment accéder aux variables d'environnement de votre code, reportez-vous à la section Gérer une configuration sensible avec Secret Manager du tutoriel sur l'authentification des utilisateurs finaux.

Étapes suivantes

Vous pouvez utiliser des variables d'environnement pour définir la configuration du buildpack. Pour obtenir des informations propres à chaque langage, consultez la documentation sur les buildpacks pour :

• Node.js
• Python
• Go
• Ruby
• PHP
• Java