Esta página contém uma visão geral da Google Cloud CLI e os padrões e recursos comuns de comando.
O que é a CLI gcloud?
O Google Cloud CLI é um conjunto de ferramentas para criar e gerenciar recursos do Google Cloud. Você pode usar essas ferramentas para executar muitas tarefas de plataforma comuns pela linha de comando ou por meio de scripts e outras automações.
Por exemplo, você pode 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 à 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 e instale a CLI gcloud e, em seguida, inicialize-a.
Por padrão, a CLI gcloud instala comandos que estão no nível de disponibilidade geral. Há outras funcionalidades 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 de versão anteriores à de disponibilidade geral.
A versão atual da CLI gcloud é 432.0.0. É possível fazer o download e a instalação de versões anteriores da CLI gcloud a partir do arquivo de downloads.
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 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 gcloud solicitará a instalação.
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 comandos, cada um representando um produto ou recurso 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 comandos da CLI gcloud a partir da linha de comando e de scripts e outras automações. Por exemplo, ao usar o Jenkins para automatizar tarefas do Google Cloud.
Propriedades
As propriedades da CLI gcloud são configurações que afetam o comportamento das ferramentas da CLI gcloud. Algumas dessas propriedades podem ser definidas por opções globais ou de comando. Nesse caso, o valor definido pela opção tem precedência.
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 regem 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
Os argumentos e opções posicionais afetam a saída de um comando da CLI gcloud, mas há uma diferença sutil entre os casos de uso de cada um. 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 da CLI gcloud é gravada em stdout. Todos os outros tipos de resposta, como solicitações, avisos e erros, são gravados em stderr. Não insira scripts 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 desejadas, a CLI gcloud
confirma suas intenções antes de executar comandos como
gcloud projects delete.
Talvez você receba uma solicitação quando precisarmos de mais informações.
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, gravar no terminal e gerar registros
A opção --quiet (também, -q) da CLI gcloud desativa todos os prompts interativos ao executar comandos da CLI da 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 opção --no-user-output-enabled.
Para ajustar o nível de detalhamento dos registros, especifique um nível de detalhamento (depuração, informações, 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 gcloud retorna uma lista de recursos, eles são impressos corretamente 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 saída, use a
opção --format para produzir uma versão tabulada
ou simplificada (para exibição interativa) ou
uma versão 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.
A seguir
- Saiba mais sobre os comandos da CLI gcloud na referência da CLI gcloud.