Visão geral da CLI gcloud

Esta página contém uma visão geral da Google Cloud CLI e seus recursos e padrões de comando comuns.

O que é a CLI gcloud?

A CLI do Google Cloud é um conjunto de ferramentas para criar e gerenciar recursos do Google Cloud. Você pode usar essas ferramentas para realizar muitas tarefas comuns de tarefas de plataforma pela linha de comando ou por scripts e outras automação.

Por exemplo, é possível usar a CLI gcloud para criar e gerenciar o seguinte:

  • 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 CLI gcloud para implantar o App Engine aplicativos, gerenciar a autenticação, personalizar a configuração local e realizar outras tarefas.

Fazer o download e instalar a CLI gcloud

A versão atual da CLI gcloud é 498.0.0.

Embora recomendemos o uso da versão atual da CLI gcloud, você também pode fazer o download e instalar versões anteriores no arquivo de download.

Se você estiver usando o Cloud Shell, a CLI gcloud está disponível automaticamente e você não precisa instalá-lo. Caso contrário, faça o download e instale a CLI gcloud e, em seguida, inicialize.

Por padrão, a CLI gcloud instala comandos que estão no nível de disponibilidade geral. A funcionalidade adicional é disponível na CLI gcloud componentes chamados alpha e beta. Esses componentes permitem que você use a CLI gcloud para trabalhar com o Bigtable, O Dataflow e outras partes do Google Cloud na versão anterior do que a disponibilidade geral.

Folha de referência da CLI gcloud

Para uma introdução rápida à CLI gcloud, confira uma lista das os comandos mais usados e para saber como eles são estruturados, consulte a Folha de referência da gcloud CLI.

Níveis de versão

Os comandos da CLI da 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.

Os componentes alpha e beta não são instalados por padrão quando você instala a CLI da gcloud. É preciso instalar esses componentes separadamente usando o comando gcloud components install. Se você tentar executar uma alfa ou beta e o componente correspondente não estiver instalado, a CLI gcloud solicita a instalação.

Grupos de comandos

Em cada nível de versão, os comandos da CLI gcloud são organizados em um hierarquia aninhada de grupos de comando, cada um representando um produto ou do Google Cloud ou dos subgrupos funcionais dele.

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 CLI da gcloud

É possível executar os comandos da CLI gcloud na linha de comando de scripts e outras automações, para por exemplo, ao usar o Jenkins para automatizar tarefas do Google Cloud.

Propriedades

As propriedades da CLI gcloud são configurações que afetar o comportamento da CLI gcloud ferramentas de visualização. Algumas dessas propriedades podem ser definidas por variáveis ou de comando. Nesse caso, o valor definido pela opção tem prioridade.

Como ativar recursos de acessibilidade

Para simplificar a experiência com o leitor de tela, a CLI gcloud vem com uma propriedade accessibility/screen_reader.

Para ativar a propriedade de acessibilidade, 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 de propriedades da CLI gcloud. Um funciona como um perfil.

Ao começar a usar a CLI da gcloud, você vai 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.

Opções globais

A CLI da gcloud fornece um conjunto de opções da CLI da gcloud que controlam o comportamento dos comandos a cada nível de invocação. Substituição das opções definidos nas propriedades da CLI gcloud.

Argumentos e opções posicionais

Embora os argumentos e as opções posicionais afetem a saída de uma há uma diferença sutil no uso da CLI gcloud casos de uso diferentes. 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 CLI da gcloud bem-sucedidos é gravada em stdout. Todos os outros tipos de respostas (solicitações, avisos e erros) gravado em stderr. Não crie um script com base nas respostas gravadas em stderr porque essas respostas 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 proteger você contra ações destrutivas não intencionais, a CLI da gcloud confirma suas intenções antes de executar comandos como gcloud projects delete.

Você poderá receber um aviso quando precisar de mais informações. Por exemplo, é preciso escolher uma zona ao criar uma Compute Engine instância de máquina virtual usando gcloud compute instances create test-instance.

Para desativar as solicitações, use a opçã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 opção --quiet (também, -q) para a CLI gcloud desativa todos os prompts interativos ao executar comandos da CLI gcloud. e é útil para scripting. 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 opçã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 opção --verbosity.

Determinar a estrutura da saída

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

Para definir apenas o formato de sua saída, use o comando A opção --format para produzir uma tabela ou simplificada de sua saída (para exibição interativa) ou uma versão da saída legível por máquina (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