orchestrator-lso 1.0.2__tar.gz → 2.0.0__tar.gz

{orchestrator_lso-1.0.2 → orchestrator_lso-2.0.0}/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.0.2
+current_version = 2.0.0
 commit = False
 tag = False
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(rc(?P<build>\d+))?

{orchestrator_lso-1.0.2 → orchestrator_lso-2.0.0}/.github/workflows/run-unit-tests.yaml

@@ -25,6 +25,10 @@ jobs:
         env:
           FLIT_ROOT_INSTALL: 1
       - name: Run Unit tests
-        run: pytest
-        env:
-          SETTINGS_FILENAME: dummy.json
+        run: pytest --cov-branch --cov=lso --cov-report=xml
+      - name: "Upload coverage to Codecov"
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: true
+          files: ./coverage.xml

{orchestrator_lso-1.0.2 → orchestrator_lso-2.0.0}/Dockerfile.example

@@ -11,7 +11,7 @@ COPY ./ansible-galaxy-requirements.yaml ./ansible-galaxy-requirements.yaml
 RUN apk add --update --no-cache gcc libc-dev libffi-dev openssh
 
 # Install the LSO python package, and additional requirements
-RUN pip install orchestrator-lso=="1.0.2"
+RUN pip install orchestrator-lso=="2.0.0"
 RUN pip install -r requirements.txt
 
 # Install required Ansible Galaxy roles and collections

