Solution de démarrage rapide : application Web Java pour le partage de grands volumes de données

Last reviewed 2023-06-27 UTC

Ce guide vous aide à comprendre, déployer et utiliser la solution de démarrage rapide application Web Java pour le partage de grands volumes de données. Cette solution montre comment créer une application capable de diffuser de grandes quantités de fichiers.

Si vous souhaitez utiliser Go au lieu de Java, consultez la solution de démarrage rapide application Web Golang pour le partage de grands volumes de données.

Ce document est destiné aux développeurs qui maîtrisent la création d'une application Web. Nous partons du principe que vous connaissez les concepts de base du cloud et de Java, mais pas nécessairement Google Cloud. L'expérience de Terraform est utile.

Objectifs

  • Comprenez le schéma d'utilisateur pour le partage de grands volumes de données.
  • Stockez et diffusez des objets dans un service de stockage d'objets basé sur le cloud.
  • Déployez une application qui utilise un réseau de diffusion distribué pour diffuser de nombreux objets.
  • Sécurisez les objets au niveau de chaque couche pour un accès suivant le principe du moindre privilège.

Produits utilisés

La solution utilise les produits Google Cloud suivants :

  • Cloud CDN (Content Delivery Network) : diffusion fiable et rapide de contenu Web et de vidéos à l'échelle mondiale.
  • Cloud Storage : un service adapté aux entreprises qui fournit un stockage d'objets économique et sans limite pour divers types de données. Les données sont accessibles depuis et en dehors de Google Cloud et sont répliquées de manière géoredondante.
  • Cloud Run : service entièrement géré qui vous permet de créer et de déployer des applications conteneurisées sans serveur. Google Cloud gère le scaling et d'autres tâches d'infrastructure afin que vous puissiez vous concentrer sur la logique métier de votre code.
  • Cloud Load Balancing : un service qui fournit un équilibrage de charge hautes performances et évolutif sur Google Cloud.
  • Firestore : base de données de documents sans serveur, entièrement gérée et évolutive.

Pour en savoir plus sur la configuration de ces produits et leur interaction, consultez la section suivante.

Architecture

Cette solution déploie une application de partage d'images entièrement mise en œuvre et prête à l'emploi. Le schéma suivant illustre l'architecture des ressources Google Cloud déployées par la solution :

Schéma de l'architecture d'une application de partage d'images utilisant Cloud CDN pour diffuser des fichiers.

Processus de requête

Voici le flux de traitement des requêtes de l'application de partage d'images déployée par cette solution. Les étapes du flux sont numérotées comme indiqué dans le schéma de l'architecture précédente.

  1. Les requêtes d'importation de fichiers des utilisateurs sont acheminées vers l'interface à l'aide d'un équilibreur de charge.
  2. L'interface achemine ces requêtes vers le backend qui utilise Cloud Run.
  3. Le backend stocke les fichiers dans Cloud Storage et les métadonnées concernant les fichiers dans Firestore.
  4. En cas de succès de cache (hit) Cloud CDN, les requêtes des utilisateurs pour afficher un fichier sont acheminées vers Cloud CDN.
  5. En cas de défaut du cache Cloud CDN, les requêtes des utilisateurs pour afficher un fichier sont acheminées vers Cloud Storage.

Composants et configuration

L'architecture comprend les composants suivants :

  • Application Web de partage d'images composée d'une interface et d'un backend exécuté sur Cloud Run. L'interface de l'application utilise Angular. Le backend de l'application est écrit en Java.
  • Un équilibreur de charge créé à l'aide de Cloud Load Balancing achemine les requêtes entrantes vers la ressource appropriée.
  • Un bucket Cloud Storage qui stocke les fichiers image.
  • Cloud CDN met en cache des images du bucket Cloud Storage et accélère la diffusion du contenu.
  • Une base de données Firestore pour stocker les métadonnées de fichiers.

Coût

Pour obtenir une estimation du coût des ressources Google Cloud utilisées par la solution d'application Web Java pour le partage de grands volumes de données, consultez l'estimation précalculée dans le Simulateur de coût Google Cloud.

Utilisez l'estimation comme point de départ pour calculer le coût de votre déploiement. Vous pouvez modifier l'estimation afin qu'elle reflète les modifications de configuration que vous prévoyez d'apporter aux ressources utilisées dans la solution.

