Solution de démarrage rapide : bibliothèques clientes Cloud SDK

Last reviewed 2024-03-21 UTC

Ce guide vous aide à comprendre et à déployer la solution de bibliothèques clientes Cloud SDK.

Cette solution vous permet d'interagir avec Google Cloud à l'aide des bibliothèques clientes Google Cloud SDK pour traiter et agréger des données, puis en afficher une visualisation dans un graphique en radar. Utilisez cette application pour identifier des tendances et des observations, basées sur les données globales.

Cette solution va vous aider à acquérir des compétences clés pour effectuer des appels d'API. Elle utilise des bibliothèques clientes Google Cloud SDK pour accéder aux API Google Cloud de manière automatisée, en exploitant les services Google Cloud (Cloud Storage, ainsi que des jobs Cloud Run) pour réduire le code récurrent.

Dans cette solution, le code analyse un exemple d'ensemble de données (ici l'ensemble 2018 Central Park Squirrel Census, qui est un décompte des espèces d'écureuils recensées en 2018 sur Central Park) à l'aide de jobs Cloud Run et de Cloud Storage. Toutes les requêtes des clients Google Cloud SDK sont consignées dans Cloud Logging à l'aide d'un modèle commun, permettant le dépannage et l'observabilité. Vous pouvez ainsi voir la durée de ces requêtes et identifier les points potentiels où un processus a rencontré une erreur. Cette solution vous guidera également dans l'exécution d'un job Cloud Run pour traiter et stocker l'ensemble de données.

Les API constituent le mécanisme fondamental qui permet aux développeurs d'interagir avec les produits et services Google Cloud. Google Cloud SDK fournit des bibliothèques clientes cloud propres aux différents langages de programmation, et décline celles-ci pour huit langages différents, en tenant compte de leurs conventions et de leurs styles. Utilisez cette solution afin d'apprendre à utiliser les bibliothèques clientes Google Cloud SDK pour traiter des données, et déployer une application d'interface dans laquelle vous pourrez afficher les résultats.

Objectifs

Ce guide de solution vous aide à effectuer les opérations suivantes :

  • Apprendre à utiliser une bibliothèque cliente pour effectuer des appels d'API Google Cloud
  • Déployer un ensemble de données interactif à l'aide de jobs Cloud Run et de Cloud Storage
  • Explorer les appels d'API Google Cloud à l'aide de Cloud Logging
  • Afficher l'application Cloud Run, les configurations de compte de service et les API activées, ainsi que leur utilisation

Architecture

Cette solution déploie les données brutes sur un bucket dans Cloud Storage, configure un job Cloud Run pour traiter les données et les stocker dans un bucket distinct dans Cloud Storage, et déploie un service de frontend dans Cloud Run capable d'afficher les données traitées et d'interagir avec elles.

Le schéma suivant montre l'architecture de la solution :

Architecture de l'infrastructure requise pour la solution de bibliothèques clientes Cloud SDK.

La section suivante décrit les ressources Google Cloud présentées dans le schéma.

Composants et configuration

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

  1. Les données non traitées ont été importées dans un bucket Cloud Storage.
  2. Un job Cloud Run transforme les données brutes dans un format plus structuré, compréhensible par le service de frontend. Le job Cloud Run importe les données traitées dans un deuxième bucket Cloud Storage.
  3. Le frontend, hébergé en tant que service Cloud Run, extrait les données traitées du deuxième bucket Cloud Storage.
  4. L'utilisateur peut accéder à l'application Web diffusée par le service de frontend Cloud Run.

Produits utilisés

La solution utilise les produits Google Cloud suivants :

  • Cloud Storage : 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 Logging : service permettant de stocker, rechercher, analyser et surveiller les données et les événements de journalisation de Google Cloud et d'autres clouds, et d'envoyer des alertes si nécessaire.
  • 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.

Coût

Pour obtenir une estimation du coût des ressources Google Cloud utilisées par la solution de bibliothèques clientes Cloud SDK, 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.

  • Emplacements Google Cloud où les ressources sont déployées.

  • La durée d'utilisation des ressources.

Déployer la solution

Les sections suivantes vont vous guider tout au long du processus de déploiement de la solution.

Créer ou choisir un projet Google Cloud

