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

Folha de referência do gcloud

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

Também inclui: guia de introdução, comandos sobre a compreensão e um PDF para impressão.

Folha de referências

Primeiros passos

Siga a ferramenta de linha de comando gcloud.

Ajuda

É um ótimo SDK do Cloud.

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

Personalização

Crie o SDK do Cloud. Personalize sua configuração com propriedades.

Credenciais

Conceder e revogar autorização para o SDK do Cloud

Projetos

Gerenciar políticas de acesso ao projeto

Gerenciamento de identidade e acesso

Como configurar preferências e contas de serviço do Cloud Identity & Access Management (IAM)

Docker e Google Kubernetes Engine (GKE)

Gerenciar aplicativos em contêineres no Kubernetes

Máquinas virtuais e Compute Engine

Crie, execute e gerencie VMs na infraestrutura do Google

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

Uma rápida introdução para começar a usar a ferramenta de linha de comando gcloud.

Como instalar o SDK do Cloud

Instale o SDK do Cloud com estas instruções de instalação.

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

Os argumentos podem ser argumentos posicionais ou sinalizações

  • 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:

    • Valor
    • Opcionais: nesse caso, o valor padrão será usado, se a sinalização não for definida

Sinalizações globais

Algumas sinalizações estão disponíveis em toda a experiência da ferramenta de linha de comando 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

Extraia o máximo de sua saída com as sinalizações filter, format, limit e sort-by.

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 os comandos gcloud; para ajudar na descoberta automática de comandos.

Como encontrar comandos gcloud

A ferramenta de linha de comando gcloud é uma árvore. Nós que não são de 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 tem o formato a seguir:

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.