Chaves de metadados predefinidas


Cada entrada de metadados é armazenada no servidor de metadados como pares de valores-chave. As chaves de metadados diferenciam maiúsculas de minúsculas. Suas chaves podem ser chaves de metadados predefinidas ou personalizadas.

Chaves de metadados predefinidas são chaves de metadados criadas pelo Compute Engine. Quando você cria uma VM, o Compute Engine define automaticamente os valores de metadados para algumas dessas chaves nessa VM, por exemplo, o ID da instância da VM ou o ID do projeto. Para chaves predefinidas em que o Compute Engine não define um valor automaticamente, você pode escolher entre um conjunto de valores disponíveis dependendo da configuração do sistema.Por exemplo, para ativar o login do SO para uma VM, você pode definir o valor da chave predefinida enable-oslogin como TRUE para essa VM. Para desabilitar o login do SO para essa VM, você pode atualizar o valor da chave para FALSE .Você só pode atualizar os valores dessas chaves, mas não as próprias chaves.

Este documento fornece informações sobre as chaves de metadados predefinidas que o Compute Engine fornece nos diretórios de metadados instance/ e project/ .

Para obter informações sobre como os metadados de VM do Compute Engine são definidos, categorizados e organizados, consulte Sobre metadados de VM .

Chaves de metadados de projeto predefinidas

As chaves de metadados predefinidas para metadados do projeto são armazenadas no seguinte diretório:

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

A tabela a seguir fornece uma lista de chaves e diretórios de metadados que o Compute Engine cria automaticamente no diretório project/ metadata:

Entrada de metadados Descrição
attributes/

Um diretório de valores de metadados personalizados transmitidos às VMs do seu projeto durante a inicialização ou desligamento. Esses valores personalizados podem ser Google Cloud atributos ou valores de metadados criados pelo usuário.

Para obter uma lista de nível de projeto Google Cloud atributos que você pode definir, consulte Atributos do projeto .

Para obter mais informações sobre como configurar metadados personalizados, consulte Definir metadados personalizados .

numeric-project-id O ID numérico do projeto (número do projeto) da instância, que não é igual ao nome do projeto visível no console do Google Cloud . Este valor é diferente do valor de entrada de metadados project-id .
project-id O ID do projeto .

Chaves de metadados de atributos de projeto predefinidos

As chaves de metadados predefinidas para atributos do projeto são armazenadas no seguinte diretório:

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

A tabela a seguir fornece uma lista de chaves de metadados que o Compute Engine cria automaticamente no diretório project/attributes/ metadata:

Entrada de metadados Descrição
disable-legacy-endpoints

Desativa os endpoints do servidor de metadados herdados para todas as VMs do seu projeto.

Os endpoints legados estão obsoletos, sempre defina disable-legacy-endpoints=TRUE .

enable-guest-attributes

Define atributos de convidado para o projeto.

Atributos de convidado são valores de metadados de instância de VM personalizados que você pode usar para publicar notificações de status pouco frequentes, dados de baixo volume ou dados de baixa frequência. Esses valores são úteis para indicar quando os scripts de inicialização foram concluídos ou para fornecer outras notificações de status pouco frequentes para outros aplicativos.

Para obter mais informações sobre atributos de convidados, consulte Definir e consultar atributos de convidados .

enable-os-inventory

Habilita ou desabilita o inventário de SO para o projeto.

Coleta e armazena informações do sistema operacional. Isso inclui informações como nome do host, versão do kernel, arquitetura e pacotes instalados.

Para obter mais informações sobre o inventário do sistema operacional, consulte Exibir detalhes do sistema operacional .

enable-oslogin

Ativa ou desativa o gerenciamento de chaves SSH no seu projeto.

Para obter mais informações sobre o login do SO, consulte Configurar o login do SO .

enable-windows-ssh

Habilita ou desabilita o SSH para VMs do Windows.

Para obter mais informações, consulte Conectar-se a VMs do Windows usando SSH .

google-compute-default-data-protection

Se definido, armazena a opção padrão usada para fazer backup de novas instâncias criadas no projeto.

Para obter mais informações, consulte Configurar a configuração de backup padrão para o console .

google-compute-default-region Se definido, armazena a região padrão usada pelo projeto.

Para obter mais informações sobre como definir regiões padrão, consulte Região e zona padrão .

google-compute-default-zone Se definido, armazena a zona padrão usada pelo projeto.

Para obter mais informações sobre como definir zonas padrão, consulte Região e zona padrão .

ssh-keys

