Cómo activar un flujo de trabajo desde Hojas de cálculo de Google

Hojas de cálculo de Google es una herramienta de solución de hojas de cálculo que permite la colaboración en tiempo real y proporciona herramientas para visualizar, procesar y comunicar datos.

En este instructivo, se muestra cómo activar Workflows desde Hojas de cálculo.

Objetivos

En este instructivo, podrás:

  1. Usa Formularios de Google, una solución de cuestionarios y encuestas basada en la nube, para crear un formulario que pueda enviar solicitudes para crear instancias de máquina virtual (VM).
  2. Vincula un archivo de Hojas de cálculo de Google al formulario para recopilar y guardar de respuestas ante incidentes.
  3. Usa Google Apps Script, una plataforma de JavaScript basada en la nube que te permite crear, leer y editar productos de Google Workspace de forma programática para activar un flujo de trabajo cada vez que se aprueba una solicitud a través de una actualización de la hoja de cálculo.
  4. Implementar un flujo de trabajo que llame al Conector de la API de Compute Engine y crea una instancia de VM de Compute Engine basada en las especificaciones recopiladas a través del formulario. Los conectores simplifican las llamadas a otras APIs de Google Cloud. Obtén más información sobre los conectores de Workflows.
  5. Prueba todo el proceso y confirma que se crea una instancia de VM como se espera.

Costos

En este documento, usarás los siguientes componentes facturables de Google Cloud:

Para generar una estimación de costos en función del uso previsto, usa la calculadora de precios. Es posible que los usuarios nuevos de Google Cloud califiquen para obtener una prueba gratuita.

En el instructivo, también se usa Google Workspace. Los servicios empresariales que no están incluidos en las apps gratuitas de Google para consumidores son facturables.

Antes de comenzar

Puedes ejecutar algunos de los siguientes comandos en la consola de Google Cloud o con Google Cloud CLI en la terminal o en Cloud Shell.

Es posible que las restricciones de seguridad que define tu organización no te permitan completar los siguientes pasos. Para obtener información sobre la solución de problemas, consulta Desarrolla aplicaciones en un entorno de Google Cloud restringido.

Console

  1. En la página del selector de proyectos de la consola de Google Cloud, elige o crea un proyecto de Google Cloud.

    Ir al selector de proyectos

  2. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud. Obtén información sobre cómo verificar si la facturación está habilitada en un proyecto.

  3. Habilita las APIs de Compute Engine y Workflows.

    Habilita las API

  4. Toma nota de la cuenta de servicio predeterminada de Compute Engine, ya que la asociarás con el flujo de trabajo de este instructivo con fines de prueba. Los proyectos nuevos que habilitaron la API de Compute Engine tienen esta cuenta de servicio creada con el rol de editor básico de IAM y con el siguiente formato de correo electrónico:

    PROJECT_NUMBER-compute@developer.gserviceaccount.com

    Puedes encontrar el número de tu proyecto en la Te damos la bienvenida de la consola de Google Cloud.

    Para entornos de producción, recomendamos crear una cuenta de servicio nueva y otorgarle uno o más roles de IAM que contengan los permisos mínimos requeridos y seguir el principio de privilegio mínimo.

gcloud

  1. In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  2. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud. Obtén información sobre cómo verificar si la facturación está habilitada en un proyecto.

  3. Habilitar las APIs de Compute Engine y Workflows

    gcloud services enable \
    compute.googleapis.com \
    workflows.googleapis.com

  4. Toma nota de la cuenta de servicio predeterminada de Compute Engine, ya que la asociarás con el flujo de trabajo de este instructivo con fines de prueba. Proyectos nuevos que habilitaron la API de Compute Engine crear esta cuenta de servicio con la política de IAM editor y con el siguiente formato de correo electrónico:

    PROJECT_NUMBER-compute@developer.gserviceaccount.com

    Puedes recuperar el número de tu proyecto de las siguientes maneras:

    gcloud projects describe PROJECT_ID

    Para entornos de producción, recomendamos crear una cuenta de servicio nueva y lo que le otorga uno o más roles de IAM que contengan el permisos mínimos necesarios y siguen el principio de privilegio mínimo.

