Code Monkey home page Code Monkey logo

indeedeng / iwf Goto Github PK

View Code? Open in Web Editor NEW
467.0 28.0 50.0 12.5 MB

iWF is an API orchestration platform offering an orchestration coding framework and service for building resilient, fault-tolerant, scalable long-running processes

License: MIT License

Makefile 1.41% Go 97.18% Shell 1.23% Dockerfile 0.18%
golang open-source workflow cron-scheduler distributed-system orchestration orchestrator workflow-as-code workflow-engine durable-timer

iwf's Introduction

iWF project - main & server repo

Slack Status Go Reference Go Report Card Coverage Status

Build status Build status

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

Basic concepts

Advanced concepts

How to use

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

The iWF SDKs required to run with the server:

Using all-in-one docker image

Run the docker command to start the container for:

docker run -p 8801:8801 -p 7233:7233 -p 8233:8233 -e AUTO_FIX_WORKER_URL=host.docker.internal --add-host host.docker.internal:host-gateway -it iworkflowio/iwf-server-lite:latest

To update the server version, use docker pull iworkflowio/iwf-server-lite:latest to get the latest image. Or change latest to specify a version tag.

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, again:

To update the server version, use docker pull iworkflowio/iwf-server:latest to get the latest image. Or update the docker-compose file to specify a 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

Join our Slack channel! Slack Status

You can also post in our Discussion, or raise an issue.

Contributing

Check out our CONTRIBUTING page.

Posts & Articles & Reference

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.