Hoja de referencia rápida de la CLI de gcloud

Lista de comandos básicos de la CLI de Google Cloud, la herramienta de línea de comandos principal de Google Cloud.

También se incluyen una guía introductoria, información sobre los comandos y un PDF imprimible.

Hoja de referencia

Primeros pasos

Empieza a usar gcloud CLI.

• gcloud init: inicializa, autoriza y configura gcloud CLI.
• gcloud version: muestra la versión y los componentes instalados.
• gcloud components install: instala componentes específicos.
• gcloud components update: actualiza tu CLI de gcloud a la versión más reciente.
• gcloud config set project: define un Google Cloud proyecto predeterminado en el que trabajar.
• gcloud info: muestra los detalles del entorno actual de la CLI de gcloud.

Ayuda

La CLI de gcloud estará encantada de ayudarte.

• gcloud help: busca términos específicos en los documentos de referencia de la CLI de gcloud.
• gcloud feedback: envía comentarios al equipo de gcloud CLI.
• gcloud topic: material de ayuda complementario para temas que no son comandos, como la accesibilidad, el filtrado y el formato.

Personalización

Personaliza gcloud CLI configurando propiedades.

• gcloud config set: define una propiedad (como compute/zone) para la configuración actual.
• gcloud config get: obtiene el valor de una propiedad de gcloud CLI.
• gcloud config list: muestra todas las propiedades de la configuración actual.
• gcloud config configurations create: crea una configuración con nombre.
• gcloud config configurations list: muestra una lista de todas las configuraciones disponibles.
• gcloud config configurations activate: cambia a una configuración con nombre que ya tengas.

Autorización y credenciales

Concede y revoca la autorización de la herramienta de línea de comandos gcloud y gestiona las credenciales.

• gcloud auth login: autoriza el acceso de la CLI de gcloud conGoogle Cloud credenciales de usuario y define la cuenta actual como activa.Google Cloud
• gcloud auth activate-service-account: Autoriza Google Cloud el acceso de forma similar a gcloud auth login, pero con las credenciales de la cuenta de servicio.
• gcloud auth application-default: Gestiona tus credenciales predeterminadas de aplicación (ADC) para las bibliotecas de cliente de Cloud.
• gcloud auth list: muestra todos los cuentas con credenciales.
• gcloud auth print-access-token: muestra el token de acceso de la cuenta actual.
• gcloud auth revoke: elimina las credenciales de acceso de una cuenta.

Proyectos

Gestionar las políticas de acceso a proyectos.

• gcloud projects describe: Muestra los metadatos de un proyecto (incluido su ID).
• gcloud projects add-iam-policy-binding: Añade un enlace de política de gestión de identidades y accesos a un proyecto específico.

Gestión de identidades y accesos

Configurar las preferencias y las cuentas de servicio de Gestión de Identidades y Accesos (IAM).

• gcloud iam list-grantable-roles: Lista los roles que se pueden conceder de gestión de identidades y accesos de un recurso.
• gcloud iam roles create: crea un rol personalizado para un proyecto o una organización.
• gcloud iam service-accounts create: Crea una cuenta de servicio para un proyecto.
• gcloud iam service-accounts add-iam-policy-binding: Añade un enlace de política de gestión de identidades y accesos a una cuenta de servicio.
• gcloud iam service-accounts set-iam-policy-binding: Sustituye la vinculación de la política de gestión de identidades y accesos.
• gcloud iam service-accounts keys list: Lista las claves de una cuenta de servicio.

Docker y Google Kubernetes Engine (GKE)

Gestiona aplicaciones en contenedores en Kubernetes.

• gcloud auth configure-docker: Registra gcloud CLI como asistente de credenciales de Docker.
• gcloud container clusters create: Crea un clúster para ejecutar contenedores de GKE.
• gcloud container clusters list: Lista los clústeres para ejecutar contenedores de GKE.
• gcloud container clusters get-credentials: Actualiza kubeconfig para que kubectl use un clúster de GKE.
• gcloud container images list-tags: muestra la etiqueta y los metadatos de resumen de una imagen de contenedor.

Máquinas virtuales y Compute Engine

