Hoja de referencia de gcloud CLI

Una lista de comandos prácticos para Google Cloud CLI, la línea de comandos principal de Google Cloud para Google Cloud.

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

Hoja de referencia

Cómo comenzar

Comienza 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 gcloud CLI a la versión más reciente.
• gcloud config set project: configura un proyecto de Google Cloud predeterminado para trabajar.
• gcloud info: Muestra los detalles del entorno actual de gcloud CLI.

Ayuda

gcloud CLI se complace en ayudarte.

• gcloud help: Busca en los documentos de referencia de gcloud CLI para obtener información condiciones.
• gcloud feedback: Proporciona comentarios al equipo de gcloud CLI.
• gcloud topic: Material de ayuda complementario para temas que no son sobre comandos, como la accesibilidad, el filtrado y el formato.

Personalización

Personaliza la CLI de gcloud y personaliza tu configuración con propiedades.

• gcloud config set: Define una propiedad (como procesamiento/zona) para la configuración actual.
• gcloud config get: Recupera 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 nueva 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 denominada existente.

Autorización y credenciales

Otorgar y revocar la autorización a gcloud CLI y administrar credenciales.

• gcloud auth login: Autorizar acceso a Google Cloud para gcloud CLI con Credenciales de usuario de Google Cloud y establece la cuenta actual como activa.
• gcloud auth activate-service-account: Autoriza el acceso a Google Cloud similar a gcloud auth login, pero con credenciales de cuenta de servicio.
• gcloud auth application-default: Administra tus credenciales predeterminadas de la aplicación (ADC) para las bibliotecas cliente de Cloud.
• gcloud auth list: Enumera todas las cuentas con credenciales.
• gcloud auth print-access-token: Muestra el token de acceso de la cuenta actual.
• gcloud auth revoke: Quita las credenciales de acceso de una cuenta.

Proyectos

Administra las políticas de acceso a los proyectos.

• gcloud projects describe: Muestra los metadatos de un proyecto (incluido su ID).
• gcloud projects add-iam-policy-binding: Agrega una vinculación de política de IAM a un proyecto especificado.

IAM

Configura las preferencias y el servicio de Identity and Access Management (IAM) cuentas de servicio.

• gcloud iam list-grantable-roles: Enumera las funciones otorgables de IAM para un recurso.
• gcloud iam roles create: Crea una función personalizada 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: Agrega una vinculación de política de IAM a una cuenta de servicio.
• gcloud iam service-accounts set-iam-policy-binding: Reemplaza la vinculación de la política de IAM existente.
• gcloud iam service-accounts keys list: Enumera las claves de una cuenta de servicio.

Docker y Google Kubernetes Engine (GKE)

Administra aplicaciones alojadas en contenedores en Kubernetes.

• gcloud auth configure-docker: Registra gcloud CLI como auxiliar de credenciales de Docker.
• gcloud container clusters create: Crea un clúster para ejecutar contenedores de GKE.
• gcloud container clusters list: Muestra una lista de clústeres para ejecutar contenedores de GKE.
• gcloud container clusters get-credentials: Actualiza kubeconfig para obtener kubectl a fin de usar 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 administra VMs en la infraestructura de Google Cloud.

• gcloud compute zones list: Enumera las zonas de Compute Engine.
• gcloud compute instances create: Crear una instancia de VM
• gcloud compute instances describe: Muestra los detalles de una instancia de VM.
• gcloud compute instances list: Enumera todas las instancias de VM en un proyecto.
• gcloud compute disks snapshot: Crea una instantánea de los discos persistentes.
• gcloud compute snapshots describe: Muestra los detalles de una instantánea.
• gcloud compute snapshots delete: Borrar una instantánea
• gcloud compute ssh: te conecta a una instancia de VM mediante SSH.

App Engine y sin servidores

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

• gcloud app deploy: Implementa el código y la configuración de tu app en el servidor de App Engine.
• gcloud app versions list: Muestra una lista de todas las versiones de todos los servicios implementados en el servidor de App Engine.
• gcloud app browse: Abre la app actual en un navegador web.
• gcloud app create: Crea una app de App Engine dentro de tu proyecto actual.
• gcloud app logs read: Muestra los últimos registros de la aplicación de App Engine.

Varios

Comandos que pueden resultar útiles

• gcloud kms decrypt: Desencriptar texto cifrado (a un archivo de texto simple) con una clave de Cloud Key Management Service.
• gcloud logging logs list: Enumera 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 de SQL.

Guía de introducción

Un manual básico y rápido para comenzar a usar gcloud CLI.

Instala Google Cloud CLI

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

Marcas, argumentos y otras excelentes adiciones

Los argumentos pueden ser marcas 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
  • 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 gcloud CLI, como:

• --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 sacar el máximo provecho de tus resultados.

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 obtener una lista de proyectos creados a partir del 15 de enero de 2018, ordenados desde los más antiguos hasta los más recientes, presentada en una tabla con número de proyecto, ID del proyecto y columnas de tiempo de creación con fechas y horas en la zona horaria local, usa el siguiente comando:

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), usa el siguiente comando:

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

Información acerca de los comandos

Los patrones subyacentes para los comandos de gcloud CLI; para ayudar el autodescubrimiento de comandos.

Busca comandos de la CLI de gcloud

gcloud CLI es un árbol; los nodos que no son de hoja son grupos de comandos y los nodos hoja son comandos. Además, el autocompletado con pestañas funciona para comandos y recursos.

La mayoría de los comandos 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.