Descripción general de gcloud CLI

En esta página, se proporciona una descripción general de Google Cloud CLI y sus funciones y patrones de comandos 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 mediante 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 gcloud CLI para implementar aplicaciones de App Engine, administrar la autenticación, personalizar la configuración local y realizar otras tareas.

La hoja de referencia de gcloud CLI

Para obtener una introducción rápida a gcloud CLI, ver una lista de los comandos de uso general y ver cómo se estructuran estos comandos, consulta la hoja de referencia de la CLI de gcloud.

Descarga y, luego, instala gcloud CLI

Si usas Cloud Shell, gcloud CLI está disponible automáticamente y no necesitas instalarla. De lo contrario, descarga e instala gcloud CLI y, luego, inicializar.

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

La versión actual de gcloud CLI es 445.0.0. Puedes descargar y, luego, instalar versiones anteriores de gcloud CLI 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 un aviso anticipado de los cambios en los comandos que rompen la funcionalidad actual, consulta las notas de la versión.
Beta beta Los comandos están completos en cuanto a sus funciones, pero aún podrían 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 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, gcloud CLI te solicitará que lo instales.

Grupos de comandos

Dentro de cada nivel de actualización, los comandos de gcloud CLI se organizan en una jerarquía anidada de grupos de comandos, y cada uno 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 gcloud CLI 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 afectan el comportamiento de las herramientas de gcloud CLI. Algunas de estas propiedades se pueden configurar mediante opciones globales o de comando; en ese caso, el valor establecido por la opción tiene prioridad.

Habilita las funciones de accesibilidad

Para obtener una experiencia de lector de pantalla más optimizada, gcloud CLI 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.

Parámetros de configuración

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

Cuando comiences a usar gcloud CLI, 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 ellas. Dentro de una configuración, puedes personalizar las propiedades. Por ejemplo, para establecer 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 gcloud CLI 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 gcloud CLI.

Argumentos posicionales y opciones

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

Uso de stdout y stderr

El resultado de los comandos exitosos de gcloud CLI se escribe en stdout. Todos los demás tipos de respuestas (mensajes, advertencias y errores) se escriben en stderr. No ejecutes secuencias de comandos en función de las respuestas escritas en stderr, ya que no son estables.

Si deseas obtener lineamientos para manejar resultados, consulta la Guía de secuencias de comandos.

Mensajes

Para protegerte contra acciones destructivas no deseadas, gcloud CLI confirma tus intenciones antes de ejecutar comandos como gcloud projects delete.

Es posible que se te pregunte si se necesita 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 escribas una secuencia de comandos en función de la redacción de los mensajes, ya que puede cambiar.

Elimina mensajes, escribe a la terminal y haz registros

La opción --quiet (también, -q) para la gcloud CLI 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 los valores predeterminados. Si no hay un valor predeterminado, se genera un error.

Para eliminar la impresión del resultado del comando como resultado estándar y 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 gcloud CLI muestra una lista de recursos, estos quedan bastante impresos en el resultado estándar. Para producir un resultado más significativo, las opciones format, filter y projection te permiten ajustar tu resultado.

Para definir solo el formato de tu resultado, usa la opción --format a fin de producir una versión tabulada o plana del resultado (para la visualización interactiva), o una versión del resultado legible por máquina (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 si haces clic en Abrir en Cloud Shell.

Abrir en Cloud Shell

¿Qué sigue?