Noções básicas sobre Workflows

O Workflows é uma plataforma de orquestração totalmente gerenciada que executa serviços na ordem que você define, ou seja, em um fluxo de trabalho. Esses fluxos de trabalho podem combinar serviços, incluindo serviços personalizados hospedados no Cloud Run ou no Cloud Functions, serviços do Google Cloud como o Cloud Vision AI e o BigQuery, além de qualquer API baseada em HTTP.

Ao incorporar fluxos de trabalho em soluções, é possível tornar as dependências de serviço explícitas e observáveis de ponta a ponta. Um fluxo de trabalho que especifica um aplicativo ou processo operacional ou de negócios fornece uma fonte de verdade ou narrativa canônica para o processo.

Os fluxos de trabalho não têm servidor e são escalonados verticalmente conforme necessário. Nenhuma cobrança é feita enquanto eles estão inativos. Como um fluxo de trabalho não tem dependências de código ou biblioteca, ele não requer patches de segurança. Depois de implantar um fluxo de trabalho, ele é executado de maneira confiável sem manutenção. Um fluxo de trabalho pode reter o estado, tentar novamente, pesquisar ou aguardar até um ano.

O diagrama a seguir mostra um exemplo de como usar o Workflows para orquestrar serviços:

Orquestração de serviços usando o Workflows

Principais casos de uso

O Workflows é compatível com muitos casos de uso. Por exemplo:

Orquestração de serviços Criar soluções combinando serviços: realize uma sequência de operações em vários sistemas, aguardando a conclusão de todas elas. Pode ser orientado por eventos. Por exemplo:
  • Enviar arquivos recém-enviados para a Vision IA do Cloud e gravar tags no Firestore
  • Chamar uma função do Cloud e envie os resultados para um serviço do Cloud Run
Jobs em lote Operar em vários itens: execute operações em um conjunto de itens ou dados em lote. Costuma ser programado. Por exemplo:
  • Enviar e-mails diários a clientes
  • Preparar e executar jobs do BigQuery ou de machine learning
  • Gerar relatórios
Processos de negócios Automatizar fluxos de trabalho de linhas de negócios: codifique as etapas de um processo empresarial, incluindo condições, ações e eventos human-in-the-loop. Por exemplo:
  • Rastrear um pedido desde a solicitação até o fulfillment
  • Automatizar solicitações de recursos com aprovações
Automação Execução gerenciada de operações de serviço: crie sequências de scripts com facilidade para operações de serviços do Google Cloud. Por exemplo:
  • Provisionar projetos ou infraestrutura de novos locatários
  • Desativar recursos de acordo com uma programação ou por acionadores de evento

Principais conceitos

Um fluxo de trabalho é uma série de etapas descritas usando a sintaxe do Workflows e pode ser gravada em YAML ou JSON. Essa é a definição de um fluxo de trabalho. Para uma explicação detalhada da sintaxe do Workflows, consulte a Referência de sintaxe.

Depois que um fluxo de trabalho é criado, ele é implantado, ficando pronto para execução. Saiba como criar e atualizar um fluxo de trabalho no Console do Google Cloud ou usando a ferramenta de linha de comando gcloud.

Uma execução é uma execução única da lógica contida na definição de um fluxo de trabalho. Um fluxo de trabalho que não foi executado não gera cobranças. Todas as execuções do fluxo de trabalho são independentes e o escalonamento rápido do produto permite um grande número de execuções simultâneas. É possível executar um fluxo de trabalho usando as bibliotecas de cliente, o Console do Cloud, a ferramenta de linha de comando gcloud ou enviando uma solicitação para a API REST do Workflows. Para detalhes, consulte Executar um fluxo de trabalho.

Principais recursos

Controle de execução

Etapas
Para criar um fluxo de trabalho, defina as etapas e a ordem de execução desejadas usando a sintaxe do Workflows. Cada fluxo de trabalho precisa ter pelo menos uma etapa. Por padrão, o Workflows trata as etapas como se estivessem em uma lista ordenada e as executa uma de cada vez até que todas sejam executadas. Para mais detalhes, consulte Etapas.
Condições
É possível usar um bloco switch como um mecanismo de seleção que permite que o valor de uma expressão controle o fluxo da execução de um fluxo de trabalho. Para detalhes, consulte Condições.
Iteração
Use uma repetição for para iterar uma sequência de números ou uma coleção de dados, como uma lista ou um mapa. Para mais detalhes, consulte Iteração.
Subfluxos de trabalho
Um subfluxo de trabalho funciona de maneira semelhante a uma rotina ou função em uma linguagem de programação, permitindo encapsular uma etapa ou um conjunto de etapas que serão repetidas várias vezes pelo fluxo de trabalho. Para detalhes, consulte Subfluxos de trabalho.

Como acionar execuções

