Acionar um fluxo de trabalho das Planilhas Google

O Planilhas Google é uma solução de planilhas baseada na nuvem que oferece suporte à colaboração em tempo real e ferramentas para visualizar, processar e comunicar dados.

Neste tutorial, mostramos como acionar Workflows nas Folhas.

Objetivos

Com este tutorial, você vai:

  1. Use o Google Formulários, uma solução de questionários e pesquisas baseada na nuvem, para criar um formulário que possa enviar solicitações para criar instâncias de máquina virtual (VM).
  2. Vincule uma planilha do Google Planilhas ao formulário para coletar e salvar as respostas.
  3. Use o Google Apps Script, uma plataforma JavaScript baseada em nuvem que permite criar, ler e editar produtos do Google Workspace de forma programática. Ele aciona um fluxo de trabalho sempre que uma solicitação é aprovada por uma atualização na planilha.
  4. Implante um fluxo de trabalho que chame o conector da API do Compute Engine e crie uma instância de VM do Compute Engine com base nas especificações coletadas pelo formulário. Os conectores simplificam a chamada de outras APIs do Google Cloud. Saiba mais sobre os conectores do Workflows.
  5. Teste todo o processo e confirme se uma instância de VM foi criada conforme o esperado.

Custos

Neste documento, você usará os seguintes componentes faturáveis do Google Cloud:

Para gerar uma estimativa de custo baseada na projeção de uso deste tutorial, use a calculadora de preços. Novos usuários do Google Cloud podem estar qualificados para uma avaliação gratuita.

O tutorial também usa o Google Workspace. Os serviços empresariais que não estão incluídos nos apps gratuitos do Google para consumidores são faturáveis.

Antes de começar

É possível executar alguns dos comandos a seguir no console do Google Cloud ou usando a Google Cloud CLI no terminal ou no Cloud Shell.

As restrições de segurança definidas pela sua organização podem impedir que você conclua as etapas a seguir. Para informações sobre solução de problemas, consulte Desenvolver aplicativos em um ambiente restrito do Google Cloud.

Console

  1. No Console do Google Cloud, na página do seletor de projetos, selecione ou crie um projeto do Google Cloud.

    Acessar o seletor de projetos

  2. Verifique se a cobrança está ativada para o seu projeto do Google Cloud. Saiba como verificar se o faturamento está ativado em um projeto.

  3. Ative as APIs Compute Engine e Workflows.

    Ative as APIs

  4. Anote a conta de serviço padrão do Compute Engine, porque você vai associá-la ao fluxo de trabalho neste tutorial para fins de teste. Os novos projetos que ativaram a API Compute Engine têm essa conta de serviço criada com a função básica de editor do IAM e com o seguinte formato de e-mail:

    PROJECT_NUMBER-compute@developer.gserviceaccount.com

    Encontre o número do projeto na página Welcome do console do Google Cloud.

    Para ambientes de produção, recomendamos criar uma nova conta de serviço e conceder a ela um ou mais papéis do IAM que contenham as permissões mínimas necessárias e sigam o princípio de privilégio 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. Verifique se a cobrança está ativada para o seu projeto do Google Cloud. Saiba como verificar se o faturamento está ativado em um projeto.

  3. Ative as APIs Compute Engine e Workflows.

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

  4. Anote a conta de serviço padrão do Compute Engine, porque você vai associá-la ao fluxo de trabalho neste tutorial para fins de teste. Os novos projetos que ativaram a API Compute Engine têm essa conta de serviço criada com a função básica de editor do IAM e com o seguinte formato de e-mail:

    PROJECT_NUMBER-compute@developer.gserviceaccount.com

    Para recuperar o número do projeto:

    gcloud projects describe PROJECT_ID

    Para ambientes de produção, recomendamos criar uma nova conta de serviço e conceder a ela um ou mais papéis do IAM que contenham as permissões mínimas necessárias e sigam o princípio de privilégio mínimo.

Criar um formulário para solicitar instâncias de VM

Crie um formulário que possa ser usado para enviar uma solicitação de criação de uma instância de máquina virtual (VM) do Compute Engine. Por padrão, quando você cria um formulário no app Formulários Google, ele é salvo no Google Drive.

  1. Acesse forms.google.com.
  2. Clique em Em branco Mais.

    Um novo formulário é aberto.

  3. Crie um formulário com cinco seções obrigatórias. O formulário vai ficar parecido com este:

    Conferir o formulário de amostra

    Exemplo de formulário para solicitar a criação de uma máquina virtual do Google Cloud
    Nome da máquina

    Texto de resposta curta
    Zona

    Menu suspenso:

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

    Menu suspenso:

    1. e2-micro
    2. e2-small
    3. e2-medium
    4. e2-standard-2
    5. e2-standard-4
    Tamanho do disco (GB)

    Texto de resposta curta
    Sistema operacional

    Menu suspenso:

    1. debian-10
    2. centos-stream-9
    3. cos-93-lts
    4. cos-97-lts
  4. Ative a coleta de e-mails para registrar os endereços de e-mail das pessoas que preencherem seu formulário:
    1. Clique em Configurações.
    2. Abra a seção Respostas.
    3. Clique no botão Coletar endereços de e-mail.

