Visão geral da ferramenta gcloud

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

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 e outros recursos do Compute Engine
  • Instâncias do Cloud SQL
  • Clusters do GKE
  • 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 mais informações 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ápidagcloud ferramenta, uma lista de comandos comumente usados e uma análise da estrutura desses comandos, consultegcloud folha de referência da ferramenta de dados.

A ferramenta gcloud e o SDK do Cloud

A ferramenta gcloud faz parte do SDK do Cloud. É necessário fazer o download e instalar o SDK do Cloud no sistema e inicializá-lo antes de usar a ferramenta gcloud.

Por padrão, o SDK do Cloud instala comandos da ferramenta gcloud que estão apenas no nível de disponibilidade geral. Outras funcionalidades estão disponíveis nos componentes do SDK do Cloud chamados 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 da versão anterior à disponibilidade geral.

As versões de ferramentas gcloud têm o mesmo número de versão que o SDK do Cloud. A versão atual do SDK do Cloud é 361.0.0. É possível fazer o download e instalar versões anteriores do SDK do Cloud a partir do 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. São exibidos alertas para comandos que interrompem a funcionalidade atual e estão documentados nas Notas de lançamento.
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.

Os componentes alpha e beta não são instalados por padrão quando você instala o SDK do Cloud. Instale 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

Em cada nível de versão, os comandos da ferramenta gcloud são organizados em uma hierarquia aninhada de grupos de comandos, 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 ferramenta gcloud

É possível executar comandos da ferramenta gcloud a partir da linha de comando da mesma forma que você 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 este guia.

Configurações

Uma configuração é um conjunto nomeado de propriedades da ferramenta gcloud. Ele funciona 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 o Guia de configurações.

Sinalizações globais

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

Sinalizações e argumentos posicionais

Embora os argumentos e as sinalizações posicionais afetem a saída de um comando da ferramenta gcloud, há uma pequena diferença nos casos de uso. Um argumento posicional é usado para definir uma entidade em que um comando opera, enquanto uma 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 ferramenta 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 uma lista definitiva de diretrizes sobre o processamento da 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.

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

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

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 a criação de scripts. Se uma entrada for necessária, os padrões serão usados. Se não houver padrões, 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, 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 de ferramenta gcloud retorna uma lista de recursos, eles são muito impressos na saída padrão. Para produzir resultados mais significativos, as sinalizações de formato, filtro e projeção permitem ajustar o resultado.

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