orchestrator-lso 1.0.0__py3-none-any.whl

lso/__init__.py

@@ -0,0 +1,49 @@
+# 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.
+
+"""Automatically invoked app factory."""
+
+__version__ = "1.0.0"
+
+import logging
+
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+
+from lso import config, 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()
+
+    app.add_middleware(
+        CORSMiddleware, allow_origins=["*"], allow_credentials=True, allow_methods=["*"], allow_headers=["*"]
+    )
+
+    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")
+
+    return app

lso/app.py

@@ -0,0 +1,23 @@
+# 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.
+
+"""Default app creation."""
+
+import lso
+
+app = lso.create_app()
+
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run("lso.app:app", host="0.0.0.0", port=44444, log_level="debug")

lso/config.py

@@ -0,0 +1,70 @@
+# 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.
+
+"""A module for loading configuration data, including a configuration schema that data is validated against.
+
+Data is loaded from a file, the location of which may be specified when using :func:`load_from_file`.
+Configuration file location can also be loaded from environment variable ``$SETTINGS_FILENAME``, which is default
+ behaviour in :func:`load`.
+"""
+
+import json
+import os
+from pathlib import Path
+
+import jsonschema
+from pydantic import BaseModel
+
+CONFIG_SCHEMA = {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "properties": {"ansible_playbooks_root_dir": {"type": "string"}},
+    "required": ["ansible_playbooks_root_dir"],
+    "additionalProperties": False,
+}
+DEFAULT_REQUEST_TIMEOUT = 10
+
+
+class Config(BaseModel):
+    """Simple Configuration class.
+
+    Contains the root directory at which Ansible playbooks are present.
+    """
+
+    ansible_playbooks_root_dir: str
+
+
+def load_from_file(file: Path) -> Config:
+    """Load, validate and return configuration parameters.
+
+    Input is validated against this JSON schema:
+
+    .. asjson:: lso.config.CONFIG_SCHEMA
+
+    :param file: :class:`Path` object that produces the configuration file.
+    :return: a dict containing the parsed configuration parameters.
+    """
+    config = json.loads(file.read_text())
+    jsonschema.validate(config, CONFIG_SCHEMA)
+    return Config(**config)
+
+
+def load() -> Config:
+    """Load a configuration file, located at the path specified in the environment variable ``$SETTINGS_FILENAME``.
+
+    Loading and validating the file is performed by :func:`load_from_file`.
+
+    :return: a dict containing the parsed configuration parameters
+    """
+    assert "SETTINGS_FILENAME" in os.environ, "Environment variable SETTINGS_FILENAME not set"  # noqa: S101
+    return load_from_file(Path(os.environ["SETTINGS_FILENAME"]))

lso/environment.py

@@ -0,0 +1,50 @@
+# 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.
+
+"""Environment module for setting up logging."""
+
+import json
+import logging.config
+import os
+from pathlib import Path
+
+LOGGING_DEFAULT_CONFIG = {
+    "version": 1,
+    "disable_existing_loggers": False,
+    "formatters": {"simple": {"format": "%(asctime)s - %(name)s (%(lineno)d) - %(levelname)s - %(message)s"}},
+    "handlers": {
+        "console": {
+            "class": "logging.StreamHandler",
+            "level": "DEBUG",
+            "formatter": "simple",
+            "stream": "ext://sys.stdout",
+        }
+    },
+    "loggers": {"resource_management": {"level": "DEBUG", "handlers": ["console"], "propagate": False}},
+    "root": {"level": "INFO", "handlers": ["console"]},
+}
+
+
+def setup_logging() -> None:
+    """Set up logging using the configured filename.
+
+    If ``LOGGING_CONFIG`` is defined in the environment, use this for the filename, otherwise use
+    ``LOGGING_DEFAULT_CONFIG``.
+    """
+    logging_config = LOGGING_DEFAULT_CONFIG
+    if "LOGGING_CONFIG" in os.environ:
+        filename = os.environ["LOGGING_CONFIG"]
+        config_file = Path(filename).read_text()
+        logging_config = json.loads(config_file)
+
+    logging.config.dictConfig(logging_config)

lso/playbook.py

