Administra la configuración de gcloud CLI

Una configuración es un conjunto determinado de propiedades de Google Cloud CLI. Estas propiedades son pares clave-valor, organizados en secciones, que determinan el comportamiento de gcloud CLI.

Las propiedades que se almacenan normalmente en las configuraciones incluyen la zona predeterminada de Compute Engine, el nivel de verbosidad, informes de uso, ID de proyecto y una cuenta de usuario o de servicio activa. Las configuraciones te permiten definir y habilitar estos y otros ajustes como un grupo.

Las configuraciones se almacenan en el directorio de configuración de usuario (por lo general, ~/.config/gcloud en macOS y Linux, o %APPDATA%\gcloud en Windows). Puedes encontrar la ubicación del directorio de configuración ejecutando gcloud info --format='value(config.paths.global_config_dir)'. Para cambiar el directorio de configuración, configura la variable de entorno CLOUDSDK_CONFIG. Además, ten en cuenta que el directorio de configuración debe estar habilitado para la escritura. Sin embargo, si usas Cloud Shell, tus preferencias de gcloud CLI se almacenan en una carpeta temporal tmp, establecida solo en tu pestaña de Cloud Shell actual, y no se conservan entre sesiones.

Si tienes varias opciones de configuración, puedes optar por alternar entre ellas o ejecutar comandos mediante una configuración específica (con la ayuda de la marca --configuration). Para obtener más información sobre el cambio de configuración, consulta la sección que aparece a continuación sobre cómo activar opciones de configuración.

Para leer sobre las configuraciones desde la línea de comandos (junto con una lista completa de las propiedades disponibles y las secciones en las que se encuentran), ejecuta gcloud topic configurations.

Configuración predeterminada

Gcloud CLI comienza con una sola configuración llamada default. Para establecer las propiedades en tu configuración, ejecuta el comando gcloud init o ejecuta gcloud config set directamente.

Por ejemplo, para inhabilitar los mensajes para la secuencia de comandos, ejecuta lo siguiente:

gcloud config set disable_prompts true

Múltiples configuraciones

La única configuración default es adecuada para la mayoría de los casos prácticos. Sin embargo, también puedes crear opciones de configuración adicionales y alternar entre ellas según sea necesario con gcloud config configurations activate. No hay nada especial acerca de la configuración default inicial; se crea para tu conveniencia. Puedes nombrar esta y cualquier configuración adicional como prefieras.

Contar con múltiples configuraciones es útil si quieres hacer lo siguiente:

  • Usar varios proyectos: Puedes crear una configuración distinta para cada proyecto y alternar entre ellas según sea necesario.
  • Usar varias cuentas de autorización.
  • Realizar tareas independientes en general: Por ejemplo, puedes usar una configuración para trabajar en una aplicación de App Engine en un proyecto y administrar instancias de Compute Engine no vinculadas en otro proyecto.

Crea una configuración

Para crear una configuración, ejecuta gcloud config configurations create:

gcloud config configurations create [NAME]

Después de crear la configuración, debes activarla para poder usarla.

Cómo activar una configuración

Solo una de tus configuraciones puede estar activa en un momento determinado. La configuración activa es la configuración cuyas propiedades determinan el comportamiento de gcloud CLI.

Para activar una configuración o cambiar a una configuración activa nueva, ejecuta gcloud config configurations activate:

gcloud config configurations activate [NAME]

gcloud config list siempre te mostrará las propiedades en tu configuración activa.

A fin de cambiar la configuración activa para una sola invocación de comando, puedes usar la marca --configuration en cualquier comando de la CLI de gcloud:

gcloud auth list --configuration=[CONFIGURATION_NAME]

Para cambiar la configuración activa para todos los comandos en tu terminal actual, puedes establecer la variable de entorno CLOUDSDK_ACTIVE_CONFIG_NAME con el nombre de la configuración que deseas usar.

Automatiza el cambio de configuración

Para ayudar a que el cambio de configuraciones sea eficiente, puedes aprovechar herramientas como direnv y ondir para cambiar automáticamente entre configuraciones cuando cambias de directorios de trabajo. Una manera de lograr esto es establecer las variables de entorno necesarias (como CLOUDSDK_ACTIVE_CONFIG_NAME) en el archivo .envrc, en el directorio raíz de tu proyecto.

Haz una lista de configuraciones

Para ver una lista de las configuraciones en tu instalación de gcloud CLI, ejecuta gcloud config configurations list:

gcloud config configurations list

Gcloud CLI enumera las configuraciones y muestra qué configuración está activa:

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

Establece las propiedades de configuración

Para configurar o cambiar las propiedades en la configuración activa, ejecuta gcloud config set y gcloud config unset:

gcloud config set project [PROJECT]

gcloud config unset project

Las propiedades también se pueden establecer mediante variables del entorno llamadas CLOUDSDK_SECTION_NAME_PROPERTY_NAME. Por ejemplo, puedes configurar las propiedades core/project y compute/zone de la siguiente manera:

CLOUDSDK_CORE_PROJECT=[YOUR_PROJECT_NAME]

CLOUDSDK_COMPUTE_ZONE=[YOUR_ZONE_NAME]

Consulta las propiedades de configuración

Para ver las propiedades de una configuración, ejecuta: gcloud config configurations describe:

gcloud config configurations describe [NAME]

O, para ver las propiedades en la configuración activa, lo siguiente:

gcloud config list

La CLI de gcloud imprime las propiedades de configuración:

is_active: false
name: default
properties:
  compute:
    region: us-east1
    zone: us-east1-b
  core:
    account: user@google.com
    project: example-project

Borra una configuración

Para borrar una configuración, ejecuta gcloud config configurations delete:

gcloud config configurations delete [NAME]

No puedes borrar la configuración activa. Usa gcloud config configurations activate si es necesario para cambiar a otra configuración antes de borrarla.

¿Qué sigue?