Crea un formulario para solicitar instancias de VM

Crea un formulario que se pueda usar para enviar una solicitud para crear una Instancia de máquina virtual (VM) de Compute Engine. De forma predeterminada, cuando creas un formulario a través de Formularios de Google, este se guarda en Google Drive.

  1. Ve a forms.google.com.
  2. Haz clic en En blanco. Plus

    Se abrirá un nuevo formulario.

  3. Crea un formulario con cinco secciones obligatorias. El formulario debería ser similar al siguiente:

    Ver formulario de muestra

    Ejemplo de formulario para solicitar la creación de una máquina virtual de Google Cloud
    Nombre de la máquina

    Texto de respuesta breve
    Zona

    Menú desplegable:

    1. us-central1-a
    2. us-central1-b
    3. us-central1-c
    4. us-central1-f
    Tipo

    Menú desplegable:

    1. e2-micro
    2. e2-small
    3. e2-medium
    4. e2-standard-2
    5. e2-standard-4
    Tamaño del disco (GB)

    Texto de respuesta breve
    Sistema operativo

    Menú desplegable:

    1. debian-10
    2. centos-stream-9
    3. cos-93-lts
    4. cos-97-lts
  4. Habilita la recopilación de correos electrónicos para registrar las direcciones de correo electrónico de las personas que completen tu formulario:
    1. Haz clic en Configuración.
    2. Expande la sección Respuestas.
    3. Haz clic en el botón de activación Recopilar direcciones de correo electrónico.

Después de crear un formulario, vincúlalo a una hoja de cálculo para que puedas guardar las respuestas en ella. La hoja de cálculo se guarda en Drive

  1. Abre el formulario en Formularios.
  2. Haz clic en Respuestas.
  3. Haz clic en Vínculo a Hojas de cálculo.
  4. En el diálogo Seleccionar el destino de las respuestas, selecciona Crear una hoja de cálculo nueva.

  5. Haz clic en Crear.

    Se abrirá la hoja de cálculo vinculada.

  6. En la columna H, agrega un encabezado ¿Aprobado?.

  7. Coloca el cursor en la primera fila de la columna H y selecciona Casilla de verificación Insertar >.

    La hoja de cálculo debería tener un aspecto similar al siguiente:

    Ejemplo de una hoja de cálculo vinculada para recopilar solicitudes

    Cada vez que se actualice la hoja con una respuesta, la casilla de verificación también aparecerá en la fila de esa respuesta.

Amplía Hojas de cálculo de Google con Apps Script

Apps Script te permite crear, leer y editar Hojas de cálculo de forma programática. La mayoría de las secuencias de comandos diseñadas para Hojas de cálculo para interactuar con las celdas, filas y columnas de una hoja de cálculo. Para obtener una introducción al uso de Apps Script con Hojas de cálculo, consulta la Guía de inicio rápido de funciones personalizadas.

  1. Crea un proyecto de Apps Script desde Hojas de cálculo:

    1. Abre tu hoja de cálculo de Hojas de cálculo.
    2. Selecciona Extensiones > Apps Script.
    3. En el editor de secuencias de comandos, haz clic en Proyecto sin título.
    4. Asígnale un nombre al proyecto y haz clic en Cambiar nombre.

    Ahora la secuencia de comandos está vinculada a la hoja de cálculo lo que permite que las secuencias de comandos modifiquen la interfaz de usuario. responder cuando se abra la hoja de cálculo.

    Un proyecto de secuencia de comandos representa una colección de Apps Script archivos y recursos. Los archivos de código de un proyecto de secuencia de comandos tienen una extensión .gs.

  2. Puedes usar Apps Script para escribir funciones personalizadas que que puedes usar en Hojas de cálculo como una función integrada. Las funciones personalizadas se crean con JavaScript estándar. Crea una función:

    1. Abre tu proyecto de Apps Script.
    2. Haz clic en Editor .
    3. Un archivo de secuencia de comandos aparece como un archivo de proyecto llamado Code.gs. Para editar el archivo, seleccionarla.

    4. Reemplaza cualquier código en el editor de secuencia de comandos con el siguiente código que dice lo siguiente: los datos de tu hoja de cálculo y los pasa como entrada a un flujo de trabajo ejecución:

      const PROJECT_ID = "your-project-id";