@@ -0,0 +1,122 @@
+# 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 logging
+import threading
+import uuid
+from pathlib import Path
+from typing import Any
+
+import ansible_runner
+import requests
+from fastapi import status
+from fastapi.responses import JSONResponse
+from pydantic import HttpUrl
+
+from lso import config
+from lso.config import DEFAULT_REQUEST_TIMEOUT
+
+logger = logging.getLogger(__name__)
+
+
+def get_playbook_path(playbook_name: str) -> Path:
+    """Get the path of a playbook on the local filesystem."""
+    config_params = config.load()
+    return Path(config_params.ansible_playbooks_root_dir) / playbook_name
+
+
+def playbook_launch_success(job_id: str) -> JSONResponse:
+    """Return a :class:`PlaybookLaunchResponse` for the successful start of a playbook execution.
+
+    :return JSONResponse: A playbook launch response that's successful.
+    """
+    return JSONResponse(content={"job_id": job_id}, status_code=status.HTTP_201_CREATED)
+
+
+def playbook_launch_error(reason: str, status_code: int = status.HTTP_400_BAD_REQUEST) -> JSONResponse:
+    """Return a :class:`PlaybookLaunchResponse` for the erroneous start of a playbook execution.
+
+    :param str reason: The reason why a request has failed.
+    :param status status_code: The HTTP status code that should be associated with this request. Defaults to HTTP 400:
+                               Bad request.
+    :return JSONResponse: A playbook launch response that's unsuccessful.
+    """
+    return JSONResponse(content={"error": reason}, status_code=status_code)
+
+
+def _run_playbook_proc(
+    job_id: str, playbook_path: str, extra_vars: dict, inventory: dict[str, Any] | str, callback: str
+) -> None:
+    """Run a playbook, internal function.
+
+    :param str job_id: Identifier of the job that's executed.
+    :param str playbook_path: Ansible playbook to be executed.
+    :param dict extra_vars: Extra variables passed to the Ansible playbook.
+    :param str callback: Callback URL to return output to when execution is completed.
+    :param dict[str, Any] | str inventory: Ansible inventory to run the playbook against.
+    """
+    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(callback, json=payload, timeout=DEFAULT_REQUEST_TIMEOUT)
+    if not status.HTTP_200_OK <= request_result.status_code < status.HTTP_300_MULTIPLE_CHOICES:
+        msg = f"Callback failed: {request_result.text}"
+        logger.error(msg)
+
+
+def run_playbook(
+    playbook_path: Path,
+    extra_vars: dict[str, Any],
+    inventory: dict[str, Any] | str,
+    callback: HttpUrl,
+) -> JSONResponse:
+    """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`
+    """
+    if not Path.exists(playbook_path):
+        msg = f"Filename '{playbook_path}' does not exist."
+        return playbook_launch_error(reason=msg, status_code=status.HTTP_404_NOT_FOUND)
+
+    if not ansible_runner.utils.isinventory(inventory):
+        msg = "Invalid inventory provided. Should be a string, or JSON object."
+        return playbook_launch_error(reason=msg, status_code=status.HTTP_400_BAD_REQUEST)
+
+    job_id = str(uuid.uuid4())
+    thread = threading.Thread(
+        target=_run_playbook_proc,
+        kwargs={
+            "job_id": job_id,
+            "playbook_path": str(playbook_path),
+            "inventory": inventory,
+            "extra_vars": extra_vars,
+            "callback": callback,
+        },
+    )
+    thread.start()
+
+    return playbook_launch_success(job_id=job_id)

lso/routes/__init__.py

@@ -0,0 +1,14 @@
+# 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 of all routes that are available in LSO."""

lso/routes/default.py

@@ -0,0 +1,43 @@
+# 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.
+
+"""Default route located at the root URL /.
+
+For now only includes a single endpoint that responds with the current version of the API and LSO.
+"""
+
+from importlib import metadata
+
+from fastapi import APIRouter
+from pydantic import BaseModel, constr
+
+API_VERSION = "1.0"
+VersionString = constr(pattern=r"\d+\.\d+")
+
+router = APIRouter()
+
+
+class Version(BaseModel):
+    """Simple model for returning a version number of both the API and the `lso` module."""
+
+    api: VersionString  # type: ignore[valid-type]
+    module: VersionString  # type: ignore[valid-type]
+
+
+@router.get("/version")
+def version() -> Version:
+    """Return the version numbers of the API version, and the module version.
+
+    :return: Version object with both API and `lso` versions numbers.
+    """
+    return Version(api=API_VERSION, module=metadata.version("orchestrator-lso"))

lso/routes/playbook.py

