Descripción general de la CLI de gcloud

Esta página contiene una descripción general de la CLI de Google Cloud y sus patrones de comando y capacidades comunes.

¿Qué es la CLI de gcloud?

La CLI de Google Cloud es un conjunto de herramientas para crear y administrar recursos de Google Cloud. Puedes usar estas herramientas para realizar muchas tareas comunes en la plataforma desde la línea de comandos o a través de secuencias de comandos y otras automatizaciones.

Por ejemplo, puedes usar la CLI de gcloud para crear y administrar lo siguiente:

  • Instancias de máquina virtual de Google Compute Engine y otros recursos
  • Instancias de Cloud SQL
  • Clústeres de Google Kubernetes Engine
  • Clústeres y trabajos de Dataproc
  • Zonas administradas y conjuntos de registros de Cloud DNS
  • Implementaciones de Cloud Deployment Manager

También puedes usar la CLI de gcloud para implementar aplicaciones de App Engine, administrar la autenticación, personalizar la configuración local y realizar otras tareas.

La hoja de referencia de la CLI de gcloud

Para obtener una introducción breve a la CLI de gcloud, una lista de los comandos de uso general y una manera de estructurar estos comandos, consulta la hoja de referencia de la CLI de gcloud.

Descarga y, luego, instala la CLI de gcloud

Antes de usar la CLI de gcloud, descarga y, luego, instala la CLI de gcloud en tu sistema y, luego, inicializa.

De forma predeterminada, la CLI de gcloud instala los comandos en el nivel de disponibilidad general. Hay funciones adicionales disponibles en los componentes de la CLI de gcloud llamados alpha y beta. Estos componentes te permiten usar la CLI de gcloud para trabajar con Cloud Bigtable, Dataflow y otras partes de Google Cloud en niveles de actualizaciones anteriores a la Disponibilidad general.

La versión actual de la CLI de gcloud es 386.0.0. Puedes descargar y también instalar versiones anteriores de la CLI de gcloud desde el archivo de descargas.

Niveles de actualización

Los comandos de la CLI de gcloud tienen los siguientes niveles de actualización:

Nivel de actualización Etiqueta Descripción
Disponibilidad general Ninguna Los comandos se consideran totalmente estables y disponibles para su uso en producción. Para obtener avisos anticipados de los cambios que afectan la funcionalidad actual, consulta las notas de la versión.
Beta beta Los comandos están completos desde el punto de vista funcional, pero aún pueden tener algunos problemas pendientes. Se pueden realizar cambios rotundos en estos comandos sin previo aviso.
Alfa alpha Los comandos están en su actualización temprana y pueden cambiar sin aviso.

Los componentes alpha y beta no se instalan de forma predeterminada cuando instalas la CLI de gcloud. Debes instalar estos componentes por separado con el comando gcloud components install. Si intentas ejecutar un comando alfa o beta y el componente correspondiente no está instalado, la CLI de gcloud te solicita que lo instales.

Grupos de comandos

Dentro de cada nivel de actualización, los comandos de la CLI de gcloud se organizan en una jerarquía anidada de grupos de comandos, cada uno de los cuales representa un producto o una función de Google Cloud o sus subgrupos funcionales.

Por ejemplo:

Grupo de comandos Descripción
gcloud compute Comandos relacionados con Compute Engine disponibles de forma general
gcloud compute instances Comandos relacionados con instancias de Compute Engine disponibles de forma general
gcloud beta compute Comandos relacionados con Compute Engine en Beta
gcloud alpha app Comandos relacionados con la administración de implementaciones de App Engine en Alfa

Ejecuta los comandos de la CLI de gcloud

Puedes ejecutar comandos de la CLI de gcloud desde la línea de comandos y desde secuencias de comandos y otras automatizaciones, por ejemplo, cuando usas Jenkins para automatizar tareas de Google Cloud.

Propiedades

Las propiedades de la CLI de gcloud son ajustes que afectan el comportamiento de las herramientas de la CLI de gcloud. Algunas de estas propiedades se pueden configurar mediante opciones globales o de comando, en cuyo caso, tiene prioridad el valor establecido por la opción.

Habilita las funciones de accesibilidad

