osism 0.20250919.0__py3-none-any.whl → 0.20251004.0__py3-none-any.whl

osism/tasks/__init__.py

@@ -1,13 +1,21 @@
 # SPDX-License-Identifier: Apache-2.0
 
+import fcntl
+import json
 import os
 import re
 import subprocess
+import yaml
+from datetime import datetime, timezone
+from pathlib import Path
 
 from loguru import logger
 
 from osism import utils
 
+# Regex pattern for extracting hosts from Ansible output
+HOST_PATTERN = re.compile(r"^(ok|changed|failed|skipping|unreachable):\s+\[([^\]]+)\]")
+
 
 class Config:
     broker_connection_retry_on_startup = True
@@ -30,6 +38,109 @@ class Config:
     }
 
 
+def get_container_version(worker):
+    """Read container version from YAML version file.
+
+    Args:
+        worker: The runtime container name (osism-ansible, kolla-ansible, ceph-ansible, osism-kubernetes)
+
+    Returns:
+        str: The container version, "latest" if empty, or "unknown" if not found
+
+    Examples:
+        >>> get_container_version("osism-ansible")
+        "7.0.5a"
+        >>> get_container_version("kolla-ansible")
+        "18.1.0"
+        >>> get_container_version("osism-kubernetes")
+        "1.29.0"
+
+    Note:
+        If the version parameter in the YAML file is an empty string (""),
+        the function returns "latest" as the default value.
+    """
+    version_file = Path(f"/interface/versions/{worker}.yml")
+
+    try:
+        if not version_file.exists():
+            logger.debug(f"Version file not found: {version_file}")
+            return "unknown"
+
+        with open(version_file, "r") as f:
+            version_data = yaml.safe_load(f)
+
+        # Convert worker name to version parameter name
+        # osism-ansible -> osism_ansible_version
+        # kolla-ansible -> kolla_ansible_version
+        # ceph-ansible -> ceph_ansible_version
+        version_key = f"{worker.replace('-', '_')}_version"
+
+        version = version_data.get(version_key, "unknown")
+
+        # If version is empty string, use "latest" as default
+        if version == "":
+            version = "latest"
+            logger.debug(f"Version parameter empty for {worker}, using 'latest'")
+
+        logger.debug(f"Read version {version} for {worker} from {version_file}")
+        return version
+
+    except Exception as e:
+        logger.warning(f"Failed to read version from {version_file}: {e}")
+        return "unknown"
+
+
+def log_play_execution(
+    request_id, worker, environment, role, hosts=None, arguments=None, result="started"
+):
+    """Log Ansible play execution to central tracking file.
+
+    Args:
+        request_id: The Celery task request ID for correlation
+        worker: The runtime container (osism-ansible, kolla-ansible, ceph-ansible, osism-kubernetes)
+        environment: The environment parameter
+        role: The playbook/role that was executed
+        hosts: List of hosts the play was executed against (default: empty list)
+        arguments: Command-line arguments passed to ansible-playbook (default: None)
+        result: Execution result - "started", "success", or "failure"
+    """
+    log_file = Path("/share/ansible-execution-history.json")
+
+    # Get runtime version from YAML version file
+    runtime_version = get_container_version(worker)
+
+    # Use provided hosts or empty list
+    if hosts is None:
+        hosts = []
+
+    execution_record = {
+        "timestamp": datetime.now(timezone.utc).isoformat().replace("+00:00", "Z"),
+        "request_id": request_id,
+        "worker": worker,
+        "worker_version": runtime_version,
+        "environment": environment,
+        "role": role,
+        "hosts": hosts,
+        "arguments": arguments if arguments else "",
+        "result": result,
+    }
+
+    try:
+        # Create directory if it doesn't exist
+        log_file.parent.mkdir(parents=True, exist_ok=True)
+
+        # Append with file locking for thread safety
+        with open(log_file, "a") as f:
+            fcntl.flock(f.fileno(), fcntl.LOCK_EX)
+            try:
+                f.write(json.dumps(execution_record) + "\n")
+            finally:
+                fcntl.flock(f.fileno(), fcntl.LOCK_UN)
+    except Exception as e:
+        # Log warning but don't fail the execution
+        logger.warning(f"Failed to log play execution to {log_file}: {e}")
+
+
 def run_ansible_in_environment(
     request_id,
     worker,
@@ -41,6 +152,7 @@ def run_ansible_in_environment(
     auto_release_time=3600,
 ):
     result = ""
+    extracted_hosts = set()  # Local set for host deduplication
 
     if type(arguments) == list:
         joined_arguments = " ".join(arguments)
@@ -73,6 +185,17 @@ def run_ansible_in_environment(
     if ansible_vault_password:
         env["VAULT"] = "/ansible-vault.py"
 
+    # Log play execution start
+    log_play_execution(
+        request_id=request_id,
+        worker=worker,
+        environment=environment,
+        role=role,
+        hosts=None,  # Hosts will be empty at start, filled at completion
+        arguments=joined_arguments,
+        result="started",
+    )
+
     # NOTE: Consider arguments in the future
     if locking:
         lock = utils.create_redlock(
@@ -110,8 +233,8 @@ def run_ansible_in_environment(
             env=env,
         )
 
-    # execute roles from kubernetes
-    elif worker == "kubernetes":
+    # execute roles from osism-kubernetes
+    elif worker == "osism-kubernetes":
         if locking:
             lock.acquire()
 
@@ -157,12 +280,30 @@ def run_ansible_in_environment(
 
     while p.poll() is None:
         line = p.stdout.readline().decode("utf-8")
+
+        # Extract hosts from Ansible output
+        match = HOST_PATTERN.match(line.strip())
+        if match:
+            hostname = match.group(2)
+            extracted_hosts.add(hostname)  # Local set (automatic deduplication)
+
         if publish:
             utils.push_task_output(request_id, line)
         result += line
 
     rc = p.wait(timeout=60)
 
+    # Log play execution result
+    log_play_execution(
+        request_id=request_id,
+        worker=worker,
+        environment=environment,
+        role=role,
+        hosts=sorted(list(extracted_hosts)),  # Direct pass of extracted hosts
+        arguments=joined_arguments,
+        result="success" if rc == 0 else "failure",
+    )
+
     if publish:
         utils.finish_task_output(request_id, rc=rc)
 

osism/tasks/kubernetes.py

@@ -21,7 +21,7 @@ def run(self, environment, playbook, arguments, publish=True, auto_release_time=
 
     return run_ansible_in_environment(
         self.request.id,
-        "kubernetes",
+        "osism-kubernetes",
         environment,
         playbook,
         arguments,

{osism-0.20250919.0.dist-info → osism-0.20251004.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: osism
-Version: 0.20250919.0
+Version: 0.20251004.0
 Summary: OSISM manager interface
 Home-page: https://github.com/osism/python-osism
 Author: OSISM GmbH
@@ -25,14 +25,14 @@ License-File: AUTHORS
 Requires-Dist: ClusterShell==1.9.3
 Requires-Dist: GitPython==3.1.45
 Requires-Dist: Jinja2==3.1.6
-Requires-Dist: PyYAML==6.0.2
+Requires-Dist: PyYAML==6.0.3
 Requires-Dist: ara==1.7.3
 Requires-Dist: celery[redis]==5.5.3
 Requires-Dist: cliff==4.11.0
 Requires-Dist: deepdiff==8.6.1
 Requires-Dist: docker==7.1.0
 Requires-Dist: dtrack-auditor==1.5.0
-Requires-Dist: fastapi==0.116.2
+Requires-Dist: fastapi==0.118.0
 Requires-Dist: flower==2.0.1
 Requires-Dist: hiredis==3.2.1
 Requires-Dist: jc==1.25.5
@@ -42,7 +42,7 @@ Requires-Dist: kubernetes==33.1.0
 Requires-Dist: loguru==0.7.3
 Requires-Dist: nbcli==0.10.0.dev2
 Requires-Dist: openstacksdk==4.7.1
-Requires-Dist: paramiko==3.5.1
+Requires-Dist: paramiko==4.0.0
 Requires-Dist: pottery==3.0.1
 Requires-Dist: prompt-toolkit==3.0.52
 Requires-Dist: pynetbox==7.5.0
@@ -53,7 +53,7 @@ Requires-Dist: sqlmodel==0.0.25
 Requires-Dist: sushy==5.7.1
 Requires-Dist: tabulate==0.9.0
 Requires-Dist: transitions==0.9.3
-Requires-Dist: uvicorn[standard]==0.35.0
+Requires-Dist: uvicorn[standard]==0.37.0
 Requires-Dist: validators==0.35.0
 Requires-Dist: watchdog==6.0.0
 Requires-Dist: websockets==15.0.1

{osism-0.20250919.0.dist-info → osism-0.20251004.0.dist-info}/RECORD

@@ -38,12 +38,12 @@ osism/services/__init__.py,sha256=bG7Ffen4LvQtgnYPFEpFccsWs81t4zqqeqn9ZeirH6E,38
 osism/services/event_bridge.py,sha256=roV90o9UgTnwoVbXnPR3muBk04IriVYCO_fewZ46Mq8,12016
 osism/services/listener.py,sha256=O8Xq5fEEVoNFIgFPE7GqfVqx6C4QkdWhUPUGzODFnws,14211
 osism/services/websocket_manager.py,sha256=F147kWOg8PAvbVG4aVYQVtK4mFMfPVtHxxYJXaqiAjg,11051
-osism/tasks/__init__.py,sha256=iAUs-ttUMw1nZElL631sT1ke29RvTjQjlhWPl_kGrEw,9003
+osism/tasks/__init__.py,sha256=l_a7IfYm_NUn6XOokfJBYjTuMZGyvGHcvDUOMWSeYGo,13814
 osism/tasks/ansible.py,sha256=wAeFqyY8EavySpOIBSgWwK3HcGXWPZCIVOaSss5irCM,1387
 osism/tasks/ceph.py,sha256=Zo-92rzbJ9NDH9dbKi_JPWwekO3cYTdbmwAGSwr5l0w,726
 osism/tasks/conductor.py,sha256=WBLsoPtr0iGUzRGERs0Xt7CMYrnHQVEwNV9qXBssI3s,274
 osism/tasks/kolla.py,sha256=1p0SZBTYpUvIg09czwUmnMh6LIBhleB6O1WSX1mkmJo,729
-osism/tasks/kubernetes.py,sha256=hrzzDPM0Vx0_KWNxQwsQG54y1v0s2goFYJIMriX0Gh4,736
+osism/tasks/kubernetes.py,sha256=LyFKjtByQryNl67ZgKjnr-csEODDqYf3LvjURf_qhK0,742
 osism/tasks/netbox.py,sha256=FjEGQUZDzAVqA9cc3eQqaPv5-hPj3iI9lEc9SkuDO7M,6278
 osism/tasks/openstack.py,sha256=c5PyVlSzn69Xw-nFgUf1cX3a3E_STSCNrIectiDzqPI,14871
 osism/tasks/reconciler.py,sha256=vlPdOr7nbqggfVMSNez-JHZmKw8L7YmqKQnLF7TOXuQ,2045
@@ -65,11 +65,11 @@ osism/tasks/conductor/sonic/interface.py,sha256=M876LHdFqGxUfTizzDusdzvCkDI0vCgq
 osism/tasks/conductor/sonic/sync.py,sha256=fpgsQVwq6Hb7eeDHhLkAqx5BkaK3Ce_m_WvmWEsJyOo,9182
 osism/utils/__init__.py,sha256=IEr0sR1HKg-QI_u84fs4gMldC6-EPSxvMBh2zMGu5dU,9939
 osism/utils/ssh.py,sha256=nxeEgwjJWvQCybKDp-NelMeWyODCYpaXFCBchAv4-bg,8691
-osism-0.20250919.0.dist-info/licenses/AUTHORS,sha256=DJIRsjyrFxKjFvmpUNDRDBS04nRiJ5B6FpKcDcfnoGM,36
-osism-0.20250919.0.dist-info/licenses/LICENSE,sha256=tAkwu8-AdEyGxGoSvJ2gVmQdcicWw3j1ZZueVV74M-E,11357
-osism-0.20250919.0.dist-info/METADATA,sha256=yUP8maQEdZTw_S98mpMq_gjQY-oRTPxIZPxH3l7vUus,2971
-osism-0.20250919.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-osism-0.20250919.0.dist-info/entry_points.txt,sha256=W45YQ7MJ7BCAPZXl3F6d2FSi6An0moZQbzLn_BwGnRE,4618
-osism-0.20250919.0.dist-info/pbr.json,sha256=PAMccwqoOE9e-txmqk4y_4SaKyVuFto85oajizESJwM,47
-osism-0.20250919.0.dist-info/top_level.txt,sha256=8L8dsI9hcaGHsdnR4k_LN9EM78EhwrXRFHyAryPXZtY,6
-osism-0.20250919.0.dist-info/RECORD,,
+osism-0.20251004.0.dist-info/licenses/AUTHORS,sha256=oWotd63qsnNR945QLJP9mEXaXNtCMaesfo8ZNuLjwpU,39
+osism-0.20251004.0.dist-info/licenses/LICENSE,sha256=tAkwu8-AdEyGxGoSvJ2gVmQdcicWw3j1ZZueVV74M-E,11357
+osism-0.20251004.0.dist-info/METADATA,sha256=AyzRodVxbpGRzpJZM9nl7_8BBf-iAjb25mOWR8sl3UM,2971
+osism-0.20251004.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+osism-0.20251004.0.dist-info/entry_points.txt,sha256=W45YQ7MJ7BCAPZXl3F6d2FSi6An0moZQbzLn_BwGnRE,4618
+osism-0.20251004.0.dist-info/pbr.json,sha256=O4D8iZGKdlEwIsuOJIdJnESPh6JYeG__nO6RBvorNPU,47
+osism-0.20251004.0.dist-info/top_level.txt,sha256=8L8dsI9hcaGHsdnR4k_LN9EM78EhwrXRFHyAryPXZtY,6
+osism-0.20251004.0.dist-info/RECORD,,

osism-0.20251004.0.dist-info/licenses/AUTHORS

@@ -0,0 +1 @@
+Christian Berendt <berendt@osism.tech>

osism-0.20251004.0.dist-info/pbr.json

@@ -0,0 +1 @@
+{"git_version": "e546bf8", "is_release": false}

osism-0.20250919.0.dist-info/licenses/AUTHORS

@@ -1 +0,0 @@
-janhorstmann <horstmann@osism.tech>

osism-0.20250919.0.dist-info/pbr.json

@@ -1 +0,0 @@
-{"git_version": "6f46bd9", "is_release": false}