Folha de referência da CLI gcloud

Uma lista de comandos para a CLI do Google Cloud, a principal ferramenta de linha de comando do Google Cloud.

Também estão incluídos: introdução primer, como entender os comandos e um PDF para impressão.

Folha de referências

Primeiros passos

Comece a usar a CLI gcloud.

Ajuda

CLI gcloud terá prazer em ajudar.

  • gcloud help: pesquise documentos de referência da CLI gcloud em termos específicos.
  • gcloud feedback: envie seu feedback para a equipe da CLI gcloud.
  • gcloud topic: material de ajuda complementar para tópicos que não são de comando, como acessibilidade, filtragem e formatação.

Personalização

Personalize a CLI gcloud. personalizar sua configuração com propriedades.

Autorização e credenciais

Conceder e revogar a autorização para a CLI gcloud e gerenciar as credenciais.

Projetos

Gerenciar políticas de acesso ao projeto.

IAM

Configurar preferências e contas de serviço do gerenciamento de identidade e acesso (IAM).

Docker e Google Kubernetes Engine (GKE)

Gerencie aplicativos conteinerizados no Kubernetes.

Máquinas virtuais e Compute Engine

Crie, execute e gerencie VMs na infraestrutura do Google Cloud.

Sem servidor e App Engine

Crie aplicativos altamente escalonáveis em uma plataforma totalmente gerenciada e sem servidor

Diversos

Comandos que podem ser úteis

Primer de introdução

Um guia rápido para começar a usar a CLI gcloud.

Como instalar a Google Cloud CLI

Instale a Google Cloud CLI seguindo estas instruções de instalação.

Sinalizações, argumentos e outras adições incríveis

Os argumentos podem ser posicionais ou flags:

  • Argumentos posicionais: definidos após o nome do comando. Precisam respeitar a ordem dos argumentos posicionais.

  • Sinalizações: definidas após argumentos posicionais. A ordem das sinalizações não importa.

    Uma sinalização pode ser:

    • Par de nome-valor (--foo=bar) ou
    • Valor booleano (--force/no-force).

    Além disso, as sinalizações podem ser:

    • Obrigatório
    • Opcional: se uma flag opcional não for definida, o valor padrão será usado.

Sinalizações globais

Algumas flags estão disponíveis durante a experiência da CLI gcloud. como:

  • --help: para quando houver dúvidas. Exibe ajuda detalhada sobre um comando.
  • --project: se estiver usando um projeto diferente do atual.
  • --quiet: desativação do prompt interativo (e da aplicação de valores padrão para entradas).
  • --verbosity: pode definir níveis de detalhamento em debug, info, warning, error, critical e none.
  • --version: exiba as informações da versão do gcloud.
  • --format: defina o formato de saída como config, csv, default, diff, disable, flattened, get, json, list, multi, none, object, table, text, value ou yaml.

Como limpar resultados

Aproveite mais sua saída com as sinalizações de filtro, formato, limite e classificação.

Para instâncias do Compute Engine com prefixo us e não tipo de máquina f1-micro:

gcloud compute instances list --filter="zone ~ ^us AND -machineType:f1-micro"

Para uma lista de projetos criados em 15 de janeiro de 2018 ou após essa data, classificados de uma tabela com número de projetos, ID do projeto e colunas de tempo de criação com datas e horários no fuso horário local:

gcloud projects list --format="table(projectNumber,projectId,createTime.date(tz=LOCAL))"
--filter="createTime>=2018-01-15T12:00:00" --sort-by=createTime

Para uma lista de dez instâncias do Compute Engine com um rótulo my-label (de qualquer valor):

gcloud compute instances list --filter="labels.my-label:*" --limit=10

Noções básicas sobre comandos

Os padrões subjacentes para comandos da CLI do gcloud; para ajudar na descoberta automática de comandos.

Como encontrar comandos da CLI da gcloud

A CLI gcloud é uma árvore. nós sem folha são grupos de comandos e nós de folha são comandos. Além disso, o preenchimento de guias funciona para comandos e recursos.

A maioria dos comandos gcloud segue o formato abaixo:

gcloud + release level (optional) + component + entity + operation + positional args + flags

Por exemplo: gcloud + compute + instances + create + example-instance-1 + --zone=us-central1-a

Nível de versão

Nível de versão refere-se ao status da versão do comando.

Exemplo: alpha para comandos Alfa, beta para comandos Beta, nenhum nível de versão necessário para os comandos do GA.

Componente

Componente refere-se aos diferentes serviços do Google Cloud.

Exemplo: compute para o Compute Engine, app para o App Engine etc.

Entity

Entidade refere-se à forma plural de um elemento ou conjunto de elementos em um componente.

Exemplo: disks, firewalls, images, instances, regions, zones para computação

Operação

Operação refere-se à forma verbal da operação a ser executada na entidade.

Exemplo: operações comuns são describe, list, create/update, delete/clear, import, export, copy, remove, add, reset, restart, restore, run e deploy.

Argumentos posicionais

Argumentos posicionais referem-se aos argumentos obrigatórios, específicos de ordem, necessários para executar o comando.

Exemplo: <INSTANCE_NAMES> é o argumento posicional obrigatório para gcloud compute instances create.

Sinalizações

Sinalizações referem-se aos argumentos adicionais, --flag-name(=value), transmitidos ao comando após os argumentos posicionais.

Exemplo: --machine-type=<MACHINE_TYPE> e --preemptible são sinalizações opcionais para gcloud compute instances create.