@@ -0,0 +1,91 @@
+# 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.
+
+"""The API endpoint from which Ansible playbooks can be executed."""
+
+import json
+import tempfile
+from contextlib import redirect_stderr
+from io import StringIO
+from typing import Annotated, Any
+
+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
+
+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.
+
+    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'.
+    """
+    loader = DataLoader()
+    output = StringIO()
+    with tempfile.NamedTemporaryFile(mode="w+") as temp_inv, redirect_stderr(output):
+        json.dump(inventory, temp_inv, ensure_ascii=False)
+        temp_inv.flush()
+
+        inventory_manager = InventoryManager(loader=loader, sources=[temp_inv.name], parse=True)
+        inventory_manager.parse_source(temp_inv.name)
+
+    output.seek(0)
+    error_messages = output.readlines()
+    if error_messages:
+        raise HTTPException(status_code=status.HTTP_422_UNPROCESSABLE_ENTITY, detail=error_messages)
+
+    return inventory
+
+
+PlaybookInventory = Annotated[dict[str, Any] | str, AfterValidator(_inventory_validator)]
+
+
+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
+    #: 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
+    #: including host vars, it should be a dictionary. Can be a simple string containing hostnames when no host vars are
+    #: needed. In the latter case, multiple hosts should be separated with a ``\n`` newline character only.
+    inventory: PlaybookInventory
+    #: Extra variables that should get passed to the playbook. This includes any required configuration objects
+    #: from the workflow orchestrator, commit comments, whether this execution should be a dry run, a trouble ticket
+    #: number, etc. Which extra vars are required solely depends on what inputs the playbook requires.
+    extra_vars: dict[str, Any] = {}
+
+
+@router.post("/")
+def run_playbook_endpoint(params: PlaybookRunParams) -> JSONResponse:
+    """Launch an Ansible playbook to modify or deploy a subscription instance.
+
+    The response will contain either a job ID, or error information.
+
+    :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),
+        extra_vars=params.extra_vars,
+        inventory=params.inventory,
+        callback=params.callback,
+    )

orchestrator_lso-1.0.0.dist-info/LICENSE

