Como gerenciar propriedades do SDK

O que é uma propriedade?

Propriedades são configurações que regem o comportamento da CLI do gcloud e de outras ferramentas do SDK.

As propriedades podem ser usadas para definir uma configuração por produto ou por serviço, como a conta usada pela CLI da gcloud e outras ferramentas do SDK do Cloud para autorização, a região padrão a ser usada ao trabalhar com recursos do Google Compute Engine ou até mesmo a opção para desativar as atualizações automáticas dos componentes do SDK do Cloud. As propriedades também podem ser usadas para definir as preferências da ferramenta de linha de comando gcloud, como nível de detalhamento e configuração de prompt para os comandos da CLI da gcloud.

Propriedades e sinalizações

A CLI da gcloud é compatível com algumas sinalizações globais e sinalizações de comando que têm o mesmo efeito que as propriedades do SDK. Por exemplo, a CLI da gcloud é compatível com a sinalização --project e a propriedade project. As propriedades permitem que você mantenha as mesmas configurações em várias execuções de comandos, enquanto as sinalizações afetam o comportamento do comando por invocação. As sinalizações substituem as propriedades quando as duas estão definidas.

Configurações

Uma configuração é um conjunto nomeado de propriedades do SDK. A CLI da gcloud usa uma configuração chamada default como a configuração ativa inicial, e default é adequada para a maioria dos casos de uso. No entanto, você também pode criar mais configurações e alterná-las conforme necessário.

Listar propriedades

Para listar as propriedades na configuração ativa, execute gcloud config list:

gcloud config list

A CLI da gcloud retorna a lista de propriedades:

[compute]
region = us-east1
zone = us-east1-d
[core]
account = user@google.com
disable_usage_reporting = False
project = example-project
[metrics]
command_name = gcloud.config.list

Como configurar propriedades

Para definir uma propriedade na configuração ativa, execute gcloud config set:

gcloud config set project [PROJECT]

Para configurar propriedades que não estão na seção core, é necessário especificar a seção seguida por uma barra antes do nome da propriedade:

gcloud config set compute/zone us-east1-b

Cancelar a definição de propriedades

Para remover a configuração de uma propriedade na configuração ativa, use gcloud config unset:

gcloud config unset disable_usage_reporting

Tipos de propriedade

Na visualização de listas de propriedades, as propriedades relacionadas do SDK são agrupadas em seções.

Propriedades de core

A seção core contém propriedades de configuração para o comando gcloud.

Nome Descrição
account Conta de usuário ou de serviço usada pela CLI da gcloud e outras ferramentas do SDK para autorização.
custom_ca_certs_file Caminho absoluto para o arquivo de certificado de CA personalizado que será usado.
disable_color Se configurado como True, evita que a CLI da gcloud imprima mensagens em cores no terminal.
disable_file_logging Se configurado como True, a CLI da gcloud não armazenará registros em um arquivo. Isso pode ser útil se o espaço do disco for limitado.
disable_prompts Se configurado como True, suprime solicitações de todos os comandos da CLI da gcloud e presume a resposta padrão. Se um comando exigir entrada do usuário e um padrão não puder ser usado, a CLI da gcloud reportará um erro. É equivalente à sinalização global --quiet.
disable_usage_reporting Se configurado como True, desativa a coleção de estatísticas anônimas sobre o uso do SDK. Você define esse valor ao instalar o SDK, mas pode alterá-lo a qualquer momento.
log_http Se configurado como True, permite a gravação de solicitações HTTP e respostas a registros. Se você quiser ver essas mensagens em seu terminal, ajuste sua configuração de detalhamento usando a propriedade verbosity ou a sinalização global --verbosity.
max_log_days Número máximo de dias para reter arquivos de registro antes da exclusão. Se for definido como 0, desativa a coleta de lixo do registro e não exclui arquivos de registro. Se não for definido, o padrão será de 30 dias.
pass_credentials_to_gsutil Se configurado como True, transmite a autenticação do SDK do Cloud para a gsutil.
project ID do projeto atual do Cloud Platform. É possível modificar esse valor usando a sinalização global --project.
show_structured_logs Visibilidade e formato de mensagens de registro estruturadas em JSON gravadas no erro padrão. Se a propriedade dele estiver desativada, os registros serão formatados como text por padrão. Os valores válidos são: never, always, log e terminal. Se não for definido, o padrão será never.
trace_token Token fornecido pelo suporte do Google para encaminhar traces das solicitações de serviço para investigação de problemas.
user_output_enabled Permite a impressão da saída do comando para a saída e o erro padrão no terminal. Se for configurado como False, a saída será suprimida.
verbosity O detalhamento da geração de registros para comandos da CLI da gcloud. A CLI da gcloud é compatível com os seguintes níveis de detalhamento padrão:
  • debug
  • info
  • warning
  • error
  • critical
  • none
