Administra propiedades del SDK

¿Qué es una propiedad?

Las propiedades son ajustes que afectan el comportamiento de la CLI de gcloud y de otras herramientas del SDK.

Las propiedades se pueden usar con el fin de definir una configuración por producto o servicio, como la cuenta usada por la CLI de gcloud y otras herramientas del SDK de Cloud para autorización, la región predeterminada que se usará cuando se trabaja con recursos de Google Compute Engine o incluso la opción para desactivar las actualizaciones automáticas del componente del SDK de Cloud. Las propiedades también se pueden usar para definir las preferencias de la herramienta de línea de comandos de gcloud, como el nivel de verbosidad y la configuración del mensaje de los comandos de la CLI de gcloud.

Propiedades y marcas

La CLI de gcloud admite algunas marcas globales y marcas de comando que tienen el mismo efecto que las propiedades del SDK. Por ejemplo, la CLI de gcloud admite la marca --project y la propiedad project. Las propiedades te permiten mantener la misma configuración en todas las ejecuciones de comandos, mientras que las marcas afectan el comportamiento de los comandos por invocación. Ten en cuenta que las marcas anulan las propiedades cuando ambas están configuradas.

Configuraciones

Una configuración es un conjunto determinado de propiedades del SDK. La CLI de gcloud usa una configuración denominada default como la configuración activa inicial. default es adecuada para la mayoría de los casos prácticos. Sin embargo, también puedes crear configuraciones adicionales y alternar entre ellas según sea necesario.

Haz una lista de las propiedades

Para ver una lista de las propiedades en la configuración activa, ejecuta gcloud config list:

gcloud config list

La CLI de gcloud muestra la lista de propiedades:

[compute]
region = us-east1
zone = us-east1-d
[core]
account = user@google.com
disable_usage_reporting = False
project = example-project
[metrics]
command_name = gcloud.config.list

Configura propiedades

Para configurar una propiedad en la configuración activa, ejecuta gcloud config set:

gcloud config set project [PROJECT]

Para configurar propiedades que no se encuentran en la sección de propiedades core, debes especificar la sección seguida de una barra diagonal antes del nombre de la propiedad:

gcloud config set compute/zone us-east1-b

Desconfigura propiedades

Para desactivar una propiedad en la configuración activa, usa gcloud config unset:

gcloud config unset disable_usage_reporting

Tipos de propiedad

Las propiedades del SDK están organizadas en secciones que agrupan las propiedades relacionadas por conveniencia cuando ves las listas de propiedades.

Propiedades principales

La sección core contiene propiedades de configuración para el comando gcloud.

Nombre Descripción
account Cuenta de usuario o cuenta de servicio que usa la CLI de gcloud y otras herramientas del SDK para la autorización.
custom_ca_certs_file Ruta de acceso absoluta al archivo del certificado de CA personalizado que se usará.
disable_color Si se configura como True, evita que la CLI de gcloud imprima mensajes en color en la terminal.
disable_file_logging Si se configura como True, la CLI de gcloud no almacenará los registros en un archivo. Esto puede ser útil si el espacio en el disco es limitado.
disable_prompts Si se configura como True, se suprimen los mensajes de todos los comandos de la CLI de gcloud y se presume la respuesta predeterminada. Si un comando requiere una entrada del usuario y no se puede usar un valor predeterminado, la CLI de gcloud informa un error. Equivale a la marca --quiet global.
disable_usage_reporting Si se configura como True, inhabilita la recopilación de estadísticas anónimas sobre el uso del SDK. Configuras este valor cuando instalas el SDK, pero puedes modificarlo en cualquier momento.
log_http Si se configura en True, habilita la escritura de solicitudes HTTP y respuestas a registros. Si deseas ver estos mensajes en tu terminal, ajusta tu nivel de verbosidad mediante la propiedad verbosity o la marca --verbosity global.
max_log_days Cantidad máxima de días para conservar los archivos de registro antes de borrarlos Si se establece en 0, se desactiva la recolección de registros no utilizados y no se borran los archivos de registro. Si no se configura, el valor predeterminado es 30 días.
pass_credentials_to_gsutil Si se configura como True, pasa la autenticación del SDK de Cloud configurado a gsutil.
project ID de proyecto del proyecto actual de Cloud Platform. Puedes anular este valor mediante la marca --project global.
show_structured_logs La visibilidad y el formato de los mensajes de registro estructurados en JSON se escriben en el error estándar. Si su propiedad está inhabilitada, los registros tendrán el formato text de manera predeterminada. Los valores válidos son never, always, log y terminal. Si no se configura, el valor predeterminado es never.
trace_token Token proporcionado por la Atención al cliente de Google para el enrutamiento de registros de solicitudes de servicio para la investigación de problemas.
user_output_enabled Habilita la impresión del resultado del comando para resultado estándar y error estándar en la terminal. Si se configura en False, se elimina el resultado.
verbosity Registro de verbosidad para comandos de la CLI de gcloud La CLI de gcloud admite los siguientes niveles de verbosidad estándar:
  • debug
  • info
  • warning
  • error
  • critical
  • none