@@ -0,0 +1,202 @@
+                             Apache License
+                       Version 2.0, January 2004
+                    http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+  "License" shall mean the terms and conditions for use, reproduction,
+  and distribution as defined by Sections 1 through 9 of this document.
+
+  "Licensor" shall mean the copyright owner or entity authorized by
+  the copyright owner that is granting the License.
+
+  "Legal Entity" shall mean the union of the acting entity and all
+  other entities that control, are controlled by, or are under common
+  control with that entity. For the purposes of this definition,
+  "control" means (i) the power, direct or indirect, to cause the
+  direction or management of such entity, whether by contract or
+  otherwise, or (ii) ownership of fifty percent (50%) or more of the
+  outstanding shares, or (iii) beneficial ownership of such entity.
+
+  "You" (or "Your") shall mean an individual or Legal Entity
+  exercising permissions granted by this License.
+
+  "Source" form shall mean the preferred form for making modifications,
+  including but not limited to software source code, documentation
+  source, and configuration files.
+
+  "Object" form shall mean any form resulting from mechanical
+  transformation or translation of a Source form, including but
+  not limited to compiled object code, generated documentation,
+  and conversions to other media types.
+
+  "Work" shall mean the work of authorship, whether in Source or
+  Object form, made available under the License, as indicated by a
+  copyright notice that is included in or attached to the work
+  (an example is provided in the Appendix below).
+
+  "Derivative Works" shall mean any work, whether in Source or Object
+  form, that is based on (or derived from) the Work and for which the
+  editorial revisions, annotations, elaborations, or other modifications
+  represent, as a whole, an original work of authorship. For the purposes
+  of this License, Derivative Works shall not include works that remain
+  separable from, or merely link (or bind by name) to the interfaces of,
+  the Work and Derivative Works thereof.
+
+  "Contribution" shall mean any work of authorship, including
+  the original version of the Work and any modifications or additions
+  to that Work or Derivative Works thereof, that is intentionally
+  submitted to Licensor for inclusion in the Work by the copyright owner
+  or by an individual or Legal Entity authorized to submit on behalf of
+  the copyright owner. For the purposes of this definition, "submitted"
+  means any form of electronic, verbal, or written communication sent
+  to the Licensor or its representatives, including but not limited to
+  communication on electronic mailing lists, source code control systems,
+  and issue tracking systems that are managed by, or on behalf of, the
+  Licensor for the purpose of discussing and improving the Work, but
+  excluding communication that is conspicuously marked or otherwise
+  designated in writing by the copyright owner as "Not a Contribution."
+
+  "Contributor" shall mean Licensor and any individual or Legal Entity
+  on behalf of whom a Contribution has been received by Licensor and
+  subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  copyright license to reproduce, prepare Derivative Works of,
+  publicly display, publicly perform, sublicense, and distribute the
+  Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+  this License, each Contributor hereby grants to You a perpetual,
+  worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+  (except as stated in this section) patent license to make, have made,
+  use, offer to sell, sell, import, and otherwise transfer the Work,
+  where such license applies only to those patent claims licensable
+  by such Contributor that are necessarily infringed by their
+  Contribution(s) alone or by combination of their Contribution(s)
+  with the Work to which such Contribution(s) was submitted. If You
+  institute patent litigation against any entity (including a
+  cross-claim or counterclaim in a lawsuit) alleging that the Work
+  or a Contribution incorporated within the Work constitutes direct
+  or contributory patent infringement, then any patent licenses
+  granted to You under this License for that Work shall terminate
+  as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+  Work or Derivative Works thereof in any medium, with or without
+  modifications, and in Source or Object form, provided that You
+  meet the following conditions:
+
+  (a) You must give any other recipients of the Work or
+      Derivative Works a copy of this License; and
+
+  (b) You must cause any modified files to carry prominent notices
+      stating that You changed the files; and
+
+  (c) You must retain, in the Source form of any Derivative Works
+      that You distribute, all copyright, patent, trademark, and
+      attribution notices from the Source form of the Work,
+      excluding those notices that do not pertain to any part of
+      the Derivative Works; and
+
+  (d) If the Work includes a "NOTICE" text file as part of its
+      distribution, then any Derivative Works that You distribute must
+      include a readable copy of the attribution notices contained
+      within such NOTICE file, excluding those notices that do not
+      pertain to any part of the Derivative Works, in at least one
+      of the following places: within a NOTICE text file distributed
+      as part of the Derivative Works; within the Source form or
+      documentation, if provided along with the Derivative Works; or,
+      within a display generated by the Derivative Works, if and
+      wherever such third-party notices normally appear. The contents
+      of the NOTICE file are for informational purposes only and
+      do not modify the License. You may add Your own attribution
+      notices within Derivative Works that You distribute, alongside
+      or as an addendum to the NOTICE text from the Work, provided
+      that such additional attribution notices cannot be construed
+      as modifying the License.
+
+  You may add Your own copyright statement to Your modifications and
+  may provide additional or different license terms and conditions
+  for use, reproduction, or distribution of Your modifications, or
+  for any such Derivative Works as a whole, provided Your use,
+  reproduction, and distribution of the Work otherwise complies with
+  the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+  any Contribution intentionally submitted for inclusion in the Work
+  by You to the Licensor shall be under the terms and conditions of
+  this License, without any additional terms or conditions.
+  Notwithstanding the above, nothing herein shall supersede or modify
+  the terms of any separate license agreement you may have executed
+  with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+  names, trademarks, service marks, or product names of the Licensor,
+  except as required for reasonable and customary use in describing the
+  origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+  agreed to in writing, Licensor provides the Work (and each
+  Contributor provides its Contributions) on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+  implied, including, without limitation, any warranties or conditions
+  of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+  PARTICULAR PURPOSE. You are solely responsible for determining the
+  appropriateness of using or redistributing the Work and assume any
+  risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+  whether in tort (including negligence), contract, or otherwise,
+  unless required by applicable law (such as deliberate and grossly
+  negligent acts) or agreed to in writing, shall any Contributor be
+  liable to You for damages, including any direct, indirect, special,
+  incidental, or consequential damages of any character arising as a
+  result of this License or out of the use or inability to use the
+  Work (including but not limited to damages for loss of goodwill,
+  work stoppage, computer failure or malfunction, or any and all
+  other commercial damages or losses), even if such Contributor
+  has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+  the Work or Derivative Works thereof, You may choose to offer,
+  and charge a fee for, acceptance of support, warranty, indemnity,
+  or other liability obligations and/or rights consistent with this
+  License. However, in accepting such obligations, You may act only
+  on Your own behalf and on Your sole responsibility, not on behalf
+  of any other Contributor, and only if You agree to indemnify,
+  defend, and hold each Contributor harmless for any liability
+  incurred by, or claims asserted against, such Contributor by reason
+  of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+  To apply the Apache License to your work, attach the following
+  boilerplate notice, with the fields enclosed by brackets "[]"
+Copyright [yyyy] [name of copyright owner]
+  replaced with your own identifying information. (Don't include
+  the brackets!)  The text should be enclosed in the appropriate
+  comment syntax for the file format. We also recommend that a
+  file or class name and description of purpose be included on the
+  same "printed page" as the copyright notice for easier
+  identification within third-party archives.
+
+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.

orchestrator_lso-1.0.0.dist-info/METADATA