Depois de criar um formulário, vincule uma planilha a ele para salvar as respostas. A planilha é salva no Drive.

  1. Abra o formulário no Formulários.
  2. Clique em Respostas.
  3. Clique em Vincular às Planilhas.
  4. Na caixa de diálogo Selecionar destino para respostas, selecione Criar uma nova planilha.

  5. Clique em Criar.

    A planilha vinculada é aberta.

  6. Na coluna H, adicione um título Aprovado?.

  7. Coloque o cursor na primeira linha da coluna H e selecione Inserir > Caixa de seleção.

    A planilha vai ficar assim:

    Exemplo de planilha vinculada para coletar solicitações

    Sempre que a planilha for atualizada com uma resposta, a caixa de seleção também vai aparecer na linha dessa resposta.

Estender as Planilhas Google usando o Apps Script

O Apps Script permite criar, ler e editar planilhas de maneira programática. A maioria dos scripts criados para as Planilhas manipula matrizes para interagir com as células, linhas e colunas em uma planilha. Para uma introdução ao uso do Apps Script com o Planilhas, consulte o Guia de início rápido da função personalizada.

  1. Crie um projeto do Apps Script nas Planilhas:

    1. Abra a planilha do Planilhas Google.
    2. Selecione Extensões > Apps Script.
    3. No editor de script, clique em Projeto sem título.
    4. Dê um nome ao projeto e clique em Renomear.

    Agora, seu script está vinculado à planilha, o que permite que ele altere a interface do usuário ou responda quando a planilha for aberta.

    Um projeto de script representa uma coleção de arquivos e recursos do Apps Script. Os arquivos de código em um projeto de script têm uma extensão .gs.

  2. Você pode usar o Apps Script para escrever funções personalizadas que podem ser usadas no Planilhas, assim como uma função integrada. As funções personalizadas são criadas usando o JavaScript padrão. Crie uma função:

    1. Abra seu projeto do Apps Script.
    2. Clique em Editor .
    3. Um arquivo de script aparece como um arquivo de projeto com o nome Code.gs. Para editar o arquivo, selecione-o.

    4. Substitua qualquer código no editor de script pelo código abaixo, que lê os dados na planilha e os transmite como entrada para uma execução de fluxo de trabalho:

      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. Substitua your-project-id pelo ID do projeto do Google Cloud.

      Encontre o ID do projeto na página Boas-vindas do console do Google Cloud.

    6. Clique em Salvar .

  3. Os gatilhos instaláveis do Apps Script permitem que um projeto de script execute uma função especificada quando determinadas condições são atendidas, como quando uma planilha é aberta ou editada. Crie um acionador:

    1. Abra seu projeto do Apps Script.
    2. Clique em Acionadores .
    3. Clique em Adicionar acionador.
    4. Na caixa de diálogo Adicionar gatilho para YOUR_PROJECT_NAME, configure o gatilho:
      1. Na lista Escolher a função a ser executada, selecione handleEdit.
      2. Na lista Escolher qual implantação será executada, selecione Cabeça.
      3. Na lista Selecionar origem de eventos, selecione Da planilha.
      4. Na lista Selecionar tipo de evento, selecione Na edição.
      5. Na lista Configurações de notificação de falha, selecione Notificar diariamente.
    5. Clique em Salvar.

    6. Se você receber uma solicitação para escolher uma Conta do Google, selecione a conta adequada e clique em Permitir.

      Isso permite que seu projeto do Apps Script visualize, edite, crie e exclua planilhas do Sheets e se conecte a um serviço externo.

  4. Um arquivo de manifesto de projeto do Apps Script é um arquivo JSON que especifica informações básicas do projeto que o Apps Script precisa para executar um script. O editor do Apps Script oculta arquivos de manifesto por padrão para proteger as configurações do projeto. Edite o arquivo de manifesto:

    1. Abra seu projeto do Apps Script.
    2. Clique em Configurações do projeto .
    3. Selecione a caixa de seleção Mostrar arquivo de manifesto "appsscript.json" no editor.
    4. Clique em Editor .
    5. O arquivo de manifesto aparece como um arquivo de projeto chamado appsscript.json. Para editar o arquivo, selecione-o.

    6. O campo oauthScopes especifica uma matriz de strings. Para definir os escopos de autorização usados pelo projeto, adicione uma matriz com os escopos que você quer oferecer suporte. Exemplo: 

      {
  "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"
  ]
}

      Isso define os escopos explícitos para:

      • Conectar a um serviço externo
      • Acessar, editar, configurar e excluir seus dados do Google Cloud e conferir o endereço de e-mail da sua Conta do Google
      • Acessar, editar, criar e excluir todas as suas planilhas do app Planilhas

    7. Clique em Salvar .

