Configuration

Important

The config value that you will set on the environment should combine with prefix, component, and name which is WORKFLOW_{component}_{name} with upper case.

Environment Variable

Core

The main configuration that use to dynamic changing with your objective of this application. If any configuration values do not set yet, it will use default value and do not raise any error to you.

Name	Component	Default	Description
REGISTRY_CALLER	Core	.	List of importable string for the call stage.
REGISTRY_FILTER	Core	ddeutil.workflow.templates	List of importable string for the filter template.
CONF_PATH	Core	./conf	The config path that keep all template .yaml files.
TIMEZONE	Core	Asia/Bangkok	A Timezone string value that will pass to ZoneInfo object.
STAGE_DEFAULT_ID	Core	false	A flag that enable default stage ID that use for catch an execution output.
STAGE_RAISE_ERROR	Core	false	A flag that all stage raise StageException from stage execution.
MAX_CRON_PER_WORKFLOW	Core	5
MAX_QUEUE_COMPLETE_HIST	Core	16
GENERATE_ID_SIMPLE_MODE	Core	true	A flog that enable generating ID with md5 algorithm.
DEBUG_MODE	Log	true	A flag that enable logging with debug level mode.
FORMAT	Log	%(asctime)s.%(msecs)03d (%(name)-10s, %(process)-5d,%(thread)-5d) [%(levelname)-7s] %(message)-120s (%(filename)s:%(lineno)s)
FORMAT_FILE	Log	{datetime} ({process:5d}, {thread:5d}) {message:120s} ({filename}:{lineno})
DATETIME_FORMAT	Log	%Y-%m-%d %H:%M:%S
TRACE_PATH	Log	./logs	The log path of the workflow saving log.
TRACE_ENABLE_WRITE	Log	false
AUDIT_PATH	Log	./audits
AUDIT_ENABLE_WRITE	Log	true	A flag that enable logging object saving log to its destination.
MAX_PROCESS	App	2	The maximum process worker number that run in scheduler app module.
MAX_SCHEDULE_PER_PROCESS	App	100	A schedule per process that run parallel.
STOP_BOUNDARY_DELTA	App	'{"minutes": 5, "seconds": 20}'	A time delta value that use to stop scheduler app in json string format.

API

Environment	Component	Default	Description
ENABLE_ROUTE_WORKFLOW	API	true	A flag that enable workflow route to manage execute manually and workflow logging.
ENABLE_ROUTE_SCHEDULE	API	true	A flag that enable run scheduler.

Execution Override

Some config can override by an extra parameters. For the below example, I override the conf_path and stage_default_id config values at the execution time from WORKFLOW_CORE_CONF_PATH and WORKFLOW_CORE_STAGE_DEFAULT_ID environment variables.

That is mean, it does not impact to running workflow that do not override and use the current environment config values.

from pathlib import Path
from ddeutil.workflow import Workflow

workflow = Workflow.from_conf(
    "wf-tester",
    extras={
        "conf_path": Path("./new/conf"),
        "stage_default_id": True,
    }
)