Comandos comuns da gcloud compute

Este documento lista alguns dos comandos gcloud compute mais usados.

Antes de começar

  • Configure a autenticação, caso ainda não tenha feito isso. A autenticação é o processo de verificação da sua identidade para acesso a serviços e APIs do Google Cloud. Para executar códigos ou amostras de um ambiente de desenvolvimento local, autentique-se no Compute Engine da seguinte maneira.

    1. Instale a Google Cloud CLI e inicialize-a executando o seguinte comando: 

      gcloud init
    2. Defina uma região e uma zona padrão.

Como descrever projetos

Execute o seguinte comando para consultar informações sobre o projeto do Compute Engine, como metadados do projeto, chaves ssh e métricas de cota:

 gcloud compute project-info describe

Para mais informações sobre como descrever seu projeto, consulte a documentação de referência gcloud compute project-info describe.

Como trabalhar com VMs

Os exemplos a seguir mostram tarefas comuns ao trabalhar com instâncias de máquina virtual (VM). Para mais informações sobre instâncias de máquina virtual (VM), consulte Instâncias de máquina virtual.

Como criar VMs

Execute o comando a seguir para criar uma identidade de serviço:

gcloud compute instances create VM_NAME \
    [--image IMAGE | --image-family IMAGE_FAMILY] \
    --image-project IMAGE_PROJECT

Substitua:

  • VM_NAME: o nome da nova VM.
  • IMAGE ou IMAGE_FAMILY: especifique uma das seguintes opções:
    • IMAGE: versão obrigatória de uma imagem pública. Por exemplo, --image debian-10-buster-v20200309.
    • IMAGE_FAMILY: uma família de imagens. Isso cria a VM a partir da imagem do SO mais recente e não obsoleta. Por exemplo, se você especificar --image-family debian-10, o Compute Engine criará uma VM a partir da versão mais recente da imagem do SO na família de imagens Debian 10.
  • IMAGE_PROJECT: o projeto que contém a imagem.

Para mais informações sobre como criar VMs, consulte Como criar e iniciar uma instância de VM e a documentação de referência de gcloud compute instances create.

Como listar VMs

Execute o seguinte comando para exibir todas as VMs de um projeto:

gcloud compute instances list

Para mais informações sobre como listar VMs, consulte a documentação de referência gcloud compute instances list.

Como listar VMs com GPUs

Execute o seguinte comando para exibir todas as VMs com GPUs em um projeto:

gcloud compute instances list --filter="guestAccelerators.acceleratorCount>0" --format="table(name,zone,guestAccelerators.acceleratorType,guestAccelerators.acceleratorCount,disks.type)"

Como listar VMs com SSDs locais

Execute o seguinte comando para exibir todas as VMs com SSDs locais em um projeto:

gcloud compute instances list  --filter="disks.type='SCRATCH'"  --format="table(name,zone,guestAccelerators.acceleratorType,guestAccelerators.acceleratorCount,disks.type)"

Como descrever VMs

Execute o seguinte comando para exibir todos os dados associados a uma VM:

gcloud compute instances describe VM_NAME

Substitua VM_NAME pelo nome da VM.

Para mais informações sobre como descrever VMs, consulte a documentação de referência gcloud compute instances describe.

Como iniciar VMs

Execute o seguinte comando para iniciar uma VM interrompida:

gcloud compute instances start VM_NAME

Substitua VM_NAME pelo nome da VM.

Para mais informações sobre como iniciar VMs, consulte Como iniciar e interromper uma instância e a documentação de referência gcloud compute instances start.

Como interromper VMs

Execute o seguinte comando para interromper uma VM:

gcloud compute instances stop VM_NAME

Substitua VM_NAME pelo nome da VM.

Para mais informações sobre como interromper VMs, consulte Como iniciar e interromper uma instância e a documentação de referência gcloud compute instances stop.

Como adicionar rótulos às VMs

Execute o seguinte comando para adicionar rótulos às VMs:

gcloud compute instances add-labels VM_NAME \
    --labels=KEY=VALUE

