Utilisez Firestore pour configurer une base de données cloud NoSQL évolutive pour votre service Cloud Run. Firestore est une base de données NoSQL flexible et évolutive conçue pour le développement mobile, Web et serveur.
Grâce à l'intégration de Cloud Run décrite sur cette page, vous pouvez connecter rapidement votre service Cloud Run à une nouvelle base de données Firestore.
Avant de commencer
- Assurez-vous que le service Cloud Run avec lequel vous effectuez l'intégration est déjà déployé.
- Consultez la page des tarifs de Firestore. Les ressources individuelles utilisées dans l'intégration vous sont facturées.
Rôles requis
Pour utiliser les intégrations Cloud Run, vous ou votre administrateur devez attribuer des rôles IAM sur deux comptes principaux différents.
Cliquez ici pour afficher les rôles requis pour votre compte Google
Pour obtenir les autorisations nécessaires pour utiliser les intégrations Cloud Run, demandez à votre administrateur d'accorder à votre compte Google les rôles IAM suivants sur votre projet :
- Développeur Cloud Run (
roles/run.developer) - Lecteur Compute (
roles/compute.viewer) - Développeur d'intégrations sans serveur (
roles/runapps.developer) - Opérateur d'intégrations sans serveur (
roles/runapps.operator) - Utilisateur du compte de service (
roles/iam.serviceAccountUser)
Cliquez ici pour afficher les rôles requis pour le compte de service
Pour déployer le service Cloud Run, vous pouvez utiliser le compte de service par défaut Compute Engine créé automatiquement ou spécifier un compte de service géré par l'utilisateur. Le compte de service doit disposer des rôles suivants :
- Développeur Cloud Run (
roles/run.developer) - Rédacteur de bucket de journaux (
roles/logging.bucketWriter) - Utilisateur du compte de service (
roles/iam.serviceAccountUser) - Administrateur de l'espace de stockage (
roles/storage.admin) - Administrateur Firestore (
roles/firestore.admin) - Administrateur de projet IAM (
roles/projectIAM.admin)
Connecter un service à une nouvelle base de données Firestore
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 connecter un service Cloud Run à une base de données Firestore à l'aide de la console ou de la ligne de commande.
Console
Dans la console Google Cloud, accédez à la page Cloud Run.
Dans la liste des services, cliquez sur celui que vous souhaitez utiliser dans cette intégration.
Cliquez sur l'onglet Integrations (Intégrations).
Cliquez sur Ajouter une intégration.
Cliquez sur Base de données Firestore.
Utilisez le nom par défaut ou remplacez le nom par la valeur que vous souhaitez utiliser.
Si vous êtes invité à activer une liste d'API, cliquez sur Activer et attendez que l'activation soit effective.
Dans le champ Ressources, prenez note des nouvelles ressources qui seront créées suite à cette intégration.
Cliquez sur Envoyer et attendez que l'intégration et les ressources soient créées. Cette opération peut prendre jusqu'à 15 minutes.
Ligne de commande
Installez la dernière version de Google Cloud CLI :
gcloud components update
Créez l'intégration :
gcloud beta run integrations create \ --type=firestore \ --service=SERVICE \
Remplacez :
- SERVICE par le nom de votre service Cloud Run.
Vous pouvez également inclure l'option
--service-account=SERVICE_ACCOUNT_EMAIL.SERVICE_ACCOUNT_EMAIL par l'adresse e-mail du compte de service géré par l'utilisateur (
PROJECT_NUMBER[email protected]) utilisé pour déployer le service. Ne renseignez pas cette option si vous souhaitez utiliser le compte de service Compute par défaut (SERVICE_ACCOUNT_ID@PROJECT_ID.iam.gserviceaccount.com).Pour continuer à utiliser le compte de service spécifié lors du déploiement des intégrations Cloud Run, exécutez la commande suivante:
gcloud config set runapps/deployment-service-account
Attendez jusqu'à 15 minutes, au cours desquelles une base de données Firestore entièrement configurée est créée et connectée. En outre, une nouvelle révision Cloud Run est créée, y compris les variables d'environnement qui identifient la base de données. Une fois le processus terminé, le message suivant s'affiche :
[firestore] integration [firestore-xxx] has been updated successfully. To connect to the Firestore database, utilize the environment variable `FIRESTORE_DB_NAME`. This variable is added to the Cloud Run service for you.
Vous pouvez vérifier son état en exécutant la commande
gcloud beta run integrations describe.
Afficher les intégrations de base de données Firestore
Pour afficher l'état actuel des intégrations de base de données Firestore pour votre service Cloud Run, procédez comme suit:
Console
Dans la console Google Cloud, accédez à la page Cloud Run.
Dans la liste des services, cliquez sur celui que vous souhaitez utiliser dans cette intégration.
Cliquez sur l'onglet Integrations (Intégrations).
Identifiez l'intégration de la base de données Firestore qui vous intéresse, puis cliquez sur Afficher les détails.
Ligne de commande
Exécutez la commande suivante pour obtenir la liste des intégrations disponibles :
gcloud beta run integrations list
Choisissez un nom dans cette liste, et exécutez la commande suivante pour en afficher les détails :
gcloud beta run integrations describe INTEGRATION_NAME
Remplacez INTEGRATION_NAME par le nom de votre intégration de base de données Firestore.
Supprimer des intégrations de base de données Firestore
La suppression d'une intégration entraîne également la suppression de toutes les ressources Google Cloud qui y sont associées, mais pas votre service Cloud Run.
Pour supprimer une intégration de base de données Firestore de votre service Cloud Run, procédez comme suit:
Console
Dans la console Google Cloud, accédez à la page Cloud Run.
Cliquez sur le service pour lequel vous souhaitez supprimer une intégration.
Cliquez sur l'onglet Integrations (Intégrations).
Identifiez l'intégration de base de données Firestore qui vous intéresse, cliquez sur l'icône représentant des points de suspension à droite de l'intégration, puis cliquez sur Supprimer.
Ligne de commande
Exécutez la commande suivante pour obtenir la liste des intégrations disponibles :
gcloud beta run integrations list
Choisissez un nom dans cette liste, et exécutez la commande suivante pour supprimer cette intégration :
gcloud beta run integrations delete INTEGRATION_NAME
Remplacez :
- INTEGRATION_NAME par le nom de votre intégration de base de données Firestore.
Vous pouvez également utiliser les options suivantes :
Option Description --service-accountAdresse e-mail du compte de service géré par l'utilisateur utilisé pour effectuer l'opération de suppression.
Accéder à la base de données Firestore dans votre code
Une fois l'intégration terminée, Cloud Run ajoute automatiquement la variable d'environnement FIRESTORE_DB_NAME à utiliser dans le code de votre service Cloud Run.
Exemple de code pour des services utilisant Firestore
Reportez-vous à la documentation de Firestore pour obtenir des exemples de code Cloud Run et Firestore.
Limites
- Les intégrations Cloud Run ne sont disponibles que dans certaines régions. Si vous devez utiliser une région non compatible avec les intégrations Cloud Run, consultez la page Utiliser une bibliothèque cliente côté serveur.
- La base de données par défaut Firestore n'est pas compatible. Cette intégration ne permet de créer que des bases de données Firestore nommées.