Uma lista de comandos importantes da Google Cloud CLI, 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
Como começar
Comece a usar a CLI gcloud.
gcloud init
: inicializar, autorizar e configurar a CLI gcloud.gcloud version
: exiba a versão e os componentes instalados.gcloud components install
: instale componentes específicos.gcloud components update
: atualize a CLI gcloud para a versão mais recente.gcloud config set project
: defina um projeto padrão do Google Cloud para trabalhar.gcloud info
: exibe os detalhes atuais do ambiente da CLI gcloud.
Ajuda
A CLI gcloud está à disposição para ajudar.
gcloud help
: pesquise termos específicos nos documentos de referência da CLI gcloud.gcloud feedback
: envie 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 com as propriedades da sua configuração.
gcloud config set
: defina uma propriedade (como computação/zona) para a configuração atual.gcloud config get
: buscar o valor de uma propriedade da CLI gcloud.gcloud config list
: exiba todas as propriedades da configuração atual.gcloud config configurations create
: crie uma nova configuração nomeada.gcloud config configurations list
: exiba uma lista de todas as configurações disponíveis.gcloud config configurations activate
: alterne para uma configuração nomeada existente.
Autorização e credenciais
Conceda e revogue a autorização à CLI gcloud e gerencie as credenciais.
gcloud auth login
: autorize o acesso do Google Cloud à CLI gcloud com credenciais de usuário do Google Cloud e defina a conta atual como ativa.gcloud auth activate-service-account
: autorize o acesso ao Google Cloud semelhante agcloud auth login
, mas com credenciais de conta de serviço.gcloud auth application-default
: gerencie o Application Default Credentials (ADC) para bibliotecas de cliente do Cloud.gcloud auth list
: liste todas as contas credenciadas.gcloud auth print-access-token
: exiba o token de acesso da conta atual.gcloud auth revoke
: remova as credenciais de acesso de uma conta.
Projetos
Gerencie as políticas de acesso ao projeto.
gcloud projects describe
: exiba metadados de um projeto (incluindo o ID dele).gcloud projects add-iam-policy-binding
: adicione uma vinculação de política de IAM a um projeto especificado.
IAM
configurar preferências e contas de serviço do Identity and Access Management (IAM).
gcloud iam list-grantable-roles
: liste os papéis atribuíveis do IAM a um recurso.gcloud iam roles create
: crie um papel personalizado para um projeto ou organização.gcloud iam service-accounts create
: crie uma conta de serviço para um projeto.gcloud iam service-accounts add-iam-policy-binding
: adicione uma vinculação de política do IAM a uma conta de serviço.gcloud iam service-accounts set-iam-policy-binding
: substitua a vinculação da política do IAM atual.gcloud iam service-accounts keys list
: liste as chaves de uma conta de serviço.
Docker e Google Kubernetes Engine (GKE)
Gerencie aplicativos conteinerizados no Kubernetes.
gcloud auth configure-docker
: registre a CLI gcloud como um auxiliar de credencial do Docker.gcloud container clusters create
: crie um cluster para executar contêineres do GKE.gcloud container clusters list
: liste clusters para executar contêineres do GKE.gcloud container clusters get-credentials
: atualizekubeconfig
para receberkubectl
para usar um cluster do GKE.gcloud container images list-tags
: liste de metadados de resumo e tag de lista para uma imagem de contêiner.
Máquinas virtuais e Compute Engine
Crie, execute e gerencie VMs na infraestrutura do Google Cloud.
gcloud compute zones list
: liste zonas do Compute Engine.gcloud compute instances create
: cria uma instância de VM.gcloud compute instances describe
: exiba os detalhes de uma instância de VM.gcloud compute instances list
: liste todas as instâncias da VM em um projeto.gcloud compute disks snapshot
: crie um snapshot de discos permanentes.gcloud compute snapshots describe
: exiba os detalhes de um snapshot.gcloud compute snapshots delete
: exclua um snapshot.gcloud compute ssh
: conecte-se a uma instância de VM usando SSH.
Sem servidor e App Engine
Crie aplicativos altamente escalonáveis em uma plataforma totalmente gerenciada e sem servidor
gcloud app deploy
: implante o código e a configuração do aplicativo no servidor do App Engine.gcloud app versions list
: liste todas as versões de todos os serviços implantados no servidor do App Engine.gcloud app browse
: abra o app atual em um navegador da Web.gcloud app create
: crie um aplicativo do App Engine no projeto atual.gcloud app logs read
: exiba os registros de aplicativos mais recentes do App Engine.
Diversos
Comandos que podem ser úteis
gcloud kms decrypt
: descriptografar texto criptografado (para um arquivo de texto simples) usando uma chave do Cloud Key Management Service.gcloud logging logs list
: liste os registros do projeto.gcloud sql backups describe
: exiba informações sobre um backup de instância do Cloud SQL.gcloud sql export sql
: exporte dados de uma instância do Cloud SQL para um arquivo SQL.
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 com estas instruções de instalação.
Sinalizações, argumentos e outras adições incríveis
Os argumentos podem ser argumentos ou sinalizações de posição:
- 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 sinalização opcional não for definida, o valor padrão será usado.
- Par de nome-valor (
Sinalizações globais
Algumas sinalizações estão disponíveis em toda 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 emdebug
,info
,warning
,error
,critical
enone
.--version
: exiba as informações da versão dogcloud
.--format
: defina o formato de saída comoconfig
,csv
,default
,diff
,disable
,flattened
,get
,json
,list
,multi
,none
,object
,table
,text
,value
ouyaml
.
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 gcloud, para ajudar na autodescoberta de comandos.
Como encontrar comandos da CLI gcloud
A CLI gcloud é uma árvore. Os nós não folha são grupos de comandos e os 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 este formato:
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
.