Getting started

What is it?

This is a simple tool to operate with Temporal workflows/activities through the REST endpoints.

Service provides some REST endpoints which can execute (now) any workflow or activity, registered is the namespace.

Based on FastAPI and may be useful for development and QA.

Run the docker image

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

You can add Temporal endpoint as an env var. All env vars`ll be listed below.

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 docker-compose manifest)

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

Use it for development or debugging

git clone git@github.com:northpowered/temporal-rest-executor.git

poetry install

python3 src/run.py

Temporal endpoint string

TEMPORAL_ENDPOINT=localhost:7233

Temporal namespace string

Will be deprecated soon, moved to the REST args

TEMPORAL_NAMESPACE=default

Name of the workflow for execution remote activities

TEMPORAL_INTERNAL_FLOW_NAME=InternalExecutionWorkflow

Task queue for internal workflow

TEMPORAL_INTERNAL_TASK_QUEUE=internal-execution-queue

Address for uvicorn HTTP server

UVICORN_BIND_ADDR=0.0.0.0

Port for uvicorn HTTP server

UVICORN_BIND_PORT=8000

Flag to enable OTEL collection

TELEMETRY_ENABLED=True

OTEL collector address

TELEMETRY_AGENT_HOST=localhost

OTEL collector port

TELEMETRY_AGENT_PORT=6831

Flag to enable Prometheus endpoint

PROMETHEUS_ENDPOINT_ENABLED=True

Prometheus endpoint port to bind on

PROMETHEUS_ENDPOINT_PORT=9000