Claves de metadatos predefinidas


Cada entrada de metadatos se almacena en el servidor de metadatos como pares clave-valor. Las claves de metadatos distinguen entre mayúsculas y minúsculas. Las claves pueden ser claves de metadatos predefinidas o personalizadas.

Las claves de metadatos predefinidas son claves de metadatos creadas por Compute Engine. Cuando creas una VM, Compute Engine asigna automáticamente los valores de metadatos de algunas de estas claves a esa VM, como el ID de instancia de la VM o el ID del proyecto. En el caso de las claves predefinidas en las que Compute Engine no asigna un valor automáticamente, puedes elegir entre un conjunto de valores que están disponibles en función de la configuración del sistema. Por ejemplo, para habilitar OS Login en una VM, puedes asignar el valor TRUE a la clave predefinida enable-oslogin de esa VM. Para inhabilitar OS Login en esa VM, puedes cambiar el valor de la clave a FALSE. Solo puede actualizar los valores de estas claves, pero no las claves en sí.

En este documento se proporciona información sobre las claves de metadatos predefinidas que ofrece Compute Engine en los directorios de metadatos instance/ y project/.

Para obtener información sobre cómo se define, categoriza y organiza el metadato de VM de Compute Engine, consulta Acerca del metadato de VM.

Claves de metadatos de proyecto predefinidas

Las claves de metadatos predefinidas de los metadatos de proyectos se almacenan en el siguiente directorio:

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

En la siguiente tabla se muestra una lista de claves de metadatos y directorios que Compute Engine crea automáticamente en el directorio de metadatos project/:

Entrada de metadatos Descripción
attributes/

Un directorio de valores de metadatos personalizados que se transfieren a las VMs de tu proyecto durante el inicio o el cierre. Estos valores personalizados pueden ser Google Cloud atributos o valores de metadatos creados por el usuario.

Para ver una lista de los atributos de nivel de proyecto Google Cloud que puede definir, consulte Atributos de proyecto.

Para obtener más información sobre cómo definir metadatos personalizados, consulta Definir metadatos personalizados.

numeric-project-id El ID de proyecto numérico (número de proyecto) de la instancia, que no es el mismo que el nombre del proyecto que se muestra en la Google Cloud console. Este valor es diferente del valor de la entrada de metadatos project-id.
project-id El ID del proyecto.

Claves de metadatos de atributos de proyecto predefinidas

Las claves de metadatos predefinidas de los atributos de proyecto se almacenan en el siguiente directorio:

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

En la siguiente tabla se muestra una lista de claves de metadatos que, si se definen en tu proyecto, Compute Engine crea en el directorio de metadatos project/attributes/, junto con el efecto asociado:

Entrada de metadatos Descripción
disable-legacy-endpoints

Inhabilita los endpoints del servidor de metadatos antiguo en todas las VMs de tu proyecto.

Los endpoints antiguos están obsoletos, así que siempre se debe definir disable-legacy-endpoints=TRUE.

enable-guest-attributes

Define los atributos de invitado del proyecto.

Los atributos de invitado son valores de metadatos de instancias de VM personalizadas que puedes usar para publicar notificaciones de estado poco frecuentes, datos de poco volumen o datos de baja frecuencia. Estos valores son útiles para indicar cuándo han finalizado las secuencias de comandos de inicio o para proporcionar otras notificaciones de estado poco frecuentes a otras aplicaciones.

Para obtener más información sobre los atributos de invitado, consulta el artículo Configurar y consultar atributos de invitados.

enable-os-inventory

Habilita o inhabilita el inventario de SO del proyecto.

Recoge y almacena información del SO. Esto incluye información como el nombre de host, la versión del kernel, la arquitectura y los paquetes instalados.

Para obtener más información sobre el inventario de sistemas operativos, consulta Ver los detalles del sistema operativo.

enable-oslogin

Habilita o inhabilita la gestión de claves SSH en tu proyecto.

Para obtener más información sobre OS Login, consulta el artículo Configurar OS Login.

enable-windows-ssh

Habilita o inhabilita SSH para las VMs de Windows.

Para obtener más información, consulta Conectarse a máquinas virtuales Windows mediante SSH.

google-compute-default-data-protection

Si se define, almacena la opción predeterminada que se usa para crear copias de seguridad de las nuevas instancias creadas en el proyecto.

Para obtener más información, consulta Configurar el ajuste de copia de seguridad predeterminado de la consola.

google-compute-default-region Si se define, almacena la región predeterminada que usa el proyecto.

Para obtener más información sobre cómo definir regiones predeterminadas, consulta Región y zona predeterminadas.

google-compute-default-zone Si se define, almacena la zona predeterminada que usa el proyecto.

Para obtener más información sobre cómo definir zonas predeterminadas, consulta Región y zona predeterminadas.

ssh-keys

Si gestionas claves SSH mediante metadatos, este atributo te permite configurar claves SSH públicas que pueden conectarse a las VMs de este proyecto. Si hay varias claves SSH, cada una debe estar separada por un carácter de salto de línea (\n). El valor del atributo ssh-keys es una cadena.

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

