Chaves de metadados predefinidas

Cada entrada de metadados é armazenada no servidor de metadados como pares de chave-valor. As chaves de metadados são sensíveis a maiúsculas e minúsculas. As chaves podem ser chaves de metadados predefinidas ou personalizadas.

As chaves de metadados predefinidas são chaves de metadados criadas pelo Compute Engine. Quando cria uma VM, o Compute Engine define automaticamente os valores de metadados para algumas destas chaves nessa VM, por exemplo, o ID da instância de VM ou o ID do projeto. Para chaves predefinidas em que o Compute Engine não define automaticamente um valor, pode escolher a partir de um conjunto de valores que estão disponíveis consoante a configuração do sistema. Por exemplo, para ativar o Início de sessão do SO para uma VM, pode definir o valor da chave predefinida enable-oslogin como TRUE para essa VM. Para desativar o Início de sessão do SO para essa VM, pode atualizar o valor da chave para FALSE. Só pode atualizar os valores destas chaves, mas não as chaves em si.

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

Para informações sobre como os metadados de VMs do Compute Engine são definidos, categorizados e organizados, consulte o artigo Acerca dos metadados de VMs.

Chaves de metadados de projetos predefinidas

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

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

A tabela seguinte apresenta uma lista de chaves e diretórios de metadados que o Compute Engine cria automaticamente no diretório de metadados project/:

Entrada de metadados Descrição
attributes/

Um diretório de valores de metadados personalizados transmitidos às VMs no seu projeto durante o arranque ou o encerramento. Estes valores personalizados podem ser Google Cloud atributos ou valores de metadados criados pelo utilizador.

Para ver uma lista de Google Cloud atributos ao nível do projeto que pode definir, consulte o artigo Atributos do projeto.

Para mais informações sobre a definição de metadados personalizados, consulte o artigo Defina metadados personalizados.
numeric-project-id O ID do projeto numérico (número do projeto) da instância, que não é o mesmo que o nome do projeto visível no Google Cloud console. Este valor é diferente do valor da entrada de metadados project-id.
project-id O ID do projeto.

Chaves de metadados de atributos do projeto predefinidas

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

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

A tabela seguinte fornece uma lista de chaves de metadados que, se definidas para o seu projeto, o Compute Engine cria no project/attributes/diretório de metadados, juntamente com o respetivo efeito associado:

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

Desativa os pontos finais do servidor de metadados antigos para todas as VMs no seu projeto.

Os pontos finais antigos estão descontinuados. Defina sempre disable-legacy-endpoints=TRUE.

enable-guest-attributes

Define os atributos de convidado para o projeto.

Os atributos de convidado são valores de metadados de instâncias de VMs personalizados que pode usar para publicar notificações de estado pouco frequentes, dados de baixo volume ou dados de baixa frequência. Estes valores são úteis para indicar quando os scripts de inicialização terminaram ou para fornecer outras notificações de estado pouco frequentes a outras aplicações.

Para mais informações sobre os atributos de convidados, consulte o artigo Defina e consulte atributos de convidados.

enable-os-inventory

Ativa ou desativa o inventário do SO para o projeto.

Recolhe e armazena informações do SO. Isto inclui informações como o nome do anfitrião, a versão do kernel, a arquitetura e os pacotes instalados.

Para mais informações sobre o inventário do SO, consulte o artigo Veja detalhes do sistema operativo.

enable-oslogin

Ativa ou desativa a gestão de chaves SSH no seu projeto.

Para mais informações sobre o Início de sessão do SO, consulte o artigo Configure o Início de sessão do SO.

enable-windows-ssh

Ativa ou desativa o SSH para VMs do Windows.

Para mais informações, consulte o artigo Estabeleça ligação a VMs do Windows através do SSH.

google-compute-default-data-protection

Se estiver definida, armazena a opção predefinida que é usada para fazer uma cópia de segurança de novas instâncias criadas no projeto.

Para mais informações, consulte o artigo Configure a definição de cópia de segurança predefinida para a consola.
google-compute-default-region Se estiver definida, armazena a região predefinida que é usada pelo projeto.

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

google-compute-default-zone Se estiver definida, armazena a zona predefinida usada pelo projeto.

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

ssh-keys