L'estimation précalculée est basée sur des hypothèses pour certains facteurs, y compris les suivants :

  • Emplacements Google Cloud où les ressources sont déployées.
  • La durée d'utilisation des ressources.

Déployer la solution

Cette section vous guide tout au long du processus de déploiement de la solution.

Créer ou choisir un projet Google Cloud

Lorsque vous déployez la solution, vous choisissez le projet Google Cloud dans lequel les ressources sont déployées. Lorsque vous décidez d'utiliser un projet existant ou d'en créer un, prenez en compte les facteurs suivants :

  • Si vous créez un projet pour la solution, vous pouvez supprimer le projet lorsque vous n'en avez plus besoin et éviter de continuer à payer des frais. Si vous utilisez un projet existant, vous devez supprimer le déploiement lorsque vous n'en avez plus besoin.
  • L'utilisation d'un nouveau projet permet d'éviter les conflits avec les ressources précédemment provisionnées, telles que les ressources utilisées pour les charges de travail de production.

Si vous souhaitez déployer la solution dans un nouveau projet, créez-le avant de commencer le déploiement.

Pour créer un projet, procédez comme suit :

  1. Dans Google Cloud Console, accédez à la page de sélection du projet.

    Accéder au sélecteur de projet

  2. Pour commencer à créer un projet Google Cloud, cliquez sur Créer un projet.

  3. Attribuez un nom à votre projet. Notez l'ID de projet que vous avez généré.

  4. Modifiez les autres champs si nécessaire.

  5. Pour créer le projet, cliquez sur Créer.

Obtenir les autorisations IAM requises

Pour démarrer le processus de déploiement, vous devez disposer des autorisations IAM (Identity and Access Management) répertoriées dans le tableau suivant. Si vous disposez du rôle de base roles/owner pour le projet dans lequel vous prévoyez de déployer la solution, vous disposez déjà de toutes les autorisations nécessaires. Si vous ne disposez pas du rôle roles/owner, demandez à votre administrateur de vous accorder ces autorisations (ou des rôles qui les incluent).

Autorisation IAM requise Rôle prédéfini incluant les autorisations requises

serviceusage.services.enable

Administrateur Service Usage
(roles/serviceusage.serviceUsageAdmin)

iam.serviceAccounts.create

Administrateur de compte de service
(roles/iam.serviceAccountAdmin)

resourcemanager.projects.setIamPolicy

Administrateur de projet IAM
(roles/resourcemanager.projectIamAdmin)
config.deployments.create
config.deployments.list
Administrateur Cloud Infrastructure Manager
(roles/config.admin)

Compte de service créé pour la solution

Si vous démarrez le processus de déploiement via la console, Google crée un compte de service pour déployer la solution en votre nom (et pour supprimer le déploiement ultérieurement si vous le souhaitez). Certaines autorisations IAM sont attribuées temporairement à ce compte de service. En d'autres termes, les autorisations sont révoquées automatiquement une fois les opérations de déploiement et de suppression de la solution terminées. Nous vous recommandons de supprimer le compte de service après avoir supprimé le déploiement, comme décrit plus loin dans ce guide.

Afficher les rôles attribués au compte de service

Ces rôles sont listés ici si un administrateur de votre projet ou de votre organisation Google Cloud a besoin de ces informations.

  • roles/storage.admin
  • roles/datastore.owner
  • roles/appengine.appAdmin
  • roles/compute.admin
  • roles/compute.networkAdmin
  • roles/cloudtrace.admin
  • roles/iam.serviceAccountUser
  • roles/run.admin
  • roles/monitoring.admin
  • roles/vpcaccess.admin

Choisir une méthode de déploiement

Pour vous aider à déployer cette solution avec un minimum d'efforts, une configuration Terraform est fournie dans GitHub. La configuration Terraform définit toutes les ressources Google Cloud requises pour la solution.