Lors du déploiement de la solution, vous devez choisir le projet Google Cloud dans lequel les ressources vont être 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. In the Google Cloud console, go to the project selector page.

    Go to project selector

  2. Click Create project.

  3. Name your project. Make a note of your generated project ID.

  4. Edit the other fields as needed.

  5. Click Create.

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/run.admin
  • roles/iam.serviceAccountAdmin
  • roles/iam.serviceAccountUser
  • roles/resourcemanager.projectIamAdmin
  • roles/iam.roleAdmin
  • roles/serviceusage.serviceUsageAdmin

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 Bibliothèques clientes Cloud SDK.

    Accéder à la solution Bibliothèques clientes Cloud SDK

  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 la solution, revenez à la page Déploiements de solutions dans la console.

  7. Avec cette solution, vous devez exécuter le job de traitement de données à l'aide de jobs Cloud Run, afin de transformer l'exemple d'ensemble de données et d'interagir avec lui. Pour obtenir des instructions détaillées sur l'exécution de cette tâche directement dans la console Google Cloud, cliquez sur Démarrer le job de traitement de données.

    Démarrer le job de traitement de données

  8. Pour afficher les ressources Google Cloud déployées et leur configuration, effectuez une visite guidée interactive.

    Commencer la visite

    Maintenant que vous avez traité l'exemple d'ensemble de données dans un bucket Cloud Storage, vous pouvez continuer à utiliser la solution de bibliothèques clientes Cloud SDK pour découvrir les thèmes suivants : interagir avec les API Google Cloud, utilisation d'Identity and Access Management comme élément sous-jacent des API et résoudre les problèmes liés aux API dans les applications exploitant des API clientes cloud.

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-cloud-client-api/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-cloud-client-api/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-cloud-client-api/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-cloud-client-api/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.
    # ID of the project in which you want to deploy the solution
    project_id = "PROJECT_ID"
    
    # Google Cloud region where you want to deploy the solution
    # Example: us-central1
    region = "REGION"
    
    # Programming language implementation to use
    # Example: python
    language = "LANGUAGE"
    
    # Version of application image to use
    # Example: 0.4.0
    image_version = "IMAGE_VERSION"
    

Pour en savoir plus sur les valeurs que vous pouvez attribuer aux variables requises, consultez les ressources suivantes :

  • project_id : identification des projets
  • region : régions disponibles
  • language : implémentation de langage de programmation à utiliser
  • image_version : version de l'image de l'application à utiliser

Valider et examiner la configuration Terraform

  1. Assurez-vous que le répertoire de travail actuel est $HOME/cloudshell_open/terraform-cloud-client-api/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-cloud-client-api/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!
    
  5. Pour afficher la solution, revenez à la page Déploiements de solutions dans la console.

  6. Avec cette solution, vous devez exécuter le job de traitement de données à l'aide de jobs Cloud Run, afin de transformer l'exemple d'ensemble de données et d'interagir avec lui. Pour obtenir des instructions détaillées sur l'exécution de cette tâche directement dans la console Google Cloud, cliquez sur Démarrer le job de traitement de données.

    Démarrer le job de traitement de données

  7. Pour afficher les ressources Google Cloud déployées et leur configuration, effectuez une visite guidée interactive.

    Commencer la visite

    Maintenant que vous avez traité l'exemple d'ensemble de données dans un bucket Cloud Storage, vous pouvez continuer à utiliser la solution de bibliothèques clientes Cloud SDK pour découvrir les thèmes suivants : interagir avec les API Google Cloud, utilisation d'Identity and Access Management comme élément sous-jacent des API et résoudre les problèmes liés aux API dans les applications exploitant des API clientes cloud.

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.

Supprimer le déploiement

Lorsque vous n'avez plus besoin de la solution, supprimez les ressources que vous avez créées dans cette solution pour éviter de continuer à payer des frais associées à ces ressources.

Supprimer via la console

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

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-cloud-client-api/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) Supprimez le projet.

Si vous avez déployé la solution dans un nouveau projet Google Cloud dont vous n'avez plus besoin, 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.

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 à l'aide 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 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 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

Continuez à explorer le potentiel de la solution de bibliothèques clientes Cloud SDK :

Contributeurs

Auteur : Kadeem Dunn | Rédacteur technique

Autre contributeur : Katie McLaughlin | Ingénieur senior des relations avec les développeurs