Uma lista de comandos essenciais para a CLI do Google Cloud, a ferramenta de linha de comando principal para Google Cloud.
(Também incluído: introdução básica, compreender os comandos e um PDF imprimível.)
Referência rápida
Começar
Comece a usar a CLI gcloud.
gcloud init
: inicialize, autorize e configure a CLI gcloud.gcloud version
: apresentar 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 Google Cloud predefinido no qual trabalhar.gcloud info
: apresenta os detalhes do ambiente da CLI gcloud atual.
Ajuda
A CLI gcloud tem todo o gosto em ajudar.
gcloud help
: pesquise os documentos de referência da CLI gcloud para encontrar termos específicos.gcloud feedback
: envie feedback à equipa da CLI gcloud.gcloud topic
: material de ajuda suplementar para tópicos que não envolvem comandos, como acessibilidade, filtragem e formatação.
Personalização
Personalize a CLI gcloud; personalize a sua configuração com propriedades.
gcloud config set
: define uma propriedade (como compute/zone) para a configuração atual.gcloud config get
: obtenha o valor de uma propriedade da CLI gcloud.gcloud config list
: apresenta todas as propriedades da configuração atual.gcloud config configurations create
: crie uma nova configuração com nome.gcloud config configurations list
: apresentar uma lista de todas as configurações disponíveis.gcloud config configurations activate
: mude para uma configuração denominada existente.
Autorização e credenciais
Conceder e revogar a autorização da CLI gcloud e gerir credenciais.
gcloud auth login
: autorize Google Cloud o acesso para a CLI gcloud com Google Cloud credenciais do utilizador e defina a conta atual como ativa.gcloud auth activate-service-account
: Autorize Google Cloud o acesso de forma semelhante agcloud auth login
, mas com credenciais da conta de serviço.gcloud auth application-default
: Faça a gestão das suas Credenciais predefinidas da aplicação (ADC) para as bibliotecas de cliente do Google Cloud.gcloud auth list
: lista todas as contas com credenciais.gcloud auth print-access-token
: Apresente a chave de acesso da conta atual.gcloud auth revoke
: remova as credenciais de acesso de uma conta.
Projetos
Faça a gestão das políticas de acesso ao projeto.
gcloud projects describe
: Apresentar metadados de um projeto (incluindo o respetivo ID).gcloud projects add-iam-policy-binding
: Adicione uma associação de políticas de IAM a um projeto especificado.
IAM
Configurar as preferências e as contas de serviço da gestão de identidade e de acesso (IAM).
gcloud iam list-grantable-roles
: Liste as funções atribuíveis de IAM para um recurso.gcloud iam roles create
: Crie uma função personalizada para um projeto ou uma 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 associação de política IAM a uma conta de serviço.gcloud iam service-accounts set-iam-policy-binding
: Substituir associação de política IAM existente.gcloud iam service-accounts keys list
: Liste as chaves de uma conta de serviço.
Docker e Google Kubernetes Engine (GKE)
Faça a gestão de aplicações contentorizadas no Kubernetes.
gcloud auth configure-docker
: Registe a CLI gcloud como um auxiliar de credenciais do Docker.gcloud container clusters create
: Crie um cluster para executar contentores do GKE.gcloud container clusters list
: Liste os clusters para executar contentores do GKE.gcloud container clusters get-credentials
: Atualize okubeconfig
para que okubectl
use um cluster do GKE.gcloud container images list-tags
: Apresente uma lista de etiquetas e resuma os metadados de uma imagem de contentor.
Máquinas virtuais e Compute Engine
Crie, execute e faça a gestão de VMs na Google Cloud infraestrutura.
gcloud compute zones list
: Listar zonas do Compute Engine.gcloud compute instances create
: Crie uma instância de VM.gcloud compute instances describe
: Apresentar os detalhes de uma instância de VM.gcloud compute instances list
: Listar todas as instâncias de VM num projeto.gcloud compute disks snapshot
: Crie um instantâneo de discos persistentes.gcloud compute snapshots describe
: Apresentar os detalhes de um resumo.gcloud compute snapshots delete
: Eliminar um instantâneo.gcloud compute ssh
: ligar a uma instância de VM através do SSH.
Sem servidor e App Engine
Crie aplicações altamente escaláveis numa plataforma sem servidor totalmente gerida
gcloud app deploy
: implemente o código e a configuração da sua app no servidor do App Engine.gcloud app versions list
: List all versions of all services deployed to the App Engine server.gcloud app browse
: abra a app atual num navegador de internet.gcloud app create
: crie uma app do App Engine no seu projeto atual.gcloud app logs read
: apresenta os registos mais recentes da app App Engine.
Diversos
Comandos que podem ser úteis
gcloud kms decrypt
: desencriptar texto cifrado (para um ficheiro de texto simples) usando uma chave do Cloud Key Management Service.gcloud logging logs list
: liste os registos do seu projeto.gcloud sql backups describe
: Apresenta informações sobre uma cópia de segurança de uma instância do Cloud SQL.gcloud sql export sql
: exportar dados de uma instância do Cloud SQL para um ficheiro SQL.
Guia introdutório
Uma introdução rápida para começar a usar a CLI gcloud.
Instalar a CLI do Google Cloud
Instale a CLI Google Cloud com estas instruções de instalação.
Flags, argumentos e outras adições maravilhosas
Os argumentos podem ser argumentos posicionais ou flags:
- Argumentos posicionais: definidos após o nome do comando; têm de respeitar a ordem dos argumentos posicionais.
Flags: definidas após os argumentos posicionais; a ordem das flags não é importante.
Uma denúncia pode ser:
- Par nome-valor (
--foo=bar
) ou - Booleano (
--force/no-force
).
Além disso, as denúncias podem ser:
- Obrigatório
- Opcional: se um sinalizador opcional não estiver definido, é usado o valor predefinido
- Par nome-valor (
Sinalizações globais
Algumas flags estão disponíveis em toda a experiência da CLI gcloud, como:
--help
: para quando tiver dúvidas; apresenta ajuda detalhada para um comando.--project
: se estiver a usar um projeto que não seja o atual.--quiet
: desativar os pedidos interativos (e aplicar valores predefinidos para as entradas).--verbosity
: Pode definir níveis de detalhe emdebug
,info
,warning
,error
,critical
enone
.--version
: Apresenta 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
.
Limpar resultados
Tire o máximo partido da saída com as flags filter, format, limit e sort-by.
Para instâncias do Compute Engine com o prefixo us
e não o tipo de máquinaf1-micro
:
gcloud compute instances list --filter="zone ~ ^us AND -machineType:f1-micro"
Para uma lista de projetos criados a 15 de janeiro de 2018 ou após essa data, ordenados do mais antigo para o mais recente, apresentada como uma tabela com o número do projeto, o ID do projeto e as colunas de hora de criação com datas e horas 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 uma etiqueta my-label
(de qualquer valor):
gcloud compute instances list --filter="labels.my-label:*" --limit=10
Compreender os comandos
Os padrões subjacentes para comandos da CLI gcloud; para ajudar na autodescoberta de comandos.
Encontrar comandos da CLI gcloud
A CLI gcloud é uma árvore. Os nós não terminais são grupos de comandos e os nós terminais são comandos. (Além disso, a conclusão automática com a tecla Tab funciona para comandos e recursos!)
A maioria dos comandos gcloud
segue o seguinte 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 lançamento
O nível de lançamento refere-se ao estado de lançamento do comando.
Exemplo: alpha
para comandos alfa, beta
para comandos beta e nenhum nível de lançamento necessário para comandos DG.
Componente
Componente refere-se aos diferentes Google Cloud serviços.
Exemplo: compute
para o Compute Engine, app
para o App Engine, etc.
Entidade
Entidade refere-se à forma plural de um elemento ou uma coleção de elementos num componente.
Exemplo: disks
, firewalls
, images
, instances
, regions
, zones
para computação
Operação
Operação refere-se à forma verbal imperativa da operação a ser realizada na entidade.
Exemplo: as operações comuns são describe
, list
, create/update
,
delete/clear
, import
, export
, copy
, remove
, add
, reset
, restart
,
restore
, run
e deploy
.
Positional args
Os argumentos posicionais referem-se aos argumentos necessários e específicos da ordem necessários para executar o comando.
Exemplo: <INSTANCE_NAMES>
é o argumento posicional obrigatório para
gcloud compute instances create
.
Bandeiras
As flags 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 flags opcionais para gcloud compute instances create
.