Las claves SSH gestionadas por OS Login no se ven en los metadatos.

sshKeys Obsoleta: usa ssh-keys.
vmdnssetting

Habilita el DNS zonal y el DNS global en las VMs de tu proyecto.

Para obtener más información sobre cómo usar nombres de DNS zonales en tus VMs, consulta Usar DNS zonal en el tipo de DNS interno.

Claves de metadatos de instancia predefinidas

Las claves de metadatos predefinidas de los metadatos de instancia se almacenan en el siguiente directorio:

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

En la siguiente tabla se muestra una lista de claves de metadatos y directorios que Compute Engine crea automáticamente en el directorio de metadatos instance/:

Entrada de metadatos Descripción
attributes/

Un directorio de valores de metadatos personalizados que se transfieren a la VM durante el inicio o el apagado. Estos valores personalizados pueden ser Google Cloud atributos o valores de metadatos creados por el usuario.

Para ver una lista de los Google Cloud atributos de nivel de instancia Google Cloud que puede definir, consulte Atributos de instancia.

Para obtener más información sobre cómo definir metadatos personalizados, consulta Definir metadatos personalizados.

cpu-platform

Plataforma de CPU de la VM.

Para obtener información sobre las plataformas de CPU, consulta Plataformas de CPU.

description Descripción de texto libre de una instancia que se asigna mediante la marca --description con la CLI de Google Cloud o la API.
disks/

Un directorio de discos conectados a la VM. Para cada disco, se puede consultar la siguiente información:

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

Para obtener más información sobre los discos, consulta el artículo sobre las opciones de almacenamiento.

gce-workload-certificates/(Vista previa)

Almacena los siguientes endpoints de la función de identidades de carga de trabajo gestionadas que usan las aplicaciones que se ejecutan en la VM.

  • config-status: contiene los errores de los valores de configuración proporcionados a través de los metadatos de la VM.
  • workload-identities: contiene las identidades gestionadas por el plano de control de Compute Engine. Este endpoint contiene el certificado X.509 y la clave privada del dominio de confianza de la VM.
  • trust-anchors: contiene un conjunto de certificados de confianza para la validación de la cadena de certificados X.509 del peer.

Para obtener más información, consulta el artículo Autenticar cargas de trabajo en otras cargas de trabajo mediante mTLS.

guest-attributes/

Define los atributos de invitado de la VM. Estos valores personalizados pueden ser Google Cloud atributos o valores de metadatos creados por el usuario.

Para ver una lista de los atributos a nivel de instancia Google Cloud que puedes definir, consulta Atributos de invitado de la instancia.

Para obtener más información sobre los atributos de invitado, consulta el artículo Configurar y consultar atributos de invitados.

hostname Nombre de host de la VM.
id El ID de la VM. Es un ID numérico único generado por Compute Engine para tu proyecto y la zona de la VM. Puedes usar este ID para identificar tu VM, sobre todo si no le has asignado un nombre personalizado.
image La imagen del sistema operativo que usa la VM. Este valor tiene el siguiente formato: projects/IMAGE_PROJECT/global/images/IMAGE_NAME.
legacy-endpoint-access/ Almacena la lista de endpoints antiguos. Los valores son 0.1 y v1beta1.
licenses/ Lista de IDs de códigos de licencia que se usan para adjuntar las licencias a imágenes, instantáneas y discos.
machine-type Tipo de máquina de esta VM. Este valor tiene el siguiente formato: projects/PROJECT_NUM/machineTypes/MACHINE_TYPE
maintenance-event Indica si un evento de mantenimiento afecta a esta VM. Para obtener más información, consulta Migración en directo.
name El nombre de la VM.
network-interfaces/

Un directorio de interfaces de red. Para cada interfaz de red, se muestra la siguiente información:

  • access-configs/

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

Para obtener más información sobre las interfaces de red, consulta el artículo Información general sobre varias interfaces de red.

partner-attributes/(Vista previa)

Un directorio que contiene los espacios de nombres en los que se almacenan las entradas de metadatos. Los espacios de nombres los crean los Google Cloud servicios, que usan atributos de partner para almacenar sus configuraciones. Si no hay servicios que usen los atributos de partner, el directorio estará vacío.

Por ejemplo, las identidades de carga de trabajo gestionadas usan atributos de partner para sus configuraciones.

preempted

Valor booleano que indica si una VM está a punto de ser desalojada.

scheduling/

Define las opciones de programación de la VM.

Los valores de los metadatos de programación incluyen los siguientes:

  • on-host-maintenance: indica si la VM se termina o se migra en tiempo real durante el mantenimiento del host.
  • automatic-restart: si este valor es TRUE, la VM se reinicia automáticamente después de un evento de mantenimiento o un fallo.
  • preemptible: si este valor es TRUE, la VM es interrumpible. Este valor se define al crear una máquina virtual y no se puede cambiar.

