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 administrarGoogle Cloud Recursos. Puede usar estas herramientas para realizar muchas tareas comunes de la plataforma desde la línea de comandos o mediante scripts y otras automatizaciones.

Por ejemplo, puede utilizar la CLI de gcloud para crear y administrar lo siguiente:

  • Instancias de máquinas virtuales de Compute Engine y otros recursos
  • Instancias de Cloud SQL
  • Clústeres de Google Kubernetes Engine
  • Clústeres y trabajos de Dataproc
  • Zonas y conjuntos de registros administrados por Cloud DNS
  • Implementaciones de Cloud Deployment Manager

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

Descargue e instale la CLI de gcloud

La versión actual de gcloud CLI es 526.0.1.

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

Si usas Cloud Shell, la CLI de gcloud está disponible automáticamente y no necesitas instalarla. De lo contrario, descárgala, instálala y luego inicialízala .

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

Hoja de trucos de la CLI de gcloud

Para obtener una introducción rápida a la CLI de gcloud, una lista de comandos comúnmente utilizados y una mirada a cómo se estructuran estos comandos, consulte la hoja de trucos de la CLI de gcloud .

Niveles de lanzamiento

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

Nivel de lanzamiento Etiqueta Descripción
Disponibilidad general Ninguno Los comandos se consideran totalmente estables y están disponibles para producción. Para obtener información anticipada sobre cambios en los comandos que alteren la funcionalidad actual, consulte las notas de la versión .
Beta beta Los comandos están funcionalmente completos, pero aún podrían presentar algunos problemas. Se pueden realizar cambios importantes en estos comandos sin previo aviso.
Alfa alpha Los comandos están en versión preliminar y pueden cambiar sin previo aviso.

Los componentes alpha y beta no se instalan de forma predeterminada al instalar la CLI de gcloud. Debe instalarlos por separado mediante el comando gcloud components install . Si intenta ejecutar un comando alfa o beta y el componente correspondiente no está instalado, la CLI de gcloud le solicitará que lo instale.

Grupos de mando

Dentro de cada nivel de versión, los comandos 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 característica de Google Cloud o sus subgrupos funcionales.

Por ejemplo:

Grupo de mando Descripción
gcloud compute Comandos relacionados con Compute Engine en disponibilidad general
gcloud compute instances Comandos relacionados con las instancias de Compute Engine en disponibilidad general
gcloud beta compute Comandos relacionados con Compute Engine en versión Beta
gcloud alpha app Comandos relacionados con la administración de implementaciones de App Engine en Alpha

Ejecución de comandos CLI de gcloud

Puede ejecutar comandos CLI de gcloud desde la línea de comandos y desde scripts y otras automatizaciones , por ejemplo, al usar Jenkins para automatizar Google Cloud tareas.

Propiedades

Las propiedades de la CLI de gcloud son configuraciones 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, el valor definido por la opción tiene prioridad.

Habilitación de funciones de accesibilidad

Para una experiencia de lectura de pantalla más optimizada, la CLI de gcloud viene con una propiedad accessibility/screen_reader .

Para habilitar la propiedad de accesibilidad, ejecute:

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 gcloud, consulte la guía Habilitación de funciones de accesibilidad .

Configuraciones

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

Al empezar a usar la CLI de gcloud, trabajarás con una única configuración llamada default y podrás configurar las propiedades ejecutando gcloud init o gcloud config set . Esta única configuración predeterminada es adecuada para la mayoría de los casos de uso.

Para trabajar con varios proyectos o cuentas de autorización, puede configurar varias configuraciones con gcloud config configurations create y alternar entre ellas. Dentro de una configuración, puede personalizar las propiedades. Por ejemplo, para configurar su proyecto dentro de una configuración activa, utilice la propiedad project :

gcloud config set project <project-id>

Para obtener una descripción detallada de estos conceptos, consulte la guía Configuraciones .

Opciones globales

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

Argumentos posicionales y opciones

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

Uso de stdout y stderr

La salida de los comandos de la CLI de gcloud ejecutados correctamente se escribe en stdout . Todos los demás tipos de respuesta (avisos, advertencias y errores) se escriben en stderr . No ejecute scripts contra respuestas escritas en stderr ya que estas respuestas no son estables.

Para obtener instrucciones sobre el manejo de la salida, consulte la Guía de secuencias de comandos .

Incitación

Para protegerse contra acciones destructivas no deseadas, la CLI de gcloud confirma sus intenciones antes de ejecutar comandos como gcloud projects delete .

Es posible que se le solicite información adicional. Por ejemplo, se le pedirá que elija una zona al crear una instancia de máquina virtual de Compute Engine con gcloud compute instances create test-instance .

Para deshabilitar las indicaciones, utilice la opción --quiet .

No escriba en contra del texto de las indicaciones porque éste puede cambiar.

Suprimir indicaciones, escritura en la terminal y registro

La opción --quiet (también conocida -q ) de la CLI de gcloud desactiva todas las solicitudes interactivas al ejecutar comandos de la CLI de gcloud y es útil para scripts. Si se requiere información, se utilizan los valores predeterminados. Si no hay un valor predeterminado, se genera un error.

Para suprimir la impresión de la salida de comando en la salida estándar y el error estándar en la terminal, utilice la opción --no-user-output-enabled .

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

Determinación de la estructura de salida

De forma predeterminada, cuando un comando CLI de gcloud devuelve una lista de recursos, estos se imprimen en la salida estándar. Para generar una salida más significativa, las opciones format , filter y projection permiten ajustar la salida.

Para definir solo el formato de su salida, use la opción --format para producir una versión tabulada o aplanada de su salida (para visualización interactiva) o una versión legible por máquina de la salida ( json , csv , yaml , value ).

Para formatear una lista de claves que seleccionan valores de datos de recursos, utilice projections . Para refinar aún más la salida según los criterios que defina, utilice filter .

Para familiarizarse con las funciones de filtro y formato, puede completar un tutorial interactivo rápido haciendo clic en Abrir en Cloud Shell .

Abrir en Cloud Shell

¿Qué sigue?