Configurer des variables d'environnement pour les services

Cette page explique comment configurer des variables d'environnement pour votre service Cloud Run.

Vous pouvez utiliser des variables d'environnement pour la configuration du service, mais nous ne les recommandons pas pour stocker des secrets, tels que les identifiants de bases de données ou les clés API. Les valeurs sensibles doivent être stockées en dehors de votre code source et des variables d'environnement. Pour stocker des secrets, nous vous recommandons d'utiliser Secret Manager. Pour configurer des services afin d'accéder aux secrets stockés dans Secret Manager, consultez la page Configurer les secrets.

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.

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 des APIGoogle Cloud , telles que des 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 pages Autorisations de déploiement et Gérer les accès.

Nombre maximal de variables d'environnement et limites

Vous pouvez définir un maximum de 1 000 variables d'environnement pour un service Cloud Run.

La longueur maximale de la variable est de 32 Ko.

Définir des variables d'environnement

Vous pouvez définir des variables d'environnement pour les services nouveaux et existants. Notez que l'indicateur --set-env-vars est une action destructive qui supprime les variables d'environnement précédemment définies qui ne sont pas incluses dans la nouvelle liste de variables d'environnement.

Les variables d'environnement sont liées à une révision de service spécifique et ne sont pas visibles par les autres services de votre Google Cloud projet.

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

gcloud run deploy SERVICE --image IMAGE_URL --set-env-vars KEY1=VALUE1,KEY2=VALUE2

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

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

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

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

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

Mettre à jour des variables d'environnement

Vous pouvez mettre à jour les variables d'environnement des services existants. Il s'agit d'une approche non destructrice, qui permet de modifier ou d'ajouter des variables d'environnement, mais qui ne supprime pas les variables d'environnement précédemment définies.

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

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 :

Supprimer des variables d'environnement

Vous pouvez supprimer des variables d'environnement pour des services existants.

gcloud run services update SERVICE --remove-env-vars KEY1,KEY2

gcloud run services update SERVICE --clear-env-vars

Bonnes pratiques

La section suivante met en évidence certaines des bonnes pratiques de configuration des variables d'environnement.

Variables d'environnement réservées pour les services

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.

Variables d'environnement réservées supplémentaires lors du déploiement de fonctions

Cloud Run définit automatiquement les variables d'environnement d'exécution suivantes lors du déploiement de fonctions:

• FUNCTION_TARGET: fonction à exécuter.
• FUNCTION_SIGNATURE_TYPE: type de la fonction: http pour les fonctions HTTP et event pour les fonctions basées sur les événements.

D'autres variables d'environnement sont définies automatiquement suivant l'environnement d'exécution utilisé par votre fonction. Celles-ci dépendent du système d'exploitation de l'environnement d'exécution (par exemple, DEBIAN_FRONTEND, SHLVL ou PATH) ainsi que de l'environnement d'exécution du langage (par exemple NODE_ENV, VIRTUAL_ENV ou GOPATH).

Les variables d'environnement fournies par l'environnement, autres que celles définies automatiquement, pourront faire l'objet de modifications dans des versions d'exécution ultérieures. Il est déconseillé de modifier ou de dépendre de variables d'environnement que vous n'avez pas définies explicitement.

Modifier les variables d'environnement fournies par l'environnement peut avoir des conséquences imprévisibles. Les tentatives de modification de ces variables d'environnement peuvent être bloquées ou, pire, avoir des conséquences inattendues comme empêcher le lancement de certaines fonctions. Nous vous recommandons de préfixer les variables d'environnement à l'aide d'une clé unique afin d'éviter tout conflit.

Variables d'environnement non valides

Vous ne pouvez pas utiliser les variables d'environnement suivantes:

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 des buildpacks. Pour obtenir des informations propres à chaque langage, consultez la documentation sur les buildpacks pour:

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

Si vous effectuez un déploiement à partir de la source et que vous devez personnaliser des variables au moment de la compilation, consultez Définir des variables d'environnement de compilation.