Faça a gestão das configurações da CLI gdcloud

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

As propriedades que são armazenadas habitualmente em configurações incluem o URL da consola da organização e o ID do projeto. As configurações permitem-lhe definir e ativar estas e outras definições em conjunto como um grupo.

As configurações são armazenadas no diretório de configuração do utilizador, normalmente ~/.config/gdcloud no Linux, $HOME/Library/Application Support/gdcloud no Mac e %AppData%\gdcloud no Windows. Tenha também em atenção que o diretório de configuração tem de ter a escrita ativada.

Se tiver várias configurações, pode optar por alternar entre elas ou executar comandos com uma configuração específica com a sinalização --configuration. Para saber mais sobre como alternar entre configurações, consulte a secção Ative uma configuração.

Para ler sobre as configurações a partir da linha de comandos e ver uma lista completa das propriedades disponíveis e das secções em que se encontram, execute gdcloud topic configurations.

Configuração predefinida

Inicialmente, a CLI gdcloud cria uma única configuração denominada default. Pode definir propriedades na sua configuração executando o comando gdcloud init ou executando gdcloud config set diretamente.

Várias configurações

A configuração default única é adequada para muitos exemplos de utilização. No entanto, também pode criar configurações adicionais e alternar entre elas conforme necessário com gdcloud config configurations activate. A configuração default inicial é criada por conveniência e não é necessária para a utilização. Pode dar o nome que quiser a esta e a quaisquer configurações adicionais.

As várias configurações são úteis se quiser:

  • Usar vários projetos: pode criar uma configuração separada para cada projeto e alternar entre eles conforme necessário.
  • Usar vários URLs da consola da organização.
  • Realizar tarefas geralmente independentes: por exemplo, pode usar uma configuração para trabalhar no serviço A num projeto e gerir um serviço B não relacionado noutro projeto.

Crie uma configuração

Para criar uma configuração, execute:

gdcloud config configurations create NAME

Tem de ativar a nova configuração após a criação para a usar.

Ative uma configuração

Apenas uma das várias configurações pode estar ativa num determinado momento. A configuração ativa é a configuração cujas propriedades regem o comportamento da CLI gdcloud.

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

gdcloud config configurations activate NAME

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

Para alterar a configuração ativa para uma única invocação de comando, aplique a sinalização --configuration a qualquer comando da CLI gdcloud:

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

Liste as configurações

Para listar as configurações na CLI gdcloud, 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

Defina as propriedades de configuração

Para definir e anular a definição das propriedades na configuração ativa, execute:

gdcloud config set project PROJECT

Veja as propriedades de configuração

Para ver as propriedades numa 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"
  core:
    organization_console_url: https://console.example.com
    project: example-project

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

gdcloud config list

Elimine uma configuração

Para eliminar uma configuração, execute:

gdcloud config configurations delete NAME

Não pode eliminar uma configuração ativa. Para mudar para outra configuração antes de eliminar, use gdcloud config configurations activate, se necessário.