Se você estiver gerenciando chaves SSH usando metadados , esse atributo permitirá configurar chaves SSH públicas que podem se conectar a VMs neste projeto. Se houver várias chaves SSH, cada chave será separada por um caractere de nova linha ( \n ). O valor do atributo ssh-keys é uma string.

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

As chaves SSH gerenciadas pelo Login do SO não são visíveis nos metadados.

sshKeys Obsoleto: use ssh-keys .
vmdnssetting

Habilite o DNS zonal e o DNS global para as VMs do seu projeto.

Para obter mais informações sobre como usar nomes DNS zonais para suas VMs, consulte Usar DNS zonal para seu tipo de DNS interno .

Chaves de metadados de instância predefinidas

Chaves de metadados predefinidos para metadados de instância são armazenadas no seguinte diretório:

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

A tabela a seguir fornece uma lista de chaves e diretórios de metadados que o Compute Engine cria automaticamente no diretório instance/ metadata:

Entrada de metadados Descrição
attributes/

Um diretório de valores de metadados personalizados passados ​​para a VM durante a inicialização ou desligamento. Esses valores personalizados podem ser Google Cloudatributos ou valores de metadados criados pelo usuário.

Para obter uma lista de nível de instância Google Cloud atributos que você pode definir, consulte Atributos de instância

Para obter mais informações sobre como configurar metadados personalizados, consulte Definir metadados personalizados .

cpu-platform

Plataforma de CPU da VM.

Para obter informações sobre plataformas de CPU, consulte Plataformas de CPU .

description A descrição de texto livre de uma instância atribuída usando a sinalização --description usando a Google Cloud CLI ou a API.
disks/

Um diretório de discos anexados à VM. Para cada disco, as seguintes informações estão disponíveis:

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

Para obter mais informações sobre discos, consulte Opções de armazenamento .

gce-workload-certificates/ ( Visualização )

Armazena os pontos de extremidade a seguir para o recurso de identidades de carga de trabalho gerenciada usado por aplicativos em execução na VM.

  • config-status : contém erros nos valores de configuração fornecidos por meio dos metadados da VM.
  • workload-identities : contém as identidades gerenciadas pelo plano de controle do Compute Engine. Este endpoint contém o certificado X.509 e a chave privada do domínio confiável da VM.
  • trust-anchors : Contém um conjunto de certificados confiáveis ​​para validação da cadeia de certificados peer X.509.

Para obter mais informações, consulte Autenticar cargas de trabalho para outras cargas de trabalho por meio de mTLS .

guest-attributes/

Define atributos de convidado para a VM. Esses valores personalizados podem ser Google Cloudatributos ou valores de metadados criados pelo usuário.

Para obter uma lista de nível de instância Google Cloud atributos que você pode definir, consulte Atributos de convidado da instância

Para obter mais informações sobre atributos de convidados, consulte Definir e consultar atributos de convidados .

hostname O nome do host da VM.
id O ID da VM. Este é um ID numérico exclusivo gerado pelo Compute Engine para seu projeto e a zona da VM. Você pode usar esse ID para identificar sua VM, especialmente se não tiver atribuído um nome personalizado à VM.
image A imagem do sistema operacional usada pela VM. Este valor tem o seguinte formato: projects/ IMAGE_PROJECT /global/images/ IMAGE_NAME .
legacy-endpoint-access/ Armazena a lista de endpoints herdados. Os valores são 0.1 e v1beta1 .
licenses/ Uma lista de IDs de códigos de licença usados ​​para anexar licenças a imagens, instantâneos e discos.
machine-type O tipo de máquina para esta VM. Este valor tem o seguinte formato: projects/ PROJECT_NUM /machineTypes/ MACHINE_TYPE
maintenance-event Indica se um evento de manutenção está afetando esta VM. Para obter mais informações, consulte Migração em tempo real .
name O nome da VM.
network-interfaces/

Um diretório de interfaces de rede. Para cada interface de rede estão disponíveis as seguintes informações:

  • access-configs/

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

Para obter mais informações sobre interfaces de rede, consulte Visão geral de múltiplas interfaces de rede .

partner-attributes/ ( Visualização )

Um diretório que contém namespaces nos quais as entradas de metadados são armazenadas. Os namespaces são criados por Google Cloud serviços, que usam atributos de parceiros para armazenar suas configurações. Quando não há serviços utilizando os atributos do parceiro, o diretório fica vazio.

Por exemplo, as identidades de carga de trabalho geridas utilizam atributos de parceiros para as suas configurações.

preempted

Um valor booleano que indica se uma VM está prestes a ser preemptada.

scheduling/

