Afficher les détails et l'état des extensions sur une VM

Utilisez les méthodes d'état d'extension en lecture seule list et get pour afficher l'état d'exécution des extensions installées sur chaque instance de VM sans vous connecter à chaque machine. Lorsque vous utilisez des règles d'extension, une VM peut avoir plusieurs extensions installées par différentes règles. Les méthodes d'état des extensions vous permettent de voir la configuration effective finale et la règle applicable pour chaque extension installée. Elles vous aident à résoudre les problèmes lorsqu'une extension inattendue est installée ou qu'une extension échoue sur une instance.

À propos des détails et de l'état des extensions

Vous installez des extensions de VM sur des VM en créant des règles d'extension globales ou zonales au niveau de l'organisation, du dossier ou du projet. Une même règle peut installer plusieurs extensions sur une même VM, et plusieurs règles de votre hiérarchie de ressources peuvent s'appliquer à la même VM.

Les méthodes d'état d'extension en lecture seule vous permettent de lister les états de toutes les extensions sur la VM pour afficher la configuration effective finale et l'état d'exécution de chaque extension installée. Les informations renvoyées indiquent la version active, l'état d'application, l'état d'intégrité et l'identifiant de la règle applicable de chaque extension.

Afficher les extensions et les versions de VM

Vous pouvez utiliser la Google Cloud CLI ou l'API Compute Engine pour afficher les détails des extensions de VM installées. Ce document explique comment utiliser gcloud. Pour en savoir plus sur l'utilisation de l'API Compute Engine pour afficher les états des extensions, consultez Afficher les états des extensions MV sur une instance.

Autorisations IAM requises pour afficher les détails d'une extension

Pour afficher les rôles requis pour consulter les informations sur les extensions installées et leurs versions au niveau du projet, du dossier ou de l'organisation, sélectionnez l'un des niveaux suivants :

Projet

Pour obtenir les autorisations nécessaires pour afficher les règles d'extension de VM zonales ou globales au niveau du projet, demandez à votre administrateur de vous accorder le rôle IAM Lecteur de règles d'extension de VM Compute (roles/compute.vmExtensionPolicyViewer) sur votre projet. Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

Ce rôle prédéfini contient les autorisations requises pour afficher les règles d'extension de VM zonales ou globales au niveau du projet. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :

Autorisations requises

Les autorisations suivantes sont requises pour afficher les règles d'extension de VM zonales ou globales au niveau du projet :

  • Décrivez une extension de VM spécifique sur une instance : compute.vmExtensions.get
  • Répertoriez toutes les extensions de VM sur une instance : compute.vmExtensions.list

Vous pouvez également obtenir ces autorisations avec des rôles personnalisés ou d'autres rôles prédéfinis.

Dossier

Les règles d'extension au niveau du dossier sont disponibles en preview.

Pour obtenir les autorisations nécessaires pour afficher les règles d'extension de VM zonales ou globales au niveau du dossier, demandez à votre administrateur de vous accorder le rôle IAM Lecteur des règles d'extension de VM Compute au niveau du dossier (roles/compute.folderVmExtensionPolicyViewer) sur votre dossier. Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

Ce rôle prédéfini contient les autorisations requises pour afficher les règles d'extension de VM zonales ou globales au niveau du dossier. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :

Autorisations requises

Les autorisations suivantes sont requises pour afficher les règles d'extension de VM zonales ou mondiales au niveau du dossier :

  • Décrivez une extension de VM spécifique sur une instance : compute.folderVmExtensions.get
  • Répertoriez toutes les extensions de VM sur une instance : compute.folderVmExtensions.list

Vous pouvez également obtenir ces autorisations avec des rôles personnalisés ou d'autres rôles prédéfinis.

Organisation

Les règles d'extension au niveau de l'organisation sont disponibles en preview.

Pour obtenir les autorisations nécessaires pour afficher les règles d'extension de VM zonales ou globales au niveau de l'organisation, demandez à votre administrateur de vous accorder le rôle IAM Lecteur de règles d'extension de VM Compute au niveau de l'organisation (roles/compute.orgVmExtensionPolicyViewer) sur votre organisation. Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

Ce rôle prédéfini contient les autorisations requises pour afficher les règles d'extension de VM zonales ou globales au niveau de l'organisation. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :

Autorisations requises

Les autorisations suivantes sont requises pour afficher les règles d'extension de VM zonales ou mondiales au niveau de l'organisation :

  • Décrivez une extension de VM spécifique sur une instance : compute.orgVmExtensions.get
  • Répertoriez toutes les extensions de VM sur une instance : compute.orgVmExtensions.list

