search

workfloworchestrator / example-orchestrator

Example Workflow Orchestrator implementation
13 stars 1 forks source link

Docs and suggestions #3

Open acidjunk opened 9 months ago

acidjunk commented 9 months ago

Not sure if this project is meant to be used as a starter for a workflow based project?

1 It's a nice and simple project layout; but I suppose that quit some refactoring is needed when you want to use this. For SURF orchestrators we use a folder layout that puts the webserver in it's own folder; which gives you more room on the root level, to add a folder tests, some helm charts, docs etc.

Probably good to be a bit opinionated as this will make support easier.

2 Without tests, or a pipeline it's a bit hard to find out how to get this running. Probably something like this in the Readme?

Quick install

create a venv, then run these commands:

pip install -r requirements.txt
python main.py db upgrade heads
python -u -m uvicorn --reload --workers 4 --host 0.0.0.0 --port 8080 main:app

This assumes a env that has correct settings or it will use the orchestrator-core defaults (like DB name orchestratorc-core).

Sparrow1029 commented 8 months ago

I'd also suggest that the docs need updating for orchestrator-core-gui v2, and I second more docs about how to run locally 👍