qontract-reconcile 0.10.1rc609__py3-none-any.whl → 0.10.1rc611__py3-none-any.whl

{qontract_reconcile-0.10.1rc609.dist-info → qontract_reconcile-0.10.1rc611.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qontract-reconcile
-Version: 0.10.1rc609
+Version: 0.10.1rc611
 Summary: Collection of tools to reconcile services with their desired state as defined in the app-interface DB.
 Home-page: https://github.com/app-sre/qontract-reconcile
 Author: Red Hat App-SRE Team

{qontract_reconcile-0.10.1rc609.dist-info → qontract_reconcile-0.10.1rc611.dist-info}/RECORD

@@ -638,8 +638,8 @@ reconcile/utils/jinja2/extensions.py,sha256=zV_x8MhSHAynKhFnG3fULXrwsm5fUG_88Iyg
 reconcile/utils/jinja2/filters.py,sha256=_kJjdMsY3lGS5PUn4NnpXUQDNrL1IwiKsB-0MhTMGYM,4521
 reconcile/utils/jinja2/utils.py,sha256=1TV_BoKrCFxVPbRY4hhUmbasrPa_wm9AoabCEIOXRLg,5947
 reconcile/utils/jobcontroller/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-reconcile/utils/jobcontroller/controller.py,sha256=9x1yiHHws4Zm38u4X00HdryqCsUWBnUX6w1_6hjNbfY,13866
-reconcile/utils/jobcontroller/models.py,sha256=N1C422MMWp4EvbMbLv1X9EbMq_bIMXQPmRl7MEYZqhQ,4947
+reconcile/utils/jobcontroller/controller.py,sha256=BeGm2KNfVnxPuQkfIFy3Tp9H_NSpoAu-gy40elUgvxs,14181
+reconcile/utils/jobcontroller/models.py,sha256=z0gRJy8Ow1leYS-GrvTUv-t-mQDPHTJVDoHb1nVcZ_8,6349
 reconcile/utils/membershipsources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 reconcile/utils/membershipsources/app_interface_resolver.py,sha256=IlDiRtJZ0AfAGKEawybB6SvsKbm1POTXL6fpEt699E0,1979
 reconcile/utils/membershipsources/models.py,sha256=IFu6KHFe-HUTJPiAO3fEw7i22yv4_ytgBW-h_wrO6V4,2015
@@ -671,7 +671,7 @@ reconcile/utils/ocm/subscriptions.py,sha256=4qSH8uF9JvFxiecVSV1Kh8-mPcGSTfTTK7In
 reconcile/utils/ocm/syncsets.py,sha256=zvji9qWvInIRTdoybMaM9-VUhq4L1VewWfWCQmp4urc,940
 reconcile/utils/ocm/upgrades.py,sha256=ZWDfg3VrmRGx7Re-JjecRjwmn7Rh-dsuLA3OljbCByg,6616
 reconcile/utils/rosa/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-reconcile/utils/rosa/rosa_cli.py,sha256=zuXBRh-cJK4yOPjtiSRbUQRURemFiLlWdjj3XteuQ-4,10475
+reconcile/utils/rosa/rosa_cli.py,sha256=b7V3EgO4b4hOnvZzrxdn-bxRbkINQysOg_ecuB8l5GA,11364
 reconcile/utils/rosa/session.py,sha256=nPEmSNos0_ATQEVg2KckAlVyIEBvxUVo7pa0WMACoOU,4150
 reconcile/utils/runtime/__init__.py,sha256=sfk92MGfsBh9tKYHl_FH17NdEsrGBwgDFTb7KNKoIfY,107
 reconcile/utils/runtime/desired_state_diff.py,sha256=finZnWoVDCiYTgu4lGk8G4QOFAGgiIDhD3fcnVqYoxM,8108
@@ -712,8 +712,8 @@ tools/test/test_app_interface_metrics_exporter.py,sha256=SX7qL3D1SIRKFo95FoQztvf
 tools/test/test_qontract_cli.py,sha256=OvalpVRfY4pNmpMaWHHYqBjV68b1eGQjX8SCyTAXb1w,3501
 tools/test/test_sd_app_sre_alert_report.py,sha256=v363r9zM7__0kR5K6mvJoGFcM9BvE33fWAayrqkpojA,2116
 tools/test/test_sre_checkpoints.py,sha256=SKqPPTl9ua0RFdSSofnoQX-JZE6dFLO3LRhfQzqtfh8,2607
-qontract_reconcile-0.10.1rc609.dist-info/METADATA,sha256=oL9FPRy78cqHHZ7uyBOLtfr24QUHtZ_mv0Vc-ElwUOg,2382
-qontract_reconcile-0.10.1rc609.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-qontract_reconcile-0.10.1rc609.dist-info/entry_points.txt,sha256=rIxI5zWtHNlfpDeq1a7pZXAPoqf7HG32KMTN3MeWK_8,429
-qontract_reconcile-0.10.1rc609.dist-info/top_level.txt,sha256=l5ISPoXzt0SdR4jVdkfa7RPSKNc8zAHYWAnR-Dw8Ey8,24
-qontract_reconcile-0.10.1rc609.dist-info/RECORD,,
+qontract_reconcile-0.10.1rc611.dist-info/METADATA,sha256=re9XFwEechJsNUfAK4s4FAFgp4lnj3LKjF7hvvHN6bw,2382
+qontract_reconcile-0.10.1rc611.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+qontract_reconcile-0.10.1rc611.dist-info/entry_points.txt,sha256=rIxI5zWtHNlfpDeq1a7pZXAPoqf7HG32KMTN3MeWK_8,429
+qontract_reconcile-0.10.1rc611.dist-info/top_level.txt,sha256=l5ISPoXzt0SdR4jVdkfa7RPSKNc8zAHYWAnR-Dw8Ey8,24
+qontract_reconcile-0.10.1rc611.dist-info/RECORD,,

reconcile/utils/jobcontroller/controller.py

@@ -258,8 +258,16 @@ class K8sJobController:
 
     def build_secret(self, job: K8sJob) -> Optional[V1Secret]:
         secret_data = job.secret_data()
-        if not secret_data:
+        script_data = job.scripts()
+        # fail if both dicts have overlapping keys
+        if not set(secret_data).isdisjoint(script_data):
+            raise JobValidationError(
+                f"Secret data and script data have overlapping keys for {job.name()}"
+            )
+        data = {**secret_data, **script_data}
+        if not data:
             return None
+
         job_name = job.name()
         job_uid = self._lookup_job_uid(job_name)
         if not job_uid:
@@ -280,7 +288,7 @@ class K8sJobController:
                     )
                 ],
             ),
