Vous pouvez installer et gérer l'Agent Ops sur un parc de VM Compute Engine dans une zone spécifique à l'aide des règles du gestionnaire d'extensions de VM. Par exemple, vous pouvez utiliser ces règles pour effectuer des tâches telles que :
Installation à l'échelle du parc : installez l'agent Ops sur toutes les VM d'une zone ou sur un sous-ensemble de VM identifiées par des libellés dans une zone.
Contrôle des versions :
- Maintenez l'agent Ops à jour en installant la dernière version.
- Épinglez la version de l'agent Ops sur une version spécifique.
Gestion de la configuration : appliquez une configuration personnalisée à l'agent Ops sur toutes les VM gérées par une règle.
VM Extension Manager vous permet de créer des règles qui indiquent les extensions que vous souhaitez installer sur les VM. L'agent Ops est l'une des extensions disponibles. Les règles VM Extension Manager peuvent gérer l'agent Ops version 2.58.0 ou ultérieure, lorsque l'agent Ops a été installé à l'aide de VM Extension Manager. Ces règles ne peuvent pas gérer les versions de l'agent Ops antérieures à la version 2.58.0, les instances de l'agent Ops installées par d'autres moyens, ni aucune version de l'ancien agent Monitoring ou agent Logging.
Vous pouvez créer et gérer des stratégies d'extension de VM à l'aide de la console Google Cloud ou de Google Cloud CLI, gcloud.
Avant de commencer
Avant de commencer à utiliser les règles d'extension VM Extension Manager, procédez comme suit :
- Consultez les systèmes d'exploitation compatibles pour vérifier que l'agent Ops et le gestionnaire d'extensions de VM sont compatibles avec vos systèmes d'exploitation.
- Attribuez les rôles requis pour utiliser le Gestionnaire d'extensions de VM.
- Si vous souhaitez utiliser une interface de ligne de commande pour créer et gérer des règles d'extension, installez Google Cloud CLI.
- Désinstallez les agents d'observabilité déjà installés sur vos VM.
Consulter les systèmes d'exploitation compatibles
Avant d'essayer d'utiliser les règles de VM Extension Manager pour gérer l'agent Ops, vérifiez que votre système d'exploitation cible est compatible à la fois avec l'agent Ops et avec VM Extension Manager.
Le gestionnaire d'extensions de VM est compatible avec tous les systèmes d'exploitation compatibles avec l'agent Ops, à l'exception de SUSE Linux Enterprise Server (SLES) et d'Ubuntu. Pour en savoir plus sur les systèmes d'exploitation compatibles avec l'agent Ops, consultez Systèmes d'exploitation.
Si votre système d'exploitation est compatible à la fois avec l'agent Ops et avec VM Extension Manager, suivez le reste de ce document.
Activer les API requises pour utiliser l'agent Ops
Pour utiliser l'agent Ops afin d'écrire des journaux et des métriques, vous devez activer les API Cloud Logging et API Cloud Monitoring sur votre projet Google Cloud .
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM
role (roles/serviceusage.serviceUsageAdmin), which
contains the serviceusage.services.enable permission. Learn how to grant
roles.
Attribuer les rôles requis pour utiliser l'agent Ops
Pour obtenir les autorisations nécessaires pour utiliser l'agent Ops afin d'écrire des journaux et des métriques, demandez à votre administrateur de vous accorder les rôles IAM suivants sur votre compte de service :
-
Pour écrire des journaux :
Rédacteur de journaux Logging (
roles/logging.logWriter) -
Pour écrire des métriques :
Rédacteur de métriques Monitoring (
roles/monitoring.metricWriter)
Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.
Vous pouvez également obtenir les autorisations requises avec des rôles personnalisés ou d'autres rôles prédéfinis.
Pour en savoir plus sur les rôles et l'agent Ops, consultez Autoriser l'agent Ops.
Accorder les rôles requis pour utiliser VM Extension Manager
Pour obtenir les autorisations nécessaires pour créer, afficher, modifier et supprimer des règles d'extension de VM, demandez à votre administrateur de vous accorder les rôles IAM suivants sur le projet :
-
Pour créer des règles d'extension :
Administrateur de règles d'extension de VM (
roles/compute.vmExtensionPolicyAdmin) -
Pour afficher les règles des extensions :
-
Lecteur de la stratégie d'extension de VM (
roles/compute.vmExtensionPolicyViewer) -
Administrateur de stratégies d'extension de VM (
roles/compute.vmExtensionPolicyAdmin)
-
Lecteur de la stratégie d'extension de VM (
-
Pour modifier les règles d'extension :
Administrateur des règles d'extension de VM (
roles/compute.vmExtensionPolicyAdmin) -
Pour supprimer des règles d'extension :
Administrateur des règles d'extension de VM (
roles/compute.vmExtensionPolicyAdmin)
Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.
Ces rôles prédéfinis contiennent les autorisations requises pour créer, afficher, modifier et supprimer des règles d'extension de VM. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :
Autorisations requises
Les autorisations suivantes sont requises pour créer, afficher, modifier et supprimer des règles d'extension de VM :
-
Pour créer des règles d'extension :
compute.vmExtensionPolicies.create -
Pour afficher les règles des extensions :
compute.vmExtensionPolicies.list -
Pour afficher les détails d'une règle d'extension :
compute.vmExtensionPolicies.get -
Pour modifier les règles d'extension :
compute.vmExtensionPolicies.update -
Pour supprimer des règles d'extension :
compute.vmExtensionPolicies.delete
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 autorisations IAM dans Compute Engine, consultez Rôles et autorisations Compute Engine.
Installer Google Cloud CLI
Vous pouvez créer et gérer des stratégies d'extension de VM à l'aide de la console Google Cloud ou de Google Cloud CLI, gcloud. Pour utiliser gcloud, vous devez d'abord l'installer en procédant comme suit :
Si vous ne l'avez pas déjà fait, installez Google Cloud CLI.
Les règles d'extension décrites dans ce document utilisent le groupe de commandes
beta.
Si vous ne l'avez pas déjà fait, installez le composant
betade la gcloud CLI en exécutant la commande suivante :gcloud components install betaPour vérifier si le composant
betaest installé, exécutez la commande suivante :gcloud components listSi vous avez déjà installé le composant
beta, vérifiez que vous disposez de la dernière version :gcloud components update
Désinstaller les agents d'observabilité
Avant de créer une règle VM Extension Manager pour gérer l'agent Ops sur une VM, assurez-vous qu'aucune instance de l'agent Ops ni des anciens agents Monitoring et Logging ne sont déjà présents sur la VM. L'exécution de l'agent Ops et des anciens agents sur la même VM peut entraîner l'ingestion de journaux en double ou créer des conflits dans l'ingestion des métriques.
Si vous utilisez une règle d'extension pour installer l'Agent Ops sur une VM sur laquelle un autre agent d'observabilité est déjà installé, la règle installe l'agent, mais celui-ci ne s'exécute pas, car un conflit est détecté.
La procédure à suivre pour supprimer des agents existants dépend de la manière dont ils ont été installés.
Agents installés par une règle OS Config de VM Manager, y compris les suivants :
- L'Agent Ops est installé à l'aide de la consoleGoogle Cloud lors de la création de la VM.
- L'agent Ops est installé par une règle OS Config VM Manager en disponibilité générale.
- L'agent Ops, ou l'ancien agent Monitoring ou Logging installé par une règle de configuration d'OS VM Manager bêta.
Pour savoir comment identifier les VM à l'aide de ces règles, consultez Rechercher les VM soumises aux règles d'OS de l'Agent Ops.
Pour savoir comment désinstaller l'agent et supprimer les règles OS Config, consultez Désinstaller l'agent Ops sur les VM couvertes par les règles d'OS de l'agent Ops.
Agents installés manuellement à l'aide d'un script d'installation. Pour en savoir plus sur la désinstallation des agents, consultez les articles suivants :
- Agent Ops : Désinstallez l'agent.
- Ancien agent Monitoring : désinstallez l'agent.
- Ancien agent Logging : désinstallez l'agent.
Installer l'Agent Ops en créant des règles d'extension de VM
Créez des règles d'extension de VM pour installer et gérer automatiquement l'agent Ops sur un parc de machines virtuelles (VM) Compute Engine. En définissant une règle, vous pouvez vous assurer que des extensions spécifiques, comme l'agent Ops, sont installées et gérées sur toutes les VM qui correspondent aux critères que vous spécifiez, comme les libellés de VM.
Conflits de règles et priorités
Le Gestionnaire d'extensions de VM associe une priorité à chaque nouvelle règle. Plus le nombre est faible, plus la priorité est élevée. La priorité par défaut est de 1 000. Une VM peut être couverte par plusieurs règles pour une extension comme l'Agent Ops, mais une seule règle pour l'extension de l'Agent Ops est effective sur la VM.
VM Extension Manager utilise des priorités pour résoudre les conflits entre les règles appliquées à une VM. Pour en savoir plus sur la procédure de résolution, consultez Priorité des règles et résolution des conflits.
Installer le dernier agent Ops sur toutes les VM d'une zone
Pour créer une règle qui installe la dernière version de l'Agent Ops sur toutes les VM d'une zone et qui met à jour l'Agent Ops lorsqu'une nouvelle version est publiée, procédez comme suit :
Console
-
Dans la console Google Cloud , accédez à la page Règles relatives aux extensions :
Accéder aux Règles des extensions
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Compute Engine.
- Cliquez sur + Créer.
- Dans le champ Nom, saisissez un nom pour la règle.
- Facultatif : Dans le champ Description, saisissez une description de la règle.
- Dans le champ Priorité, spécifiez un numéro de priorité pour résoudre les conflits entre les règles. Plus le nombre est faible, plus la priorité est élevée. La valeur par défaut est 1 000.
Dans la liste Zone, sélectionnez la zone dans laquelle vous souhaitez appliquer cette règle.
Dans la section Gérer les extensions, cliquez sur Ajouter une extension, puis procédez comme suit :
- Dans la liste Extension, sélectionnez
Google Cloud's Extension for Ops Agent. - Laissez le champ Version vide.
- Dans la liste Extension, sélectionnez
Cliquez sur Créer.
gcloud
Exécutez la commande gcloud beta compute zone-vm-extension-policies create suivante pour créer la règle :
gcloud beta compute zone-vm-extension-policies create POLICY_NAME \
--project=PROJECT_ID \
--zone=ZONE \
--extensions=ops-agent
Remplacez les variables suivantes dans la commande :
- POLICY_NAME : nom de la règle d'extension de VM.
- PROJECT_ID : identifiant du projet.
- ZONE : zone cible (par exemple,
us-central1-f).
L'option create de gcloud beta compute zone-vm-extension-policies accepte une option --version.
Si vous omettez l'option --version, la règle installe la dernière version et met à jour l'agent Ops lorsqu'une nouvelle version est publiée.
Épingler l'agent Ops à une version spécifique sur toutes les VM d'une zone
Pour créer une règle qui installe une version spécifique de l'agent Ops sur toutes les VM d'une zone, procédez comme suit :
Console
-
Dans la console Google Cloud , accédez à la page Règles relatives aux extensions :
Accéder aux Règles des extensions
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Compute Engine.
- Cliquez sur + Créer.
- Dans le champ Nom, saisissez un nom pour la règle.
- Facultatif : Dans le champ Description, saisissez une description de la règle.
- Dans le champ Priorité, spécifiez un numéro de priorité pour résoudre les conflits entre les règles. Plus le nombre est faible, plus la priorité est élevée. La valeur par défaut est 1 000.
Dans la liste Zone, sélectionnez la zone dans laquelle vous souhaitez appliquer cette règle.
Dans la section Gérer les extensions, cliquez sur Ajouter une extension, puis procédez comme suit :
- Dans la liste Extension, sélectionnez
Google Cloud's Extension for Ops Agent. - Dans la liste Version, sélectionnez la version à installer. Utilisez la version 2.58.0 ou ultérieure.
- Dans la liste Extension, sélectionnez
Cliquez sur Créer.
gcloud
Exécutez la commande gcloud beta compute zone-vm-extension-policies create suivante pour créer la règle :
gcloud beta compute zone-vm-extension-policies create POLICY_NAME \
--project=PROJECT_ID \
--zone=ZONE \
--extensions=ops-agent
--version=ops-agent=VERSION
Remplacez les variables suivantes dans la commande :
- POLICY_NAME : nom de la règle d'extension de VM.
- PROJECT_ID : identifiant du projet.
- ZONE : zone cible (par exemple,
us-central1-f).
VERSION : version de l'agent Ops à installer. Utilisez la version 2.58.0 ou ultérieure.
Si vous omettez l'option
--version, la règle installe la dernière version et met à jour l'agent Ops lorsqu'une nouvelle version est publiée, comme indiqué dans l'exemple d'installation de la dernière version.
Pour obtenir la liste des versions de l'agent Ops, consultez la page des versions de l'agent Ops sur GitHub.
Installer l'agent Ops sur des VM dans une zone avec un libellé spécifique
Pour créer une règle qui installe la dernière version de l'agent Ops sur les VM d'une zone portant un libellé spécifique, procédez comme suit :
Console
-
Dans la console Google Cloud , accédez à la page Règles relatives aux extensions :
Accéder aux Règles des extensions
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Compute Engine.
- Cliquez sur + Créer.
- Dans le champ Nom, saisissez un nom pour la règle.
- Facultatif : Dans le champ Description, saisissez une description de la règle.
- Dans le champ Priorité, spécifiez un numéro de priorité pour résoudre les conflits entre les règles. Plus le nombre est faible, plus la priorité est élevée. La valeur par défaut est 1 000.
Dans la liste Zone, sélectionnez la zone dans laquelle vous souhaitez appliquer cette règle.
Dans la section Extensions, cliquez sur Ajouter une extension, puis procédez comme suit :
- Dans la liste Extension, sélectionnez
Google Cloud's Extension for Ops Agent. - Laissez le champ Version vide.
- Dans la liste Extension, sélectionnez
Dans la section Instances de VM cibles, sélectionnez les VM pour la règle. Pour sélectionner des VM avec des libellés spécifiques, cliquez sur Ajouter des libellés, puis ajoutez la paire clé-valeur.
Cliquez sur Créer.
gcloud
Utilisez l'option --inclusion-labels de la commande gcloud beta compute zone-vm-extension-policies create pour spécifier une liste de paires clé/valeur séparées par une virgule :
gcloud beta compute zone-vm-extension-policies create POLICY_NAME \
--project=PROJECT_ID \
--zone=ZONE \
--extensions=ops-agent
--inclusion-labels=KEY1=VALUE1,KEY2=VALUE2
Remplacez les variables suivantes dans la commande :
- POLICY_NAME : nom de la règle d'extension de VM.
- PROJECT_ID : identifiant du projet.
- ZONE : zone cible (par exemple,
us-central1-f).
- KEY1=VALUE1,KEY2=VALUE2 : liste de paires clé/valeur séparées par une virgule qui définissent les libellés d'inclusion pour un sélecteur. Pour être incluses, les VM doivent comporter tous les libellés spécifiés dans un sélecteur (opérateur logique ET). Si vous spécifiez l'option
--inclusion_labelsplusieurs fois, la règle cible les VM qui correspondent à tous les libellés de l'un des sélecteurs (OR logique). Si vous omettez cette option, la règle cible toutes les VM de la zone spécifiée.
Installer l'agent Ops avec une configuration personnalisée sur toutes les VM d'une zone
Pour créer une règle qui installe la dernière version de l'Agent Ops sur toutes les VM d'une zone et fournit une configuration personnalisée pour l'Agent Ops, procédez comme suit :
Console
-
Dans la console Google Cloud , accédez à la page Règles relatives aux extensions :
Accéder aux Règles des extensions
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Compute Engine.
- Cliquez sur + Créer.
- Dans le champ Nom, saisissez un nom pour la règle.
- Facultatif : Dans le champ Description, saisissez une description de la règle.
- Dans le champ Priorité, spécifiez un numéro de priorité pour résoudre les conflits entre les règles. Plus le nombre est faible, plus la priorité est élevée. La valeur par défaut est 1 000.
Dans la liste Zone, sélectionnez la zone dans laquelle vous souhaitez appliquer cette règle.
Dans la section Extensions, cliquez sur Ajouter une extension, puis procédez comme suit :
- Dans la liste Extension, sélectionnez
Google Cloud's Extension for Ops Agent. - Laissez le champ Version vide.
- Dans le champ Contenu du fichier de configuration, saisissez la chaîne de configuration YAML pour l'agent Ops.
- Dans la liste Extension, sélectionnez
Cliquez sur Créer.
gcloud
Utilisez l'option --config-from-file de la commande gcloud beta compute zone-vm-extension-policies create pour spécifier un fichier de configuration :
gcloud beta compute zone-vm-extension-policies create POLICY_NAME \
--project=PROJECT_ID \
--zone=ZONE \
--extensions=ops-agent
--config-from-file=ops-agent="OPS_AGENT_CONFIG_PATH"
Remplacez les variables suivantes dans la commande :
- POLICY_NAME : nom de la règle d'extension de VM.
- PROJECT_ID : identifiant du projet.
- ZONE : zone cible (par exemple,
us-central1-f).
OPS_AGENT_CONFIG_PATH : chemin d'accès à un fichier contenant la chaîne de configuration YAML pour l'agent Ops. Ce fichier doit exister dans l'environnement dans lequel vous exécutez la commande gcloud.
Le fichier YAML de configuration de l'agent Ops peut être long. Il est beaucoup moins risqué de placer la configuration dans un fichier et de transmettre ce fichier à gcloud CLI que d'essayer de saisir du code YAML correctement mis en forme sur la ligne de commande. Si vous modifiez ce fichier après avoir créé la règle, celle-ci ne sera pas mise à jour. Pour mettre à jour une règle, utilisez la commande
gcloud beta compute zone-vm-extension-policiesupdate.
Si vous fournissez une configuration personnalisée pour l'agent Ops lorsque vous créez ou mettez à jour une règle d'extension, la règle déploie l'agent Ops avec la configuration personnalisée. Vous n'avez pas besoin de redémarrer l'agent manuellement.
La configuration est stockée avec la règle d'extension. N'incluez donc pas de données sensibles telles que des mots de passe dans la configuration. Étant donné que la configuration est stockée avec la règle d'extension, la modification du fichier de configuration ne modifie pas la configuration de l'agent. Vous devez mettre à jour la configuration stockée avec la règle à l'aide de la commande gcloud beta compute zone-vm-extension-policies update.
Lorsque vous fournissez une configuration personnalisée pour l'Agent Ops, VM Extension Manager copie la configuration à l'emplacement utilisé par l'Agent Ops pour les fichiers de configuration spécifiés par l'utilisateur sur la VM cible :
- Linux :
/etc/google-cloud-ops-agent/config.yaml - Windows :
C:\Program Files\Google\Cloud Operations\Ops Agent\config\config.yaml
Si un fichier config.yaml est présent sur la VM, la règle d'extension l'écrase.
Pour obtenir des informations générales sur l'utilisation de la consoleGoogle Cloud et de gcloud CLI pour créer des règles d'extension de VM, consultez Installer des extensions de VM en créant des règles d'extension .
Gérer l'Agent Ops en mettant à jour les règles d'extension de VM
Pour modifier la façon dont une règle gère l'agent Ops, mettez à jour la règle. Lorsque vous mettez à jour une règle, VM Extension Manager déploie les modifications sur toutes les VM applicables, généralement en une minute. Si vous modifiez les libellés d'inclusion, l'agent Ops peut être installé sur de nouvelles VM ou désinstallé de VM existantes, selon que les VM correspondent aux libellés mis à jour.
Les sections suivantes expliquent comment gérer l'agent Ops pour effectuer les opérations suivantes :
- Mettre à jour la version épinglée de l'agent sur toutes les VM d'une zone
- Modifier la configuration de l'agent Ops sur toutes les VM d'une zone
Mettre à jour la version épinglée de l'agent Ops sur toutes les VM d'une zone
Pour modifier la version épinglée de l'agent Ops sur toutes les VM d'une zone, procédez comme suit :
Console
-
Dans la console Google Cloud , accédez à la page Règles relatives aux extensions :
Accéder aux Règles des extensions
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Compute Engine.
- Sélectionnez le règlement que vous souhaitez modifier.
- Cliquez sur Modifier.
- Dans la section Gérer les extensions, procédez comme suit :
- Sélectionnez
Google Cloud's Extension for Ops Agent. - Modifiez le champ Version. Utilisez la version 2.58.0 ou ultérieure.
- Cliquez sur OK.
- Sélectionnez
- Cliquez sur Enregistrer.
gcloud
Utilisez la commande gcloud beta compute zone-vm-extension-policies update avec l'option --version pour modifier la version de l'agent épinglée.
Lorsque vous mettez à jour une règle à l'aide de gcloud, la requête remplace complètement la règle existante. Tous les champs facultatifs que vous omettez reviennent à leur valeur par défaut au lieu de conserver les valeurs existantes de la règle modifiée.
Pour modifier la version de l'agent Ops installé sur toutes les VM d'une zone à l'aide d'une règle, utilisez la commande suivante :
gcloud beta compute zone-vm-extension-policies update POLICY_NAME \
--project=PROJECT_ID \
--zone=ZONE \
--extensions=ops-agent
--version=ops-agent=VERSION
Remplacez les variables suivantes dans la commande :
- POLICY_NAME : nom de la règle d'extension de VM.
- PROJECT_ID : identifiant du projet.
- ZONE : zone cible (par exemple,
us-central1-f).
VERSION : version de l'agent Ops à installer. Utilisez la version 2.58.0 ou ultérieure. Pour obtenir la liste des versions, consultez la page des versions de l'agent Ops sur GitHub.
Si vous omettez l'option
--version, la règle installe la dernière version et met à jour l'agent Ops lorsqu'une nouvelle version est publiée, comme indiqué dans l'exemple d'installation de la dernière version.
Modifier la configuration de l'agent Ops sur toutes les VM d'une zone
Pour modifier la configuration de l'agent Ops sur toutes les VM d'une zone, procédez comme suit :
Console
-
Dans la console Google Cloud , accédez à la page Règles relatives aux extensions :
Accéder aux Règles des extensions
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Compute Engine.
- Sélectionnez le règlement que vous souhaitez modifier.
- Cliquez sur Modifier.
- Dans la section Gérer les extensions, procédez comme suit :
- Sélectionnez
Google Cloud's Extension for Ops Agent. - Modifiez le champ Contenu du fichier de configuration.
- Cliquez sur OK.
- Sélectionnez
- Cliquez sur Enregistrer.
gcloud
Utilisez gcloud beta compute zone-vm-extension-policies update avec l'option --config-from-file ou l'option --config pour spécifier une nouvelle configuration.
Lorsque vous mettez à jour une règle à l'aide de gcloud, la requête remplace complètement la règle existante. Tous les champs facultatifs que vous omettez reviennent à leur valeur par défaut au lieu de conserver les valeurs existantes de la règle modifiée.
Pour modifier la configuration de l'agent Ops installé sur toutes les VM d'une zone à l'aide d'une règle, utilisez la commande suivante :
gcloud beta compute zone-vm-extension-policies update POLICY_NAME \
--project=PROJECT_ID \
--zone=ZONE \
--extensions=ops-agent
--config-from-file=ops-agent="OPS_AGENT_CONFIG_PATH"
Remplacez les variables suivantes dans la commande :
- POLICY_NAME : nom de la règle d'extension de VM.
- PROJECT_ID : identifiant du projet.
- ZONE : zone cible (par exemple,
us-central1-f).
OPS_AGENT_CONFIG_PATH : chemin d'accès à un fichier contenant la chaîne de configuration YAML pour l'agent Ops. Ce fichier doit exister dans l'environnement dans lequel vous exécutez la commande gcloud.
Le fichier YAML de configuration de l'agent Ops peut être long. Il est beaucoup moins risqué de placer la configuration dans un fichier et de transmettre ce fichier à la gcloud CLI que d'essayer de saisir du code YAML correctement formaté sur la ligne de commande.
Si vous fournissez une configuration personnalisée pour l'agent Ops lorsque vous créez ou mettez à jour une règle d'extension, la règle déploie l'agent Ops avec la configuration personnalisée. Vous n'avez pas besoin de redémarrer l'agent manuellement.
La configuration est stockée avec la règle d'extension. N'incluez donc pas de données sensibles telles que des mots de passe dans la configuration. Étant donné que la configuration est stockée avec la règle d'extension, la modification du fichier de configuration ne modifie pas la configuration de l'agent. Vous devez mettre à jour la configuration stockée avec la règle à l'aide de la commande gcloud beta compute zone-vm-extension-policies update.
Lorsque vous fournissez une configuration personnalisée pour l'Agent Ops, VM Extension Manager copie la configuration à l'emplacement utilisé par l'Agent Ops pour les fichiers de configuration spécifiés par l'utilisateur sur la VM cible :
- Linux :
/etc/google-cloud-ops-agent/config.yaml - Windows :
C:\Program Files\Google\Cloud Operations\Ops Agent\config\config.yaml
Si un fichier config.yaml est présent sur la VM, la règle d'extension l'écrase.
Pour obtenir des informations générales sur l'utilisation de la consoleGoogle Cloud et de gcloud CLI pour gérer les règles d'extension de VM, consultez Modifier les extensions en mettant à jour une règle d'extension de VM.
Désinstaller l'Agent Ops en supprimant les règles d'extension de VM
Pour désinstaller l'Agent Ops, supprimez la règle d'extension de VM qui le gère. Si une autre règle active de priorité inférieure s'applique à une VM et gère également l'Agent Ops, l'agent reste installé sur cette VM en fonction de la règle de priorité inférieure.
VM Extension Manager supprime l'agent Ops de toutes les VM accessibles dans la minute qui suit la suppression de la règle. Si une VM est inaccessible, VM Extension Manager ignore la suppression de l'agent. Si la VM redevient disponible, VM Extension Manager supprime l'agent à ce moment-là.
Console
-
Dans la console Google Cloud , accédez à la page Règles relatives aux extensions :
Accéder aux Règles des extensions
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Compute Engine.
- Sélectionnez la règle que vous souhaitez supprimer.
- Cliquez sur Supprimer.
- Dans la boîte de dialogue de confirmation, cliquez sur Supprimer.
gcloud
Pour supprimer la règle d'extension de VM qui gère l'Agent Ops, utilisez la commande gcloud beta compute zone-vm-extension-policies delete :
gcloud beta compute zone-vm-extension-policies delete POLICY_NAME \
--project=PROJECT_ID \
--zone=ZONE
Remplacez les variables suivantes dans la commande :
- POLICY_NAME : nom de la règle d'extension de VM.
- PROJECT_ID : identifiant du projet.
- ZONE : zone cible (par exemple,
us-central1-f).
Récupérer des informations sur les règles d'extension de VM
Vous pouvez récupérer les informations suivantes sur les règles d'extension de VM existantes :
- Liste de toutes les règles de votre projet Google Cloud .
- Informations de configuration sur une règle spécifique.
Console
-
Dans la console Google Cloud , accédez à la page Règles relatives aux extensions :
Accéder aux Règles des extensions
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Compute Engine.
Cette page répertorie toutes les règles d'extension de VM de votre projet. - Pour afficher les détails d'une règle d'extension spécifique, cliquez sur son nom.
gcloud
Lister les règles d'extension de VM
Pour lister les informations sur toutes les règles d'extension de VM dans une zone, utilisez gcloud beta compute zone-vm-extension-policies list :
gcloud beta compute zone-vm-extension-policies list \
--project=PROJECT_ID \
--zone=ZONE \
--page-size=PAGE_SIZE_INTEGER
Remplacez les variables suivantes dans la commande :
- PROJECT_ID : identifiant du projet.
- ZONE : zone cible (par exemple,
us-central1-f). - PAGE_SIZE_INTEGER : nombre de règles à répertorier par page (par exemple,
2). Pour en savoir plus sur les options de tri et de filtrage, consultezgcloud beta compute zone-vm-extension-policieslist.
Décrire une règle d'extension de VM nommée
Pour récupérer la configuration d'une règle nommée dans une zone, utilisez la commande gcloud beta compute zone-vm-extension-policies describe :
gcloud beta compute zone-vm-extension-policies describe POLICY_NAME \
--project=PROJECT_ID \
--zone=ZONE
Remplacez les variables suivantes dans la commande :
- POLICY_NAME : nom de la règle d'extension de VM.
- PROJECT_ID : identifiant du projet.
- ZONE : zone cible (par exemple,
us-central1-f).
Pour obtenir des informations générales sur l'utilisation de la consoleGoogle Cloud et de gcloud CLI pour récupérer des informations sur les règles d'extension de VM, consultez Afficher les règles d'extension.
Vérifier l'installation de l'agent Ops
Cette page explique comment effectuer les opérations suivantes :
- Vérifier l'état ou la version d'une installation de l'agent Ops
- Vérifier que l'agent Ops collecte des données de télémétrie
Vérifier l'état ou la version d'une installation de l'agent Ops
Pour déterminer l'état ou la version de l'agent Ops, utilisez l'une des pages de la consoleGoogle Cloud suivantes :
Compute Engine
-
Dans la console Google Cloud , accédez à la page Instances de VM.
Accéder à la page Instances de VM
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Compute Engine.
- Sélectionnez une VM dans la liste.
- Cliquez sur l'onglet Observabilité.
Cloud Monitoring
-
Dans la console Google Cloud , accédez à la page Instances de VM :
Accéder à la page Instances de VM
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.
- Sélectionnez la vue Liste.
Une fois l'agent Ops installé sur la VM et qu'il collecte des journaux et des métriques, son état est indiqué par une coche verte à côté du libellé Agent Ops.
Pour déterminer la version de l'agent installé, pointez sur le libellé Agent Ops dans le tableau de bord Compute Engine ou Monitoring.
Vérifier que l'agent Ops collecte la télémétrie
Si l'agent Ops a été installé et s'exécute correctement, il envoie des métriques à Cloud Monitoring et des journaux à Cloud Logging.
- Pour savoir comment vérifier la collecte des métriques, consultez L'agent est en cours d'exécution, mais les données ne sont pas ingérées.
- Pour savoir comment vérifier la collecte des journaux, consultez Vérifier la réussite de la collecte de journaux.
Redémarrer un agent Ops installé par une règle d'extension
Lorsque l'agent Ops est installé et géré par VM Extension Manager, il n'est pas géré par le service de gestion du système d'exploitation, c'est-à-dire systemd sur Linux ou le Gestionnaire de services Windows sur Windows. Par conséquent, les commandes Linux systemctl et Windows *-Service ne fonctionnent pas avec un agent Ops installé par une stratégie d'extension.
Pour redémarrer un agent Ops installé par une règle d'extension, procédez de l'une des manières suivantes :
Recréez la règle.
Utilisez une règle temporaire de priorité plus élevée. Si la règle d'origine affecte un grand nombre de VM, mais que vous ne souhaitez redémarrer l'Agent Ops que sur un petit nombre d'entre elles, ajoutez un libellé à ces VM et configurez la nouvelle règle pour filtrer sur ce libellé.
Par exemple, si une règle de priorité 1000 n'a pas réussi à démarrer l'Agent Ops sur une VM, vous pouvez ajouter un libellé tel que
status=failedà la VM. Ensuite, créez une stratégie avec une priorité plus élevée, par exemple 500. Par exemple, une commande Google Cloud CLI peut ressembler à ce qui suit :gcloud beta compute zone-vm-extension-policiescreatePOLICY_NAME \ --project=PROJECT_ID \ --zone=ZONE \ --extensions=ops-agent --inclusion-labels=status=failed \ --priority=500 \ --config-from-file=ops-agent=/usr/ops-agent-config.yamlRemplacez les variables suivantes dans la commande :
- POLICY_NAME : nom de la règle d'extension de VM.
- PROJECT_ID : identifiant du projet.
- ZONE : zone cible (par exemple,
us-central1-f).
Une fois que la nouvelle règle a installé l'agent Ops, supprimez la règle et retirez l'étiquette des VM. L'Agent Ops reste installé sur la VM, car la règle d'origine est toujours active.
Activer le journal de débogage de l'agent invité sur la VM
Les règles VM Extension Manager utilisent l'agent invité Compute Engine pour gérer l'agent Ops en tant qu'extension de VM. Pour savoir comment activer la journalisation de débogage pour l'agent invité, consultez Afficher les journaux de débogage pour l'agent invité.
Résoudre les problèmes liés aux règles d'extension
Cette section fournit des informations sur la résolution des problèmes liés à l'utilisation des règles d'extension pour gérer l'agent Ops :
- Échec des commandes
gcloud beta compute zone-vm-extension-policies - La règle d'extension est créée, mais l'état de l'agent Ops est "non détecté"
- Le gestionnaire de services Linux
systemctlet Windows ne fonctionne pas avec l'agent Ops
Pour savoir comment résoudre les problèmes liés à l'agent Ops, consultez Résoudre les problèmes liés à l'agent Ops.
Échec des commandes gcloud beta compute zone-vm-extension-policies
gcloud beta compute zone-vm-extension-policiesLorsqu'une commande échoue, la réponse inclut des suggestions de dépannage. Corrigez les erreurs dans les options ou les arguments de commande suggérés par le message d'erreur.gcloud beta compute zone-vm-extension-policies
Si le résultat de la commande mentionne des autorisations IAM insuffisantes, consultez les rôles et autorisations nécessaires décrits dans Accorder les rôles requis pour utiliser le Gestionnaire d'extensions de VM.
La règle d'extension est créée, mais l'état de l'agent Ops est "non détecté"
Vous avez créé une règle d'extension, mais l'agent Ops affiche l'état Non détecté sur la VM.
L'Agent Ops peut s'afficher comme "non détecté" si l'un des cas suivants se produit :
- La règle d'extension ne parvient pas à installer l'agent Ops.
- Un agent Ops installé rencontre une condition d'erreur qui l'empêche de s'exécuter.
Les sections suivantes expliquent comment diagnostiquer ces cas.
Vérifier que l'agent Ops a été installé par la règle
Les règles VM Extension Manager utilisent l'agent invité Compute Engine pour gérer l'agent Ops en tant qu'extension de VM.
Pour déterminer si l'agent Ops a été installé par la règle d'extension, utilisez l'une des méthodes suivantes pour rechercher les entrées de journaux de l'agent invité :
Explorateur de journaux
-
Dans la console Google Cloud , accédez à la page Explorateur de journaux.
Accéder à l'explorateur de journaux
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Logging.
Saisissez la requête suivante, puis cliquez sur Exécuter la requête :
log_id("GCEGuestAgentManager")
Linux
Exécutez la commande suivante sur la VM Compute Engine :
journalctl -u google-guest-agent-manager
Windows
Exécutez la commande suivante sur la VM Compute Engine :
Get-Eventlog -Source google_guest_agent_manager -LogName Application
Si vous voyez des journaux contenant une chaîne telle que Failed to install plugin
"ops-agent-plugin" ... ou si la requête ne renvoie aucun journal, cela signifie que la règle d'extension n'a pas réussi à installer l'agent Ops. Pour connaître les étapes suivantes, consultez Échec de l'installation de l'agent Ops par la règle d'extension.
Si vous voyez des journaux contenant une chaîne telle que Successfully installed plugin
"ops-agent_nnnnnnnn", cela signifie que la stratégie d'extension a installé l'agent Ops. Pour connaître les étapes suivantes, consultez L'agent Ops installé n'est pas détecté.
Échec de l'installation de l'agent Ops par la règle d'extension
Une règle d'extension peut être inefficace si l'une des conditions suivantes est remplie :
L'agent invité n'est pas installé sur la VM. Pour diagnostiquer et résoudre ce problème, procédez comme suit :
Vérifiez que la VM utilise l'un des systèmes d'exploitation compatibles avec l'environnement invité Compute Engine.
Affichez les packages installés sur la VM pour vérifier que
google-guest-agentest inclus.Si
google-guest-agentn'est pas installé, installez l'agent invité.
L'agent invité est installé, mais il est obsolète. Pour diagnostiquer et résoudre ce problème, procédez comme suit :
Validez l'environnement invité pour déterminer la version du package
google-guest-agent. VM Extension Manager nécessite la version20241209.01ou ultérieure.Si la version de
google-guest-agentest antérieure à20241209.01, mettez à jour l'environnement invité.
Le système d'exploitation de la VM n'est pas compatible avec VM Extension Manager. Pour en savoir plus, consultez Vérifier les systèmes d'exploitation compatibles.
L'Agent Ops installé a l'état "Non détecté"
L'état de l'Agent Ops peut être "Non détecté" si l'une des conditions suivantes est remplie :
Des agents d'observabilité sont déjà installés sur la VM. Les agents existants peuvent entraîner des conflits et doivent être désinstallés. Pour en savoir plus, consultez Désinstaller les agents d'observabilité.
Après avoir désinstallé les agents précédemment installés, vous pouvez redémarrer l'agent Ops.
L'agent Ops ne dispose pas des autorisations suffisantes pour envoyer des données à Cloud Logging et Cloud Monitoring. Pour en savoir plus, consultez Causes courantes d'échec de la transmission de télémétrie.
Vérifier que la configuration de l'agent Ops est valide
Vous avez fourni une configuration personnalisée à l'agent Ops en créant ou en mettant à jour une règle d'extension, mais l'état de l'agent est "non détecté". Il peut s'agir d'une erreur dans votre configuration personnalisée. Utilisez les journaux de débogage de l'agent invité pour rechercher les erreurs de configuration.
Activer la journalisation de débogage de l'agent invité
Pour savoir comment activer la journalisation de débogage pour l'agent invité, consultez Afficher les journaux de débogage pour l'agent invité.
Examiner les journaux de débogage
Explorateur de journaux
-
Dans la console Google Cloud , accédez à la page Explorateur de journaux.
Accéder à l'explorateur de journaux
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Logging.
Saisissez la requête suivante, puis cliquez sur Exécuter la requête :
severity>=DEBUG log_id("GCEGuestAgentManager") "The agent config file is not valid"
Linux
Exécutez la commande suivante sur la VM Linux Compute Engine :
journalctl -u google-guest-agent-manager | grep "The agent config file is not valid"
Windows
Exécutez la commande suivante sur la VM Windows Compute Engine :
Get-Eventlog -Source google_guest_agent_manager -LogName Application |
Where-Object {$_.Message -like "*The agent config file is not valid*"}
Si vous voyez des journaux contenant la chaîne The agent config file is not valid, cela signifie que la configuration personnalisée de l'agent Ops que vous avez fournie lors de la création ou de la mise à jour de la règle d'extension n'est pas valide.
Pour résoudre ce problème, procédez comme suit :
Corrigez la configuration en vous reportant à Configurer l'agent Ops. Pour en savoir plus sur la structure d'un fichier de configuration de l'agent Ops.
Mettez à jour la règle d'extension avec la configuration corrigée.
Les commandes Linux systemctl status et Windows Get-Service ne fonctionnent pas avec l'agent Ops
Vous exécutez une commande telle que sudo systemctl status google-cloud-ops-agent"*", mais aucune information n'est renvoyée.
Lorsque l'agent Ops est installé et géré par VM Extension Manager, il n'est pas géré par le service de gestion du système d'exploitation, c'est-à-dire systemd sur Linux ou le Gestionnaire de services Windows sur Windows.
Pour trouver les informations d'état d'un agent Ops géré par VM Extension Manager, consultez les informations suivantes :
Les commandes Linux systemctl restart et Windows Restart-Service ne fonctionnent pas avec l'agent Ops
Vous exécutez une commande telle que sudo systemctl restart google-cloud-ops-agent, mais l'agent Ops ne redémarre pas.
Lorsque l'agent Ops est installé et géré par VM Extension Manager, il n'est pas géré par le service de gestion du système d'exploitation, c'est-à-dire systemd sur Linux ou le Gestionnaire de services Windows sur Windows. Par conséquent, vous ne pouvez pas arrêter ni démarrer l'agent Ops manuellement, et les commandes telles que les suivantes ne fonctionnent pas avec l'agent Ops :
- Linux :
sudo systemctl [stop|start|restart] - Windows :
Stop-Service,Start-Service,Restart-Service
Pour arrêter ou redémarrer un Agent Ops géré par le Gestionnaire d'extensions de VM, vous devez désinstaller l'agent en supprimant la règle d'extension. Pour en savoir plus sur l'arrêt ou le redémarrage de l'agent Ops, consultez Redémarrer un agent Ops installé par une règle d'extension.
Informations de dépannage supplémentaires
Pour en savoir plus sur la résolution des problèmes liés à la création et à l'utilisation des règles du gestionnaire d'extensions de VM, consultez Résoudre les problèmes liés aux extensions de VM.
Pour en savoir plus sur le dépannage de l'agent Ops, consultez Résoudre les problèmes liés à l'agent Ops.
Quota
Pour en savoir plus sur le nombre de règles d'extension que vous pouvez créer dans un projet Google Cloud , consultez Quota.
Tarifs
Pour en savoir plus sur les coûts associés à l'utilisation de VM Extension Manager, consultez la page Tarifs.
Si vous installez l'agent Ops, les métriques, les journaux ou les traces envoyés par l'agent à votre projet Google Cloud peuvent vous être facturés. Pour en savoir plus sur la tarification, consultez la page Tarifs de Google Cloud Observability.
Étapes suivantes
- Consultez des informations détaillées sur la configuration de l'agent Ops.
- En savoir plus sur VM Extension Manager