Para obtener una experiencia más optimizada de lector de pantalla, la CLI de gcloud incluye una propiedad accessibility/screen_reader.

Para habilitar la propiedad de accesibilidad, ejecuta lo siguiente:

gcloud config set accessibility/screen_reader true

Para obtener más detalles sobre las funciones de accesibilidad que vienen con la herramienta de línea de comandos de gcloud, consulta la guía Habilita funciones de accesibilidad.

Configuraciones

Una configuración es un conjunto de propiedades de la CLI de gcloud. Una configuración funciona como un perfil.

Cuando comiences a usar la CLI de gcloud, trabajarás con una sola configuración llamada default y podrás establecer propiedades ejecutando gcloud init o gcloud config set. Esta única configuración predeterminada es adecuada para la mayoría de los casos prácticos.

Para trabajar con varios proyectos o cuentas de autorización, puedes establecer varias configuraciones con gcloud config configurations create y alternar entre las configuraciones. Dentro de una configuración, puedes personalizar las propiedades. Por ejemplo, para configurar tu proyecto en una configuración activa, usa la propiedad project:

gcloud config set project <project-id>

Para obtener una cuenta detallada de estos conceptos, consulta la guía de configuración.

Opciones globales

La CLI de gcloud proporciona un conjunto de opciones de la CLI de gcloud que rigen el comportamiento de los comandos en un nivel por invocación. Las opciones anulan los valores establecidos en las propiedades de la CLI de gcloud.

Argumentos posicionales y opciones

Si bien los argumentos posicionales y las opciones afectan el resultado de un comando de la CLI de gcloud, existe una diferencia sutil en los casos de uso. Se usa un argumento posicional para definir una entidad en la que opera un comando, mientras que se necesitan opciones para establecer una variación en el comportamiento de un comando.

Uso de stdout y stderr

El resultado de los comandos correctos de la CLI de gcloud se escribe en stdout. Todos los demás tipos de respuestas (mensajes, advertencias y errores) se escriben en stderr. No realices secuencias de comandos contra respuestas escritas en stderr porque estas respuestas no son estables.

Para conocer los lineamientos sobre el manejo de resultados, consulta la guía de secuencias de comandos.

Mensajes

Para brindar protección contra acciones destructivas no deseadas, la CLI de gcloud confirma tus intenciones antes de ejecutar comandos como gcloud projects delete.

Es posible que se te solicite agregar información adicional. Por ejemplo, se te pedirá que elijas una zona cuando crees una instancia de máquina virtual de Compute Engine mediante gcloud compute instances create test-instance.

Para inhabilitar los mensajes, usa la opción --quiet.

No escribas contra la redacción de los mensajes, ya que pueden cambiar.

Elimina mensajes, escribe a la terminal y haz registros

La opción --quiet (también -q) para la CLI de gcloud inhabilita todos los mensajes interactivos cuando se ejecutan comandos de la CLI de gcloud y es útil para las secuencias de comandos. Si se necesita una entrada, se usan las opciones predeterminadas. Si no hay un valor predeterminado, se genera un error.

Para suprimir la impresión del resultado del comando como una salida estándar o un error estándar en la terminal, usa la opción --no-user-output-enabled.

Para ajustar la verbosidad de los registros, especifica un nivel de verbosidad (depuración, información, advertencia, error, crítico o ninguno) con la opción --verbosity.

Determina la estructura del resultado

De forma predeterminada, cuando un comando de la CLI de gcloud muestra una lista de recursos, estos se imprimen con bastante exactitud en los resultados estándar. Para producir resultados más significativos, las opciones format, filter y projection te permiten ajustar los resultados.

Para definir solo el formato del resultado, usa la opción --format a fin de producir una versión tabulada o plana del resultado (para la pantalla interactiva), o una versión del resultado que se pueda leer (json, csv, yaml, value).

Para dar formato a una lista de claves que seleccionan valores de datos de recursos, usa projections. Para definir aún mejor los resultados según criterios que deseas especificar, usa filter.

Para familiarizarte con la funcionalidad de filtro y formato, puedes completar un instructivo interactivo rápido haciendo clic en Abrir en Cloud Shell.

Abrir en Cloud Shell

¿Qué sigue?