Equivalente al uso de la marca --verbosity global.

Propiedades del administrador de componentes

La sección component_manager contiene las propiedades que se usan cuando se administran componentes del SDK.

Name Descripción
component_manager/additional_repositories Lista separada por comas de repositorios adicionales para buscar componentes. Los comandos del grupo de comandos de gcloud components repositories administran esta propiedad automáticamente.
component_manager/disable_update_check Si se configura en True, el SDK no comprueba automáticamente si hay actualizaciones.

Propiedades de App Engine

La sección app contiene propiedades que especifican el comportamiento del comando gcloud app deploy.

Name Descripción
app/cloud_build_timeout Tiempo, en segundos, para esperar a que se completen las compilaciones de Docker durante las implementaciones. Todas las compilaciones de Docker ahora usan la API Cloud Build.
app/promote_by_default Si es True, promueve la versión para recibir todo el tráfico de un servicio cuando implementa una nueva versión del servicio. Esta propiedad se puede anular mediante las marcas --promote-by-default o --no-promote-by-default.
app/stop_previous_version Si es True, detiene la versión implementada previamente cuando implementa una nueva versión de la aplicación. Si se configura en False, la versión anterior debe detenerse manualmente antes de la implementación.
app/use_runtime_builders Si se establece, alternar el uso de una nueva ruta de código para crear aplicaciones con entornos de ejecución prefabricados que se pueden actualizar independientemente de las herramientas del cliente. Si no se establece, se usa la ruta predeterminada para cada entorno de ejecución.

Propiedades de Compute Engine

La sección compute incluye las propiedades que usan los comandos de la CLI de gcloud que operan en los recursos de Google Compute Engine.

Name Descripción
compute/region Región predeterminada que se usa cuando se trabaja con recursos de Compute Engine. Si un comando de la CLI de gcloud requiere la marca --region, pero no se proporciona, se usa este valor.
compute/zone Zona predeterminada que se usa cuando se trabaja con recursos de Compute Engine. Si un comando de la CLI de gcloud requiere la marca --zone, pero no se proporciona, se usa este valor.

Propiedades de Kubernetes Engine

La sección container contiene las propiedades que usan los comandos de la CLI de gcloud que operan en los clústeres de Google Kubernetes Engine.

Name Descripción
container/cluster Nombre del clúster predeterminado.

Propiedades del proxy de red

La sección proxy contiene las propiedades relacionadas con el uso de proxies de red mediante el comando gcloud.

Name Descripción
proxy/type Tipo de servidor proxy. Los tipos de proxy compatibles son los siguientes:
  • http
  • http_no_tunnel
  • socks4
  • socks5
proxy/address Nombre de host o dirección IP del servidor proxy.
proxy/port Puerto usado al conectarse al servidor proxy.
proxy/username Nombre de usuario usado al conectarse al servidor proxy, si es necesario.
proxy/password Contraseña usada al conectarse al servidor proxy, si es necesaria.
proxy/rdns Si se configura en True (predeterminado), las consultas de DNS no se ejecutarán localmente. En cambio, se entregarán al proxy para que las resuelva.

Qué sigue