Gerenciar configurações da CLI gdcloud

Uma configuração é um conjunto nomeado de propriedades da CLI do Distributed Cloud. Essas propriedades são pares de chave-valor, organizados em seções, que regem o comportamento da CLI gdcloud.

As propriedades comumente armazenadas nas configurações incluem o URL do console da organização e o ID do projeto. As configurações permitem que você defina e ative essas e outras configurações como um grupo.

As configurações são armazenadas no diretório de configuração do usuário, normalmente ~/.config/gdcloud no macOS e no Linux. Além disso, o diretório de configuração precisa ser ativado para gravação.

Se você tiver várias configurações, é possível alternar entre elas ou executar comandos usando uma configuração específica com a flag --configuration. Para saber mais sobre como mudar as configurações, consulte a seção Ativar uma configuração.

Para ler sobre as configurações na linha de comando e uma lista completa de propriedades disponíveis e as seções em que elas estão, execute gdcloud topic configurations.

Configuração padrão

A CLI gdcloud cria inicialmente uma única configuração chamada default. É possível definir propriedades na sua configuração executando o comando gdcloud init ou gdcloud config set diretamente.

Várias configurações

A única configuração default é adequada para muitos casos de uso. No entanto, também é possível criar outras configurações e alternar entre elas conforme necessário usando gdcloud config configurations activate. A configuração inicial de default é criada como uma conveniência e não é obrigatória para uso. É possível nomear essa e qualquer outra configuração conforme sua preferência.

Dependendo da sua intenção de uso, várias configurações são úteis:

• Usar vários projetos: é possível criar uma configuração separada para cada projeto e alternar entre eles conforme necessário.
• Usar vários URLs do console da organização.
• Executar tarefas geralmente independentes: por exemplo, é possível usar uma configuração para trabalhar no serviço A em um projeto e gerenciar um serviço B não relacionado em outro projeto.

Criar uma configuração

Para criar uma configuração, execute:

gdcloud config configurations create NAME

Você precisa ativar a nova configuração depois da criação para usá-la.

Ativar uma configuração

Apenas uma das diversas configurações pode estar ativa em um determinado momento. As propriedades da configuração ativa controlam o comportamento da CLI gdcloud.

Para ativar uma nova configuração ou alternar para uma nova configuração ativa, execute:

gdcloud config configurations activate NAME

gdcloud config list sempre mostra as propriedades na sua configuração ativa.

Para mudar a configuração ativa de uma única invocação de comando, aplique a flag --configuration a qualquer comando da CLI gcloud:

gdcloud auth print-identity-token --configuration=CONFIGURATION

Listar configurações

Para listar as configurações na gcloud CLI, execute:

gdcloud config configurations list

A CLI gdcloud lista as configurações e mostra qual está ativa:

NAME                ISACTIVE   PROPERTIES.CORE.PROJECT PROPERTIES.CORE.ORGANIZATIONCONSOLEURL
default             False      example-project-default https://console.default-org.example.com
config-project-1    False      example-project-1       https://console.org-1.example.com
config-project-2    False      example-project-2       https://console.org-2.example.com

Como definir propriedades de configuração

Para definir e remover as propriedades da configuração ativa, execute:

gdcloud config set project PROJECT

Como visualizar propriedades de configuração

Para ver as propriedades em uma configuração, execute:

gdcloud config configurations describe NAME

A CLI gdcloud imprime as propriedades de configuração:

is_active: false
name: default
properties:
  accessibility:
    screen_reader: "false"
  auth:
    login_config_cert_path: /tmp/root-web-tls-ca.cert
  core:
    organization_console_url: https://console.example.com
    project: example-project

Para ver as propriedades na configuração ativa, execute:

gdcloud config list

Excluir uma configuração

Para excluir uma configuração, execute:

gdcloud config configurations delete NAME

Não é possível excluir uma configuração ativa. Para mudar para outra configuração antes de excluir, use gdcloud config configurations activate, se necessário.