Gestionar configuraciones de la CLI de gdcloud

Una configuración es un conjunto de propiedades de la CLI de Distributed Cloud con nombre. Estas propiedades son pares clave-valor organizados en secciones que rigen el comportamiento de la CLI gdcloud.

Entre las propiedades que suelen almacenarse en las configuraciones se incluyen la URL de la consola de la organización y el ID del proyecto. Las configuraciones te permiten definir y habilitar estos y otros ajustes como un grupo.

Las configuraciones se almacenan en el directorio de configuración del usuario, que suele ser ~/.config/gdcloud en Linux, $HOME/Library/Application Support/gdcloud en Mac y %AppData%\gdcloud en Windows. Además, ten en cuenta que el directorio de configuración debe tener habilitado el acceso de escritura.

Si tienes varias configuraciones, puedes cambiar de una a otra o ejecutar comandos con una configuración específica mediante la marca --configuration. Para obtener más información sobre cómo cambiar de configuración, consulta la sección sobre Activar una configuración.

Para obtener información sobre las configuraciones desde la línea de comandos y ver una lista completa de las propiedades disponibles y las secciones en las que se encuentran, ejecuta gdcloud topic configurations.

Configuración predeterminada

La CLI gdcloud crea inicialmente una única configuración llamada default. Puedes definir propiedades en tu configuración ejecutando el comando gdcloud init o gdcloud config set directamente.

Varias configuraciones

La configuración default es adecuada para muchos casos prácticos. Sin embargo, también puedes crear configuraciones adicionales y cambiar de una a otra según sea necesario con gdcloud config configurations activate. La configuración default inicial se crea por comodidad y no es obligatoria. Puedes asignar el nombre que quieras a esta y a cualquier otra configuración.

Las configuraciones múltiples son útiles si quieres hacer lo siguiente:

  • Usar varios proyectos: puedes crear una configuración independiente para cada proyecto y cambiar de una a otra según sea necesario.
  • Usar varias URLs de la consola de la organización.
  • Realizar tareas generalmente independientes: por ejemplo, puedes usar una configuración para trabajar en el servicio A de un proyecto y gestionar un servicio B no relacionado en otro proyecto.

Crear una configuración

Para crear una configuración, ejecuta lo siguiente:

gdcloud config configurations create NAME

Debes activar la nueva configuración después de crearla para poder usarla.

Activar una configuración

Solo una de tus varias configuraciones puede estar activa en un momento dado. La configuración activa es aquella cuyas propiedades rigen el comportamiento de la CLI gdcloud.

Para activar una nueva configuración o cambiar a una nueva configuración activa, ejecuta lo siguiente:

gdcloud config configurations activate NAME

gdcloud config list siempre muestra las propiedades de la configuración activa.

Para cambiar la configuración activa en una sola invocación de comando, aplica la marca --configuration a cualquier comando de la CLI gdcloud:

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

Mostrar una lista de configuraciones

Para mostrar una lista de las configuraciones de la CLI gdcloud, ejecuta lo siguiente:

gdcloud config configurations list

La CLI gdcloud muestra las configuraciones y la configuración activa:

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

Definir propiedades de configuración

Para definir y anular la definición de las propiedades de la configuración activa, ejecuta lo siguiente:

gdcloud config set project PROJECT

Ver propiedades de configuración

Para ver las propiedades de una configuración, ejecuta lo siguiente:

gdcloud config configurations describe NAME

La CLI gdcloud muestra las propiedades de configuración:

is_active: false
name: default
properties:
  accessibility:
    screen_reader: "false"
  core:
    organization_console_url: https://console.example.com
    project: example-project

Para ver las propiedades de la configuración activa, ejecuta lo siguiente:

gdcloud config list

Eliminar una configuración

Para eliminar una configuración, ejecuta lo siguiente:

gdcloud config configurations delete NAME

No puedes eliminar una configuración activa. Para cambiar a otra configuración antes de eliminarla, usa gdcloud config configurations activate si es necesario.