Descripción general de la herramienta de línea de comandos de gcloud

Esta página contiene una descripción general de la herramienta de línea de comandos de gcloud y sus patrones y capacidades de comando comunes.

¿Qué es la herramienta de línea de comandos de gcloud?

La interfaz de línea de comandos de gcloud es la principal herramienta de CLI para crear y administrar recursos de Google Cloud. Puedes usar esta herramienta para realizar varias tareas comunes en la plataforma, ya sea desde la línea de comandos o con 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 Google Cloud SQL
  • Clústeres de Google Kubernetes Engine
  • Trabajos y clústeres de Google Cloud Dataproc
  • Zonas administradas y conjuntos de registros de Google Cloud DNS
  • Implementaciones de Google 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. Para obtener más información sobre las funcionalidades de esta herramienta, puedes leer la referencia de la CLI de gcloud.

Hoja de referencia de la herramienta de línea de comandos de gcloud

Para obtener una introducción rápida a la herramienta de línea de comandos de gcloud, una lista de los comandos más utilizados y ver cómo están estructurados estos comandos, consulta la hoja de referencia de la herramienta de línea de comandos de gcloud.

La CLI de gcloud y el SDK de Cloud

La CLI de gcloud forma parte del SDK de Google Cloud. Debes descargar el SDK e instalarlo en tu sistema y, luego, inicializarlo para poder usar la herramienta de línea de comandos de gcloud.

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

Las versiones de la CLI de gcloud tienen el mismo número de versión que el SDK. La versión actual del SDK es 314.0.0. Puedes descargar y también instalar versiones previas del SDK desde el archivo de descargas.

Descarga la herramienta de línea de comandos de gcloud

Puedes descargar la versión más reciente del SDK de Cloud, que incluye la herramienta de línea de comandos de gcloud, desde la página 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. Se realizarán advertencias anticipadas para los comandos que rompen la funcionalidad actual y se documentarán en las notas de la versión.
Beta beta Los comandos son completos en cuanto a sus funciones, pero aún pueden 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 se instala el SDK. 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 herramienta de línea de comandos 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 Cloud Platform 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 de la misma forma en que usas otras herramientas de línea de comandos. También puedes ejecutar comandos de la CLI de gcloud desde secuencias de comandos y otras automatizaciones, por ejemplo, cuando usas Jenkins para automatizar tareas de Cloud Platform.

Propiedades

Las propiedades de la CLI de gcloud son ajustes que afectan el comportamiento de la CLI de gcloud y de otras herramientas del SDK de Cloud. Algunas de estas propiedades se pueden configurar mediante marcas globales o de comando, en cuyo caso, tendrá prioridad el valor establecido por la marca.

Habilita las funciones de accesibilidad

Para ofrecer una experiencia de lector de pantalla más optimizada, la herramienta de línea de comandos de gcloud incluye una propiedad accessibility/screen_reader.

Para habilitarla, 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 para habilitar funciones de accesibilidad.

Configuraciones

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

Comienza con el SDK de Cloud para trabajar con una única configuración llamada default y puedes establecer propiedades si ejecutas gcloud init o gcloud config set. Esta única configuración predeterminada es adecuada para la mayoría de los casos prácticos.

Si deseas trabajar con diversos proyectos o cuentas de autorización, puedes establecer varias configuraciones con gcloud config configurations create y cambiarlas según corresponda. Dentro de estas configuraciones, puede personalizar las propiedades. Por ejemplo, para establecer tu proyecto dentro de una configuración activa, use la propiedad project: gcloud config set project <project-id>.

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

Marcas globales

La CLI de gcloud proporciona un conjunto de marcas de toda la CLI de gcloud que determinan el comportamiento de los comandos en un nivel por invocación. Las marcas anulan cualquier valor configurado en las propiedades de SDK.

Marcas y argumentos posicionales

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

Uso de stdout y stderr

El resultado correcto de los comandos de la CLI de gcloud se escribe en stdout. Cualquier otro tipo de respuesta —mensajes, advertencias y errores— se escribe en stderr. Ten en cuenta que todo lo que se escribe en stderr no es estable y no debe incluirse en la secuencia de comandos.

Para obtener una lista definitiva de lineamientos sobre el manejo de resultados, consulta la Guía de secuencia de comandos.

Mensajes

Como protección contra acciones destructivas no deseadas, la CLI de gcloud confirmará tus intenciones antes de ejecutar comandos como gcloud projects delete.

También pueden aparecer mensajes si creas una instancia de máquina virtual de Google Compute Engine, por ejemplo, "test-instance", con gcloud compute instances create test-instance. Se te pedirá que selecciones una zona en la cual crear la instancia.

Para inhabilitar los mensajes, usa la marca --quiet.

Ten en cuenta que la redacción de los mensajes puede cambiar y no debe incluirse en la secuencia de comandos.

Elimina mensajes, escribe a la terminal y haz registros

La marca --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 cuando se crean secuencias de comandos. En el caso de que sea necesaria una entrada, se usarán los valores predeterminados. Si no existen, se generará un error.

A fin de eliminar la impresión del resultado del comando como una salida estándar o un error estándar en la terminal, usa la marca --no-user-output-enabled.

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

Determina la estructura del resultado

De forma predeterminada, cuando un comando de la CLI de gcloud muestra una lista de recursos, se imprimen con formato de salida estándar. Para producir resultados más significativos, las marcas de formato, filtro y proyección te permiten ajustar tus resultados.

Si deseas definir solo el formato del resultado, usa la marca --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.

Si deseas realizar un instructivo interactivo rápido para familiarizarte con la funcionalidad de filtro y formato, sigue el vínculo a continuación.

Abrir en Cloud Shell

Qué sigue