Vous pouvez également obtenir ces autorisations avec des rôles personnalisés ou d'autres rôles prédéfinis.

Pour en savoir plus sur les rôles et les autorisations IAM dans Compute Engine, consultez Rôles et autorisations Compute Engine.

Lister les extensions et les versions de VM

Pour lister les extensions de VM et les versions gérées par VM Extension Manager dans plusieurs zones ou de manière globale dans votre projet, dossier ou organisation, sélectionnez l'une des options suivantes :

Zonal

Utilisez la commande gcloud preview compute zone-vm-extension-policies extensions list pour lister les extensions de VM d'une zone de votre projet, dossier ou organisation :

Niveau du projet

gcloud preview compute zone-vm-extension-policies extensions list \
  --project=PROJECT_ID \
  --zone=ZONE

Remplacez les variables suivantes dans la commande :

  • PROJECT_ID : identifiant du projet.
  • ZONE : zone cible, par exemple us-central1-f.
Niveaux de dossier et d'organisation

Pour effectuer la tâche précédente au niveau du dossier ou de l'organisation, utilisez la même commande avec l'une des modifications suivantes :

  • Pour obtenir des informations au niveau du dossier, remplacez l'option --project=PROJECT_ID par --folder=folders/FOLDER_ID, où FOLDER_ID est l'ID numérique de votre dossier.
  • Pour obtenir des informations au niveau de l'organisation, remplacez l'option --project=PROJECT_ID par --organization=organizations/ORGANIZATION_ID, où ORGANIZATION_ID est l'ID numérique de votre organisation.

Monde

Utilisez la commande gcloud preview compute global-vm-extension-policies extensions list pour lister les extensions de VM dans toutes les zones de votre projet, dossier ou organisation :

Niveau du projet

gcloud preview compute global-vm-extension-policies extensions list \
  --project=PROJECT_ID

Remplacez la variable suivante dans la commande :

  • PROJECT_ID : identifiant du projet.
Niveaux de dossier et d'organisation

Pour effectuer la tâche précédente au niveau du dossier ou de l'organisation, utilisez la même commande avec l'une des modifications suivantes :

  • Pour obtenir des informations au niveau du dossier, remplacez l'option --project=PROJECT_ID par --folder=folders/FOLDER_ID, où FOLDER_ID est l'ID numérique de votre dossier.
  • Pour obtenir des informations au niveau de l'organisation, remplacez l'option --project=PROJECT_ID par --organization=organizations/ORGANIZATION_ID, où ORGANIZATION_ID est l'ID numérique de votre organisation.

Afficher des informations sur une extension de VM spécifique

Pour afficher les détails d'une extension de VM spécifique dans une seule zone ou globalement dans votre projet, dossier ou organisation, sélectionnez l'une des options suivantes :

Zonal

Utilisez la commande gcloud preview compute zone-vm-extension-policies extensions describe pour afficher les détails d'une extension de VM spécifique dans une zone de votre projet, dossier ou organisation :

Niveau du projet

gcloud preview compute zone-vm-extension-policies extensions describe EXTENSION_NAME \
  --project=PROJECT_ID \
  --zone=ZONE

Remplacez les variables suivantes dans la commande :

  • EXTENSION_NAME : l'une des extensions compatibles avec le VM Extension Manager, par exemple ops-agent.
  • PROJECT_ID : identifiant du projet.
  • ZONE : zone cible, par exemple us-central1-f.
Niveaux de dossier et d'organisation

Pour effectuer la tâche précédente au niveau du dossier ou de l'organisation, utilisez la même commande avec l'une des modifications suivantes :

  • Pour obtenir des informations au niveau du dossier, remplacez l'option --project=PROJECT_ID par --folder=folders/FOLDER_ID, où FOLDER_ID est l'ID numérique de votre dossier.
  • Pour obtenir des informations au niveau de l'organisation, remplacez l'option --project=PROJECT_ID par --organization=organizations/ORGANIZATION_ID, où ORGANIZATION_ID est l'ID numérique de votre organisation.

Monde

Utilisez la commande gcloud preview compute global-vm-extension-policies extensions describe pour afficher les détails d'une extension de VM spécifique dans toutes les zones de votre projet, dossier ou organisation :

Niveau du projet

gcloud preview compute global-vm-extension-policies extensions describe EXTENSION_NAME \
  --project=PROJECT_ID

Remplacez les variables suivantes dans la commande :

  • EXTENSION_NAME : l'une des extensions compatibles avec le VM Extension Manager, par exemple ops-agent.
  • PROJECT_ID : identifiant du projet.
Niveaux de dossier et d'organisation

