gcloud compute

A ferramenta de linha de comando gcloud permite gerenciar os recursos do Compute Engine usando o grupo de comandos gcloud compute. gcloud compute é uma alternativa ao uso da API Compute Engine.

A ferramenta de linha de comando unificada gcloud faz parte do SDK do Cloud e inclui recursos como preenchimento automático de instruções, atualização no local, ajuda da linha de comando e formatos de saída legíveis por humanos e compatíveis com máquina, além da integração com o SDK do Cloud.

Se você nunca usou o Compute Engine, confira o Guia de início rápido do Linux ou o Guia de início rápido do Windows.

Antes de começar

  • Se você quiser executar gcloud compute em um prompt de comando, instale, atualize e inicialize o SDK do Cloud.
  • Se você não tiver um prompt de comando disponível, tente usar gcloud compute no Cloud Shell. O Cloud Shell é instalado, atualizado e inicializado automaticamente com o SDK do Cloud mais recente.

Propriedades padrão

Ao criar uma instância de máquina virtual, o Compute Engine configura uma VM usando as propriedades padrão do servidor de metadados. Verifique as propriedades padrão da VM executando o seguinte comando:

gcloud compute project-info describe --project PROJECT_ID

Substitua PROJECT_ID pela ID do seu projeto.

Projeto padrão

Se você definir um projeto padrão ao configurar e inicializar o SDK do Cloud, todos os comandos gcloud compute usarão esse ID do projeto por padrão.

É possível substituir o ID do projeto padrão usando um dos seguintes métodos:

  • Execute cada comando gcloud compute com a sinalização --project.

  • Defina a variável de ambiente CLOUDSDK_CORE_PROJECT.

    Linux e macOS

    Use o comando export para definir a variável de ambiente do projeto.

    export CLOUDSDK_CORE_PROJECT=PROJECT_ID

    Substitua PROJECT_ID pelo ID do projeto que você quer usar como padrão.

    Como desativar variáveis de ambiente do projeto

    Se você precisar desativar as variáveis de ambiente do projeto, use os seguintes comandos unset:

    unset CLOUDSDK_CORE_PROJECT

    Windows

    Use o comando set para definir a variável de ambiente do projeto.

    set CLOUDSDK_CORE_PROJECT=PROJECT_ID

    Substitua PROJECT_ID pelo ID do projeto que você quer usar como padrão.

    Como desativar variáveis de ambiente do projeto

    Se você precisar desativar as variáveis de ambiente do projeto, use o seguinte comando:

    set CLOUDSDK_CORE_PROJECT=

Se você não definir um projeto ou variável de ambiente padrão, precisará incluir uma sinalização --project em cada comando gcloud compute que executar.

Região e zona padrão

Alguns comandos gcloud compute exigem sinalizações --region ou --zone. Em vez de especificar essas sinalizações sempre que você executar comandos, defina uma região e zona padrão para o projeto. Se você não definir uma região ou zona padrão e executar um comando que depende de região ou zona, a ferramenta de linha de comando gcloud poderá solicitar que você forneça uma sinalização--region ou --zone, ou retornará um erro.

É possível definir a região e a zona padrão de três maneiras:

  • No servidor de metadados. A região e a zona padrão definidas no servidor de metadados são aplicadas ao seu cliente local quando você executa gcloud init.
  • No seu cliente local. A região e a zona padrão definidas no seu cliente local modificam a região e a zona padrão definidas no servidor de metadados.
  • Nas variáveis de ambiente. A região e a zona padrão definidas nas variáveis de ambiente modificam a região e a zona padrão definidas no cliente local e no servidor de metadados.

É possível substituir a região e a zona padrão no servidor de metadados, no cliente local ou nas variáveis de ambiente fornecendo as sinalizações --region e --zone ao: executar comandos.

Ver região e zona padrão

Para visualizar a região e zona padrão, execute os seguintes comandos:

gcloud config get-value compute/region
gcloud config get-value compute/zone

Se a saída for (unset), nenhuma região ou zona padrão será definida.

Ver regiões e zonas disponíveis

É possível ver uma lista das regiões e zonas executando os seguintes comandos:

gcloud compute regions list
gcloud compute zones list

Definir a região e a zona padrão no servidor de metadados

