Comandos comuns de computação do gcloud

Este documento lista alguns dos comandos gcloud compute mais comumente usados.

Antes de começar

  • Se ainda não o fez, configure a autenticação. Autenticação é o processo pelo qual sua identidade é verificada para acesso a Google Cloud serviços e APIs. Para executar códigos ou amostras em um ambiente de desenvolvimento local, você pode se autenticar no Compute Engine selecionando uma das seguintes opções:

    1. After installing the Google Cloud CLI, initialize it by running the following command: 

      gcloud init

      If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

    2. Set a default region and zone.

Descrevendo projetos

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

 gcloud compute project-info describe

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

Trabalhando com VMs

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

Criando VMs

Execute o seguinte comando para criar uma VM:

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

Substitua o seguinte:

  • VM_NAME : o nome da nova VM.
  • IMAGE ou IMAGE_FAMILY : especifique um dos seguintes:
    • 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 sistema operacional 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 sistema operacional na família de imagens Debian 10.
  • IMAGE_PROJECT : o projeto que contém a imagem.

Para obter mais informações sobre a criação de VMs, consulte Criação e início de uma instância de VM e a documentação de referência gcloud compute instances create .

Listando VMs

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

gcloud compute instances list

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

Listando 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)"

Listando 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)"

Descrevendo 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 obter mais informações sobre a descrição de VMs, consulte a documentação de referência gcloud compute instances describe .

Iniciando VMs

Execute o seguinte comando para iniciar uma VM parada:

gcloud compute instances start VM_NAME

Substitua VM_NAME pelo nome da VM.

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

Parando VMs

Execute o seguinte comando para parar uma VM:

gcloud compute instances stop VM_NAME

Substitua VM_NAME pelo nome da VM.

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

Adicionando 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 o seguinte:

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

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

Conectando-se a VMs

Usando SSH para conectar-se a instâncias

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

gcloud compute ssh VM_NAME

Substitua VM_NAME pelo nome da VM.

Para obter mais informações sobre como se conectar a VMs usando SSH, consulte Conectar-se a VMs Linux e a documentação de referência gcloud compute ssh .

Usando SCP para transferir arquivos para instâncias

Execute o seguinte comando para copiar arquivos para 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 o seguinte:

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

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

Trabalhando com discos

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

Listando discos

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

gcloud compute disks list

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

Trabalhando com instantâneos

Os exemplos a seguir mostram tarefas comuns ao trabalhar com snapshots. Para obter mais informações sobre snapshots, consulte Snapshots de discos permanentes .

Listando instantâneos

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

gcloud compute snapshots list

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

Descrevendo instantâneos

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 instantâneo.

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

Excluindo instantâneos

Execute o seguinte comando para excluir um snapshot: 

gcloud compute snapshots delete SNAPSHOT_NAME

Substitua SNAPSHOT_NAME pelo nome do instantâneo.

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

Trabalhando com regras de firewall

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

Descrevendo 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 obter mais informações sobre a descrição de regras de firewall, consulte a documentação de referência gcloud compute firewall-rules describe .

Criando regras de firewall

Execute o seguinte comando 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 partida. allow ou deny .
  • PROTOCOL : PORT : o protocolo e a porta cujo tráfego será afetado pela regra de firewall.

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

Trabalhar com grupos de instâncias gerenciadas (MIGs)

Os exemplos a seguir mostram tarefas comuns ao trabalhar com MIGs. Para obter mais informações sobre MIGs, consulte Grupos de instâncias gerenciadas (MIGs) .

Como criar grupos de instâncias gerenciadas

Execute o seguinte comando para criar um MIG: 

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

Substitua o seguinte:

  • INSTANCE_GROUP_NAME : o nome deste 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 obter mais informações sobre a criação de MIGs, consulte Cenários básicos para a criação de um MIG e a documentação de referência gcloud compute instance-groups managed create .

Configurando 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 o seguinte:

  • 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 autoescalador deve manter, entre 0.0 e 1.0

Para obter 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 gcloud compute instance-groups managed set-autoscaling .

Trabalhando com metadados

O exemplo a seguir mostra uma tarefa comum ao trabalhar com metadados. Para obter mais informações sobre metadados, consulte Armazenando e recuperando metadados .

Adicionando 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 o seguinte:

  • VM_NAME : o nome da VM
  • KEY = VALUE : o par chave-valor dos metadados

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

Adicionando metadados em nível de 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 o seguinte:

  • VM_NAME : o nome da VM
  • KEY = VALUE : o par chave-valor dos metadados

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

Obtendo páginas de ajuda

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

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

Ajuda rápida pode ser obtida usando o sinalizador -h em vez do sinalizador --help . Você também pode revisar toda a ajuda abrangente em Referência da CLI do Google Cloud .

Para obter ajuda abrangente com comandos específicos para configurar a CLI gcloud, execute: 

gcloud topic TOPIC

Substitua TOPIC pelo tópico para o qual deseja ajuda. Para obter uma lista de tópicos para os quais você pode obter ajuda, consulte a documentação de referência gcloud topic .

O que vem a seguir?