{"id":15050018,"url":"https://github.com/workfloworchestrator/lso","last_synced_at":"2025-06-13T18:09:48.264Z","repository":{"id":198496974,"uuid":"638944227","full_name":"workfloworchestrator/lso","owner":"workfloworchestrator","description":"Lightweight Service Orchestrator","archived":false,"fork":false,"pushed_at":"2025-06-10T10:06:13.000Z","size":6421,"stargazers_count":10,"open_issues_count":4,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-06-13T18:09:45.756Z","etag":null,"topics":["ansible","api","orchestration"],"latest_commit_sha":null,"homepage":"http://workfloworchestrator.org/lso/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/workfloworchestrator.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-05-10T12:40:28.000Z","updated_at":"2025-06-09T06:16:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"913c1ed6-f49b-44be-b1b2-8feb063603e9","html_url":"https://github.com/workfloworchestrator/lso","commit_stats":null,"previous_names":["workfloworchestrator/lso"],"tags_count":30,"template":false,"template_full_name":null,"purl":"pkg:github/workfloworchestrator/lso","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workfloworchestrator%2Flso","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workfloworchestrator%2Flso/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workfloworchestrator%2Flso/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workfloworchestrator%2Flso/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/workfloworchestrator","download_url":"https://codeload.github.com/workfloworchestrator/lso/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/workfloworchestrator%2Flso/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259695306,"owners_count":22897514,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ansible","api","orchestration"],"created_at":"2024-09-24T21:24:17.827Z","updated_at":"2025-06-13T18:09:48.212Z","avatar_url":"https://github.com/workfloworchestrator.png","language":"Python","readme":"![Lightweight Service Orchestrator](./docs/LSO_banner.jpg)\n[![Supported python versions](https://img.shields.io/pypi/pyversions/orchestrator-lso.svg?color=%2334D058)](https://pypi.org/project/orchestrator-lso)\n[![Downloads](https://static.pepy.tech/badge/orchestrator-lso/month)](https://pepy.tech/project/orchestrator-lso)\n[![codecov](https://codecov.io/github/workfloworchestrator/lso/graph/badge.svg?token=NVFHBBU3AR)](https://codecov.io/github/workfloworchestrator/lso)\n\nLSO: an API that allows for remotely executing Ansible playbooks.\n\n## Code documentation\n\nCode documentation can be found at \u003chttps://workfloworchestrator.org/lso\u003e\n\n## Quick start\n\nThis is a quick setup guide for running on your local machine.\n\n### As a Docker container\n\nTo run LSO as a Docker container, build an image using the `Dockerfile.example` as an example. Be sure to update\n`requirements.txt` and `ansible-galaxy-requirements.yaml` accordingly, depending on your specific Ansible collection and\n-role needs.\n\nUse the Docker image to then spin up an environment. An example Docker compose file is presented below:\n\n```yaml\nservices:\n  lso:\n    image: my-lso:latest\n    env_file: \n      .env  # Load default environment variables from the .env file\n    volumes:\n      - \"/home/user/ansible_inventory:/opt/ansible_inventory:ro\"\n      - \"~/.ssh/id_ed25519.pub:/root/.ssh/id_ed25519.pub:ro\"\n      - \"~/.ssh/id_ed25519:/root/.ssh/id_ed25519:ro\"\n```\n\nThis will expose the API on port 8000. The container requires some more files to be mounted:\n\n* An .env file: Sets default environment variables, like ANSIBLE_PLAYBOOKS_ROOT_DIR for the location of Ansible playbooks **inside the container**.\n* Environment variables: Specific configurations, such as ANSIBLE_ROLES_PATH, can be directly set in the environment section. This is ideal for values you may want to override without modifying the .env file.\n* An Ansible inventory for all host and group variables that are used in the playbooks\n* A public/private key pair for SSH authentication on external machines that are targeted by Ansible playbooks.\n* Any Ansible-specific configuration (such as `collections_path`, `roles_path`, etc.) should be set using\n  environment variables. `ANSIBLE_ROLES_PATH` is given as an example in the Docker compose snippet above.\n\n### Install the module\n\n\nAs an alternative, below are a set of instructions for installing and running LSO directly on a machine.\n\n*One of these should be what you're looking for:*\n\n* Install the latest release\n\n```bash\n  python3 -m venv my-venv-directory\n  . my-venv-directory/bin/activate\n\n  pip install orchestrator-lso\n```\n\n* Install the source code\n\n```bash\n  git clone https://github.com/workfloworchestrator/lso.git \u0026\u0026 cd lso\n  python3 -m venv my-venv-directory\n  . my-venv-directory/bin/activate\n  \n  pip install flit\n  flit install --deps production\n  \n  # Or, for the full development environment\n  flit install --deps develop\n```\n\n### Running the app\n\n* Set required environment variables; see `env.example` for reference.\n* If necessary, set the environment variable `ANSIBLE_HOME` to a custom path.\n* Run the app like this (`app.py` starts the server on port 44444):\n\n```bash\n  source .env \u0026\u0026 python -m lso.app\n```\n\n### Task Execution Options\n1. Celery (Distributed Execution)\n\n  - For distributed task execution, set `EXECUTOR=celery`.\n  - Add Celery config in your environment variables:\n\n```bash\nCELERY_BROKER_URL=redis://localhost:6379/0\nCELERY_RESULT_BACKEND=redis://localhost:6379/0\nWORKER_QUEUE_NAME=lso-worker-queue # default value is None so you don't need this by default.\n```\n  - Start a Celery worker:\n\n```bash\ncelery -A lso.worker worker --loglevel=info -Q lso-worker-queue\n```\n2. ThreadPoolExecutor (Local Execution)\n\nFor local concurrent tasks, set `EXECUTOR=threadpool` and configure `MAX_THREAD_POOL_WORKERS`.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworkfloworchestrator%2Flso","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fworkfloworchestrator%2Flso","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fworkfloworchestrator%2Flso/lists"}