@@ -0,0 +1,138 @@
+Metadata-Version: 2.1
+Name: orchestrator-lso
+Version: 1.0.0
+Summary: Automatically invoked app factory.
+Author-email: GÉANT Orchestration and Automation Team <goat@geant.org>
+Requires-Python: >=3.11,<3.13
+Description-Content-Type: text/markdown
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development
+Classifier: Typing :: Typed
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Web Environment
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Telecommunications Industry
+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: types-setuptools ; extra == "dev"
+Requires-Dist: types-requests ; extra == "dev"
+Requires-Dist: toml ; extra == "dev"
+Requires-Dist: types-toml ; extra == "dev"
+Requires-Dist: mypy_extensions ; extra == "dev"
+Requires-Dist: pre-commit ; extra == "dev"
+Requires-Dist: sphinx ; extra == "doc"
+Requires-Dist: sphinx-rtd-theme ; extra == "doc"
+Requires-Dist: docutils ; extra == "doc"
+Requires-Dist: pytest ; extra == "test"
+Requires-Dist: Faker ; extra == "test"
+Requires-Dist: responses ; extra == "test"
+Requires-Dist: mypy ; extra == "test"
+Requires-Dist: ruff ; extra == "test"
+Requires-Dist: jsonschema ; extra == "test"
+Requires-Dist: starlette ; extra == "test"
+Project-URL: Documentation, https://workfloworchestrator.org/lso/
+Project-URL: Source, https://github.com/workfloworchestrator/lso
+Provides-Extra: dev
+Provides-Extra: doc
+Provides-Extra: test
+
+# Lightweight Service Orchestrator
+
+LSO: an API that allows for remotely executing Ansible playbooks.
+
+## Code documentation
+
+Code documentation can be found at <https://workfloworchestrator.org/lso>
+
+## Quick start
+
+This is a quick setup guide for running on your local machine.
+
+### As a Docker container
+
+To run LSO as a Docker container, build an image using the `Dockerfile.example` as an example. Be sure to update
+`requirements.txt` and `ansible-galaxy-requirements.yaml` accordingly, depending on your specific Ansible collection and
+-role needs.
+
+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"
+```
+
+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 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
+  environment variables. `ANSIBLE_ROLES_PATH` is given as an example in the Docker compose snippet above.
+
+### Install the module
+
+
+As an alternative, below are a set of instructions for installing and running LSO directly on a machine.
+
+*One of these should be what you're looking for:*
+
+* Install the latest release
+
+```bash
+  python3 -m venv my-venv-directory
+  . my-venv-directory/bin/activate
+
+  pip install orchestrator-lso
+```
+
+* Install the source code
+
+```bash
+  git clone https://github.com/workfloworchestrator/lso.git && cd lso
+  python3 -m venv my-venv-directory
+  . my-venv-directory/bin/activate
+  
+  pip install flit
+  flit install --deps production
+  
+  # Or, for the full development environment
+  flit install --deps develop
+```
+
+### Running the app
+
+* Create a settings file, see `config.json.example` for an example.
+* 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
+```
+

orchestrator_lso-1.0.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+lso/__init__.py,sha256=Eie5f0XbHVc3oRvedABnFbZsPyxAK5PaLeECN72e_Lw,1547
+lso/app.py,sha256=WDtlmjELIeFA437j-WPfqBQf6QT_l35LEABbEosHlqY,775
+lso/config.py,sha256=CB4Ydc8LxGaM24YrLMh59LxYFMOHGK03y4X9R-r_cAM,2436
+lso/environment.py,sha256=iZ3DmsSKAC5a7VNL-HfJOJZ0sQwUMf7ZzNGC34B2CG0,1771
+lso/playbook.py,sha256=EuMdKtXjkcD-D-q5ytrKB0fXTT5IhOjnyEXiln0bdk0,4925
+lso/routes/__init__.py,sha256=1kRrth9zkFgmj6LChujieYJq5cjIETeTGXa1G70pduk,639
+lso/routes/default.py,sha256=a7STN1BJyFVizXUzmqKuADO0fpE1SHun-PzaZ-jx1wU,1438
+lso/routes/playbook.py,sha256=VwxCNRvIg-MTAXyHDHcFhAAY2vQQG77VVMJf_GjZsr4,3837
+orchestrator_lso-1.0.0.dist-info/LICENSE,sha256=CgFXf7XbZXJADozQIw2uUmmvU-zwAwXo4u7cgDfx3rE,10744
+orchestrator_lso-1.0.0.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
+orchestrator_lso-1.0.0.dist-info/METADATA,sha256=01xOdNNhPFgZSt2zXp10py6tqablp5sfChmk8bdtb6Y,5017
+orchestrator_lso-1.0.0.dist-info/RECORD,,

orchestrator_lso-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: flit 3.9.0
+Root-Is-Purelib: true
+Tag: py3-none-any