Se estiver a gerir chaves SSH através de metadados, este atributo permite-lhe configurar chaves SSH públicas que podem estabelecer ligação a VMs neste projeto. Se existirem várias chaves SSH, cada chave é separada por um caráter 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 geridas pelo Início de sessão do SO não são visíveis nos metadados.

sshKeys Descontinuado: use ssh-keys.
vmdnssetting

Ative o DNS zonal e o DNS global para as VMs no seu projeto.

Para mais informações sobre a utilização de nomes DNS zonais para as suas VMs, consulte o artigo Use o DNS zonal para o seu tipo de DNS interno.

Chaves de metadados de instâncias predefinidas

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

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

A tabela seguinte apresenta uma lista de chaves e diretórios de metadados que o Compute Engine cria automaticamente no diretório de metadados instance/:

Entrada de metadados Descrição
attributes/

Um diretório de valores de metadados personalizados transmitidos à VM durante o arranque ou o encerramento. Estes valores personalizados podem ser Google Cloud atributos ou valores de metadados criados pelo utilizador.

Para ver uma lista dos Google Cloud atributos ao nível da instância que pode definir, consulte Atributos da instância

Para mais informações sobre a definição de metadados personalizados, consulte o artigo Defina metadados personalizados.
cpu-platform

Plataforma da CPU da VM.

Para informações sobre plataformas de CPU, consulte o artigo Plataformas de CPU.
description A descrição de texto livre de uma instância que é atribuída através da flag --description com a CLI do Google Cloud ou a API.
disks/

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

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

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

gce-workload-certificates/(Pré-visualizar)

Armazena os seguintes pontos finais para a funcionalidade de identidades de carga de trabalho geridas usada por aplicações em execução na VM.

  • config-status: contém erros nos valores de configuração fornecidos através dos metadados da VM.
  • workload-identities: contém as identidades geridas pelo plano de controlo do Compute Engine. Este ponto final contém o certificado X.509 e a chave privada para o domínio de confiança da VM.
  • trust-anchors: Contém um conjunto de certificados fidedignos para a validação da cadeia de certificados X.509 de pares.

Para mais informações, consulte o artigo Autentique cargas de trabalho para outras cargas de trabalho através de mTLS.

guest-attributes/

Define os atributos de convidado para a VM. Estes valores personalizados podem ser Google Cloud atributos ou valores de metadados criados pelo utilizador.

Para ver uma lista de atributos ao nível da instância que pode definir, consulte o artigo Atributos de convidados da instância Google Cloud

Para mais informações sobre os atributos de convidados, consulte o artigo Defina e consulte atributos de convidados.

hostname O nome do anfitrião da VM.
id O ID da VM. Este é um ID numérico exclusivo gerado pelo Compute Engine para o seu projeto e a zona da VM. Pode usar este ID para identificar a sua VM, especialmente se não tiver atribuído um nome personalizado à VM.
image A imagem do sistema operativo usada pela VM. Este valor tem o seguinte formato: projects/IMAGE_PROJECT/global/images/IMAGE_NAME.
legacy-endpoint-access/ Armazena a lista de pontos finais antigos. Os valores são 0.1 e v1beta1.
licenses/ Uma lista de IDs de códigos de licenças que são usados para anexar as licenças a imagens, instantâneos e discos.
machine-type O tipo de máquina desta VM. Este valor tem o seguinte formato: projects/PROJECT_NUM/machineTypes/MACHINE_TYPE
maintenance-event Indica se um evento de manutenção está a afetar esta VM. Para mais informações, consulte o artigo Migração em direto.
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 mais informações sobre as interfaces de rede, consulte o artigo Vista geral das várias interfaces de rede.

partner-attributes/(Pré-visualizar)

Um diretório que contém espaços de nomes nos quais as entradas de metadados são armazenadas. Os espaços de nomes são criados por Google Cloud serviços, que usam atributos de parceiros para armazenar as respetivas configurações. Quando não existem serviços a usar os partner-attributes, o diretório está vazio.

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

preempted

Um valor booleano que indica se uma VM está prestes a ser anulada.
scheduling/

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

Os valores dos metadados de agendamento incluem o seguinte:

  • on-host-maintenance: indica se a VM termina ou é migrada em direto durante a manutenção do anfitrião.
  • automatic-restart: se este valor for TRUE, a VM é reiniciada automaticamente após um evento de manutenção ou uma falha.
  • preemptible: se este valor for TRUE, a VM é preemptiva. Este valor é definido quando cria uma MV e não pode ser alterado.

