Visão geral da CLI gcloud

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

O que é a CLI gcloud?

A CLI do Google Cloud é um conjunto de ferramentas para criar e gerenciar recursos do Google Cloud. É possível usar essas ferramentas para realizar muitas tarefas comuns de plataforma na linha de comando ou por meio de 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 aplicativos do App Engine, gerenciar a autenticação, personalizar a configuração local e realizar outras tarefas.

Folha de referência da CLI gcloud

Para uma introdução rápida sobre a CLI gcloud, uma lista de comandos usados com frequência e uma visão de como esses comandos são estruturados, consulte a Folha de referência da CLI gcloud.

Fazer o download e instalar a CLI gcloud

Se você estiver usando o Cloud Shell, a CLI gcloud estará disponível automaticamente e não será necessário instalá-la. Caso contrário, faça o download da CLI gcloud e instale-a. Em seguida, inicialize-a.

Por padrão, a CLI da gcloud instala comandos que estão no nível de disponibilidade geral. Há outros recursos disponíveis nos componentes da CLI gcloud chamados alpha e beta. Esses componentes permitem usar a CLI gcloud para trabalhar com o Cloud Bigtable, o Dataflow e outras partes do Google Cloud em níveis da versão anterior à de disponibilidade geral.

A versão atual da CLI gcloud é 391.0.0. Faça o download e a instalação de versões anteriores da CLI gcloud no arquivo de download.

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 Nenhuma 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 gcloud. É 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 CLI do gcloud solicitará que você o instale.

Grupos de comandos

Em cada nível de versão, os comandos da CLI gcloud são organizados em uma hierarquia aninhada de grupos de comando, cada um representando um produto ou recurso do Google Cloud ou dos 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 CLI da gcloud

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

Propriedades

As propriedades da CLI do gcloud são configurações que afetam o comportamento das ferramentas da CLI do gcloud. Algumas dessas propriedades podem ser definidas por opções globais ou de comando. Nesse caso, o valor definido pela opção tem prioridade.

Como ativar recursos de acessibilidade

Para uma experiência de leitor de tela mais simplificada, 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. Uma configuração funciona como um perfil.

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

Opções globais

A CLI gcloud fornece um conjunto de opções da CLI gcloud que controlam o comportamento dos comandos a cada invocação. As opções substituem os valores definidos nas propriedades da CLI gcloud.

Argumentos e opções posicionais

Embora as opções e os argumentos posicionais afetem a saída de um comando da CLI do gcloud, há uma pequena diferença nos casos de uso. Um argumento posicional é usado para definir uma entidade em que um comando opera enquanto as opções são necessárias para definir uma variação no comportamento de um comando.

Uso de stdout e stderr

A saída dos comandos de CLI gcloud bem-sucedidos é gravada em stdout. Todos os outros tipos de resposta, como solicitações, avisos e erros, são gravados no stderr. Não faça o script com 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 gcloud confirma suas intenções antes de executar comandos como gcloud projects delete.

Talvez você receba uma solicitação quando mais informações forem necessárias. Por exemplo, você precisará escolher uma zona ao criar uma instância de máquina virtual do Compute Engine 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 de prompt, fazer gravações no terminal e gerar registros

A opção --quiet, também -q, para a CLI da gcloud desativa todos os prompts interativos quando os comandos da CLI da gcloud são executados 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 saída do 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 verbosidade (depuração, informações, aviso, erro, crítico ou nenhum) usando a opção --verbosity.

Como 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 pouco impressos na saída padrão. Para produzir uma saída mais significativa, as opções format, filter e projection permitem ajustar a saída.

Para definir apenas o formato da sua saída, use a opção --format para produzir uma versão tabular ou nivelada da sua 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