Clés de métadonnées prédéfinies

Chaque entrée de métadonnées est stockée sur le serveur de métadonnées en tant que paire clé/valeur. Les clés de métadonnées sont sensibles à la casse. Vos clés peuvent être des clés de métadonnées prédéfinies ou personnalisées.

Les clés de métadonnées prédéfinies sont des clés de métadonnées créées par Compute Engine. Lorsque vous créez une VM, Compute Engine définit automatiquement les valeurs de métadonnées de certaines de ces clés sur cette VM (par exemple, l'ID d'instance de VM ou l'ID de projet). Pour les clés prédéfinies dans lesquelles Compute Engine ne définit pas automatiquement de valeur, vous pouvez choisir parmi un ensemble de valeurs disponibles en fonction de la configuration système. Par exemple, pour activer OS Login pour une VM, vous pouvez définir la valeur de la clé prédéfinie enable-oslogin sur TRUE pour cette VM. Pour désactiver OS Login pour cette VM, vous pouvez mettre à jour la valeur de la clé vers FALSE.Vous ne pouvez mettre à jour que les valeurs de ces clés, pas les clés elles-mêmes.

Ce document fournit des informations sur les clés de métadonnées prédéfinies fournies par Compute Engine dans vos répertoires de métadonnées instance/ et project/.

Pour en savoir plus sur la définition, la classification et l'organisation des métadonnées de VM pour Compute Engine, consultez la page À propos des métadonnées de VM.

Clés de métadonnées de projet prédéfinies

Les clés de métadonnées prédéfinies pour les métadonnées de projet sont stockées dans le répertoire suivant :

  • http://metadata.google.internal/computeMetadata/v1/project/

Le tableau suivant fournit une liste de clés de métadonnées et de répertoires que Compute Engine crée automatiquement dans le répertoire de métadonnées project/ :

Entrée de métadonnées Description
attributes/

Répertoire des valeurs de métadonnées personnalisées transmises aux VM de votre projet lors du démarrage ou de l'arrêt. Ces valeurs personnalisées peuvent être des attributs Google Cloud ou des valeurs de métadonnées créées par l'utilisateur.

Pour obtenir la liste des attributs Google Cloud au niveau du projet que vous pouvez définir, consultez la section Attributs du projet.

Pour en savoir plus sur la définition des métadonnées, consultez la page Définir des métadonnées personnalisées.
numeric-project-id ID numérique du projet (numéro du projet) de l'instance, à ne pas confondre avec le nom du projet visible dans la console Google Cloud. Cette valeur est différente de la valeur d'entrée de métadonnées project-id.
project-id ID du projet.

Clés de métadonnées d'attributs de projet prédéfinis

Les clés de métadonnées prédéfinies pour les attributs de projet sont stockées dans le répertoire suivant :

  • http://metadata.google.internal/computeMetadata/v1/project/attributes/

Le tableau suivant fournit une liste des clés de métadonnées que Compute Engine crée automatiquement dans le répertoire de métadonnées project/attributes/ :

Entrée de métadonnées Description
disable-legacy-endpoints

Désactive les anciens points de terminaison du serveur de métadonnées pour toutes les VM de votre projet.

Les anciens points de terminaison sont obsolètes, et toujours définis sur disable-legacy-endpoints=TRUE.

enable-guest-attributes

Définit les attributs d'invité pour le projet.

Les attributs d'invité sont des valeurs de métadonnées d'instances de VM personnalisées que vous pouvez utiliser pour publier des notifications d'état peu fréquentes, des données de faible volume ou des données de basse fréquence. Ces valeurs sont utiles pour indiquer la fin des scripts de démarrage ou pour fournir d’autres notifications d’état peu fréquentes à d’autres applications.

Pour en savoir plus sur les attributs d'invité, consultez Définir et interroger des attributs d'invité.

enable-os-inventory

Active ou désactive OS Inventory pour le projet.

Collecte et stocke les informations sur l'OS. Cela inclut des informations telles que le nom d'hôte, la version du noyau, l'architecture et les packages installés.

Pour en savoir plus sur OS Inventory, consultez la page Afficher les détails des systèmes d'exploitation.

enable-oslogin

Active ou désactive la gestion des clés SSH dans votre projet.

Pour plus d'informations sur OS Login, consultez la page Configurer OS Login.

enable-windows-ssh

Active ou désactive SSH pour les VM Windows.

Pour en savoir plus, consultez la page Se connecter à des VM Windows à l'aide de SSH.

google-compute-default-region Si elle est définie, la région par défaut utilisée par le projet est enregistrée.

Pour en savoir plus sur la configuration des régions par défaut, consultez la section Région et zone par défaut.

google-compute-default-zone Si elle est définie, la zone par défaut utilisée par le projet est enregistrée.

Pour en savoir plus sur la configuration des zones par défaut, consultez la section Région et zone par défaut.

ssh-keys

Si vous gérez des clés SSH à l'aide de métadonnées, cet attribut vous permet de configurer des clés SSH publiques pouvant se connecter aux VM de ce projet. S'il existe plusieurs clés SSH, chaque clé est séparée par un caractère de retour à la ligne (\n). La valeur de l'attribut ssh-keys est une chaîne.

Exemple "user1:ssh-rsa mypublickey user1@host.com\nuser2:ssh-rsa mypublickey user2@host.com"

Les clés SSH gérées par OS Login ne sont pas visibles dans les métadonnées.

sshKeys Obsolète : utilisez ssh-keys.
vmdnssetting

Active le DNS zonal et le DNS global pour les VM de votre projet.

Pour en savoir plus sur l'utilisation de noms DNS zonaux pour vos VM, consultez la section Utiliser le DNS zonal pour votre type DNS interne.

Clés de métadonnées d'instance prédéfinies

Les clés de métadonnées prédéfinies pour les métadonnées d'instance sont stockées dans le répertoire suivant :

  • http://metadata.google.internal/computeMetadata/v1/instance/

Le tableau suivant fournit une liste de clés de métadonnées et de répertoires que Compute Engine crée automatiquement dans le répertoire de métadonnées instance/ :

Entrée de métadonnées Description
attributes/

Répertoire des valeurs de métadonnées personnalisées transmises à la VM lors du démarrage ou de l'arrêt. Ces valeurs personnalisées peuvent être des attributs Google Cloud ou des valeurs de métadonnées créées par l'utilisateur.

Pour obtenir la liste des attributs Google Cloud au niveau de l'instance que vous pouvez définir, consultez la section Attributs de l'instance.

Pour en savoir plus sur la définition des métadonnées personnalisées, consultez la section Définir des métadonnées personnalisées.
cpu-platform

Plate-forme de processeur de la VM.

Pour en savoir plus sur les plates-formes de processeur, consultez la page Plates-formes de processeur.
description Description en texte libre d'une instance attribuée avec l'option --description à l'aide de Google Cloud CLI ou de l'API.
disks/

Répertoire des disques associés à la VM. Les informations suivantes sont disponibles pour chaque disque :

  • device-name
  • index
  • interface
  • mode
  • type

Pour en savoir plus sur les disques, consultez la page Options de stockage.

gce-workload-certificates/ (preview)

Stocke les points de terminaison suivants pour la fonctionnalité d'identités de charge de travail gérées, utilisée par les applications exécutées dans la VM.

  • config-status : contient les erreurs associées aux valeurs de configuration fournies via les métadonnées de la VM.
  • workload-identities : contient les identités gérées par le plan de contrôle Compute Engine. Ce point de terminaison contient le certificat X.509 et la clé privée du domaine de confiance de la VM.
  • trust-anchors : contient un ensemble de certificats de confiance pour la validation de la chaîne de certificats X.509 associés aux pairs.

Pour en savoir plus, consultez la page Authentifier des charges de travail auprès d'autres charges de travail via mTLS.

guest-attributes/

Définit les attributs d'invité de la VM. Ces valeurs personnalisées peuvent être des attributs Google Cloud ou des valeurs de métadonnées créées par l'utilisateur.

Pour obtenir la liste des attributs Google Cloud au niveau de l'instance que vous pouvez définir, consultez la section Attributs d'invité de l'instance.

Pour en savoir plus sur les attributs d'invité, consultez Définir et interroger des attributs d'invité.

hostname Nom d'hôte de la VM.
id ID de la VM. Il s'agit d'un identifiant numérique unique généré par Compute Engine. Cette valeur est utile pour identifier les VM si vous n'utilisez pas de noms de VM.
image Image du système d'exploitation utilisée par la VM. Cette valeur a le format suivant : projects/IMAGE_PROJECT/global/images/IMAGE_NAME.
legacy-endpoint-access/ Stocke la liste des anciens points de terminaison. Les valeurs sont 0.1 et v1beta1.
licenses/ Liste des ID de codes de licence utilisés pour associer les licences aux images, instantanés et disques.
machine-type Type de machine de cette VM. Cette valeur a le format suivant : projects/PROJECT_NUM/machineTypes/MACHINE_TYPE
maintenance-event Indique si un événement de maintenance affecte cette VM. Pour en savoir plus, consultez la section Migrer à chaud.
name Nom de la VM.
network-interfaces/

Répertoire des interfaces réseau. Les informations suivantes sont disponibles pour chaque interface réseau :

  • access-configs/

    • external-ip
    • type
  • dns-servers
  • forwarded-ips/
  • gateway
  • ip
  • ip-aliases/
  • mac
  • mtu
  • network
  • subnetmask
  • target-instance-ips

Pour en savoir plus sur les interfaces réseau, consultez la page Présentation des configurations utilisant plusieurs interfaces réseau.

partner-attributes/ (preview)

Répertoire contenant les espaces de noms dans lesquels les entrées de métadonnées sont stockées. Les espaces de noms sont créés par les services Google Cloud, qui utilisent des attributs spécifiques au partenaire pour stocker leurs configurations. Si aucun service n'utilise les attributs de partenaire, le répertoire est vide.

Par exemple, les identités de charges de travail gérées utilisent des attributs de partenaire pour leurs configurations.

preempted

Valeur booléenne indiquant si une VM est sur le point d'être préemptée.
scheduling/

Définit les options de programmation de la VM.

La planification des valeurs de métadonnées inclut ce qui suit :

  • on-host-maintenance : indique si la VM s'arrête ou migre à chaud pendant la maintenance de l'hôte.
  • automatic-restart : si cette valeur est définie sur TRUE, la VM redémarre automatiquement après un événement de maintenance ou un plantage.
  • preemptible : si cette valeur est définie sur TRUE, l'instance est préemptive. Cette valeur est définie lorsque vous créez une VM, et elle ne peut pas être modifiée.

Pour en savoir plus sur les options de planification, consultez la page Définir les règles de disponibilité d'une instance.

service-accounts/

Répertoire des comptes de service associés à la VM. Pour chaque compte de service, les informations suivantes sont disponibles :

  • aliases
  • email : adresse e-mail associée au compte de service.
  • identity : jeton Web JSON unique à la VM. Vous devez inclure le paramètre audience dans votre requête pour cette valeur de métadonnées de VM. Par exemple, ?audience=http://www.example.com.

    Pour en savoir plus sur la façon de demander et de vérifier des jetons d'identité d'instance, consultez la page Vérifier l'identité des VM.

  • scopes : niveaux d'accès attribués au compte de service.
  • token : jeton d'accès OAuth2 pouvant être utilisé pour authentifier des applications.

    Pour en savoir plus sur les jetons d'accès, consultez la section Authentifier des applications directement avec les jetons d'accès.

Pour plus d'informations sur la manière dont Compute Engine utilise les comptes de service, consultez la page Comptes de service.

tags

Répertorie tous les tags réseau associés à la VM.

Pour en savoir plus sur les tags réseau, consultez la page Ajouter des tags réseau.

zone Zone où se trouve la VM. Cette valeur a le format suivant : projects/PROJECT_NUM/zones/ZONE.

Clés de métadonnées d'attributs d'instance prédéfinies

Les clés de métadonnées prédéfinies pour les attributs d'instance sont stockées dans le répertoire suivant :

  • http://metadata.google.internal/computeMetadata/v1/instance/attributes/

Le tableau suivant fournit une liste des clés de métadonnées que Compute Engine crée automatiquement dans le répertoire de métadonnées instance/attributes/ :

Entrée de métadonnées Description
physical_host

Chaîne de hachage qui représente l'emplacement d'une VM créée avec une stratégie d'emplacement compact.

Pour en savoir plus sur cet attribut, consultez la section Vérifier l'emplacement physique d'une VM.

enable-oslogin

Active ou désactive la gestion des clés SSH sur votre VM.

Pour plus d'informations sur OS Login, consultez la page Configurer OS Login.

enable-windows-ssh (bêta)

Active ou désactive SSH pour les VM Windows.

Pour en savoir plus, consultez la page Se connecter à des VM Windows à l'aide de SSH.

enable-workload-certificate (bêta)

Active ou désactive les identités de charge de travail gérées sur une VM.

Pour en savoir plus, consultez la section Activer les identités de charge de travail gérées pour des VM individuelles.
vmdnssetting

Active le DNS zonal et le DNS global pour la VM.

Pour en savoir plus sur l'utilisation de noms DNS zonaux pour le DNS de vos VM, consultez la section Utiliser le DNS zonal pour votre type DNS interne.

ssh-keys

Si vous gérez des clés SSH à l'aide de métadonnées, cet attribut vous permet de configurer des clés SSH publiques pouvant se connecter aux VM de ce projet. S'il existe plusieurs clés SSH, chaque clé est séparée par un caractère de retour à la ligne (\n). La valeur de l'attribut ssh-keys est une chaîne.

Exemple "user1:ssh-rsa mypublickey user1@host.com\nuser2:ssh-rsa mypublickey user2@host.com"

Les clés SSH gérées par OS Login ne sont pas visibles dans les métadonnées.

Clés de métadonnées d'attributs d'invité prédéfinis

Les clés de métadonnées prédéfinies pour les attributs d'invité d'instance sont stockées dans le répertoire suivant :

  • http://metadata.google.internal/computeMetadata/v1/instance/guest-attributes/

Le tableau suivant fournit une liste de clés de métadonnées et de répertoires que Compute Engine crée automatiquement dans le répertoire de métadonnées instance/guest-attributes/ :

Entrée de métadonnées Description
guestInventory/

Stocke OS Inventory pour la VM.

Collecte et stocke les informations sur le système d'exploitation. Cela inclut des informations telles que le nom d'hôte, la version du noyau, l'architecture et les détails des packages installés.

Pour en savoir plus sur OS Inventory, consultez la page Afficher les détails des systèmes d'exploitation.

hostkeys/

Stocke les clés d'hôte SSH. Les clés d'hôte peuvent servir à identifier un hôte ou une machine spécifique.

Pour plus d'informations sur les clés d'hôte, consultez la section Stocker les clés d'hôte en activant les attributs d'invité.

Étapes suivantes