Skip to content

Latest commit

 

History

History
140 lines (106 loc) · 4.16 KB

README.md

File metadata and controls

140 lines (106 loc) · 4.16 KB
Raw

Temporal-REST-executor

codecov CI Docker Image CD Quality Gate Status

This is a simple tool to execute Temporal workflows/activities through the REST endpoints

All documentation are available here

Based on FastAPI and may be useful for development and QA

Quick start

Just run docker image

docker run -p 8000:8000 ghcr.io/northpowered/temporal-rest-executor:latest

You can add Temporal endpoint as an env var

docker run -e TEMPORAL_ENDPOINT=temporal:7233 -p 8000:8000 ghcr.io/northpowered/temporal-rest-executor:latest

And specify docker network (this is the example for default Temporal compose manifest)

docker run -e TEMPORAL_ENDPOINT=temporal:7233 -p 8000:8000 --network temporal-network ghcr.io/northpowered/temporal-rest-executor:latest

Args for endpoints:

Activity execution

activity_name - [string] - REQUIRED
activity_task_queue - [string] - REQUIRED
args - [ANY] - may be null
start_to_close_timeout - [int] - Default is 10
schedule_to_start_timeout - [int] - may be null
heartbeat_timeout - [int] - may be null
schedule_to_close_timeout - [int] - may be null
retry_policy - [Object] - may be null
parent_workflow_id - [string] - If null, UUID4 will be used
parent_workflow_execution_timeout - [int] - Default is 10
parent_workflow_run_timeout - [int] - may be null
parent_workflow_task_timeout - [int] - may be null

# RetryPolicy object

initial_interval - [int] - Default is 1
backoff_coefficient - [float] - Default is 2
maximum_interval - [int] - may be null
maximum_attempts - [int] - Default is 0

Workflow execution

workflow_name - [string] - REQUIRED
workflow_task_queue - [string] - REQUIRED
args - [ANY] - may be null
execution_timeout - [int] - Default is 10
workflow_id- [string] - If null, UUID4 will be used

Config

Some env vars:

TEMPORAL_ENDPOINT = localhost:7233

TEMPORAL_NAMESPACE = default

TEMPORAL_INTERNAL_FLOW_NAME = InternalExecutionWorkflow

TEMPORAL_INTERNAL_TASK_QUEUE = internal-execution-queue

UVICORN_BIND_ADDR = 0.0.0.0

UVICORN_BIND_PORT = 8000

TELEMETRY_ENABLED = True

TELEMETRY_AGENT_HOST = localhost

TELEMETRY_AGENT_PORT = 6831

PROMETHEUS_ENDPOINT_ENABLED = True

PROMETHEUS_ENDPOINT_PORT = 9000

Usage

Default FastAPI Swagger is available

or You can use curl:

Activity execution

curl -X 'POST' \
  'http://localhost:8000/v1/activity/execute' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "activity_name": "your_remote_activity",
  "activity_task_queue": "your_queue",
  "args": "some args: string, object or null",
  "start_to_close_timeout": 10,
  "parent_workflow_id": "MyId",
  "schedule_to_start_timeout": 0,
  "heartbeat_timeout": 0,
  "schedule_to_close_timeout": 0,
  "retry_policy": {
    "initial_interval": 1,
    "backoff_coefficient": 2,
    "maximum_interval": 0,
    "maximum_attempts": 0
  },
  "parent_workflow_execution_timeout": 10,
  "parent_workflow_run_timeout": 0,
  "parent_workflow_task_timeout": 0
}'

Workflow execution

curl -X 'POST' \
  'http://localhost:8000/v1/workflow/execute' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "workflow_name": "string",
  "workflow_task_queue": "string",
  "args": "string",
  "workflow_id": "string",
  "execution_timeout": 1
}'