Para obtener más información sobre las opciones de programación, consulta el artículo Definir políticas de disponibilidad de instancias.

service-accounts/

Un directorio de cuentas de servicio asociadas a la VM. Para cada cuenta de servicio, se muestra la siguiente información:

  • aliases
  • email: la dirección de correo de la cuenta de servicio.
  • identity: un JSON Web Token único para la VM. Debe incluir el parámetro audience en su solicitud de este valor de metadatos de la VM. Por ejemplo, ?audience=http://www.example.com.

    Para obtener información sobre cómo solicitar y verificar tokens de identidad de instancias, consulta Verificar la identidad de una máquina virtual.

  • scopes: los ámbitos de acceso asignados a la cuenta de servicio.
  • token: el token de acceso OAuth2 que se puede usar para autenticar aplicaciones.

    Para obtener información sobre los tokens de acceso, consulta el artículo Autenticar aplicaciones directamente con tokens de acceso.

Para obtener más información sobre cómo usa Compute Engine las cuentas de servicio, consulta el artículo Cuentas de servicio.

tags

Muestra las etiquetas de red asociadas a la VM.

Para obtener más información sobre las etiquetas de red, consulta el artículo Añadir etiquetas de red.

virtual-clock/drift-token

La desviación acumulada del reloj de la VM. Se inicializa en cero durante la creación de la instancia y aumenta según la diferencia de reloj acumulada a medida que la máquina virtual se migra en directo.

zone La zona en la que se encuentra esta VM. Este valor tiene el siguiente formato: projects/PROJECT_NUM/zones/ZONE

Claves de metadatos de atributos de instancia predefinidas

Las claves de metadatos predefinidas de los atributos de instancia se almacenan en el siguiente directorio:

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

En la siguiente tabla se muestra una lista de claves de metadatos que, si se definen en tu instancia, Compute Engine crea en el directorio de metadatos instance/attributes/, junto con el efecto asociado:

Entrada de metadatos Descripción
physical_host

Cadena hash que representa la ubicación de una VM creada con una política de colocación compacta.

Para obtener más información sobre este atributo, consulta Verificar la ubicación física de una máquina virtual.

enable-oslogin

Habilita o inhabilita la gestión de claves SSH en tu VM.

Para obtener más información sobre OS Login, consulta el artículo Configurar OS Login.

enable-windows-ssh (Vista previa)

Habilita o inhabilita SSH para las VMs de Windows.

Para obtener más información, consulta Conectarse a máquinas virtuales Windows mediante SSH.

enable-workload-certificate (Vista previa)

Habilita o inhabilita las identidades de carga de trabajo gestionadas en una VM.

Para obtener más información, consulta Habilitar identidades de carga de trabajo gestionadas para máquinas virtuales concretas.

vmdnssetting

Habilita el DNS zonal y el DNS global en la VM.

Para obtener más información sobre cómo usar nombres de DNS zonales para el DNS de tus VMs, consulta Usar DNS zonal para el tipo de DNS interno.

ssh-keys

Si gestionas claves SSH mediante metadatos, este atributo te permite configurar claves SSH públicas que pueden conectarse a las VMs de este proyecto. Si hay varias claves SSH, cada una debe estar separada por un carácter de salto de línea (\n). El valor del atributo ssh-keys es una cadena.

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

Las claves SSH gestionadas por OS Login no se ven en los metadatos.

block-project-ssh-keys

Bloquea las claves SSH del proyecto en las VMs que usan claves SSH basadas en metadatos.

Para obtener más información, consulta Restringir claves SSH de máquinas virtuales.

disable-https-mds-setup

Inhabilita el aprovisionamiento automático de certificados del servidor de metadatos HTTPS por parte de Compute Engine.

Para obtener más información, consulta el artículo Habilitar la configuración automática de certificados.

enable-https-mds-native-cert-store

Permite que Compute Engine añada el certificado raíz al almacén de confianza del SO durante el aprovisionamiento automático del certificado del servidor de metadatos HTTPS.

Para obtener más información, consulta el artículo sobre cómo habilitar el almacenamiento de certificados raíz en el almacén de confianza del SO.

Claves de metadatos de atributos de invitado predefinidas

Las claves de metadatos predefinidas de los atributos de invitado de la instancia se almacenan en el siguiente directorio:

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

En la siguiente tabla se muestra una lista de claves de metadatos y directorios que Compute Engine crea automáticamente en el directorio instance/guest-attributes/metadata:

Entrada de metadatos Descripción
guestInventory/

Almacena el inventario de SO de la VM.

Recoge y almacena información sobre los detalles del SO. Esto incluye información como el nombre de host, la versión del kernel, la arquitectura y los detalles de los paquetes instalados.

Para obtener más información sobre el inventario de sistemas operativos, consulta Ver los detalles del sistema operativo.

hostkeys/

Almacena claves de host SSH. Las claves de host se pueden usar para identificar un host o una máquina concretos.

Para obtener información sobre las claves de host, consulta el artículo Almacenar claves de host habilitando atributos de invitado.

Siguientes pasos