A região e a zona padrão no servidor de metadados aplicam-se a todas as configurações no seu projeto. Para definir a região e a zona padrão no servidor de metadados, faça o seguinte:

  1. Defina a região e a zona padrão:

    gcloud compute project-info add-metadata \
   --metadata google-compute-default-region=REGION,google-compute-default-zone=ZONE

    Por exemplo:

    gcloud compute project-info add-metadata \
   --metadata google-compute-default-region=europe-west1,google-compute-default-zone=europe-west1-b

  2. Inicialize a alteração no seu cliente local:

    gcloud init

É possível substituir a região e a zona padrão definidas no servidor de metadados. Basta definir a região e a zona padrão no seu cliente local, definindo a região e a zona padrão nas variáveis de ambiente ou incluindo a sinalização --zone ou --region nos comandos.

Não definir a região e a zona padrão no servidor de metadados

Para desativar a região e a zona padrão no servidor de metadados, faça o seguinte:

  1. Não definir metadados:

    gcloud compute project-info remove-metadata \
   --keys=google-compute-default-region,google-compute-default-zone

  2. Inicialize a alteração no seu cliente local:

    gcloud init

Definir a região e a zona padrão no seu cliente local

A região e a zona padrão definidas no seu cliente local modificam a região e a zona padrão definidas no servidor de metadados.

Para definir a região e a zona padrão no seu cliente local, execute os seguintes comandos:

gcloud config set compute/region REGION

gcloud config set compute/zone ZONE

Não definir a região e a zona padrão no seu cliente local

Para desativar a definição da região ou zona padrão no cliente local, execute os seguintes comandos:

gcloud config unset compute/zone

gcloud config unset compute/region

É possível modificar a região e a zona padrão definidas no cliente local definindo a região e a zona padrão nas variáveis de ambiente ou incluindo a sinalização --zone ou --region nos comandos.

Definir a região e a zona padrão nas variáveis de ambiente

A região e a zona padrão definidas nas variáveis de ambiente modificam a região e a zona padrão definidas no cliente local e no servidor de metadados.

Linux e macOS

Use o comando export para definir as variáveis de região e zona.

export CLOUDSDK_COMPUTE_REGION=REGION

export CLOUDSDK_COMPUTE_ZONE=ZONE

Para tornar essas variáveis de ambiente permanentes, inclua esses comandos no arquivo ~/.bashrc e reinicie o terminal.

Windows

Use o comando set para definir as variáveis de região e zona.

set CLOUDSDK_COMPUTE_REGION=REGION

set CLOUDSDK_COMPUTE_ZONE=ZONE

É possível substituir as variáveis de ambiente por meio da inclusão da sinalização --zone ou --region nos comandos.

Não definir a região e a zona padrão nas variáveis de ambiente

Use os comandos a seguir para desativar a região e a zona padrão nas variáveis de ambiente.

Linux e macOS

Para desativar a definição das variáveis de ambiente de zona e região, use os seguintes comandos unset:

unset CLOUDSDK_COMPUTE_REGION

unset CLOUDSDK_COMPUTE_ZONE

Windows

Para desativar a definição das variáveis de ambiente de zona e região, use os seguintes comandos:

set CLOUDSDK_COMPUTE_REGION=

set CLOUDSDK_COMPUTE_ZONE=

Substituir a zona padrão com sinalizações

Use a sinalização --zone para substituir a zona padrão definida no servidor de metadados, no cliente local e nas variáveis de ambiente.

Exemplo:

gcloud compute instances create example-instance \
    --zone=ZONE

Configurações

gcloud topic configurations é um recurso avançado que pode ser usado para influenciar o comportamento da ferramenta gcloud. Para a maioria dos usuários, o uso das configurações padrão é suficiente.

As configurações podem ser úteis para usuários que:

  • trabalhem com vários projetos. É possível criar uma configuração separada para cada projeto;
  • usem várias contas. Por exemplo, uma conta de usuário e uma conta de serviço;
  • executem várias tarefas independentes (trabalham em um aplicativo do App Engine em um projeto, administram um cluster do Compute Engine na zona us-central-1a, gerenciam as configurações de rede para a região asia-east-1 etc.).

Para alternar entre elas, execute o seguinte comando:

gcloud config configurations activate CONFIGURATION_NAME

Para mais informações sobre como gerenciar configurações, consulte gcloud config configurations.

A seguir