Visão geral da ferramenta de linha de comando 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 de linha de comando gcloud?

A interface de linha de comando gcloud é a principal ferramenta da 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, use a CLI da gcloud para criar e gerenciar:

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

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

A folha de referência da ferramenta de linha de comando gcloud

Para uma rápida introdução à ferramenta de linha de comando gcloud, uma lista de comandos mais usados e uma visão de como esses comandos são estruturados, consulte a folha de referência da ferramenta de linha de comando gcloud.

A CLI da gcloud e o SDK do Cloud

A CLI do gcloud faz parte do SDK do Google Cloud. Faça o download e a instalação do SDK no sistema e inicialize-o antes de usar a ferramenta de linha de comando gcloud.

Por padrão, o SDK instala os comandos da CLI da gcloud que estão apenas no nível de disponibilidade geral. Outras funcionalidades estão disponíveis nos componentes do SDK nomeados alpha e beta. Esses componentes permitem usar a CLI do gcloud para trabalhar com o Google Cloud Bigtable, o Google Cloud Dataflow e outras partes do Cloud Platform em versões anteriores à de disponibilidade geral.

As versões da CLI da gcloud têm o mesmo número que as do SDK. A versão atual do SDK é 302.0.0. Faça o download e a instalação de versões anteriores do SDK a partir do arquivo de downloads.

Como fazer o download da ferramenta de linha de comando gcloud

É possível fazer o download da versão mais recente do SDK do Cloud, que inclui a ferramenta de linha de comando gcloud, na página 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 Nenhum Os comandos são considerados totalmente estáveis e disponíveis para uso da produção. São exibidos alertas para comandos que interrompem a funcionalidade atual e estão documentados nas notas da versão.
Beta beta Os comandos estão funcionalmente completos, mas ainda têm alguns problemas pendentes. Nesses comandos, as alterações importantes 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, os componentes alpha e beta não são instalados por padrão. Você precisa instalá-los 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 de linha de comando gcloud solicitará a instalação.

Grupos de comandos

Em cada nível de versão, os comandos da CLI da gcloud são organizados em uma hierarquia aninhada de grupos de comando, cada um representando um produto ou recurso do Cloud Platform ou seus 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 da gcloud a partir da linha de comando da mesma maneira que usa outras ferramentas de linha de comando. Também é possível executar comandos da CLI do gcloud a partir de scripts e outras automações. Por exemplo, ao usar o Jenkins para automatizar tarefas do Cloud Platform.

Properties

As propriedades da CLI da gcloud são configurações que afetam o comportamento da CLI da 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.

Encontre uma lista de propriedades disponíveis neste link.

Como ativar recursos de acessibilidade

Para uma experiência de leitor de tela mais otimizada, a ferramenta de linha de comando 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 este guia.

Configurações

Uma configuração é um conjunto nomeado de propriedades da CLI da gcloud. Essencialmente, elas funcionam como um perfil.

Começando com o SDK do Cloud, será possível trabalhar com uma configuração única chamada default e definir propriedades executando gcloud init ou gcloud config set. Essa configuração padrão única é adequada para a maioria dos casos de uso.

Se preferir trabalhar com vários projetos ou contas de autorização, será possível definir várias configurações com gcloud config configurations create e alternar entre elas de acordo com o caso. Nessas configurações, é possível personalizar as 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 as explorações de configurações e seu gerenciamento.

Sinalizações globais

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

Sinalizações e argumentos posicionais

Tanto as sinalizações quanto os argumentos posicionais afetam a saída de um comando da CLI da 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 bem-sucedida dos comandos da CLI da gcloud é gravada em stdout. Todos os outros tipos de resposta, como solicitações, avisos e erros, são gravados em stderr. Observe que as gravações em stderr não são estáveis e não devem ser usadas novamente em scripts.

Para ver uma lista definitiva de diretrizes sobre o gerenciamento de saída, leia esta seção.

Solicitações de prompt

A CLI da gcloud confirmará suas intenções antes de executar comandos, como gcloud projects delete, para proteger você de ações destrutivas não intencionais.

Se você criar uma instância de máquina virtual do Google Compute Engine, por exemplo, "test-instance", usando gcloud compute instances create test-instance, talvez surjam prompts. Será necessário escolher uma zona para criar a instância.

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

Observe que a formulação dos prompts pode mudar e não pode ser usada em scripts.

Como suprimir solicitações de prompt, fazer gravações no terminal e gerar registros

A sinalização --quiet, também -q, para a CLI da gcloud desativa todos os prompts interativos ao executar comandos da CLI da gcloud e é útil quando o script é executado. Caso uma entrada seja necessária, os padrões serão usados. Se não houver um padrão, será exibido um erro.

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, use a sinalização --verbosity com um nível apropriado (depuração, informação, aviso, erro, crítico ou nenhum).

Determinar a estrutura da saída

Por padrão, quando um comando da CLI da gcloud retorna uma lista de recursos, eles tem estilo formatado para a saída padrão. Para produzir resultados mais significativos, ajuste a saída com as sinalizações de formato, filtro e projeção.

Se quiser definir apenas o formato da saída, use a sinalização --format para produzir uma versão tabulada ou achatada da saída, para exibições interativas, ou uma versão legível por máquina da saída, como 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.

Se você quiser ver um tutorial interativo rápido para se familiarizar mais rapidamente com os recursos de filtro e formato, siga o link abaixo.

Abrir no Cloud Shell

A seguir