Manual
É possível gerenciar fluxos de trabalho no Console do Google Cloud ou na linha de comando usando o SDK do Cloud. A compatibilidade com a visualização durante a edição da sintaxe do Workflows também está disponível no Console do Google Cloud.
Programático
As bibliotecas de cliente do Cloud para a API Workflows ou a API REST podem ser usadas para gerenciar fluxos de trabalho. Para detalhes, consulte APIs e referência do Workflows.
Programada
É possível usar o Cloud Scheduler para executar um fluxo de trabalho seguindo uma programação específica, como toda segunda-feira às 9h ou a cada 15 minutos. Veja mais detalhes em Programar um fluxo de trabalho usando o Cloud Scheduler.
Argumentos de ambiente de execução
Os dados transmitidos no ambiente de execução podem ser acessados adicionando um campo params ao seu fluxo de trabalho principal (posicionado em um bloco main). O campo params nomeia o mapa que o fluxo de trabalho usa para armazenar os dados transmitidos. Use a notação de ponto para acessar os argumentos. Para detalhes, consulte Argumentos de ambiente de execução.

Como conectar serviços

APIs HTTP
É possível definir uma etapa de fluxo de trabalho que faça uma chamada HTTP e atribuir a resposta da chamada a uma variável. Por exemplo, é possível invocar um serviço do Google Cloud como o Cloud Functions ou o Cloud Run por uma solicitação HTTP. Tanto solicitações HTTP como HTTPS são compatíveis. Para mais detalhes, consulte Fazer uma solicitação HTTP.
Conectores
O Workflows publica conectores que podem ser usados para se conectar a outras APIs Google Cloud em um fluxo de trabalho e integrar seus fluxos de trabalho a esses produtos do Google Cloud. Eles simplificam os serviços de chamada porque processam a formatação das solicitações, fornecendo métodos e argumentos para que você não precise conhecer os detalhes de uma API Google Cloud. Veja mais detalhes em Como funcionam os conectores.
Variáveis de ambiente e biblioteca padrão
A biblioteca padrão do Workflows e as variáveis de ambiente integradas permitem facilmente criar argumentos para serviços e respostas de processo.
A biblioteca padrão inclui módulos e funções usadas com frequência, como para conversão de formatos e tipos de dados. Não é necessário importar ou carregar bibliotecas em um fluxo de trabalho. As funções da biblioteca estão prontas para uso. Para mais detalhes, consulte a Visão geral da biblioteca padrão.
É possível acessar as informações do ambiente de um fluxo de trabalho (como o local ou o identificador do projeto) usando variáveis de ambiente integradas. As variáveis de ambiente integradas não precisam de declaração e estão disponíveis em todas as execuções de fluxo de trabalho. Para detalhes, consulte Variáveis de ambiente integradas.

Como lidar com erros

É possível tornar seus fluxos de trabalho resilientes e personalizar o comportamento em caso de falha. Para isso, use o processamento de exceções do Workflows, incluindo novas tentativas de chamadas HTTP automatizadas com esperas exponenciais, gerenciadores de erros personalizados e outros recursos avançados. Para detalhes, consulte Erros de fluxo de trabalho.

Aguardando

Os callbacks permitem que as execuções de fluxo de trabalho aguardem outro serviço para fazer uma solicitação ao endpoint de callback. Essa solicitação retoma a execução do fluxo de trabalho. Com os callbacks, é possível sinalizar para o fluxo de trabalho que evento especificado ocorreu e aguardar esse evento sem a necessidade de pesquisa. Para mais detalhes, consulte Aguardar usando callbacks.

É possível pausar a execução de um fluxo de trabalho adicionando uma etapa de suspensão à definição do fluxo. Depois, é possível usar sys.sleep para pesquisar dados em um determinado intervalo. Veja os detalhes em Aguardar usando pesquisas.

Autenticação e controle de acesso

Como cada execução de fluxo de trabalho requer uma chamada autenticada, é possível usar fluxos de trabalho para reduzir o risco de chamadas acidentais ou maliciosas. Também é possível simplificar as interações com outras APIs Google Cloud usando contas de serviço baseadas no IAM e armazenar chaves e senhas com segurança para autenticar APIs externas usando o Secret Manager. Para detalhes, consulte Autenticação e Controle de acesso.

Observabilidade

O Workflows gera registros de execução no Cloud Logging automaticamente. Também é possível usar registros de chamadas ou registros personalizados para controlar quando os registros são enviados para o Logging durante uma execução de fluxo de trabalho. Para detalhes, consulte Enviar registros para o Cloud Logging.

As informações de registro de auditoria estão disponíveis pelos Registros de auditoria do Cloud. Para detalhes, consulte Informações sobre a geração de registros de auditoria do Workflows.

Amostras de código

Você encontra muitas amostras de código úteis do Workflows na página de amostras.

A seguir