Uma configuração é um conjunto nomeado de propriedades da Google Cloud CLI. Essas propriedades são pares de chave-valor, organizados em seções, que controlam o comportamento da gcloud CLI.
As propriedades comumente armazenadas em configurações incluem a zona padrão do Compute Engine, o nível de detalhamento, os relatórios de uso, o ID do projeto e uma conta de usuário ou serviço ativa. As configurações permitem que você defina e ative essas e outras configurações em conjunto, como um grupo.
As configurações são armazenadas no diretório de configuração do usuário (normalmente ~/.config/gcloud no macOS e Linux, ou %APPDATA%\gcloud no Windows). Você pode encontrar a localização do diretório de configuração executando gcloud info --format='value(config.paths.global_config_dir)' . O diretório de configuração pode ser alterado definindo a variável de ambiente CLOUDSDK_CONFIG . Observe também que o diretório de configuração deve estar habilitado para gravação. No entanto, se você estiver usando o Cloud Shell, suas preferências da CLI do gcloud serão armazenadas em uma pasta temporária tmp , definida apenas para a sua guia atual do Cloud Shell, e não persistirá entre as sessões.
Se você tiver várias configurações, poderá optar por alternar entre elas ou executar comandos usando uma configuração específica (com a ajuda do sinalizador --configuration ). Para saber mais sobre como alternar configurações, consulte a seção abaixo sobre Ativação de configurações .
Para ler sobre configurações na linha de comando (junto com uma lista completa de propriedades disponíveis e as seções em que elas estão), execute gcloud topic configurations .
Configuração padrão
A CLI do gcloud inicia com uma única configuração chamada default . Você pode definir propriedades na sua configuração executando o comando gcloud init ou executando gcloud config set diretamente.
Por exemplo, para desabilitar a solicitação de script, execute:
gcloud config set disable_prompts true
Múltiplas configurações
A configuração default única é adequada para muitos casos de uso. No entanto, você também pode criar configurações adicionais e alternar entre elas conforme necessário usando gcloud config configurations activate . Não há nada de especial na configuração default inicial; ela é criada por conveniência. Você pode nomear esta e quaisquer configurações adicionais como desejar.
Várias configurações são úteis se você quiser:
- Usar vários projetos : você pode criar uma configuração separada para cada projeto e alternar entre eles conforme necessário.
- Use várias contas de autorização
- Execute tarefas geralmente independentes : por exemplo, você pode usar uma configuração para trabalhar em um aplicativo do App Engine em um projeto e gerenciar instâncias não relacionadas do Compute Engine em outro projeto.
Criando uma configuração
Para criar uma configuração, execute gcloud config configurations create :
gcloud config configurations create [NAME]
Você deve ativar a nova configuração após a criação para poder usá-la.
Ativando uma configuração
Apenas uma das suas múltiplas configurações pode estar ativa por vez. A configuração ativa é aquela cujas propriedades determinarão o comportamento da CLI do gcloud.
Para ativar uma nova configuração ou alternar para uma nova configuração ativa, execute: gcloud config configurations activate :
gcloud config configurations activate [NAME]
gcloud config list sempre mostrará as propriedades na sua configuração ativa.
Para alterar a configuração ativa de uma única invocação de comando, você pode usar o sinalizador --configuration em qualquer comando da CLI do gcloud:
gcloud auth list --configuration=[CONFIGURATION_NAME]
Para alterar a configuração ativa de todos os comandos no seu terminal atual, você pode definir a variável de ambiente CLOUDSDK_ACTIVE_CONFIG_NAME como o nome da configuração que deseja usar.
Automatizando a troca de configuração
Para facilitar a alteração de configurações, você pode utilizar ferramentas como direnv e ondir para alternar automaticamente entre as configurações ao alternar entre diretórios de trabalho. Uma maneira de fazer isso é definir as variáveis de ambiente necessárias (como CLOUDSDK_ACTIVE_CONFIG_NAME ) no arquivo .envrc no diretório raiz do seu projeto.
Configurações de listagem
Para listar as configurações na instalação do gcloud CLI, execute gcloud config configurations list :
gcloud config configurations list
A CLI do gcloud lista as configurações e mostra qual configuração está ativa:
NAME IS_ACTIVE ACCOUNT PROJECT DEFAULT_ZONE DEFAULT_REGION default False user@gmail.com example-project-1 us-east1-b us-east1 project-1 False user@gmail.com example-project-2 us-east1-c us-east1 project-2 True user@gmail.com example-project-3 us-east1-b us-east1
Definindo propriedades de configuração
Para definir e desconfigurar as propriedades na configuração ativa, execute gcloud config set e gcloud config unset :
gcloud config set project [PROJECT]
gcloud config unset project
Propriedades também podem ser definidas por meio de variáveis de ambiente denominadas CLOUDSDK_SECTION_NAME_PROPERTY_NAME . Por exemplo, você pode definir as propriedades core/project e compute/zone da seguinte forma:
CLOUDSDK_CORE_PROJECT=[YOUR_PROJECT_NAME]
CLOUDSDK_COMPUTE_ZONE=[YOUR_ZONE_NAME]
Visualizando propriedades de configuração
Para visualizar as propriedades em uma configuração, execute: gcloud config configurations describe :
gcloud config configurations describe [NAME]
Ou, para visualizar propriedades na configuração ativa:
gcloud config list
A CLI do gcloud imprime as propriedades de configuração:
is_active: false
name: default
properties:
compute:
region: us-east1
zone: us-east1-b
core:
account: user@google.com
project: example-project
Excluindo uma configuração
Para excluir uma configuração, execute: gcloud config configurations delete :
gcloud config configurations delete [NAME]
Não é possível excluir a configuração ativa. Use gcloud config configurations activate se necessário para alternar para outra configuração antes de excluir.
O que vem a seguir
- Leia as propriedades da CLI do gcloud para saber mais sobre propriedades.