Merge branch 'improvement/ARTESCA-11283_metalk8s_cronjob_salt_module'…

… into q/126.0

CHANGELOG.md

@@ -8,9 +8,13 @@
   Workload Plane/Control Plane CIDRs.
   (PR[#4217](https://github.com/scality/metalk8s/pull/4217))
 
+- Add a new salt module `metalk8s_kubernetes_cronjob`
+  to manage Kubernetes CronJobs objects.
+  (PR[#4240](https://github.com/scality/metalk8s/pull/4240))
+
 ### Bug fixes
 
-- Salt module metalk8s_monitoring fixed and improved
+- Salt module `metalk8s_monitoring` fixed and improved
   (PR[#4238](https://github.com/scality/metalk8s/pull/4238))
 
 ## Release 126.0.2

salt/_modules/metalk8s_kubernetes_cronjob.py

@@ -0,0 +1,217 @@
+"""Utiliy methods to interact with Kubernetes Cron Job in MetalK8s.
+"""
+
+import time
+from salt.exceptions import CommandExecutionError
+
+__virtualname__ = "metalk8s_kubernetes_cronjob"
+
+
+def __virtual__():
+    return __virtualname__
+
+
+def list_cronjobs(
+    suspended=None,
+    all_namespaces=False,
+    namespace="default",
+    **kwargs,
+):
+    """Get a list of CronJobs
+
+    Args:
+        suspended (bool, optional): filter on the suspended state. Defaults to None.
+        all_namespaces (bool, optional): filter to get all namespaces at once. Defaults to False.
+        namespace (str, optional): filter on a specific namespace. Defaults to "default".
+
+    Raises:
+        CommandExecutionError: if there is no result for the given criteria.
+
+    Returns:
+        list: list of CronJobs matching the given criteria.
+    """
+
+    results = __salt__["metalk8s_kubernetes.list_objects"](
+        kind="CronJob",
+        apiVersion="batch/v1",
+        all_namespaces=all_namespaces,
+        namespace=namespace,
+        **kwargs,
+    )
+    if not results:
+        raise CommandExecutionError(
+            "No CronJobs found using the given criteria: "
+            f"suspended={suspended}, "
+            f"all_namespaces={all_namespaces}, "
+            f"namespace={namespace}"
+        )
+
+    if suspended is not None:
+        results = [
+            cronjob for cronjob in results if cronjob["spec"]["suspend"] == suspended
+        ]
+
+    return results
+
+
+def get_cronjob(name, namespace, **kwargs):
+    """Get a specific CronJob by name and namespace.
+
+    Args:
+        name (str): name of the CronJob.
+        namespace (str): namespace of the CronJob.
+
+    Raises:
+        CommandExecutionError: if the CronJob is not found.
+
+    Returns:
+        dict: the CronJob object.
+    """
+
+    cronjob = __salt__["metalk8s_kubernetes.get_object"](
+        kind="CronJob",
+        apiVersion="batch/v1",
+        name=name,
+        namespace=namespace,
+        **kwargs,
+    )
+    if not cronjob:
+        raise CommandExecutionError(
+            f"CronJob {name} not found in namespace {namespace}"
+        )
+
+    return cronjob
+
+
+def _set_cronjob_suspend(name, namespace, suspend, **kwargs):
+    """Set the suspend state of a CronJob.
+
+    Args:
+        name (str): name of the CronJob.
+        namespace (str): namespace of the CronJob.
+        suspend (bool): the new suspend state.
+
+    Returns:
+        True: if the suspend state has been updated.
+    """
+    cronjob = get_cronjob(name, namespace, **kwargs)
+
+    if cronjob["spec"]["suspend"] != suspend:
+        __salt__["metalk8s_kubernetes.update_object"](
+            kind="CronJob",
+            apiVersion="batch/v1",
+            name=name,
+            namespace=namespace,
+            patch={"spec": {"suspend": suspend}},
+            old_object=cronjob,
+            **kwargs,
+        )
+
+    return True
+
+
+def suspend_cronjob(name, namespace, **kwargs):
+    """Suspend a CronJob.
+
+    Args:
+        name (str): name of the CronJob.
+        namespace (str): namespace of the CronJob.
+
+    Returns:
+        True: if the suspend state has been updated.
+    """
+    return _set_cronjob_suspend(name, namespace, suspend=True, **kwargs)
+
+
+def activate_cronjob(name, namespace, **kwargs):
+    """Activate a CronJob.
+
+    Args:
+        name (str): name of the CronJob.
+        namespace (str): namespace of the CronJob.
+
+    Returns:
+        True: if the suspend state has been updated.
+    """
+    return _set_cronjob_suspend(name, namespace, suspend=False, **kwargs)
+
+
+def get_jobs(cronjob_name, namespace, **kwargs):
+    """Get the Jobs created by a CronJob.
+
+    Args:
+        cronjob_name (str): name of the CronJob.
+        namespace (str): namespace of the CronJob.
+
+    Returns:
+        list: list of Jobs created by the CronJob.
+    """
+    cronjob_uid = get_cronjob(cronjob_name, namespace, **kwargs)["metadata"]["uid"]
+
+    # Get all Jobs in the namespace
+    jobs = __salt__["metalk8s_kubernetes.list_objects"](
+        kind="Job", apiVersion="batch/v1", namespace=namespace, **kwargs
+    )
+
+    if not jobs:
+        return []
+
+    # Filter Jobs created by the CronJob
+    filtered_jobs = []
+
+    for job in jobs:
+        for owner_ref in job["metadata"].get("ownerReferences") or []:
+            if owner_ref.get("uid") == cronjob_uid:
+                filtered_jobs.append(job)
+                break
+
+    return filtered_jobs
+
+
+def stop_jobs(cronjob_name, namespace, wait=False, timeout_seconds=60, **kwargs):
+    """Stop all Jobs created by a CronJob.
+
+    Args:
+        cronjob_name (str): name of the CronJob.
+        namespace (str): namespace of the CronJob.
+        wait (bool, optional): wait for the Jobs to be deleted. Defaults to False.
+        timeout_seconds (int, optional): timeout in seconds to wait for the Jobs to be deleted. Defaults to 60.
+
+    Raises:
+        CommandExecutionError: if the wait timeout is exceeded.
+
+    Returns:
+        list: list of Jobs that have been deleted.
+    """
+    suspend_cronjob(cronjob_name, namespace, **kwargs)
+
+    jobs = get_jobs(cronjob_name, namespace, **kwargs)
+
+    for job in jobs:
+        __salt__["metalk8s_kubernetes.delete_object"](
+            kind="Job",
+            apiVersion="batch/v1",
+            name=job["metadata"]["name"],
+            namespace=namespace,
+            **kwargs,
+        )
+
+    # Wait for jobs to be deleted
+    # grace period is 30 seconds usually
+    if wait:
+        start_ts = time.time()
+        while time.time() - start_ts < timeout_seconds:
+            waiting_jobs = get_jobs(cronjob_name, namespace, **kwargs)
+            if not waiting_jobs:
+                break
+
+            time.sleep(1)
+        else:
+            waiting_jobs_names = ", ".join([job["name"] for job in waiting_jobs])
+
+            raise CommandExecutionError(
+                f"Wait timeout exceeded while deleting the following Jobs {waiting_jobs_names} "
+                f"for CronJob {cronjob_name} in namespace {namespace}"
+            )
+
+    return jobs