-            string_data=secret_data,
+            string_data=data,
         )
 
     def create_job(self, job: K8sJob) -> None:

reconcile/utils/jobcontroller/models.py

@@ -10,8 +10,12 @@ from kubernetes.client import (
     V1EnvVarSource,
     V1Job,
     V1JobSpec,
+    V1KeyToPath,
     V1ObjectMeta,
     V1SecretKeySelector,
+    V1SecretVolumeSource,
+    V1Volume,
+    V1VolumeMount,
 )
 
 
@@ -133,7 +137,18 @@ class K8sJob(ABC):
         """
         return {}
 
+    def scripts(self) -> dict[str, str]:
+        """
+        If a job relies on some scripts, it should return them here. The
+        job controller will manage the lifecycle of a kubernetes Secret containing them.
+        """
+        return {}
+
     def secret_data_to_env_vars_secret_refs(self) -> list[V1EnvVar]:
+        """
+        Helper function to generate env var references from the `secret_data`,
+        to be used in container specs
+        """
         secret_name = self.name()
         return [
             V1EnvVar(
@@ -147,3 +162,34 @@ class K8sJob(ABC):
             )
             for secret_key_name in self.secret_data().keys()
         ]
+
+    def scripts_volume_mount(self, directory: str) -> V1VolumeMount:
+        """
+        Helper function to generate a volume mount for the `scripts` to be used
+        in container specs
+        """
+        secret_name = self.name()
+        return V1VolumeMount(
+            name=secret_name,
+            mount_path=directory,
+        )
+
+    def scripts_volume(self) -> V1Volume:
+        """
+        Helper function to generate a volume for the `scripts` to be used in
+        pod specs
+        """
+        secret_name = self.name()
+        return V1Volume(
+            name=secret_name,
+            secret=V1SecretVolumeSource(
+                secret_name=secret_name,
+                items=[
+                    V1KeyToPath(
+                        key=script_name,
+                        path=script_name,
+                    )
+                    for script_name in self.scripts().keys()
+                ],
+            ),
+        )

reconcile/utils/rosa/rosa_cli.py

@@ -1,6 +1,8 @@
+import collections
 import itertools
 import os
 import textwrap
+from collections.abc import Iterable
 from typing import Any, Callable, Optional
 
 from kubernetes.client import (
@@ -22,6 +24,9 @@ from pydantic import BaseModel
 
 from reconcile.utils.jobcontroller.models import JobStatus, K8sJob
 
+SCRIPTS_MOUNT_PATH = "/scripts"
+EXEC_SCRIPT = "execute.sh"
+
 
 class LogHandle:
     """