Vous pouvez déployer la solution en utilisant l'une des méthodes suivantes :

  • Via la console : utilisez cette méthode si vous souhaitez essayer la solution avec la configuration par défaut et voir comment elle fonctionne. Cloud Build déploie toutes les ressources requises pour la solution. Lorsque vous n'avez plus besoin de la solution déployée, vous pouvez la supprimer via la console. Toutes les ressources que vous créez après le déploiement de la solution devront peut-être être supprimées séparément.

    Pour utiliser cette méthode de déploiement, suivez les instructions de la section Déployer via la console.

  • À l'aide de la CLI Terraform : utilisez cette méthode si vous souhaitez personnaliser la solution, ou automatiser le provisionnement et la gestion des ressources à l'aide de l'approche Infrastructure as Code (IaC). Téléchargez la configuration Terraform depuis GitHub, personnalisez éventuellement le code si nécessaire et déployez la solution à l'aide de la CLI Terraform. Après avoir déployé la solution, vous pouvez continuer à la gérer à l'aide de Terraform.

    Pour utiliser cette méthode de déploiement, suivez les instructions de la section Déployer à l'aide de la CLI Terraform.

Déployer via la console

Pour déployer la solution préconfigurée, suivez la procédure suivante.

  1. Dans le catalogue de solutions de démarrage rapide Google Cloud, accédez à la solution Application Web Java pour le partage de grands volumes de données.

    Accéder à la solution d'application Web Java pour le partage de grands volumes de données

  2. Examinez les informations fournies sur la page, telles que l'estimation du coût de la solution et le temps de déploiement estimé.

  3. Lorsque vous êtes prêt à déployer la solution, cliquez sur Déployer.

    Un guide interactif détaillé s'affiche.

  4. Suivez la procédure du guide interactif.

    Notez le nom que vous saisissez pour le déploiement. Ce nom sera requis ultérieurement lorsque vous supprimerez le déploiement.

    Lorsque vous cliquez sur Déployer, la page Déploiements de solutions s'affiche. Le champ État de cette page indique En cours de déploiement.

  5. Attendez que la solution soit déployée.

    Si le déploiement échoue, le champ État indique Échec. Vous pouvez utiliser le journal Cloud Build pour diagnostiquer les erreurs. Pour en savoir plus, consultez la section Erreurs lors du déploiement via la console.

    Une fois le déploiement terminé, le champ État indique Déployé.

  6. Pour afficher et utiliser la solution, revenez à la page Déploiements de solutions dans la console.

    1. Cliquez sur le menu  Actions.
    2. Sélectionnez Afficher l'application Web pour ouvrir l'application de partage d'images.

Lorsque vous n'avez plus besoin de la solution, vous pouvez supprimer le déploiement pour éviter de continuer à payer des frais pour les ressources Google Cloud. Pour en savoir plus, consultez la section Supprimer le déploiement.

Déployer via la CLI Terraform

Cette section explique comment personnaliser la solution, ou automatiser son provisionnement et sa gestion à l'aide de la CLI Terraform. Les solutions que vous déployez à l'aide de la CLI Terraform ne s'affichent pas sur la page Déploiements de solutions de la console Google Cloud.

Configurer le client Terraform

Vous pouvez exécuter Terraform dans Cloud Shell ou sur votre hôte local. Ce guide explique comment exécuter Terraform dans Cloud Shell, où Terraform est préinstallé et configuré pour s'authentifier auprès de Google Cloud.

Le code Terraform de cette solution est disponible dans un dépôt GitHub.

  1. Clonez le dépôt GitHub dans Cloud Shell.

    Ouvrir dans Cloud Shell

    Une invite s'affiche pour confirmer le téléchargement du dépôt GitHub dans Cloud Shell.

  2. Cliquez sur Confirmer.

    Cloud Shell est lancé dans un onglet de navigateur distinct, et le code Terraform est téléchargé dans le répertoire $HOME/cloudshell_open de votre environnement Cloud Shell.

  3. Dans Cloud Shell, vérifiez si le répertoire de travail actuel est $HOME/cloudshell_open/terraform-large-data-sharing-java-webapp/infra. Il s'agit du répertoire qui contient les fichiers de configuration Terraform pour la solution. Si vous devez accéder à ce répertoire, exécutez la commande suivante :

    cd $HOME/cloudshell_open/terraform-large-data-sharing-java-webapp/infra
    
  4. Initialisez Terraform à l'aide de la commande suivante :

    terraform init
    

    Attendez que le message suivant s'affiche :

    Terraform has been successfully initialized!
    

Configurer les variables Terraform