const REGION = "us-central1";
const WORKFLOW = "create-vm-from-form";

function handleEdit(e) {
  var range = e.range.getA1Notation();
  var sheet = e.source;

  if (range.length > 1 && range[0] === 'H') {
    if (e.value == "TRUE") {
      Logger.log("Approved checkbox: true");

      var row = range.slice(1)
      var email = sheet.getRange('B' + row).getCell(1, 1).getValue()
      var vmName = sheet.getRange('c' + row).getCell(1, 1).getValue()
      var zone = sheet.getRange('D' + row).getCell(1, 1).getValue()
      var machineType = sheet.getRange('E' + row).getCell(1, 1).getValue()
      var diskSize = sheet.getRange('F' + row).getCell(1, 1).getValue()
      var imageFamily = sheet.getRange('G' + row).getCell(1, 1).getValue()
      var imageProject = imageFamily.substring(0, imageFamily.indexOf('-')) + "-cloud"

      const executionPayload = {
        "argument": "{\"diskSize\": \"" + diskSize + "\", \"email\": \"" + email + "\", \"imageFamily\": \"" + imageFamily + "\", \"imageProject\": \"" + imageProject + "\", \"machineType\": \"" + machineType + "\", \"vmName\": \"" + vmName + "\", \"zone\": \"" + zone +  "\"}"
      };

      approve(executionPayload);
    }
    else {
      Logger.log("Approved checkbox: false");
    }
  }
}

function approve(executionPayload) {
  const headers = {
    "Authorization": "Bearer " + ScriptApp.getOAuthToken()
  };

  const params = {
    "method": 'post',
    "contentType": 'application/json',
    "headers": headers,
    "payload": JSON.stringify(executionPayload)
  };

  const url = "https://workflowexecutions.googleapis.com/v1/projects/" + PROJECT_ID + "/locations/" + REGION + "/workflows/" + WORKFLOW + "/executions";

  Logger.log("Workflow execution request to " + url);
  var response = UrlFetchApp.fetch(url, params);
  Logger.log(response);
}

    5. Reemplaza your-project-id por el ID del proyecto de Google Cloud.

      Puedes buscar el ID del proyecto en la página de bienvenida de la consola de Google Cloud.

    6. Haz clic en Guardar .

  3. Apps Script activadores instalables permiten que un proyecto de secuencia de comandos ejecute una función específica cuando se cumplen ciertas condiciones se cumplen, como cuando se abre o se edita una hoja de cálculo. Crea un activador:

    1. Abre tu proyecto de Apps Script.
    2. Haz clic en Activadores .
    3. Haz clic en Agregar activador.
    4. En el diálogo Agregar activador para YOUR_PROJECT_NAME, configura el activador:
      1. En la lista Elige qué función ejecutar, selecciona handleEdit.
      2. En la lista Choose what deployment should run, selecciona Head.
      3. En la lista Seleccionar fuente de eventos, selecciona Desde una hoja de cálculo.
      4. En la lista Seleccionar tipo de evento, selecciona En edición.
      5. En la lista Failure notification settings, selecciona Notify me daily.
    5. Haz clic en Guardar.

    6. Si recibes un mensaje para elegir una Cuenta de Google, selecciona la cuenta correcta y, luego, haz clic en Permitir.

      Esto permite que tu proyecto de Apps Script vea, edite crear y borrar tus Hojas de cálculo y conectarse a un servicio externo.

  4. El archivo de manifiesto de un proyecto de Apps Script es un archivo JSON que especifica la información básica del proyecto que Apps Script necesita para ejecutar una secuencia de comandos correctamente. Ten en cuenta que el editor de Apps Script oculta los archivos de manifiesto de forma predeterminada para proteger la configuración de tu proyecto de Apps Script. Edita el archivo de manifiesto:

    1. Abre tu proyecto de Apps Script.
    2. Haz clic en Configuración del proyecto .
    3. Selecciona la casilla de verificación Mostrar el archivo de manifiesto "appsscript.json" en el editor.
    4. Haz clic en Editor .
    5. El archivo de manifiesto aparece como un archivo de proyecto llamado appsscript.json. Para editar el archivo, selecciónalo.

    6. El campo oauthScopes especifica un array de cadenas. Para establecer los permisos de autorización que usa tu proyecto, agrega un array con los permisos que deseas admitir. Por ejemplo: 

      {
  "timeZone": "America/Toronto",
  "dependencies": {
  },
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8",
  "oauthScopes": [
    "https://www.googleapis.com/auth/script.external_request",
    "https://www.googleapis.com/auth/cloud-platform",
    "https://www.googleapis.com/auth/spreadsheets"
  ]
}

      Esto establece permisos explícitos para lo siguiente:

      • Se conecta a un servicio externo.
      • Ver, editar, configurar y borrar tus datos de Google Cloud y ver la dirección de correo electrónico de tu Cuenta de Google
      • Consultar, editar, crear y borrar todas tus hojas de cálculo de Hojas de cálculo

    7. Haz clic en Guardar .

