Visão geral da ferramenta gcloud

Esta página contém uma visão geral da ferramenta de linha de comando gcloud e dos padrões e recursos comuns de comando dela.

O que é a ferramenta gcloud?

A ferramenta de linha de comando gcloud é a principal ferramenta de CLI para criar e gerenciar recursos do Google Cloud. É possível usar essa ferramenta para realizar muitas tarefas de plataforma comuns pela linha de comando ou em scripts e outras automações.

Por exemplo, é possível usar a ferramenta gcloud para criar e gerenciar:

  • Instâncias de máquina virtual do Compute Engine e outros recursos
  • Instâncias do Cloud SQL
  • Clusters do Google Kubernetes Engine
  • Clusters e jobs do Dataproc
  • Zonas gerenciadas e conjuntos de registros do Cloud DNS
  • Implantações do Cloud Deployment Manager

Também é possível usar a ferramenta gcloud para implantar aplicativos do App Engine, gerenciar a autenticação, personalizar a configuração local e realizar outras tarefas. Para saber mais sobre os recursos da ferramenta gcloud, consulte a referência da ferramenta gcloud.

Folha de referência da ferramenta gcloud

Para uma introdução rápida à ferramenta gcloud, uma lista de comandos comumente usados e uma análise da estrutura desses comandos, consulte a folha de referência da ferramenta gcloud.

A ferramenta gcloud e o SDK do Cloud

A ferramenta gcloud faz parte do SDK do Cloud. Antes de usar a ferramenta gcloud, é necessário fazer o download e instalar o SDK do Cloud no seu sistema e inicializar o SDK do Cloud.

Por padrão, o SDK do Cloud instala os comandos da ferramenta gcloud que estão no nível de disponibilidade geral. Outras funcionalidades estão disponíveis nos componentes do SDK do Cloud nomeados alpha e beta. Esses componentes permitem que você use a ferramenta gcloud para trabalhar com o Cloud Bigtable, o Dataflow e outras partes do Google Cloud em níveis de versão anterior à disponibilidade geral.

As versões da ferramenta gcloud têm o mesmo número de versão que o SDK do Cloud. A versão atual do SDK do Cloud é 370.0.0. É possível fazer o download e instalar versões anteriores do SDK do Cloud no arquivo de download.

Como fazer o download da ferramenta gcloud

É possível fazer o download da versão mais recente do SDK do Cloud, que inclui a ferramenta gcloud, na página de download.

Níveis de versão

Os comandos da ferramenta gcloud têm os seguintes níveis de versão:

Nível de versão Rótulo Descrição
Disponibilidade geral Nenhum Os comandos são considerados totalmente estáveis e disponíveis para uso da produção. Para saber sobre mudanças nos comandos que interrompem a funcionalidade atual, consulte as notas de lançamento.
Beta beta Os comandos são funcionalmente completos, mas ainda podem ter alguns problemas pendentes. Nesses comandos, as alterações interruptivas podem ser feitas sem aviso prévio.
Alfa alpha Os comandos estão na versão inicial e podem mudar sem aviso.

Quando você instala o SDK do Cloud, os componentes alpha e beta não são instalados por padrão. É preciso instalar esses componentes separadamente usando o comando gcloud components install. Se você tentar executar um comando Alfa ou Beta e o componente correspondente não estiver instalado, a ferramenta gcloud solicitará que você o instale.

Grupos de comandos

Dentro de cada nível da versão, os comandos da ferramenta gcloud são organizados em uma hierarquia aninhada de grupos de comandos. Cada um desses grupos representa um produto ou um recurso do Google Cloud ou os respectivos subgrupos funcionais.

Exemplo:

Grupo de comandos Descrição
gcloud compute Comandos relacionados ao Compute Engine em disponibilidade geral
gcloud compute instances Comandos relacionados a instâncias do Compute Engine em disponibilidade geral
gcloud beta compute Comandos relacionados ao Compute Engine em Beta
gcloud alpha app Comandos relacionados ao gerenciamento de implantações do App Engine em Alfa

Como executar comandos da ferramenta gcloud

É possível executar comandos da ferramenta gcloud pela linha de comando da mesma maneira que usa outras ferramentas de linha de comando. Também é possível executar comandos da ferramenta gcloud a partir de scripts e outras automações, por exemplo, ao usar o Jenkins para automatizar tarefas do Google Cloud.