Le code Terraform que vous avez téléchargé comprend des variables que vous pouvez utiliser pour personnaliser le déploiement en fonction de vos besoins. Par exemple, vous pouvez spécifier le projet Google Cloud et la région dans laquelle vous souhaitez déployer la solution.

  1. Assurez-vous que le répertoire de travail actuel est $HOME/cloudshell_open/terraform-large-data-sharing-java-webapp/infra. Si ce n'est pas le cas, accédez à ce répertoire :

  2. Dans le même répertoire, créez un fichier texte nommé terraform.tfvars.

  3. Dans le fichier terraform.tfvars, copiez l'extrait de code suivant et définissez les valeurs des variables requises.

    • Suivez les instructions fournies en tant que commentaires dans l'extrait de code.
    • Cet extrait de code n'inclut que les variables pour lesquelles vous devez définir des valeurs. La configuration Terraform inclut d'autres variables ayant des valeurs par défaut. Pour examiner toutes les variables et les valeurs par défaut, consultez le fichier variables.tf disponible dans le répertoire $HOME/cloudshell_open/terraform-large-data-sharing-java-webapp/infra.
    • Assurez-vous que chaque valeur que vous définissez dans le fichier terraform.tfvars correspond au type de la variable, comme déclaré dans le fichier variables.tf. Par exemple, si le type défini pour une variable dans le fichier variables.tf est bool, vous devez spécifier true ou false comme valeur de cette variable dans le fichier terraform.tfvars.
    # This is an example of the terraform.tfvars file.
    # The values in this file must match the variable types declared in variables.tf.
    # The values in this file override any defaults in variables.tf.
    
    # ID of the project in which you want to deploy the solution
    project_id = "PROJECT_ID"
    

    Pour en savoir plus sur le project_id, consultez la page Identifier des projets.

Valider et examiner la configuration Terraform

  1. Assurez-vous que le répertoire de travail actuel est $HOME/cloudshell_open/terraform-large-data-sharing-java-webapp/infra. Si ce n'est pas le cas, accédez à ce répertoire :

  2. Vérifiez que la configuration ne comporte aucune erreur :

    terraform validate
    

    Si la commande renvoie une erreur, apportez les corrections nécessaires dans la configuration, puis exécutez à nouveau la commande terraform validate. Répétez cette étape jusqu'à ce que la commande renvoie le message suivant :

    Success! The configuration is valid.
    
  3. Examinez les ressources définies dans la configuration :

    terraform plan
    
  4. Si vous n'avez pas créé le fichier terraform.tfvars comme décrit précédemment, Terraform vous invite à saisir des valeurs pour les variables qui n'ont pas de valeurs par défaut. Saisissez les valeurs requises.

    Le résultat de la commande terraform plan est une liste des ressources provisionnées par Terraform lorsque vous appliquez la configuration.

    Si vous souhaitez apporter des modifications, modifiez la configuration, puis exécutez à nouveau les commandes terraform validate et terraform plan.

Provisionner les ressources

Lorsqu'aucune autre modification n'est nécessaire dans la configuration, déployez les ressources.

  1. Assurez-vous que le répertoire de travail actuel est $HOME/cloudshell_open/terraform-large-data-sharing-java-webapp/infra. Si ce n'est pas le cas, accédez à ce répertoire :

  2. Appliquez la configuration Terraform :

    terraform apply
    
  3. Si vous n'avez pas créé le fichier terraform.tfvars comme décrit précédemment, Terraform vous invite à saisir des valeurs pour les variables qui n'ont pas de valeurs par défaut. Saisissez les valeurs requises.

    Terraform affiche la liste des ressources qui seront créées.

  4. Lorsque vous êtes invité à effectuer les actions, saisissez yes.

    Terraform affiche les messages indiquant la progression du déploiement.

    Si le déploiement ne peut pas être terminé, Terraform affiche les erreurs à l'origine de l'échec. Consultez les messages d'erreur et mettez à jour la configuration pour corriger les erreurs, puis exécutez à nouveau la commande terraform apply. Pour obtenir de l'aide concernant la résolution des erreurs Terraform, consultez la section Erreurs lors du déploiement de la solution à l'aide de la CLI Terraform.

    Une fois toutes les ressources créées, Terraform affiche le message suivant :

    Apply complete!
    
    Outputs:
    bucket_name = "BUCKET_NAME"
    lb_external_ip = "IP_ADDRESS"
    neos_walkthrough_url = "https://console.cloud.google.com/products/solutions/deployments?walkthrough_id=solutions-in-console--large-data-sharing--large-data-sharing-java_tour"
    
  5. Pour afficher et utiliser l'exemple d'application, ouvrez le lb_external_ip dans votre navigateur.

