iwf

README

iWF project - main & server repo

iWF will make you a 10x developer!

iWF is an API orchestration platform for building resilient, fault-tolerant, scalable long-running applications. It offers an orchestration coding framework with abstractions for durable timers, async/background execution with backoff retry, KV storage, RPC, and message queues. You will build long-running reliable processes faster than ever.

What is iWF

Use case study/examples

• User sign-up/registry in Python/Java
• Abstracted microservice orchestration in Java/Golang
• Employer & JobSeeker engagement in Java or Golang
• Subscription Workflow in Java or Golang

Basic concepts

• Basic concepts overview
• WorkflowState
• RPC
• Persistence

Advanced concepts

• WorkflowOptions
• WorkflowStateOptions
• Persistence Caching

How to use

As a coding framework, iWF provides three SDKs to use with:

• iWF Java SDK and samples
• iWF Golang SDK and samples
• iWF Python SDK and samples

The iWF SDKs required to run with the server:

Using docker image & docker-compose

This is the simpler(preferred) option to run the server locally for development.

Checkout this repo, go to the docker-compose folder and run it:

cd docker-compose && docker-compose up

This by default will run Temporal server with it. And it will also register a default Temporal namespace and required search attributes by iWF. Link to the Temporal WebUI: http://localhost:8233/namespaces/default/workflows

By default, iWF server is serving port 8801, server URL is http://localhost:8801/ )

NOTE:

Use docker pull iworkflowio/iwf-server:latest to update the latest image.Or update the docker-compose file to specify the version tag.

How to build & run locally

• Run make bins to build the binary iwf-server
• Make sure you have registered the system search attributes required by iWF server:
  • Keyword: IwfWorkflowType
  • Int: IwfGlobalWorkflowVersion
  • Keyword: IwfExecutingStateIds
  • See Contribution for more detailed commands.
  • For Cadence without advancedVisibility enabled, set disableSystemSearchAttributes to true
• Then run ./iwf-server start to run the service . This defaults to serve workflows APIs with Temporal interpreter implementation. It requires to have local Temporal setup. See Run with local Temporal.
• Alternatively, run ./iwf-server --config config/development_cadence.yaml start to run with local Cadence. See below instructions for setting up local Cadence.

Support

For support or any question, please post in our Discussion, or raise an issue. If you are interested in helping this project, check out our CONTRIBUTING page. Below is the basic and comprehensive documentation of iWF. There are some more details in the wiki pages.

Posts & Articles & Reference

• Cadence community spotlight
• A story of iWF
• iWF is an abstracted Temporal framework. Same for Cadence.