Propriedades

As propriedades da ferramenta gcloud são configurações que afetam o comportamento da ferramenta gcloud e de outras ferramentas do SDK do Cloud. Algumas dessas propriedades podem ser definidas por sinalizações globais ou de comando. Nesse caso, o valor definido pela sinalização tem precedência.

Como ativar recursos de acessibilidade

Para uma experiência mais simples do leitor de tela, a ferramenta gcloud vem com uma propriedade accessibility/screen_reader.

Para ativar essa propriedade, execute:

gcloud config set accessibility/screen_reader true

Para mais detalhes sobre os recursos de acessibilidade que acompanham a ferramenta de linha de comando gcloud, consulte o guia Como ativar os recursos de acessibilidade.

Configurações

Uma configuração é um conjunto nomeado de propriedades da ferramenta gcloud. Uma configuração funciona como um perfil.

Ao começar a usar o SDK do Cloud, você trabalhará com uma única configuração chamada default e poderá definir propriedades executando gcloud init ou gcloud config set. Essa configuração padrão única é adequada para a maioria dos casos de uso.

Para trabalhar com vários projetos ou contas de autorização, é possível definir várias configurações com gcloud config configurations create e alternar entre as configurações. Em uma configuração, é possível personalizar propriedades. Por exemplo, para definir seu projeto em uma configuração ativa, use a propriedade project.

gcloud config set project <project-id>

Para uma descrição detalhada desses conceitos, consulte o Guia de configurações.

Sinalizações globais

A ferramenta gcloud oferece um conjunto de sinalizações na ferramenta gcloud que controlam o comportamento dos comandos a cada invocação. As sinalizações substituem os valores configurados nas propriedades do SDK do Cloud.

Sinalizações e argumentos posicionais

As sinalizações e os argumentos posicionais afetam a saída de um comando da ferramenta gcloud, mas há uma diferença sutil entre os casos de uso de cada um. O argumento posicional é usado para definir uma entidade em que um comando opera. Já a sinalização é necessária para definir uma variação no comportamento de um comando.

Uso de stdout e stderr

A saída dos comandos da ferramenta gcloud é gravada em stdout. Todos os outros tipos de resposta, como solicitações, avisos e erros, são gravados em stderr. Não crie scripts para respostas gravadas em stderr porque elas não são estáveis.

Para ver diretrizes sobre como processar a saída, consulte o Guia de script.

Solicitações de prompt

Para se proteger contra ações destrutivas não intencionais, a ferramenta gcloud confirma as intenções antes de executar comandos como gcloud projects delete.

As solicitações também serão exibidas se você criar uma instância de máquina virtual do Compute Engine usando gcloud compute instances create test-instance. Você precisará escolher uma zona para criar a instância.

Para desativar a solicitação de prompts, use a sinalização --quiet.

Não crie scripts no texto das solicitações porque o texto pode mudar.

Como suprimir solicitações, gravar no terminal e gerar registros

A sinalização --quiet (também -q) para a ferramenta gcloud desativa todas as solicitações interativas ao executar comandos da ferramenta gcloud e é útil para scripts. Se uma entrada for necessária, os padrões serão usados. Se não houver um padrão, um erro será gerado.

Para suprimir a impressão da resposta ao comando para a saída padrão e o erro padrão no terminal, use a sinalização --no-user-output-enabled.

Para ajustar o nível de detalhes dos registros, especifique um nível de detalhamento (depuração, informação, aviso, erro, crítico ou nenhum) usando a sinalização --verbosity.

Determinar a estrutura da saída

Por padrão, quando um comando de ferramenta gcloud retorna uma lista de recursos, os recursos são impressos para a saída padrão. Para produzir resultados mais significativos, as sinalizações format, filter e projection permitem ajustar a saída.

Para definir apenas o formato da saída, use a sinalização --format para produzir uma versão tabular ou nivelada da saída (para exibição interativa) ou uma versão legível por máquina da saída (json, csv, yaml, value).

Para formatar uma lista de chaves que selecionam valores de dados de recursos, use projections. Para refinar ainda mais sua saída para os critérios definidos, use filter.

Clique no botão Abrir no Cloud Shell para se familiarizar com a funcionalidade de filtragem e formatação e concluir um tutorial interativo rápido.

Abrir no Cloud Shell

A seguir