Lorsque vous n'avez plus besoin de la solution, vous pouvez supprimer le déploiement pour éviter de continuer à payer des frais pour les ressources Google Cloud. Pour en savoir plus, consultez la section Supprimer le déploiement.

Personnaliser la solution

Cette section fournit des informations que les développeurs Terraform peuvent utiliser pour modifier la solution d'application Web Java pour le partage de grands volumes de données afin de répondre à leurs propres exigences techniques et métier. Les conseils de cette section ne sont pertinents que si vous déployez la solution à l'aide de la CLI Terraform.

  1. Vérifiez que le répertoire de travail actuel est $HOME/cloudshell_open/terraform-large-data-sharing-java-webapp/infra. Si ce n'est pas le cas, accédez à ce répertoire :

    cd $HOME/cloudshell_open/terraform-large-data-sharing-java-webapp/infra
    
  2. Ouvrez main.tf et apportez les modifications requises, comme indiqué dans les exemples du tableau suivant :


    Paramètre

    Argument Terraform dans main.tf

    Limite de processeur pour le backend de l'application

    Argument : cloud_run_server.limits.cpu

    Extrait de code pertinent dans main.tf :

    
    module "cloud_run_server" {
    …
      limits = {
        cpu    = "2000m"
        …
      }
    


    Limite de mémoire pour le backend de l'application

    Argument : cloud_run_server.limits.memory

    Extrait de code pertinent dans main.tf :

    
    module "cloud_run_server" {
    …
      limits = {
        …
        memory = "2Gi"
        …
    


    Limite du processeur pour l'interface de l'application

    Argument : cloud_run_client.limits.cpu

    Extrait de code pertinent dans main.tf :

    
    module "cloud_run_client" {
    …
      limits = {
        cpu    = "1000m"
        …
      }
    


    Limite de mémoire pour l'interface de l'application

    Argument : cloud_run_client.limits.memory

    Extrait de code pertinent dans main.tf :

    
    module "cloud_run_client" {
    …
    
      limits = {
        …
        memory = "512Mi"
        …
    

  3. Validez et provisionnez les ressources en suivant la même procédure que dans la section précédente :

    1. Validez et examinez la configuration Terraform.

    2. Provisionnez les ressources.

Supprimer le déploiement

Lorsque vous n'avez plus besoin du déploiement de la solution, supprimez-le pour éviter de continuer à payer des frais pour les ressources que vous avez créées.

Supprimer le projet

Si vous avez déployé la solution dans un nouveau projet Google Cloud et si vous n'avez plus besoin du projet, supprimez-le en procédant comme suit :

  1. Dans la console Google Cloud, accédez à la page Gérer les ressources.

    Accéder à la page Gérer les ressources

  2. Dans la liste des projets, sélectionnez le projet que vous souhaitez supprimer, puis cliquez sur Supprimer.
  3. Lorsque vous y êtes invité, saisissez l'ID du projet, puis cliquez sur Arrêter.

Si vous décidez de conserver le projet, supprimez le compte de service créé pour cette solution, comme décrit dans la section suivante.

Supprimer via la console

Si vous supprimez le déploiement de la solution via la console, la base de données Firestore ne sera pas supprimée. Pour supprimer cette base de données, supprimez le projet comme décrit précédemment.

Suivez cette procédure si vous avez déployé la solution via la console.

  1. Dans la console Google Cloud, accédez à la page Déploiements de solutions.

    Accéder à la page "Déploiements de solutions"

  2. Sélectionnez le projet contenant le déploiement que vous souhaitez supprimer.

  3. Recherchez le déploiement que vous souhaitez supprimer.

  4. Cliquez sur Actions, puis sélectionnez Supprimer.

  5. Saisissez le nom du déploiement, puis cliquez sur Confirmer.

    Le champ État indique Suppression.

    Si la suppression échoue, consultez les conseils de dépannage de la section Erreur lors de la suppression d'un déploiement.

Lorsque vous n'avez plus besoin du projet Google Cloud que vous avez utilisé pour la solution, vous pouvez le supprimer. Pour en savoir plus, consultez la section Facultatif : supprimer le projet.

Suppression à l'aide de la CLI Terraform

Si vous supprimez le déploiement de la solution à l'aide de la CLI Terraform, la base de données Firestore ne sera pas supprimée. Pour supprimer cette base de données, supprimez le projet comme décrit précédemment.

Suivez cette procédure si vous avez déployé la solution à l'aide de la CLI Terraform.

  1. Dans Cloud Shell, assurez-vous que le répertoire de travail actuel est $HOME/cloudshell_open/terraform-large-data-sharing-java-webapp/infra. Si ce n'est pas le cas, accédez à ce répertoire :

  2. Supprimez les ressources provisionnées par Terraform :

    terraform destroy
    

    Terraform affiche la liste des ressources qui seront supprimées.

  3. Lorsque vous êtes invité à effectuer les actions, saisissez yes.

    Terraform affiche des messages de progression. Une fois toutes les ressources supprimées, Terraform affiche le message suivant :

    Destroy complete!
    

    Si la suppression échoue, consultez les conseils de dépannage de la section Erreur lors de la suppression d'un déploiement.

Lorsque vous n'avez plus besoin du projet Google Cloud que vous avez utilisé pour la solution, vous pouvez le supprimer. Pour en savoir plus, consultez la section Facultatif : supprimer le projet.

Facultatif : supprimer le compte de service

Si vous avez supprimé le projet que vous avez utilisé pour la solution, ignorez cette section.

Comme mentionné précédemment dans ce guide, lorsque vous avez déployé la solution, un compte de service a été créé en votre nom. Certaines autorisations IAM ont été accordées temporairement au compte de service. Autrement dit, les autorisations ont été révoquées automatiquement après la fin des opérations de déploiement et de suppression de la solution, mais le compte de service n'est pas supprimé. Nous vous recommandons de supprimer ce compte de service.

  • Si vous avez déployé la solution via la console Google Cloud, accédez à la page Déploiements de solutions. (Si vous êtes déjà sur cette page, actualisez le navigateur.) Un processus est déclenché en arrière-plan pour supprimer le compte de service. Aucune autre action n'est nécessaire.

  • Si vous avez déployé la solution à l'aide de la CLI Terraform, procédez comme suit :

    1. Dans Google Cloud Console, accédez à la page Comptes de service.

      Accéder à la page "Comptes de service"

    2. Sélectionnez le projet que vous avez utilisé pour la solution.

    3. Sélectionnez le compte de service que vous souhaitez supprimer.

      L'ID d'adresse e-mail du compte de service créé pour la solution est au format suivant :

      goog-sc-DEPLOYMENT_NAME-NNN@PROJECT_ID.iam.gserviceaccount.com
      

      L'ID d'adresse e-mail contient les valeurs suivantes :

      • DEPLOYMENT_NAME : nom du déploiement.
      • NNN : nombre aléatoire à trois chiffres.
      • PROJECT_ID : ID du projet dans lequel vous avez déployé la solution.
    4. Cliquez sur Supprimer.

Résoudre les erreurs

Les actions à effectuer pour diagnostiquer et résoudre les erreurs dépendent de la méthode de déploiement et de la complexité de l'erreur.

Erreurs lors du déploiement via la console

Si le déploiement échoue lorsque vous utilisez la console, procédez comme suit :

  1. Accédez à la page Déploiements de solutions.

    Si le déploiement a échoué, le champ État indique Échec.

  2. Afficher les détails des erreurs à l'origine de l'échec :

    1. Cliquez sur Actions.

    2. Sélectionnez Afficher les journaux Cloud Build.

  3. Consultez le journal Cloud Build et prenez les mesures appropriées pour résoudre le problème à l'origine de l'échec.

Erreurs lors du déploiement de la solution à partir de la CLI Terraform

Si le déploiement échoue lors de l'utilisation de Terraform, le résultat de la commande terraform apply inclut des messages d'erreur que vous pouvez consulter pour diagnostiquer le problème.

Les exemples des sections suivantes présentent des erreurs de déploiement que vous pouvez rencontrer lorsque vous utilisez Terraform.

Erreur : Erreur de création de la base de données : googleapi : erreur 409 : La base de données existe déjà Veuillez utiliser un autre database_id

Par défaut, le déploiement Terraform suppose qu'une base de données Firestore n'existe pas déjà dans votre projet. Si votre base de données existe déjà, exécutez à nouveau le déploiement avec l'option suivante pour ignorer la création de la base de données :

$ terraform apply -var "init=false"

Erreur : Erreur de création de l'index : googleapi : erreur 409 : l'index existe déjà

Cette erreur indique que la solution a été précédemment déployée dans ce projet. Sélectionnez un autre projet ou supprimez les index Firestore créés précédemment par l'exemple d'application.

Erreur API non activée

Si vous créez un projet, puis tentez immédiatement de déployer la solution dans le nouveau projet, le déploiement peut échouer avec l'erreur suivante :

Error: Error creating Network: googleapi: Error 403: Compute Engine API has not
been used in project PROJECT_ID before or it is disabled. Enable it by visiting
https://console.developers.google.com/apis/api/compute.googleapis.com/overview?project=PROJECT_ID
then retry. If you enabled this API recently, wait a few minutes for the action
to propagate to our systems and retry.

Si cette erreur se produit, attendez quelques minutes, puis exécutez à nouveau la commande terraform apply.

Erreur "Impossible d'attribuer l'adresse demandée"

Lorsque vous exécutez la commande terraform apply, une erreur cannot assign requested address peut se produire avec un message semblable à celui-ci :

Error: Error creating service account:
 Post "https://iam.googleapis.com/v1/projects/PROJECT_ID/serviceAccounts:
 dial tcp [2001:db8:ffff:ffff::5f]:443:
 connect: cannot assign requested address

Si cette erreur se produit, exécutez à nouveau la commande terraform apply.

Erreur lors de la suppression d'un déploiement

Dans certains cas, les tentatives de suppression d'un déploiement peuvent échouer :

  • Après avoir déployé une solution via la console, si vous modifiez une ressource provisionnée par la solution et que vous essayez de supprimer le déploiement, la suppression peut échouer. Le champ État de la page Déploiements de solutions indique Échec. Le journal Cloud Build affiche la cause de l'erreur.
  • Après avoir déployé une solution à l'aide de la CLI Terraform, si vous modifiez une ressource à l'aide d'une interface autre que Terraform (par exemple, la console), et que vous essayez de supprimer le déploiement, la suppression peut échouer. Les messages dans le résultat de la commande terraform destroy indiquent la cause de l'erreur.

Examinez les journaux et les messages d'erreur, identifiez et supprimez les ressources à l'origine de l'erreur, puis essayez à nouveau de supprimer le déploiement.

Si un déploiement effectué à partir de la console n'est pas supprimé et si vous ne pouvez pas diagnostiquer l'erreur à l'aide du journal Cloud Build, vous pouvez supprimer le déploiement à l'aide de la CLI Terraform, comme décrit dans la section suivante.

Supprimer un déploiement effectué à partir de la console à l'aide de la CLI Terraform

Cette section explique comment supprimer un déploiement effectué à partir de la console si des erreurs se produisent lorsque vous essayez de le supprimer via la console. Dans cette approche, vous téléchargez la configuration Terraform du déploiement que vous souhaitez supprimer, puis vous supprimez le déploiement à l'aide de la CLI Terraform.

  1. Identifiez la région dans laquelle le code Terraform, les journaux et d'autres données du déploiement sont stockés. Cette région peut être différente de celle que vous avez sélectionnée lors du déploiement de la solution.

    1. Dans la console Google Cloud, accédez à la page Déploiements de solutions.

      Accéder à la page "Déploiements de solutions"

    2. Sélectionnez le projet contenant le déploiement que vous souhaitez supprimer.

    3. Dans la liste des déploiements, identifiez la ligne correspondant au déploiement que vous souhaitez supprimer.

    4. Cliquez sur Afficher tout le contenu de la ligne.

    5. Dans la colonne Emplacement, notez le deuxième emplacement, comme indiqué dans l'exemple suivant :

      Emplacement du code, des journaux et d'autres artefacts du déploiement.

  2. Dans la console Google Cloud, activez Cloud Shell.

    Activer Cloud Shell

    En bas de la fenêtre de la console Google Cloud, une session Cloud Shell démarre et affiche une invite de ligne de commande. Cloud Shell est un environnement shell dans lequel Google Cloud CLI est déjà installé, et dans lequel des valeurs sont déjà définies pour votre projet actuel. L'initialisation de la session peut prendre quelques secondes.

  3. Créez des variables d'environnement pour l'ID de projet, la région et le nom du déploiement que vous souhaitez supprimer :

    export REGION="REGION"
    export PROJECT_ID="PROJECT_ID"
    export DEPLOYMENT_NAME="DEPLOYMENT_NAME"
    

    Dans ces commandes, remplacez les éléments suivants :

    • REGION : emplacement que vous avez noté précédemment dans cette procédure.
    • PROJECT_ID : ID du projet dans lequel vous avez déployé la solution.
    • DEPLOYMENT_NAME : nom du déploiement que vous souhaitez supprimer.
  4. Obtenez l'ID de la dernière révision du déploiement que vous souhaitez supprimer :

    export REVISION_ID=$(curl \
        -H "Authorization: Bearer $(gcloud auth print-access-token)" \
        -H "Content-Type: application/json" \
        "https://config.googleapis.com/v1alpha2/projects/${PROJECT_ID}/locations/${REGION}/deployments/${DEPLOYMENT_NAME}" \
        | jq .latestRevision -r)
        echo $REVISION_ID
    

    Le résultat ressemble à ce qui suit :

    projects/PROJECT_ID/locations/REGION/deployments/DEPLOYMENT_NAME/revisions/r-0
    
  5. Obtenez l'emplacement Cloud Storage de la configuration Terraform pour le déploiement :

    export CONTENT_PATH=$(curl \
        -H "Authorization: Bearer $(gcloud auth print-access-token)" \
        -H "Content-Type: application/json" \
        "https://config.googleapis.com/v1alpha2/${REVISION_ID}" \
        | jq .applyResults.content -r)
        echo $CONTENT_PATH
    

    Voici un exemple de résultat de cette commande :

    gs://PROJECT_ID-REGION-blueprint-config/DEPLOYMENT_NAME/r-0/apply_results/content
    
  6. Téléchargez la configuration Terraform de Cloud Storage vers Cloud Shell :

    gsutil cp -r $CONTENT_PATH $HOME
    cd $HOME/content/infra
    

    Attendez que le message Operation completed s'affiche, comme illustré dans l'exemple suivant :

    Operation completed over 45 objects/268.5 KiB
    
  7. Initialisez Terraform :

    terraform init
    

    Attendez que le message suivant s'affiche :

    Terraform has been successfully initialized!
    
  8. Supprimez les ressources déployées :

    terraform destroy
    

    Terraform affiche la liste des ressources qui seront supprimées.

    Si des avertissements concernant des variables non déclarées s'affichent, ignorez-les.

  9. Lorsque vous êtes invité à effectuer les actions, saisissez yes.

    Terraform affiche des messages de progression. Une fois toutes les ressources supprimées, Terraform affiche le message suivant :

    Destroy complete!
    
  10. Supprimez l'artefact de déploiement :

    curl -X DELETE \
        -H "Authorization: Bearer $(gcloud auth print-access-token)" \
        -H "Content-Type: application/json" \
        "https://config.googleapis.com/v1alpha2/projects/${PROJECT_ID}/locations/${REGION}/deployments/${DEPLOYMENT_NAME}?force=true&delete_policy=abandon"
    
  11. Attendez quelques secondes, puis vérifiez que l'artefact de déploiement a été supprimé :

    curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
        -H "Content-Type: application/json" \
        "https://config.googleapis.com/v1alpha2/projects/${PROJECT_ID}/locations/${REGION}/deployments/${DEPLOYMENT_NAME}" \
        | jq .error.message
    

    Si le résultat indique null, attendez quelques secondes, puis exécutez à nouveau la commande.

    Une fois l'artefact de déploiement supprimé, un message s'affiche comme illustré dans l'exemple suivant :

    Resource 'projects/PROJECT_ID/locations/REGION/deployments/DEPLOYMENT_NAME' was not found
    

Envoyer des commentaires

Les solutions pour un démarrage rapide sont fournies uniquement à titre d'information et ne constituent pas des produits officiellement compatibles. Google est susceptible de modifier ou supprimer des solutions sans préavis.

Pour résoudre les erreurs, consultez les journaux Cloud Build et la sortie Terraform.

Pour envoyer vos commentaires, procédez comme suit :

  • Pour obtenir de la documentation, des tutoriels intégrés à la console ou la solution, utilisez le bouton Envoyer des commentaires.
  • Pour obtenir le code Terraform non modifié, créez des problèmes dans le dépôt GitHub. Les problèmes GitHub sont examinés de la manière la plus optimale possible et ne sont pas destinés aux questions d'utilisation générales.
  • Pour les problèmes liés aux produits utilisés dans la solution, prenez contact avec Cloud Customer Care.

Étapes suivantes