Utiliser des 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. Par exemple, supposons que le service en cours d'exécution active une journalisation supplémentaire lorsqu'il lit LOGGING_VERBOSE: true dans l'environnement. Dans ce scénario, vous définissez la paire clé/valeur pour la variable d'environnement comme ceci : LOGGING_VERBOSE=true. Les commandes exactes et l'interface utilisateur sont présentées dans les sections suivantes.

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.

Définir des variables d'environnement sur un service

Toute modification 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 Cloud Console, de la ligne de commande gcloud ou d'un fichier YAML lorsque vous créez un service ou déployez une nouvelle révision :

Console

  1. Accédez à Cloud Run

  2. Cliquez sur Créer un service si vous configurez un nouveau service sur lequel effectuer un déploiement. 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, renseignez la page de paramètres initiale du service, puis cliquez sur Suivant > Paramètres avancés pour accéder à la page de configuration du service.

  4. Cliquez sur l'onglet Variables et secrets.

    image

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

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

Ligne de commande

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 :

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 du conteneur, par exemple gcr.io/myproject/my-image:latest.

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"

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=..."

YAML

Vous pouvez télécharger et afficher la configuration de service existante à l'aide de la commande gcloud run services describe --format export, qui renvoie les résultats nettoyés au format YAML. Vous pouvez ensuite modifier les champs décrits ci-dessous et importer le fichier YAML modifié à l'aide de la commande gcloud beta run services replace. Veillez à ne modifier que les champs indiqués.

  1. Pour afficher et télécharger la configuration, exécutez la commande suivante :

    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:
        spec:
          containers:
          - env:
            - name: KEY-1
              value: VALUE-1
            - name: KEY-N
              value: VALUE-N

    Remplacez

    • SERVICE par le nom de votre service Cloud Run ;
    • 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.
  3. Remplacez la configuration du service en utilisant la commande suivante :

    gcloud beta run services replace service.yaml

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 les variables 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.

Afficher les paramètres des variables d'environnement

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

Console

  1. 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 Variables et secrets.

Ligne de commande

  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.