Substitua:

  • VM_NAME: o nome da VM.
  • KEY=VALUE: o par de chave-valor do rótulo.

Para mais informações sobre como rotular VMs, consulte Como rotular recursos e a documentação de referência gcloud compute instances add-labels.

Como se conectar a VMs

Como usar SSH para se conectar a instâncias

Execute o seguinte comando para se conectar a uma VM usando SSH:

gcloud compute ssh VM_NAME

Substitua VM_NAME pelo nome da VM.

Para mais informações sobre como se conectar a VMs usando SSH, consulte a seção Como se conectar a VMs do Linux e a documentação de referência de gcloud compute ssh (em inglês).

Como usar o SCP para transferir arquivos para instâncias

Execute este comando para copiar os arquivos em uma VM:

gcloud compute scp LOCAL_FILE_PATH VM_NAME:REMOTE_DIRECTORY

Execute o seguinte comando para copiar arquivos de uma VM:

gcloud compute scp VM_NAME:REMOTE_DIRECTORY LOCAL_FILE_PATH

Substitua:

  • LOCAL_FILE_PATH: o caminho do arquivo na estação de trabalho.
  • VM_NAME: o nome da VM.
  • REMOTE_DIRECTORY: o caminho para o diretório na VM.

Para mais informações sobre como transferir arquivos de e para VMs usando o SCP, consulte Como transferir arquivos usando a CLI do Google Cloud e o gcloud compute scp documentação de referência.

Como trabalhar com discos

O exemplo a seguir mostra uma tarefa comum ao trabalhar com discos. Para mais informações sobre discos, consulte Opções de armazenamento.

Como listar discos

Execute o seguinte comando para exibir todos os discos em um projeto:

gcloud compute disks list

Para mais informações sobre como listar discos, consulte a documentação de referência gcloud compute disks list.

Como trabalhar com snapshots

Veja a seguir os exemplos de tarefas comuns ao trabalhar com snapshots. Para mais informações, consulte Snapshots de discos permanentes.

Como listar snapshots

Execute o seguinte comando para exibir todos os snapshots em um projeto:

gcloud compute snapshots list

Para mais informações sobre como descrever snapshots, consulte a documentação de referência gcloud compute snapshots list.

Como descrever snapshots

Execute o seguinte comando para exibir todos os dados associados a um snapshot:

gcloud compute snapshots describe SNAPSHOT_NAME

Substitua SNAPSHOT_NAME pelo nome do snapshot.

Para mais informações sobre como descrever snapshots, consulte a documentação de referência gcloud compute snapshots describe.

Excluindo snapshots

Execute o seguinte comando para excluir um snapshot:

gcloud compute snapshots delete SNAPSHOT_NAME

Substitua SNAPSHOT_NAME pelo nome do snapshot.

Para mais informações sobre como excluir snapshots, consulte Como excluir um snapshot e a documentação de referência de gcloud compute snapshots delete.

Como trabalhar com regras de firewall

Os exemplos a seguir mostram tarefas comuns ao trabalhar com regras de firewall. Para mais informações sobre regras de firewall, consulte Visão geral das regras de firewall da VPC.

Como descrever regras de firewall

Execute o seguinte comando para exibir todos os dados associados a uma regra de firewall:

gcloud compute firewall-rules describe FIREWALL_RULE_NAME

Substitua FIREWALL_RULE_NAME pelo nome da regra de firewall.

Para mais informações sobre como descrever regras de firewall, consulte a documentação de referência gcloud compute firewall-rules describe.

Criar regras de firewall

Execute o comando a seguir para criar uma regra de firewall:

gcloud compute firewall-rules create FIREWALL_RULE_NAME \
    [--allow=PROTOCOL:PORT | --action=ACTION --rules=PROTOCOL:PORT]

Especifique --allow ou --action e --rules e substitua o seguinte:

  • FIREWALL_RULE_NAME: o nome da regra de firewall.
  • ACTION: a ação na correspondência. Que que pode ser allow ou deny.
  • PROTOCOL:PORT: o protocolo e a porta cujo tráfego será afetado pela regra de firewall.