Crea, ejecuta y gestiona máquinas virtuales en la infraestructura de Google Cloud .

• gcloud compute zones list: Lista las zonas de Compute Engine.
• gcloud compute instances create: Crea una instancia de VM.
• gcloud compute instances describe: muestra los detalles de una instancia de VM.
• gcloud compute instances list: Lista todas las instancias de VM de un proyecto.
• gcloud compute disks snapshot: Crea una captura de los discos persistentes.
• gcloud compute snapshots describe: muestra los detalles de una instantánea.
• gcloud compute snapshots delete: elimina una captura.
• gcloud compute ssh: conéctate a una instancia de VM mediante SSH.

Sin servidor y App Engine

Crea aplicaciones muy escalables en una plataforma sin servidor totalmente gestionada

• gcloud app deploy: implementa el código y la configuración de tu aplicación en el servidor de App Engine.
• gcloud app versions list: muestra una lista con todas las versiones de todos los servicios implementados en el servidor de App Engine.
• gcloud app browse: abre la aplicación actual en un navegador web.
• gcloud app create: crea una aplicación de App Engine en tu proyecto actual.
• gcloud app logs read: muestra los registros de la aplicación App Engine más recientes.

Varios

Comandos que pueden ser útiles

• gcloud kms decrypt: descifra texto cifrado (en un archivo de texto sin formato) mediante una clave de Cloud Key Management Service.
• gcloud logging logs list: muestra los registros de tu proyecto.
• gcloud sql backups describe: muestra información sobre una copia de seguridad de una instancia de Cloud SQL.
• gcloud sql export sql: exporta datos de una instancia de Cloud SQL a un archivo SQL.

Guía introductoria

Una introducción rápida para empezar a usar la CLI de gcloud.

Instalar Google Cloud CLI

Instala Google Cloud CLI siguiendo estas instrucciones de instalación.

Marcas, argumentos y otras maravillosas incorporaciones

Los argumentos pueden ser argumentos posicionales o marcas:

• Argumentos posicionales: se definen después del nombre del comando y deben respetar el orden de los argumentos posicionales.

• Marcas: se definen después de los argumentos posicionales. El orden de las marcas no importa.

  Una marca puede ser de dos tipos:

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

  Además, las marcas pueden ser de dos tipos:

  • Obligatorio
  • Opcional: si no se define una marca opcional, se usa el valor predeterminado.

Marcas globales

Algunas marcas están disponibles en toda la experiencia de la CLI de gcloud, como las siguientes:

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

Limpiar los resultados

Saca el máximo partido a tus resultados con las marcas de filtro, formato, límite y orden.

En el caso de las instancias de Compute Engine con el prefijo us y no con el tipo de máquina f1-micro:

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

Para obtener una lista de los proyectos creados a partir del 15 de enero del 2018, ordenados del más antiguo al más reciente, en una tabla con las columnas de número de proyecto, ID de proyecto y hora de creación con fechas y horas en la zona horaria local, haz lo siguiente:

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 la etiqueta my-label (de cualquier valor), haz lo siguiente:

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

Información sobre los comandos

Los patrones subyacentes de los comandos de la CLI de gcloud para facilitar el descubrimiento de comandos.

Buscar comandos de la CLI de gcloud

La CLI de gcloud es un árbol. Los nodos que no son hojas son grupos de comandos y los nodos hoja son comandos. (Además, el autocompletado con la tecla Tab funciona con comandos y recursos).

La mayoría de los comandos de gcloud siguen este 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 lanzamiento

Nivel de lanzamiento hace referencia al estado de lanzamiento del comando.

Ejemplo: alpha para comandos alfa, beta para comandos beta y ningún nivel de lanzamiento para comandos de disponibilidad general.

Componente

Componente hace referencia a los diferentes Google Cloud servicios.

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

Entidad

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

Ejemplo: disks, firewalls, images, instances, regions, zones para el cálculo

Operación

Operación hace referencia a la forma verbal imperativa de la operación que se va a 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 son los argumentos obligatorios y específicos del orden que se necesitan para ejecutar el comando.

Ejemplo: <INSTANCE_NAMES> es el argumento posicional obligatorio de gcloud compute instances create.

Banderas

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

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