Reference¶
Components¶
Package |
Role |
|---|---|
|
DAG/task models, rendering, and Airflow compatibility imports |
|
Hydra/YAML composition and DAG generation |
|
Shared operators and task helpers |
|
Host/port selection and configuration viewer |
|
HA cycles, retries, and execution limits |
|
DAG-run listener routing to alert backends |
|
Supervisor workload integration |
|
Nomad jobs, watchdogs, and allocation logs |
|
Cron configuration converted to Airflow DAGs |
|
Supervisor configuration and RPC client |
|
Nomad job models and client tools |
|
Cron configuration models |
The airflow_laminar module exposes __version__. Import tasks and models from the component packages.
Dependency bounds¶
Dependency |
Bound |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Compatibility¶
airflow-laminar requires Python >=3.11 and installs all components listed above. Install Apache Airflow through a component’s airflow or airflow3 extra, or use an existing Airflow environment.
Environment |
Installation path |
Verification |
|---|---|---|
Configuration loading and source generation |
|
Models support generation without a running scheduler or managed workload. |
Airflow 2 |
|
Examples checked on Python 3.11 / Airflow 2.11.2. |
Airflow 3 |
|
Examples checked on Python 3.11 / Airflow 3.3.2. |
The Balancer component extras select Airflow >=2.8,<3 or >=3,<3.4 and install SSH/standard providers. Component packages declare their provider requirements and supported versions. The checks above cover installation and DAG construction; running workloads requires the services listed below.
Runtime requirements¶
Integration |
External runtime |
|---|---|
Configuration/model rendering |
Python packages; a running Airflow scheduler is not needed. |
Cron conversion |
Airflow executes commands on its task worker. No system cron daemon is needed for these generated DAGs. |
Local Supervisor |
Supervisor tools/processes on the managed host, with access to the configured working directory and RPC endpoint. |
SSH Supervisor |
SSH access and Supervisor on the remote managed host. |
Nomad |
Nomad CLI and a reachable Nomad agent/cluster with an eligible client and the job’s task driver. |
Priority delivery |
The chosen backend SDK and receiver credentials. |
A Nomad development agent runs client and server roles in one process. The Nomad tutorial includes that setup and the task driver used by its example.
Entry points¶
The meta-package has no command-line entry points. Component commands include airflow-config and airflow-balancer-viewer; each SDK documents its own commands.