La hoja de referencia de la herramienta de línea de comandos de gcloud

La hoja de referencia de gcloud

Una lista para ir a los comandos de gcloud para la herramienta de gcloud, la herramienta de línea de comandos principal de Google Cloud.

También se incluyen: guías de introducción, comprensión de los comandos y un PDF imprimible).

Hoja de referencia

Comenzar

Comienza a usar la herramienta de línea de comandos de gcloud.

Ayuda

El SDK de Cloud te ayudará con mucho gusto.

  • gcloud help: Busca documentos específicos en los documentos de referencia de la herramienta de gcloud.
  • gcloud feedback: proporciona comentarios para el equipo del SDK de Cloud.
  • gcloud topic: Material de ayuda complementario para temas que no son sobre comandos, como la accesibilidad, el filtrado y el formato.

Personalización

Personaliza el SDK de Cloud y personaliza tu configuración con propiedades.

Credenciales

Otorga y revoca la autorización al SDK de Cloud

Proyectos

Administra las políticas de acceso a proyectos

Administración de identidades y accesos

Configura preferencias y cuentas de servicio de Cloud Identity & Access Management (IAM)

Docker y Google Kubernetes Engine (GKE)

Administra aplicaciones en contenedores en Kubernetes

Máquinas virtuales y Compute Engine

Crea, ejecuta y administra las VM en la infraestructura de Google.

App Engine y sin servidores

Compila aplicaciones muy escalables en una plataforma completamente administrada y sin servidores

Varios

Comandos que pueden resultar útiles

Guía de introducción

Una guía rápida para comenzar a usar la herramienta de línea de comandos de gcloud.

Instala el SDK de Cloud

Instala el SDK de Cloud con estas instrucciones de instalación.

Marcas, argumentos y otras excelentes adiciones

Los argumentos pueden ser argumentos o argumentos posicionales.

  • Argumentos posicionales: Se configuran después del nombre del comando debe respetar el orden de los argumentos posicionales.
  • Marcas: se configuran después de los argumentos posicionales. El orden de las marcas no importa.

    Una marca puede ser una de las siguientes opciones:

    • Par nombre-valor (--foo=bar) o
    • Booleano (--force/no-force).

    Además, las marcas pueden ser de la siguiente manera:

    • Obligatorio
    • Opcionales: En ese caso, se usa el valor predeterminado si la marca no está definida.

Marcas globales

Algunas marcas están disponibles a través de la experiencia de la herramienta de línea de comandos de gcloud, como las que se muestran a continuación:

  • --help: para cuando tengas dudas, muestra la ayuda detallada de un comando.
  • --project: si usas un proyecto que no sea el actual.
  • --quiet: inhabilita los mensajes interactivos (y aplica valores predeterminados para las entradas).
  • --verbosity: Puede establecer niveles de verbosidad en debug, info, warning, error, critical y none.
  • --version: Muestra la información de la versión de gcloud.
  • --format : Establece formato de salida como config, csv, default, diff, disable, flattened, get, json, list, multi, none, object, table, text, value, o yaml.

Realiza una limpieza de los resultados

Usa los filtros, el formato, el límite y las marcas de clasificación para maximizar los resultados de tu resultado.

Para instancias de Compute Engine con el prefijo us y no el tipo de máquina f1-micro usa lo siguiente:

gcloud compute instances list --filter="zone ~ ^us AND -machineType:f1-micro"

Para una lista de proyectos creados a partir del 15 de enero de 2018, ordenados desde la más antigua hasta la más reciente, se presenta una tabla con el número de proyecto, el ID del proyecto y las columnas de tiempo de creación con fechas y horas en la zona horaria local:

gcloud projects list --format="table(projectNumber,projectId,createTime.date(tz=LOCAL))"
--filter="createTime>=2018-01-15T12:00:00" --sort-by=createTime

Para obtener una lista de diez instancias de Compute Engine con una etiqueta my-label (de cualquier valor), haz lo siguiente:

gcloud compute instances list --filter="labels.my-label:*" --limit=10

Información acerca de los comandos

Los patrones subyacentes para los comandos de gcloud para facilitar la autodetección de los comandos.

Busca comandos de gcloud

La herramienta de línea de comandos de gcloud es un árbol; los nodos de hoja diferente son grupos de comandos y nodos de hoja. (Además, el autocompletado con pestañas funciona para comandos y recursos).

La mayoría de los comandos de gcloud tienen el siguiente formato:

gcloud + release level (optional) + component + entity + operation + positional args + flags

Por ejemplo: gcloud + compute + instances + create + example-instance-1 + --zone=us-central1-a

Nivel de actualización

Nivel de actualización hace referencia al estado de la actualización del comando.

Ejemplo: alpha para los comandos Alfa, beta para los comandos Beta, no se necesita un nivel de actualización para los comandos de GA.

Componente

Componente se refiere a los diferentes servicios de Google Cloud.

Ejemplo: compute para Compute Engine, app para App Engine, etcétera.

Entity

Entidad hace referencia a la forma plural de un elemento o una colección de elementos en un componente.

Ejemplo: disks, firewalls, images, instances, regions, zones para el procesamiento

Operación

Operación hace referencia a la forma verbo imperativo de la operación que se realizará en la entidad.

Ejemplo: Las operaciones comunes son describe, list, create/update, delete/clear, import, export, copy, remove, add, reset, restart, restore, run y deploy.

Argumentos posicionales

Los argumentos posicionales hacen referencia a los argumentos obligatorios y específicos de orden necesarios para ejecutar el comando.

Ejemplo: <INSTANCE_NAMES> es el argumento posicional requerido para gcloud compute instances create.

Marcas

Las marcas hacen referencia a los argumentos adicionales, --flag-name(=value), que se pasan al comando después de los argumentos posicionales.

Ejemplo: --machine-type=<MACHINE_TYPE> y --preemptible son marcas opcionales para gcloud compute instances create.