É equivalente ao uso da sinalização global --verbosity.

Propriedades do administrador do componente

A seção component_manager contém as propriedades usadas ao gerenciar os componentes do SDK.

Nome Descrição
component_manager/additional_repositories Lista separada por vírgulas de repositórios extras para verificação de componentes. Essa propriedade é gerenciada automaticamente pelos comandos no grupo gcloud components repositories.
component_manager/disable_update_check Caso seja True, o SDK não verificará automaticamente se há atualizações.

Propriedades do App Engine

A seção app contém propriedades que especificam o comportamento do comando gcloud app deploy.

Nome Descrição
app/cloud_build_timeout Tempo, em segundos, para aguardar a criação das versões do Docker durante as implantações. Todas as compilações do Docker agora usam a API do Cloud Build.
app/promote_by_default Se True, promova a versão para receber todo o tráfego de um serviço ao implantar uma nova versão do serviço. Esta propriedade pode ser substituída pelos sinalizadores --promote-by-default ou --no-promote-by-default.
app/stop_previous_version Se True, interrompa a versão implantada anteriormente ao implantar uma nova versão do aplicativo. Caso seja False, a versão mais antiga precisa ser interrompida manualmente antes da implantação.
app/use_runtime_builders Se definido, alterne o uso de um novo caminho de código para criar aplicativos usando tempos de execução pré-fabricados que podem ser atualizados independentemente das ferramentas do cliente. Se não definido, o caminho padrão para cada tempo de execução é usado.

Propriedades do Compute Engine

A seção compute contém propriedades usadas pelos comandos da CLI da gcloud que operam nos recursos do Google Compute Engine.

Nome Descrição
compute/region Região padrão a ser usada no trabalho com recursos do Compute Engine. Se a sinalização --region for exigida por um comando da CLI da gcloud, mas não for fornecida, esse valor será usado.
compute/zone Zona padrão a ser usada no trabalho com recursos do Compute Engine. Esse valor será usado caso a sinalização --zone seja obrigatória para um comando da CLI da gcloud, mas não seja fornecida.

Propriedades do Kubernetes Engine

A seção container contém propriedades usadas pelos comandos da CLI da gcloud que operam em clusters do Google Kubernetes Engine.

Nome Descrição
container/cluster Nome do cluster a ser usado por padrão.

Propriedades do proxy de rede

A seção proxy contém propriedades relacionadas ao uso de proxies de rede pelo comando gcloud.

Nome Descrição
proxy/type Tipo de servidor proxy. Os tipos de proxy compatíveis são:
  • http
  • http_no_tunnel
  • socks4
  • socks5
proxy/address Nome do host ou endereço IP do servidor proxy.
proxy/port Porta a ser usada na conexão com o servidor proxy.
proxy/username Nome de usuário a ser usado na conexão com o servidor proxy, caso necessário.
proxy/password Senha a ser usada na conexão com o servidor proxy, caso necessário.
proxy/rdns Se for "True" (padrão), as consultas de DNS não serão realizadas localmente. Em vez disso, elas serão entregues ao proxy para ser resolvidas.

A seguir