@@ -32,10 +37,14 @@ class LogHandle:
     def __init__(self, log_file: str) -> None:
         self.log_file = log_file
 
-    def get_log_lines(self, max_lines: int = 5) -> list[str]:
+    def get_log_lines(
+        self, max_lines: int = 5, from_file_end: bool = False
+    ) -> Iterable[str]:
         if max_lines <= 0:
             return []
         with open(self.log_file, "r", encoding="utf-8") as f:
+            if from_file_end:
+                return collections.deque(f, maxlen=max_lines)
             return [line.rstrip() for line in itertools.islice(f, max_lines)]
 
     def write_logs_to_logger(self, logger: Callable[..., None]) -> None:
@@ -64,15 +73,23 @@ class RosaCliResult:
         self.command = command
         self.log_handle = log_handle
 
-    def get_log_lines(self, max_lines: int = 5) -> list[str]:
+    def get_log_lines(
+        self, max_lines: int = 5, from_file_end: bool = False
+    ) -> Iterable[str]:
         if self.log_handle:
-            return self.log_handle.get_log_lines(max_lines)
+            return self.log_handle.get_log_lines(
+                max_lines=max_lines, from_file_end=from_file_end
+            )
         return []
 
     def write_logs_to_logger(self, logger: Callable[..., None]) -> None:
         if self.log_handle:
             self.log_handle.write_logs_to_logger(logger)
 
+    def cleanup(self) -> None:
+        if self.log_handle:
+            self.log_handle.cleanup()
+
 
 class RosaCliException(Exception, RosaCliResult):
     """
@@ -135,6 +152,9 @@ class RosaJob(K8sJob, BaseModel, frozen=True, arbitrary_types_allowed=True):
     def secret_data(self) -> dict[str, str]:
         return {"OCM_TOKEN": self.ocm_token}
 
+    def scripts(self) -> dict[str, str]:
+        return {EXEC_SCRIPT: self.cmd}
+
     def assume_role_arn(self) -> str:
         return f"arn:aws:iam::{self.aws_account_id}:role/{self.aws_iam_role}"
 
@@ -223,8 +243,8 @@ class RosaJob(K8sJob, BaseModel, frozen=True, arbitrary_types_allowed=True):
                         V1Container(
                             name="rosa-cli",
                             image=self.image,
-                            command=["/bin/bash", "-c"],
-                            args=[self.cmd],
+                            command=["/bin/bash"],
+                            args=[f"{SCRIPTS_MOUNT_PATH}/{EXEC_SCRIPT}"],
                             env=[
                                 V1EnvVar(
                                     name="AWS_SHARED_CREDENTIALS_FILE",
@@ -241,11 +261,16 @@ class RosaJob(K8sJob, BaseModel, frozen=True, arbitrary_types_allowed=True):
                                     name="workdir",
                                     mount_path="/.config",
                                 ),
+                                V1VolumeMount(
+                                    name="workdir",
+                                    mount_path="/.aws",
+                                ),
                                 V1VolumeMount(
                                     name="bound-sa-token",
                                     mount_path="/var/run/secrets/openshift/serviceaccount",
                                     read_only=True,
                                 ),
+                                self.scripts_volume_mount(SCRIPTS_MOUNT_PATH),
                             ],
                         )
                     ],
@@ -278,6 +303,7 @@ class RosaJob(K8sJob, BaseModel, frozen=True, arbitrary_types_allowed=True):
                                 size_limit="10Mi",
                             ),
                         ),
+                        self.scripts_volume(),
                     ],
                 ),
             ),