Define as opções de agendamento para a VM.

Os valores de metadados de agendamento incluem o seguinte:

  • on-host-maintenance : indica se a VM é encerrada ou migra em tempo real durante a manutenção do host.
  • automatic-restart : se esse valor for TRUE , a VM será reiniciada automaticamente após um evento de manutenção ou falha.
  • preemptible : se este valor for TRUE , a VM é preemptiva. Este valor é definido quando você cria uma VM e não pode ser alterado.

Para obter mais informações sobre opções de agendamento, consulte Definir políticas de disponibilidade de instância .

service-accounts/

Um diretório de contas de serviço associadas à VM. Para cada conta de serviço, as seguintes informações estão disponíveis:

  • aliases
  • email : o endereço de email da conta de serviço.
  • identity : um JSON Web Token exclusivo da VM. Você deve incluir o parâmetro audience na sua solicitação para esse valor de metadados da VM. Por exemplo, ?audience=http://www.example.com .

    Para obter informações sobre como solicitar e verificar tokens de identidade da instância, consulte Verificar a identidade da VM .

  • scopes : os escopos de acesso atribuídos à conta de serviço.
  • token : o token de acesso OAuth2 que pode ser usado para autenticar aplicativos.

    Para obter informações sobre tokens de acesso, consulte Autenticando aplicativos diretamente com tokens de acesso .

Para mais informações sobre como o Compute Engine usa contas de serviço, consulte Contas de serviço .

tags

Lista todas as tags de rede associadas à VM.

Para obter mais informações sobre tags de rede, consulte Adicionar tags de rede .

zone A zona onde esta VM está localizada. Este valor tem o seguinte formato: projects/ PROJECT_NUM /zones/ ZONE

Chaves de metadados de atributos de instância predefinidos

As chaves de metadados predefinidas para atributos de instância são armazenadas no seguinte diretório:

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

A tabela a seguir fornece uma lista de chaves de metadados que o Compute Engine cria automaticamente no diretório instance/attributes/ metadata:

Entrada de metadados Descrição
physical_host

Uma string hash que representa o local de uma VM criada com uma política de posicionamento compacto.

Para obter mais informações sobre esse atributo, consulte Verificar a localização física de uma VM .

enable-oslogin

Ativa ou desativa o gerenciamento de chaves SSH na sua VM.

Para obter mais informações sobre o login do SO, consulte Configurar o login do SO .

enable-windows-ssh ( Visualização )

Habilita ou desabilita o SSH para VMs do Windows.

Para obter mais informações, consulte Conectar-se a VMs do Windows usando SSH .

enable-workload-certificate ( Visualização )

Habilita ou desabilita identidades de carga de trabalho gerenciadas em uma VM.

Para obter mais informações, consulte Habilitar identidades de carga de trabalho gerenciadas para VMs individuais .

vmdnssetting

Habilite o DNS zonal e o DNS global para a VM.

Para obter mais informações sobre como usar nomes DNS zonais para o DNS de suas VMs, consulte Usar DNS zonal para seu tipo de DNS interno .

ssh-keys

Se você estiver gerenciando chaves SSH usando metadados , esse atributo permitirá configurar chaves SSH públicas que podem se conectar a VMs neste projeto. Se houver várias chaves SSH, cada chave será separada por um caractere de nova linha ( \n ). O valor do atributo ssh-keys é uma string.

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

As chaves SSH gerenciadas pelo Login do SO não são visíveis nos metadados.

block-project-ssh-keys

Bloqueie chaves SSH do projeto de VMs que usam chaves SSH baseadas em metadados.

Para obter mais informações, consulte Restringir chaves SSH de VMs .

Chaves de metadados de atributos de convidado predefinidas

Chaves de metadados predefinidos para atributos de convidados de instância são armazenadas no seguinte diretório:

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

A tabela a seguir fornece uma lista de chaves e diretórios de metadados que o Compute Engine cria automaticamente no diretório instance/guest-attributes/ metadata:

Entrada de metadados Descrição
guestInventory/

Armazena o inventário do sistema operacional para a VM.

Coleta e armazena informações detalhadas do sistema operacional. Isso inclui informações como nome do host, versão do kernel, arquitetura e detalhes dos pacotes instalados.

Para obter mais informações sobre o inventário do sistema operacional, consulte Exibir detalhes do sistema operacional .

hostkeys/

Armazena chaves de host SSH. As chaves de host podem ser usadas para identificar um host ou máquina específica.

Para obter informações sobre chaves de host, consulte Armazenando chaves de host ativando atributos de convidado .

O que vem a seguir?