Implementa un flujo de trabajo que cree una instancia de VM

Implementa un flujo de trabajo que se active cuando se apruebe una solicitud para crear una instancia de VM. El flujo de trabajo llama al conector de la API de Compute Engine para crear una instancia de VM de Compute Engine según las especificaciones recopiladas a través del formulario.

Console

  1. En la consola de Google Cloud, ve a la página Flujos de trabajo:

    Ir a Workflows

  2. Haz clic en  Crear.

  3. Ingresa un nombre para el flujo de trabajo nuevo: create-vm-from-form.

  4. En la lista Región, selecciona us-central1 (Iowa).

  5. En Cuenta de servicio, selecciona la configuración predeterminada de Compute Engine cuenta de servicio (PROJECT_NUMBER-compute@developer.gserviceaccount.com).

  6. Haz clic en Siguiente.

  7. En el editor de flujos de trabajo, ingresa la siguiente definición para tu flujo de trabajo:

    main:
   params: [input]
   steps:
   - init:
       assign:
            - projectId: ${sys.get_env("GOOGLE_CLOUD_PROJECT_ID")}
            - zone: ${input.zone}
            - machineType: ${input.machineType}
            - diskSize: ${input.diskSize}
            - imageProject: ${input.imageProject}
            - imageFamily: ${input.imageFamily}
            - vmName: ${input.vmName}
            - email: ${input.email}
   - createResource:
       call: googleapis.compute.v1.instances.insert
       args:
           project: ${projectId}
           zone: ${zone}
           body:
               name: ${vmName}
               machineType: ${"projects/" + projectId + "/zones/" + zone + "/machineTypes/" + machineType}
               disks:
                - initializeParams:
                    diskSizeGb: ${diskSize}
                    sourceImage: ${"projects/" + imageProject + "/global/images/family/" + imageFamily}
                  type: PERSISTENT
                  boot: true
                  autoDelete: true
               networkInterfaces:
                - network: "global/networks/default"
       result: insertResult
   - retStep:
       return: ${insertResult}

  8. Haz clic en Implementar.

gcloud

  1. Crea un archivo de código fuente para tu flujo de trabajo:

    touch create-vm-from-form.yaml

  2. En un editor de texto, copia el siguiente flujo de trabajo en tu archivo de código fuente:

    main:
   params: [input]
   steps:
   - init:
       assign:
            - projectId: ${sys.get_env("GOOGLE_CLOUD_PROJECT_ID")}
            - zone: ${input.zone}
            - machineType: ${input.machineType}
            - diskSize: ${input.diskSize}
            - imageProject: ${input.imageProject}
            - imageFamily: ${input.imageFamily}
            - vmName: ${input.vmName}
            - email: ${input.email}
   - createResource:
       call: googleapis.compute.v1.instances.insert
       args:
           project: ${projectId}
           zone: ${zone}
           body:
               name: ${vmName}
               machineType: ${"projects/" + projectId + "/zones/" + zone + "/machineTypes/" + machineType}
               disks:
                - initializeParams:
                    diskSizeGb: ${diskSize}
                    sourceImage: ${"projects/" + imageProject + "/global/images/family/" + imageFamily}
                  type: PERSISTENT
                  boot: true
                  autoDelete: true
               networkInterfaces:
                - network: "global/networks/default"
       result: insertResult
   - retStep:
       return: ${insertResult}

  3. Para implementar el flujo de trabajo, ingresa el siguiente comando:

    gcloud workflows deploy create-vm-from-form \
    --source=create-vm-from-form.yaml \
    --location=us-central1 \
    --service-account=PROJECT_NUMBER-compute@developer.gserviceaccount.com

    Reemplaza PROJECT_NUMBER por el número de proyecto de Google Cloud. Puedes recuperar el número de tu proyecto de las siguientes maneras:

    gcloud projects describe PROJECT_ID