Implantar um fluxo de trabalho que cria uma instância de VM

Implante um fluxo de trabalho que seja acionado quando uma solicitação para criar uma instância de VM for aprovada. O fluxo de trabalho chama o conector da API Compute Engine para criar uma instância de VM do Compute Engine com base nas especificações coletadas no formulário.

Console

  1. No console do Google Cloud, acesse a página Fluxos de trabalho:

    Acessar fluxos de trabalho

  2. Clique em Criar.

  3. Insira um nome para o novo fluxo de trabalho: create-vm-from-form.

  4. Na lista Região, selecione us-central1 (Iowa).

  5. Para a Conta de serviço, selecione a conta de serviço padrão do Compute Engine (PROJECT_NUMBER-compute@developer.gserviceaccount.com).

  6. Clique em Próxima.

  7. No editor de fluxo de trabalho, insira a seguinte definição:

    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. Clique em Implantar.

gcloud

  1. Crie um arquivo de código-fonte para seu fluxo de trabalho:

    touch create-vm-from-form.yaml

  2. Em um editor de texto, copie o seguinte fluxo de trabalho para o arquivo de código-fonte:

    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. Implante o fluxo de trabalho digitando o seguinte 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

    Substitua PROJECT_NUMBER pelo número do projeto do Google Cloud. Para recuperar o número do projeto:

    gcloud projects describe PROJECT_ID

Testar o fluxo completo

Para confirmar se tudo está funcionando conforme o esperado, tente executar todo o processo.

  1. Envie o formulário para você mesmo e responda às perguntas.

    Verifique se as especificações usadas para criar uma instância de VM são válidas. Caso contrário, a execução do fluxo de trabalho vai falhar. Para mais informações, consulte Família de máquinas de uso geral do Compute Engine.

  2. Para enviar sua resposta, clique em Enviar.

  3. Abra o formulário no Formulários.

  4. Clique em Respostas.

  5. Clique em Ver nas Planilhas.

    A planilha vinculada é aberta.

  6. Na linha da sua resposta, marque a caixa de seleção Aprovado?.

  7. Abra seu projeto do Apps Script.

  8. Clique em Execuções .

    O acionador precisa ser executado e listado com o status Completed.

  9. Confirme se o fluxo de trabalho create-vm-from-form foi concluído:

    Console

    1. No console do Google Cloud, abra a página Workflows.

      Acessar fluxos de trabalho

    2. Na página Fluxos de trabalho, clique no fluxo create-vm-from-form para acessar a página de detalhes dele.

    3. Na página Detalhes do fluxo de trabalho, para recuperar os detalhes de uma execução específica, clique no ID de execução apropriado.

      O estado de execução deve ser Concluído e, no painel de entrada, as especificações da VM solicitadas vão aparecer.

    gcloud

    Extraia uma lista das tentativas de execução do fluxo de trabalho:

    gcloud workflows executions list create-vm-from-form

    O resultado será semelhante a este:

    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. Confirme se uma nova VM foi criada conforme o esperado:

    Console

    No console do Google Cloud, acesse a página Instâncias de VMs.

    Acessar instâncias de VM

    A instância de VM precisa estar listada com um status indicando que ela está em execução.

    gcloud

    Extraia uma lista agregada de todas as VMs em todas as zonas de um projeto:

    gcloud compute instances list

    A instância de VM precisa estar listada com um status indicando que ela está em execução.

    Para mais informações sobre o comando gcloud compute instances list, consulte a página de referência.

Limpar

Se você criou um novo projeto para este tutorial, exclua o projeto. Se você usou um projeto atual e quer mantê-lo sem as alterações incluídas neste tutorial, exclua os recursos criados para o tutorial.

Exclua o projeto

O jeito mais fácil de evitar cobranças é excluindo o projeto que você criou para o tutorial.

Para excluir o projeto:

  1. In the Google Cloud console, go to the Manage resources page.

    Go to Manage resources

  2. In the project list, select the project that you want to delete, and then click Delete.
  3. In the dialog, type the project ID, and then click Shut down to delete the project.

Excluir os recursos criados neste tutorial

  1. Excluir arquivos no Drive.
  2. Exclua uma instância de VM do Compute Engine.
  3. Excluir um fluxo de trabalho.

A seguir