Esta página contém uma visão geral do Google Cloud CLI e seus padrões de comando e recursos comuns.
O que é o gcloud CLI?
O Google Cloud CLI é um conjunto de ferramentas para criar e gerenciarGoogle Cloud Recursos. Você pode usar essas ferramentas para executar muitas tarefas comuns da plataforma a partir da linha de comando ou por meio de scripts e outras automações.
Por exemplo, você pode usar o gcloud CLI 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 trabalhos do Dataproc
- Zonas gerenciadas e conjuntos de registros do Cloud DNS
- Implantações do Cloud Deployment Manager
Você também pode usar o gcloud CLI para implantar aplicativos do App Engine, gerenciar autenticação, personalizar a configuração local e executar outras tarefas.
Baixe e instale o gcloud CLI
A versão atual do gcloud CLI é 526.0.1.
Embora recomendemos fortemente que você use a versão atual do gcloud CLI, você também pode baixar e instalar versões anteriores do arquivo de download .
Se você estiver usando o Cloud Shell, a CLI do gcloud estará disponível automaticamente e você não precisará instalá-la. Caso contrário, baixe e instale a CLI do gcloud e, em seguida, inicialize- a.
Por padrão, a CLI do gcloud instala comandos que estão no nível de Disponibilidade Geral. Funcionalidades adicionais estão disponíveis nos componentes da CLI do gcloud chamados alpha e beta . Esses componentes permitem que você use a CLI do gcloud para trabalhar com o Bigtable, o Dataflow e outras partes do Google Cloud em níveis de lançamento anteriores à Disponibilidade Geral.
Folha de dicas do gcloud CLI
Para uma introdução rápida ao gcloud CLI, uma lista de comandos comumente usados e uma visão de como esses comandos são estruturados, consulte a folha de dicas do gcloud CLI .
Níveis de liberação
Os comandos da CLI do gcloud têm os seguintes níveis de versão:
| Nível de liberação | Rótulo | Descrição |
|---|---|---|
| Disponibilidade geral | Nenhum | Os comandos são considerados totalmente estáveis e disponíveis para uso em produção. Para avisos antecipados sobre alterações nos comandos que interrompem a funcionalidade atual, consulte as notas de lançamento . |
| Beta | beta | Os comandos estão funcionalmente completos, mas ainda podem apresentar alguns problemas pendentes. Alterações significativas nesses comandos podem ser feitas sem aviso prévio. |
| Alfa | alpha | Os comandos estão em versão inicial e podem mudar sem aviso prévio. |
Os componentes alpha e beta não são instalados por padrão ao instalar a CLI do gcloud. Você deve 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 comando
Em cada nível de versão, os comandos do gcloud CLI são organizados em uma hierarquia aninhada de grupos de comandos, cada um dos quais representa um produto ou recurso de Google Cloud ou seus subgrupos funcionais.
Por exemplo:
| Grupo de comando | 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 no Alpha |
Executando comandos CLI do gcloud
Você pode executar comandos do gcloud CLI a partir da linha de comando e de scripts e outras automações — por exemplo, ao usar Jenkins para automatizar Google Cloud tarefas.
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 precedência.
Habilitando recursos de acessibilidade
Para uma experiência de leitor de tela mais simplificada, o gcloud CLI vem com uma propriedade accessibility/screen_reader .
Para habilitar a propriedade de acessibilidade, execute:
gcloud config set accessibility/screen_reader true
Para obter mais detalhes sobre os recursos de acessibilidade que vêm com a ferramenta de linha de comando gcloud, consulte o guia Habilitando recursos de acessibilidade .
Configurações
Uma configuração é um conjunto de propriedades da CLI do gcloud. Uma configuração funciona como um perfil .
Ao começar a usar a CLI do gcloud, você trabalhará com uma única configuração chamada default e poderá definir propriedades executando gcloud init ou gcloud config set . Essa única configuração default é adequada para a maioria dos casos de uso.
Para trabalhar com vários projetos ou contas de autorização, você pode definir várias configurações com gcloud config configurations create e alternar entre elas. Dentro de uma configuração, você pode 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 Configurações .
Opções globais
A CLI do gcloud fornece um conjunto de opções da CLI do gcloud que controlam o comportamento dos comandos por invocação. As opções substituem os valores definidos nas propriedades da CLI do gcloud.
Argumentos posicionais e opções
Embora argumentos posicionais e opções afetem a saída de um comando da CLI do gcloud, há uma diferença sutil em seus casos de uso. Um argumento posicional é usado para definir uma entidade na qual um comando opera, enquanto uma opção é necessária para definir uma variação no comportamento de um comando.
Uso de stdout e stderr
A saída dos comandos CLI do gcloud bem-sucedidos é gravada em stdout . Todos os outros tipos de respostas — prompts, avisos e erros — são gravados em stderr . Não crie scripts com base nas respostas gravadas em stderr , pois elas não são estáveis.
Para obter diretrizes sobre como lidar com a saída, consulte o Guia de script .
Solicitação
Para proteger contra ações destrutivas não intencionais, o gcloud CLI confirma suas intenções antes de executar comandos como gcloud projects delete .
Você poderá ser solicitado quando informações adicionais forem necessárias. Por exemplo, você será solicitado a escolher uma zona ao criar uma instância de máquina virtual do Compute Engine usando gcloud compute instances create test-instance .
Para desabilitar o prompt, use a opção --quiet .
Não escreva textos baseados no texto dos prompts, pois o texto pode mudar.
Suprimindo prompts, escrevendo no terminal e registrando
A opção --quiet (também conhecida -q ) para a CLI do gcloud desabilita todos os prompts interativos ao executar comandos da CLI do gcloud e é útil para scripts. Se for necessária uma entrada, os padrões são usados. Se não houver um padrão, um erro é gerado.
Para suprimir a impressão da saída do comando na saída padrão e no erro padrão no terminal, use a opção --no-user-output-enabled .
Para ajustar a verbosidade dos logs, especifique um nível de verbosidade (depuração, informação, aviso, erro, crítico ou nenhum) usando a opção --verbosity .
Determinando a estrutura de saída
Por padrão, quando um comando da CLI gcloud retorna uma lista de recursos, estes são impressos de forma elegante na saída padrão. Para produzir uma saída mais significativa, as opções format , filter e projection permitem que você ajuste sua saída.
Para definir apenas o formato da sua saída, use a opção --format para produzir uma versão tabulada ou simplificada 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 de acordo com os critérios definidos por você, use filter .
O que vem a seguir
- Saiba mais sobre os comandos da CLI do gcloud na referência da CLI do gcloud .