Prueba el flujo de extremo a extremo

Para confirmar que todo funciona según lo esperado, intenta ejecutar todo el proceso.

  1. Envíate el formulario y responde las preguntas de forma adecuada.

    Asegúrate de que las especificaciones que usas para crear una instancia de VM sean válidas. De lo contrario, la ejecución de tu flujo de trabajo fallará. Para obtener más información, consulta Familia de máquinas de uso general de Compute Engine.

  2. Para enviar tu respuesta, haz clic en Enviar.

  3. Abre el formulario en Formularios.

  4. Haz clic en Respuestas.

  5. Haz clic en Ver en Hojas de cálculo.

    Se abrirá la hoja de cálculo vinculada.

  6. En la fila de tu respuesta, selecciona la casilla de verificación ¿Aprobado?.

  7. Abre tu proyecto de Apps Script.

  8. Haz clic en Ejecuciones .

    El activador debería estar ejecutado y debe mostrarse con un estado Completed.

  9. Confirma que el flujo de trabajo de create-vm-from-form se haya completado correctamente:

    Console

    1. En la consola de Google Cloud, ve a la página Flujos de trabajo.

      Ir a Workflows

    2. En la página Flujos de trabajo, haz clic en el create-vm-from-form para ir a su página de detalles.

    3. En la página Detalles del flujo de trabajo, para recuperar los detalles de una ejecución en particular, haz clic en el ID de ejecución correspondiente.

      El Estado de ejecución debe ser Sin errores y, en el campo Entrada deberías ver las especificaciones de la VM que solicitaste.

    gcloud

    Recupera una lista de los intentos de ejecución de tu flujo de trabajo:

    gcloud workflows executions list create-vm-from-form

    El resultado debería ser similar al siguiente:

    NAME: projects/918619793306/locations/us-central1/workflows/create-vm-from-form/executions/d8947ecb-9ccb-4ea1-ba10-e5c10414e3be
STATE: SUCCEEDED
START_TIME: 2023-01-24T15:07:40.404741791Z
END_TIME: 2023-01-24T15:07:55.649373625Z

  10. Confirma que se creó una VM nueva como se esperaba:

    Console

    En la consola de Google Cloud, ve a la página Instancias de VM.

    Ir a Instancias de VM

    Tu instancia de VM debería aparecer en la lista con un estado que indique que está en ejecución.

    gcloud

    Recupera una lista agregada de todas las VMs en todas las zonas de un proyecto:

    gcloud compute instances list

    Tu instancia de VM debería aparecer con un estado que indique en ejecución.

    Para obtener más información sobre el comando gcloud compute instances list, consulta su página de referencia.

Limpia

Si creaste un proyecto nuevo para este instructivo, bórralo. Si usaste un proyecto existente y deseas conservarlo sin los cambios que se agregaron en este instructivo, borra los recursos creados para el instructivo.

Borra el proyecto

La manera más fácil de eliminar la facturación es borrar el proyecto que creaste para el instructivo.

Para borrar el proyecto, sigue estos pasos:

  1. En la consola de Google Cloud, ve a la página Administrar recursos.

    Ir a Administrar recursos

  2. En la lista de proyectos, elige el proyecto que quieres borrar y haz clic en Borrar.
  3. En el diálogo, escribe el ID del proyecto y, luego, haz clic en Cerrar para borrar el proyecto.

Borra los recursos creados en este instructivo

  1. Borra archivos de Drive.
  2. Borra una instancia de VM de Compute Engine.
  3. Borra un flujo de trabajo.

¿Qué sigue?