Para mais informações sobre as opções de agendamento, consulte o artigo Defina políticas de disponibilidade de instâncias.

service-accounts/

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

  • aliases
  • email: o endereço de email da conta de serviço.
  • identity: um símbolo da Web JSON que é exclusivo da VM. Tem de incluir o parâmetro audience no seu pedido para este valor de metadados da VM. Por exemplo, ?audience=http://www.example.com.

    Para ver informações sobre como pedir e validar tokens de identidade de instâncias, consulte o artigo Valide a identidade da VM.

  • scopes: os âmbitos de acesso atribuídos à conta de serviço.
  • token: o token de acesso OAuth2 que pode ser usado para autenticar aplicações.

    Para obter informações sobre as chaves de acesso, consulte Autenticar aplicações diretamente com chaves de acesso.

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

tags

Lista todas as etiquetas de rede associadas à VM.

Para mais informações sobre etiquetas de rede, consulte o artigo Adicione etiquetas de rede.
virtual-clock/drift-token

A variação acumulada do relógio da VM. Inicializado como zero durante a criação da instância e aumentado pelo desvio de tempo acumulado à medida que a VM migra em direto.
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 predefinidas

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

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

A tabela seguinte fornece uma lista de chaves de metadados que, se definidas para a sua instância, o Compute Engine cria no diretório de metadados instance/attributes/, juntamente com o respetivo efeito associado:

Entrada de metadados Descrição
physical_host

Uma string hash que representa a localização de uma VM criada com uma política de posicionamento compacta.

Para mais informações sobre este atributo, consulte o artigo Valide a localização física de uma VM.

enable-oslogin

Ativa ou desativa a gestão de chaves SSH na sua VM.

Para mais informações sobre o Início de sessão do SO, consulte o artigo Configure o Início de sessão do SO.

enable-windows-ssh (Pré-visualizar)

Ativa ou desativa o SSH para VMs do Windows.

Para mais informações, consulte o artigo Estabeleça ligação a VMs do Windows através do SSH.

enable-workload-certificate (Pré-visualizar)

Ativa ou desativa identidades de cargas de trabalho geridas numa VM.

Para mais informações, consulte o artigo Ative identidades de cargas de trabalho geridas para VMs individuais.
vmdnssetting

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

Para mais informações sobre a utilização de nomes DNS zonais para o DNS das suas VMs, consulte o artigo Use o DNS zonal para o seu tipo de DNS interno.

ssh-keys

Se estiver a gerir chaves SSH através de metadados, este atributo permite-lhe configurar chaves SSH públicas que podem estabelecer ligação a VMs neste projeto. Se existirem várias chaves SSH, cada chave é separada por um caráter 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 geridas pelo Início de sessão do SO não são visíveis nos metadados.

block-project-ssh-keys

Bloquear chaves SSH do projeto em VMs que usam chaves SSH baseadas em metadados.

Para mais informações, consulte o artigo Restrinja as chaves SSH de VMs.
disable-https-mds-setup

Desativa o aprovisionamento automático de certificados do servidor de metadados HTTPS pelo Compute Engine.

Para mais informações, consulte o artigo Ative a configuração automática de certificados.
enable-https-mds-native-cert-store

Permite que o Compute Engine adicione o certificado de raiz à loja de confiança do SO durante o aprovisionamento automático do certificado do servidor de metadados HTTPS.

Para mais informações, consulte o artigo Ativar o armazenamento de certificados de raiz na loja de confiança do SO.

Chaves de metadados de atributos de hóspedes predefinidas

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

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

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

Entrada de metadados Descrição
guestInventory/

Armazena o inventário do SO para a VM.

Recolhe e armazena informações detalhadas do SO. Isto inclui informações como o nome do anfitrião, a versão do kernel, a arquitetura e os detalhes dos pacotes instalados.

Para mais informações sobre o inventário do SO, consulte o artigo Veja detalhes do sistema operativo.

hostkeys/

Armazena chaves de anfitrião SSH. As chaves de anfitrião podem ser usadas para identificar um anfitrião ou uma máquina específicos.

Para obter informações sobre as chaves de anfitrião, consulte Armazenar chaves de anfitrião ativando os atributos de convidado.

O que se segue?