Descripción general de la CLI de gcloud

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

¿Qué es gcloud CLI?

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

Por ejemplo, puedes usar gcloud CLI para crear y administrar los siguientes elementos:

  • 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.

Descarga e instala gcloud CLI

La versión actual de gcloud CLI es 498.0.0.

Aunque te recomendamos que uses la versión actual de gcloud CLI, también puedes descargar e instalar versiones anteriores desde el archivo de descarga.

Si usas Cloud Shell, gcloud CLI está disponible automáticamente y no tendrás que instalarlo. De lo contrario, descarga e instala gcloud CLI y, luego, inicializarlo.

De forma predeterminada, la CLI de gcloud instala los comandos que están 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 Bigtable, Dataflow y otras partes de Google Cloud en niveles de versiones anteriores a la Disponibilidad general.

Hoja de referencia de gcloud CLI

Para una introducción rápida a gcloud CLI, una lista de las instancias que usaste y para ver cómo se estructuran, consulta la Hoja de referencia de gcloud CLI.

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 un aviso anticipado de los cambios en los comandos que generan errores en la funcionalidad actual, consulta las notas de la versión.
Beta beta Los comandos están completos en cuanto a funcionalidad, pero aún podrían tener algunos problemas. Pueden realizarse cambios rotundos en estos comandos sin 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 lo instalas. con gcloud CLI. 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 pedirá que lo instales.

Grupos de comandos

Dentro de cada nivel de actualización, los comandos de la CLI de gcloud están organizados 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 parámetros de configuración que afectará el comportamiento de gcloud CLI con herramientas de visualización. 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 ofrecer una experiencia de lector de pantalla más optimizada, 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 API de de herramienta de línea de comandos, consulta la Cómo habilitar las funciones de accesibilidad .

Configuraciones

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

Cuando comiences a usar la CLI de gcloud, trabajarás con una única configuración llamada default y puedes 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 cambiar entre ellas. En una configuración, puedes personalizar las propiedades. Por ejemplo, para configurar tu proyecto dentro de 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 determinan el comportamiento de los comandos en un nivel por invocación. Las opciones anula los valores establecidos en las propiedades de gcloud CLI.

Argumentos y opciones posicionales

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

Uso de stdout y stderr

El resultado de los comandos de la CLI de gcloud que se ejecutan correctamente se escribe en stdout. Cualquier otro tipo de respuesta (mensajes, advertencias y errores) se escribe en stderr. No uses la secuencia de comandos en función de las respuestas escritas en stderr porque estas respuestas no son estables.

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

Mensajes

Como 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 información adicional. Por ejemplo, se te pedirá que elijas una zona cuando crees una instancia de máquina virtual de Compute Engine con gcloud compute instances create test-instance.

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

No crees secuencias de comandos con las palabras de las solicitudes porque las palabras puede 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 los comandos de la CLI de gcloud y resulta útil para crear secuencias de comandos. Si se necesita una entrada, se usarán los valores predeterminados. Si no hay una opción predeterminada, se genera un error.

Para eliminar 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 formato en el resultado estándar. Para producir resultados más significativos, las opciones format, filter y projection te permiten ajustar tus resultados.

Para definir solo el formato del resultado, usa la opción --format para producir una versión tabulada o plana de este (para pantalla interactiva), o una versión del resultado que la máquina pueda procesar (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 y rápido instructivo interactivo con un clic en Abrir en Cloud Shell.

Abrir en Cloud Shell

¿Qué sigue?