Pour effectuer la tâche précédente au niveau du dossier ou de l'organisation, utilisez la même commande avec l'une des modifications suivantes :

  • Pour obtenir des informations au niveau du dossier, remplacez l'option --project=PROJECT_ID par --folder=folders/FOLDER_ID, où FOLDER_ID est l'ID numérique de votre dossier.
  • Pour obtenir des informations au niveau de l'organisation, remplacez l'option --project=PROJECT_ID par --organization=organizations/ORGANIZATION_ID, où ORGANIZATION_ID est l'ID numérique de votre organisation.

Afficher les états des extensions de VM sur une instance

Les règles d'extension peuvent installer plusieurs extensions sur une même VM. Pour déterminer l'état de chaque extension, y compris sa configuration effective, son état d'exécution et d'autres informations, vous pouvez examiner l'état des extensions sur une VM spécifique.

Les méthodes d'état d'extension ne renvoient des informations que sur les instances de l'agent Ops installées et gérées par les règles de VM Extension Manager. Si certaines VM exécutent des agents installés par d'autres moyens, aucune information d'extension n'est à signaler pour ces agents.

Vous pouvez utiliser la Google Cloud CLI ou l'API Compute Engine pour afficher l'état des extensions installées sur les VM. Ce document explique comment utiliser gcloud. Pour en savoir plus sur l'utilisation de l'API Compute Engine pour afficher les états des extensions, consultez Afficher les états des extensions MV sur une instance.

Autorisations IAM requises pour afficher l'état de l'extension

Pour obtenir les autorisations nécessaires pour afficher les états des extensions de VM sur une instance, demandez à votre administrateur de vous accorder le rôle IAM Lecteur Compute (roles/compute.viewer) sur votre projet. Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

Ce rôle prédéfini contient les autorisations requises pour afficher les états des extensions de VM sur une instance. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :

Autorisations requises

Les autorisations suivantes sont requises pour afficher les états des extensions de VM sur une instance :

  • Répertoriez les états de toutes les extensions de VM sur une instance : compute.instances.listVmExtensionStates
  • Obtenez l'état d'une extension de VM spécifique sur une instance : compute.instances.getVmExtensionState

Vous pouvez également obtenir ces autorisations avec des rôles personnalisés ou d'autres rôles prédéfinis.

Répertorier les extensions installées sur une instance de VM

Pour lister toutes les extensions de VM installées sur une instance et afficher leur état actuel à l'aide de gcloud, exécutez la commande gcloud beta compute instances list-vm-extension-states :

gcloud beta compute instances list-vm-extension-states INSTANCE_NAME \
    --project=PROJECT_ID \
    --zone=ZONE

Remplacez les variables suivantes dans la commande :

  • INSTANCE_NAME : nom de l'instance de VM.
  • PROJECT_ID : identifiant du projet.
  • ZONE : zone dans laquelle se trouve l'instance, par exemple us-central1-f.

La commande renvoie le nom, l'état d'application et l'état de fonctionnement de chaque extension installée. Pour en savoir plus sur les valeurs renvoyées lors de l'affichage des états des extensions, consultez Interpréter les champs d'état des extensions de VM.

Pour en savoir plus sur l'affichage des informations sur l'état des extensions sur vos VM, y compris sur l'utilisation de l'API Compute Engine, consultez Afficher les états des extensions de VM sur une instance.

Afficher l'état d'une extension de VM spécifique sur une instance

Pour obtenir des informations sur l'état d'une extension de VM spécifique installée sur une VM à l'aide de gcloud, exécutez la commande gcloud beta compute instances get-vm-extension-state :

gcloud beta compute instances get-vm-extension-state INSTANCE_NAME \
    --project=PROJECT_ID \
    --zone=ZONE \
    --extension-name=EXTENSION_NAME

Remplacez les variables suivantes dans la commande :

  • INSTANCE_NAME : nom de l'instance de VM.
  • PROJECT_ID : identifiant du projet.
  • ZONE : zone dans laquelle se trouve l'instance, par exemple us-central1-f.
  • EXTENSION_NAME : l'une des extensions compatibles avec le VM Extension Manager, par exemple ops-agent.

La commande renvoie le nom de l'extension, la version active, les informations d'état, les informations d'application et l'ID de la règle applicable. Pour en savoir plus sur les valeurs renvoyées lors de l'affichage des états des extensions, consultez Interpréter les champs d'état des extensions de VM.

Pour en savoir plus sur l'affichage des informations sur l'état des extensions sur vos VM, y compris sur l'utilisation de l'API Compute Engine, consultez Afficher les états des extensions de VM sur une instance.

Étapes suivantes