{orchestrator_lso-1.0.2 → orchestrator_lso-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: orchestrator-lso
-Version: 1.0.2
+Version: 2.0.0
 Summary: LSO, an API for remotely running Ansible playbooks.
 Author-email: GÉANT Orchestration and Automation Team <goat@geant.org>
 Requires-Python: >=3.11,<3.13
@@ -25,13 +25,15 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: ansible-runner~=2.3.4
-Requires-Dist: ansible~=9.3.0
-Requires-Dist: fastapi~=0.110.0
-Requires-Dist: httpx~=0.27.0
-Requires-Dist: jsonschema~=4.21.1
-Requires-Dist: uvicorn[standard]~=0.28.0
-Requires-Dist: requests~=2.31.0
+Requires-Dist: ansible-runner==2.4.0
+Requires-Dist: ansible==10.6.0
+Requires-Dist: fastapi==0.115.5
+Requires-Dist: httpx==0.27.2
+Requires-Dist: uvicorn[standard]==0.32.0
+Requires-Dist: requests==2.32.3
+Requires-Dist: pydantic-settings==2.5.2
+Requires-Dist: celery==5.4.0
+Requires-Dist: redis==5.2.0
 Requires-Dist: types-setuptools ; extra == "dev"
 Requires-Dist: types-requests ; extra == "dev"
 Requires-Dist: toml ; extra == "dev"
@@ -42,6 +44,7 @@ Requires-Dist: sphinx ; extra == "doc"
 Requires-Dist: sphinx-rtd-theme ; extra == "doc"
 Requires-Dist: docutils ; extra == "doc"
 Requires-Dist: pytest ; extra == "test"
+Requires-Dist: pytest-cov ; extra == "test"
 Requires-Dist: Faker ; extra == "test"
 Requires-Dist: responses ; extra == "test"
 Requires-Dist: mypy ; extra == "test"
@@ -54,7 +57,10 @@ Provides-Extra: dev
 Provides-Extra: doc
 Provides-Extra: test
 
-# Lightweight Service Orchestrator
+![Lightweight Service Orchestrator](./docs/LSO_banner.jpg)
+[![Supported python versions](https://img.shields.io/pypi/pyversions/orchestrator-lso.svg?color=%2334D058)](https://pypi.org/project/orchestrator-lso)
+[![Downloads](https://static.pepy.tech/badge/orchestrator-lso/month)](https://pepy.tech/project/orchestrator-lso)
+[![codecov](https://codecov.io/github/workfloworchestrator/lso/graph/badge.svg?token=NVFHBBU3AR)](https://codecov.io/github/workfloworchestrator/lso)
 
 LSO: an API that allows for remotely executing Ansible playbooks.
 
@@ -75,23 +81,21 @@ To run LSO as a Docker container, build an image using the `Dockerfile.example`
 Use the Docker image to then spin up an environment. An example Docker compose file is presented below:
 
 ```yaml
-  version: "3.5"
-  services:
-   lso:
-     image: my-lso:latest
-     environment:
-       SETTINGS_FILENAME: /app/config.json
-       ANSIBLE_ROLES_PATH: /app/lso/ansible_roles
-     volumes:
-       - "/home/user/config.json:/app/config.json:ro"
-       - "/home/user/ansible_inventory:/opt/ansible_inventory:ro"
-       - "~/.ssh/id_ed25519.pub:/root/.ssh/id_ed25519.pub:ro"
-       - "~/.ssh/id_ed25519:/root/.ssh/id_ed25519:ro"
+services:
+  lso:
+    image: my-lso:latest
+    env_file: 
+      .env  # Load default environment variables from the .env file
+    volumes:
+      - "/home/user/ansible_inventory:/opt/ansible_inventory:ro"
+      - "~/.ssh/id_ed25519.pub:/root/.ssh/id_ed25519.pub:ro"
+      - "~/.ssh/id_ed25519:/root/.ssh/id_ed25519:ro"
 ```
 
 This will expose the API on port 8000. The container requires some more files to be mounted:
 
-* A `config.json` that references to the location where the Ansible playbooks are stored **inside the container**.
+* An .env file: Sets default environment variables, like ANSIBLE_PLAYBOOKS_ROOT_DIR for the location of Ansible playbooks **inside the container**.
+* 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.
 * An Ansible inventory for all host and group variables that are used in the playbooks
 * A public/private key pair for SSH authentication on external machines that are targeted by Ansible playbooks.
 * Any Ansible-specific configuration (such as `collections_path`, `roles_path`, etc.) should be set using
@@ -129,11 +133,30 @@ As an alternative, below are a set of instructions for installing and running LS
 
 ### Running the app
 
-* Create a settings file, see `config.json.example` for an example.
+* Set required environment variables; see `env.example` for reference.
 * If necessary, set the environment variable `ANSIBLE_HOME` to a custom path.
 * Run the app like this (`app.py` starts the server on port 44444):
 
 ```bash
-  SETTINGS_FILENAME=/absolute/path/to/config.json python -m lso.app
+  source .env && python -m lso.app
 ```
 
+### Task Execution Options
+1. Celery (Distributed Execution)
+
+  - For distributed task execution, set `EXECUTOR=celery`.
+  - Add Celery config in your environment variables:
+
+```bash
+CELERY_BROKER_URL=redis://localhost:6379/0
+CELERY_RESULT_BACKEND=redis://localhost:6379/0
+WORKER_QUEUE_NAME=lso-worker-queue # default value is None so you don't need this by default.
+```
+  - Start a Celery worker:
+
+```bash
+celery -A lso.worker worker --loglevel=info -Q lso-worker-queue
+```
+2. ThreadPoolExecutor (Local Execution)
+
+For local concurrent tasks, set `EXECUTOR=threadpool` and configure `MAX_THREAD_POOL_WORKERS`.

{orchestrator_lso-1.0.2 → orchestrator_lso-2.0.0}/README.md

@@ -1,4 +1,7 @@
-# Lightweight Service Orchestrator
+![Lightweight Service Orchestrator](./docs/LSO_banner.jpg)
+[![Supported python versions](https://img.shields.io/pypi/pyversions/orchestrator-lso.svg?color=%2334D058)](https://pypi.org/project/orchestrator-lso)
+[![Downloads](https://static.pepy.tech/badge/orchestrator-lso/month)](https://pepy.tech/project/orchestrator-lso)
+[![codecov](https://codecov.io/github/workfloworchestrator/lso/graph/badge.svg?token=NVFHBBU3AR)](https://codecov.io/github/workfloworchestrator/lso)
 
 LSO: an API that allows for remotely executing Ansible playbooks.
 
@@ -19,23 +22,21 @@ To run LSO as a Docker container, build an image using the `Dockerfile.example`
 Use the Docker image to then spin up an environment. An example Docker compose file is presented below:
 
 ```yaml
-  version: "3.5"
-  services:
-   lso:
-     image: my-lso:latest
-     environment:
-       SETTINGS_FILENAME: /app/config.json
-       ANSIBLE_ROLES_PATH: /app/lso/ansible_roles
-     volumes:
-       - "/home/user/config.json:/app/config.json:ro"
-       - "/home/user/ansible_inventory:/opt/ansible_inventory:ro"
-       - "~/.ssh/id_ed25519.pub:/root/.ssh/id_ed25519.pub:ro"
-       - "~/.ssh/id_ed25519:/root/.ssh/id_ed25519:ro"
+services:
+  lso:
+    image: my-lso:latest
+    env_file: 
+      .env  # Load default environment variables from the .env file
+    volumes:
+      - "/home/user/ansible_inventory:/opt/ansible_inventory:ro"
+      - "~/.ssh/id_ed25519.pub:/root/.ssh/id_ed25519.pub:ro"
+      - "~/.ssh/id_ed25519:/root/.ssh/id_ed25519:ro"
 ```
 
 This will expose the API on port 8000. The container requires some more files to be mounted:
 
-* A `config.json` that references to the location where the Ansible playbooks are stored **inside the container**.
+* An .env file: Sets default environment variables, like ANSIBLE_PLAYBOOKS_ROOT_DIR for the location of Ansible playbooks **inside the container**.
+* 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.
 * An Ansible inventory for all host and group variables that are used in the playbooks
 * A public/private key pair for SSH authentication on external machines that are targeted by Ansible playbooks.
 * Any Ansible-specific configuration (such as `collections_path`, `roles_path`, etc.) should be set using
@@ -73,10 +74,30 @@ As an alternative, below are a set of instructions for installing and running LS
 
 ### Running the app
 
-* Create a settings file, see `config.json.example` for an example.
+* Set required environment variables; see `env.example` for reference.
 * If necessary, set the environment variable `ANSIBLE_HOME` to a custom path.
 * Run the app like this (`app.py` starts the server on port 44444):
 
 ```bash
-  SETTINGS_FILENAME=/absolute/path/to/config.json python -m lso.app
+  source .env && python -m lso.app
 ```
+
+### Task Execution Options
+1. Celery (Distributed Execution)
+
+  - For distributed task execution, set `EXECUTOR=celery`.
+  - Add Celery config in your environment variables:
+
+```bash
+CELERY_BROKER_URL=redis://localhost:6379/0
+CELERY_RESULT_BACKEND=redis://localhost:6379/0
+WORKER_QUEUE_NAME=lso-worker-queue # default value is None so you don't need this by default.
+```
+  - Start a Celery worker:
+
+```bash
+celery -A lso.worker worker --loglevel=info -Q lso-worker-queue
+```
+2. ThreadPoolExecutor (Local Execution)
+
+For local concurrent tasks, set `EXECUTOR=threadpool` and configure `MAX_THREAD_POOL_WORKERS`.

{orchestrator_lso-1.0.2 → orchestrator_lso-2.0.0}/docs/source/_static/custom.css

@@ -1,10 +1,10 @@
 .wy-menu > p > span {
-    color: rgb(237 21 86);
+    color: rgb(254 122 54);
 }
 
 section > dl > .sig-object {
     background: #e5e8e8 !important;
-    color: rgb(237 21 86) !important;
+    color: rgb(254 122 54) !important;
     border-top: 3px solid rgb(167 179 180) !important;
 }
 

{orchestrator_lso-1.0.2 → orchestrator_lso-2.0.0}/docs/source/conf.py

@@ -47,7 +47,7 @@ def setup(app):
 # -- Project information -----------------------------------------------------
 
 project = "Lightweight Service Orchestrator"
-copyright = "2023, GÉANT Vereniging"
+copyright = "2023-2024, GÉANT Vereniging"
 author = "GÉANT Orchestration & Automation Team"
 
 # -- General configuration ---------------------------------------------------
@@ -66,8 +66,9 @@ exclude_patterns = []
 
 html_theme = "sphinx_rtd_theme"
 html_static_path = ["_static"]
-html_theme_options = {"style_nav_header_background": "rgb(0 63 95)"}
+html_theme_options = {"style_nav_header_background": "rgb(40 2 116)", "logo_only": True}
 html_css_files = ["custom.css"]
+html_logo = "_static/lso_logo.png"
 
 
 # Both the class' and the ``__init__`` method's docstring are concatenated and inserted.

orchestrator_lso-2.0.0/env.example

@@ -0,0 +1,23 @@
+# Environment configuration for LSO application
+
+# Ansible configuration
+ANSIBLE_PLAYBOOKS_ROOT_DIR="/path/to/ansible/playbooks"
+ANSIBLE_ROLES_PATH="/app/lso/ansible_roles"  # Set specific Ansible roles path
+
+# Executor configuration
+EXECUTOR="threadpool"  # Options: "threadpool", "celery"
+MAX_THREAD_POOL_WORKERS=10
+
+# Request settings
+REQUEST_TIMEOUT_SEC=10
+
+# Celery configuration
+CELERY_BROKER_URL="redis://localhost:6379/0"
+CELERY_RESULT_BACKEND="redis://localhost:6379/0"
+CELERY_TIMEZONE="Europe/Amsterdam"
+CELERY_ENABLE_UTC=True
+CELERY_RESULT_EXPIRES=3600
+WORKER_QUEUE_NAME="lso-worker-queue"
+
+# Debug/Testing
+TESTING=False

{orchestrator_lso-1.0.2 → orchestrator_lso-2.0.0}/lso/__init__.py

@@ -13,24 +13,21 @@
 
 """LSO, an API for remotely running Ansible playbooks."""
 
-__version__ = "1.0.2"
+__version__ = "2.0.0"
 
 import logging
 
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
 
-from lso import config, environment
+from lso import environment
 from lso.routes.default import router as default_router
 from lso.routes.playbook import router as playbook_router
 
 
 def create_app() -> FastAPI:
-    """Override default settings with those found in the file read from environment variable `SETTINGS_FILENAME`.
-
-    :return: a new flask app instance
-    """
-    app = FastAPI()
+    """Initialise the :term:`LSO` app."""
+    app = FastAPI(docs_url="/api/doc", redoc_url="/api/redoc", openapi_url="/api/openapi.json")
 
     app.add_middleware(
         CORSMiddleware, allow_origins=["*"], allow_credentials=True, allow_methods=["*"], allow_headers=["*"]
@@ -39,9 +36,6 @@ def create_app() -> FastAPI:
     app.include_router(default_router, prefix="/api")
     app.include_router(playbook_router, prefix="/api/playbook")
 
-    # test that configuration parameters are loaded and available
-    config.load()
-
     environment.setup_logging()
 
     logging.info("FastAPI app initialized")

orchestrator_lso-2.0.0/lso/config.py

@@ -0,0 +1,48 @@
+# Copyright 2023-2024 GÉANT Vereniging.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Module for loading and managing configuration settings for the LSO app.
+
+Uses `pydantic`'s `BaseSettings` to load settings from environment variables.
+"""
+
+import os
+from enum import Enum
+
+from pydantic_settings import BaseSettings
+
+
+class ExecutorType(Enum):
+    """Enum representing the types of executors available for task execution."""
+
+    WORKER = "celery"
+    THREADPOOL = "threadpool"
+
+
+class Config(BaseSettings):
+    """The set of parameters required for running :term:`LSO`."""
+
+    TESTING: bool = False
+    ANSIBLE_PLAYBOOKS_ROOT_DIR: str = "/path/to/ansible/playbooks"
+    EXECUTOR: ExecutorType = ExecutorType.THREADPOOL
+    MAX_THREAD_POOL_WORKERS: int = min(32, (os.cpu_count() or 1) + 4)
+    REQUEST_TIMEOUT_SEC: int = 10
+    CELERY_BROKER_URL: str = "redis://localhost:6379/0"
+    CELERY_RESULT_BACKEND: str = "redis://localhost:6379/0"
+    CELERY_TIMEZONE: str = "Europe/Amsterdam"
+    CELERY_ENABLE_UTC: bool = True
+    CELERY_RESULT_EXPIRES: int = 3600
+    WORKER_QUEUE_NAME: str | None = None
+
+
+settings = Config()

orchestrator_lso-2.0.0/lso/playbook.py

@@ -0,0 +1,76 @@
+# Copyright 2023-2024 GÉANT Vereniging.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Module that gathers common API responses and data models."""
+
+import uuid
+from concurrent.futures import ThreadPoolExecutor
+from pathlib import Path
+from typing import Any
+
+from pydantic import HttpUrl
+
+from lso.config import ExecutorType, settings
+from lso.tasks import run_playbook_proc_task
+
+_executor = None
+
+
+def get_thread_pool() -> ThreadPoolExecutor:
+    """Get and optionally initialise a ThreadPoolExecutor.
+
+    Returns:
+        ThreadPoolExecutor
+
+    """
+    global _executor  # noqa: PLW0603
+    if _executor is None:
+        _executor = ThreadPoolExecutor(max_workers=settings.MAX_THREAD_POOL_WORKERS)
+
+    return _executor
+
+
+def get_playbook_path(playbook_name: Path) -> Path:
+    """Get the path of a playbook on the local filesystem."""
+    return Path(settings.ANSIBLE_PLAYBOOKS_ROOT_DIR) / playbook_name
+
+
+def run_playbook(
+    playbook_path: Path,
+    extra_vars: dict[str, Any],
+    inventory: dict[str, Any] | str,
+    callback: HttpUrl,
+) -> uuid.UUID:
+    """Run an Ansible playbook against a specified inventory.
+
+    :param Path playbook_path: playbook to be executed.
+    :param dict[str, Any] extra_vars: Any extra vars needed for the playbook to run.
+    :param dict[str, Any] | str inventory: The inventory that the playbook is executed against.
+    :param HttpUrl callback: Callback URL where the playbook should send a status update when execution is completed.
+                             This is used for workflow-orchestrator to continue with the next step in a workflow.
+    :return: Result of playbook launch, this could either be successful or unsuccessful.
+    :rtype: :class:`fastapi.responses.JSONResponse`
+    """
+    job_id = uuid.uuid4()
+    if settings.EXECUTOR == ExecutorType.THREADPOOL:
+        executor = get_thread_pool()
+        executor_handle = executor.submit(
+            run_playbook_proc_task, str(job_id), str(playbook_path), extra_vars, inventory, str(callback)
+        )
+        if settings.TESTING:
+            executor_handle.result()
+
+    elif settings.EXECUTOR == ExecutorType.WORKER:
+        run_playbook_proc_task.delay(str(job_id), str(playbook_path), extra_vars, inventory, str(callback))
+
+    return job_id

{orchestrator_lso-1.0.2 → orchestrator_lso-2.0.0}/lso/routes/playbook.py

@@ -15,14 +15,16 @@
 
 import json
 import tempfile
+import uuid
 from contextlib import redirect_stderr
 from io import StringIO
+from pathlib import Path
 from typing import Annotated, Any
 
+import ansible_runner
 from ansible.inventory.manager import InventoryManager
 from ansible.parsing.dataloader import DataLoader
 from fastapi import APIRouter, HTTPException, status
-from fastapi.responses import JSONResponse
 from pydantic import AfterValidator, BaseModel, HttpUrl
 
 from lso.playbook import get_playbook_path, run_playbook
@@ -31,11 +33,19 @@ router = APIRouter()
 
 
 def _inventory_validator(inventory: dict[str, Any] | str) -> dict[str, Any] | str:
-    """Validate the format of the provided inventory by trying to parse it.
+    """Validate the provided inventory format.
 
-    If an inventory can't be parsed without warnings or errors, these are returned to the user by means of an HTTP
-    status 422 for 'unprocessable entity'.
+    Attempts to parse the inventory to verify its validity. If the inventory cannot be parsed or the inventory
+    format is incorrect an HTTP 422 error is raised.
+
+    :param inventory: The inventory to validate, can be a dictionary or a string.
+    :return: The validated inventory if no errors are found.
+    :raises HTTPException: If parsing fails or the format is incorrect.
     """
+    if not ansible_runner.utils.isinventory(inventory):
+        detail = "Invalid inventory provided. Should be a string, or JSON object."
+        raise HTTPException(status_code=status.HTTP_422_UNPROCESSABLE_ENTITY, detail=detail)
+
     loader = DataLoader()
     output = StringIO()
     with tempfile.NamedTemporaryFile(mode="w+") as temp_inv, redirect_stderr(output):
@@ -53,15 +63,31 @@ def _inventory_validator(inventory: dict[str, Any] | str) -> dict[str, Any] | st
     return inventory
 
 
+def _playbook_path_validator(playbook_name: Path) -> Path:
+    playbook_path = get_playbook_path(playbook_name)
+    if not Path.exists(playbook_path):
+        msg = f"Filename '{playbook_path}' does not exist."
+        raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail=msg)
+
+    return playbook_path
+
+
 PlaybookInventory = Annotated[dict[str, Any] | str, AfterValidator(_inventory_validator)]
+PlaybookName = Annotated[Path, AfterValidator(_playbook_path_validator)]
+
+
+class PlaybookRunResponse(BaseModel):
+    """PlaybookRunResponse domain model schema."""
+
+    job_id: uuid.UUID
 
 
 class PlaybookRunParams(BaseModel):
     """Parameters for executing an Ansible playbook."""
 
     #: The filename of a playbook that's executed. It should be present inside the directory defined in the
-    #: configuration option ``ansible_playbooks_root_dir``.
-    playbook_name: str
+    #: configuration option ``ANSIBLE_PLAYBOOKS_ROOT_DIR``.
+    playbook_name: PlaybookName
     #: The address where LSO should call back to upon completion.
     callback: HttpUrl
     #: The inventory to run the playbook against. This inventory can also include any host vars, if needed. When
@@ -74,8 +100,8 @@ class PlaybookRunParams(BaseModel):
     extra_vars: dict[str, Any] = {}
 
 
-@router.post("/")
-def run_playbook_endpoint(params: PlaybookRunParams) -> JSONResponse:
+@router.post("/", response_model=PlaybookRunResponse, status_code=status.HTTP_201_CREATED)
+def run_playbook_endpoint(params: PlaybookRunParams) -> PlaybookRunResponse:
     """Launch an Ansible playbook to modify or deploy a subscription instance.
 
     The response will contain either a job ID, or error information.
@@ -83,9 +109,11 @@ def run_playbook_endpoint(params: PlaybookRunParams) -> JSONResponse:
     :param PlaybookRunParams params: Parameters for executing a playbook.
     :return JSONResponse: Response from the Ansible runner, including a run ID.
     """
-    return run_playbook(
-        playbook_path=get_playbook_path(params.playbook_name),
+    job_id = run_playbook(
+        playbook_path=params.playbook_name,
         extra_vars=params.extra_vars,
         inventory=params.inventory,
         callback=params.callback,
     )
+
+    return PlaybookRunResponse(job_id=job_id)

orchestrator_lso-2.0.0/lso/tasks.py

@@ -0,0 +1,64 @@
+# Copyright 2023-2024 GÉANT Vereniging.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Module defines tasks for executing Ansible playbooks asynchronously using Celery.
+
+The primary task, `run_playbook_proc_task`, runs an Ansible playbook and sends a POST request with
+the results to a specified callback URL.
+"""
+
+import logging
+from typing import Any
+
+import ansible_runner
+import requests
+from starlette import status
+
+from lso.config import settings
+from lso.worker import RUN_PLAYBOOK, celery
+
+logger = logging.getLogger(__name__)
+
+
+class CallbackFailedError(Exception):
+    """Exception raised when a callback url can't be reached."""
+
+
+@celery.task(name=RUN_PLAYBOOK)  # type: ignore[misc]
+def run_playbook_proc_task(
+    job_id: str, playbook_path: str, extra_vars: dict[str, Any], inventory: dict[str, Any] | str, callback: str
+) -> None:
+    """Celery task to run a playbook.
+
+    :param str job_id: Identifier of the job being executed.
+    :param str playbook_path: Path to the playbook to be executed.
+    :param dict[str, Any] extra_vars: Extra variables to pass to the playbook.
+    :param dict[str, Any] | str inventory: Inventory to run the playbook against.
+    :param HttpUrl callback: Callback URL for status updates.
+    :return: None
+    """
+    msg = f"playbook_path: {playbook_path}, callback: {callback}"
+    logger.info(msg)
+    ansible_playbook_run = ansible_runner.run(playbook=playbook_path, inventory=inventory, extravars=extra_vars)
+
+    payload = {
+        "status": ansible_playbook_run.status,
+        "job_id": job_id,
+        "output": ansible_playbook_run.stdout.readlines(),
+        "return_code": int(ansible_playbook_run.rc),
+    }
+
+    request_result = requests.post(str(callback), json=payload, timeout=settings.REQUEST_TIMEOUT_SEC)
+    if not status.HTTP_200_OK <= request_result.status_code < status.HTTP_300_MULTIPLE_CHOICES:
+        msg = f"Callback failed: {request_result.text}, url: {callback}"
+        raise CallbackFailedError(msg)