Para mais informações sobre como criar regras de firewall, consulte Como criar regras de firewall e a documentação de referência de gcloud compute firewall-rules create.

Como trabalhar com grupos gerenciados de instâncias (MIGs, na sigla em inglês)

Veja a seguir os exemplos de tarefas comuns ao trabalhar com MIGs. Para mais informações sobre MIGs, consulte Grupos gerenciados de instâncias (MIGs).

Como criar grupos de instâncias gerenciadas

Execute o comando a seguir para criar uma MIG:

gcloud compute instance-groups managed create INSTANCE_GROUP_NAME \
    --size=SIZE \
    --template=INSTANCE_TEMPLATE

Substitua:

  • INSTANCE_GROUP_NAME: o nome desse grupo de instâncias
  • SIZE: o tamanho do grupo de instâncias
  • INSTANCE_TEMPLATE: o nome do modelo de instância a ser usado para este grupo

Para mais informações sobre como criar MIGs, consulte Cenários básicos para criar um MIG e a documentação de referência do gcloud compute instance-groups managed create.

Como configurar o escalonamento automático

Execute o seguinte comando para definir o escalonamento automático em um MIG com base na utilização da CPU:

gcloud compute instance-groups managed set-autoscaling INSTANCE_GROUP_NAME \
    --max-num-replicas=MAX_NUM_REPLICAS \
    --target-cpu-utilization=TARGET_CPU_UTILIZATION

Substitua:

  • INSTANCE_GROUP_NAME: o nome de um MIG
  • MAX_NUM_REPLICAS: o número máximo de réplicas que o escalonador automático pode criar
  • TARGET_CPU_UTILIZATION: o nível de CPU que o escalonador automático deve manter, entre 0.0 e 1.0

Para mais informações sobre como configurar o escalonamento automático, consulte Escalonamento automático de grupos de instâncias e a documentação de referência de gcloud compute instance-groups managed set-autoscaling.

Como trabalhar com metadados

O exemplo a seguir mostra uma tarefa comum ao trabalhar com metadados. Para mais informações sobre metadados, consulte Como armazenar e recuperar metadados.

Como adicionar metadados no nível do projeto

Execute o seguinte comando para adicionar metadados ao seu projeto:

gcloud compute project-info add-metadata VM_NAME \
    --metadata=KEY=VALUE,[KEY=VALUE]

Substitua:

  • VM_NAME: O nome da VM.
  • KEY=VALUE: o par de chave-valor de metadados

Para mais informações sobre como adicionar metadados a VMs, consulte Como configurar metadados personalizados de projeto e a documentação de referência de gcloud compute project-info add-metadata.

Como adicionar metadados no nível da instância

Execute o seguinte comando para adicionar metadados a uma VM:

gcloud compute instances add-metadata VM_NAME \
    --metadata=KEY=VALUE,[KEY=VALUE]

Substitua:

  • VM_NAME: O nome da VM.
  • KEY=VALUE: o par de chave-valor de metadados

Para mais informações sobre como adicionar metadados a VMs, consulte Como configurar metadados de instância e a documentação de referência gcloud compute instances add-metadata.

Como acessar páginas de ajuda

Use os comandos a seguir para saber como acessar diferentes tipos de ajuda, desde a ajuda geral sobre o comando gcloud compute até a ajuda específica sobre um grupo de recursos (instances) ou um comando (create). A ajuda abrangente para todos os recursos e comandos segue esse padrão:

gcloud compute --help
gcloud compute instances --help
gcloud compute instances create --help

É possível receber ajuda rápida usando a sinalização -h em vez da sinalização --help. Revise todo o conteúdo de ajuda abrangente em Referência da CLI do Google Cloud.

Para ajuda abrangente especificamente com comandos para configurar a CLI gcloud, execute:

gcloud topic TOPIC

Substitua TOPIC pelo tópico em que você quer ajuda. Para ver uma lista de tópicos que têm recursos de ajuda disponíveis, consulte a documentação de referência de gcloud topic.

A seguir