flickr-immich-k8s-sync-operator 0.0.1__py3-none-any.whl → 0.0.3__py3-none-any.whl

flickr_immich_k8s_sync_operator/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.0.1"
+__version__ = "0.0.3"
 
 import os
 import sys

flickr_immich_k8s_sync_operator/__main__.py

@@ -1,6 +1,7 @@
 import signal
 import sys
 import threading
+from dataclasses import fields
 
 from loguru import logger as glogger
 
@@ -28,6 +29,8 @@ def main() -> None:
 
     try:
         cfg = OperatorConfig.from_env()
+        for f in fields(cfg):
+            glogger.info("  {}: {}", f.name, getattr(cfg, f.name))
     except ValueError as exc:
         glogger.error("Configuration error: {}", exc)
         sys.exit(1)

flickr_immich_k8s_sync_operator/config.py

@@ -17,6 +17,7 @@ class OperatorConfig:
     job_names: list[str]
     check_interval: int
     restart_delay: int
+    skip_delay_on_oom: bool
 
     @classmethod
     def from_env(cls) -> OperatorConfig:
@@ -32,6 +33,9 @@ class OperatorConfig:
             Seconds between check cycles (default ``60``).
         RESTART_DELAY : str, optional
             Seconds after failure before a Job is restarted (default ``3600``).
+        SKIP_DELAY_ON_OOM : str, optional
+            If ``"true"`` (case-insensitive), skip the restart delay when the
+            failure reason is ``OOMKilled`` (default ``"false"``).
 
         Raises
         ------
@@ -48,4 +52,5 @@ class OperatorConfig:
             job_names=job_names,
             check_interval=int(os.environ.get("CHECK_INTERVAL", "60")),
             restart_delay=int(os.environ.get("RESTART_DELAY", "3600")),
+            skip_delay_on_oom=os.environ.get("SKIP_DELAY_ON_OOM", "false").strip().lower() == "true",
         )

flickr_immich_k8s_sync_operator/operator.py

@@ -123,9 +123,16 @@ class JobRestartOperator:
         """Log pod details and restart the Job if the restart delay has elapsed."""
         elapsed = (datetime.now(timezone.utc) - failure_time).total_seconds()
 
-        self._log_pod_details(job_name)
+        reasons = self._get_pod_failure_reasons(job_name)
+        skip_delay = self._cfg.skip_delay_on_oom and "OOMKilled" in reasons
 
-        if elapsed >= self._cfg.restart_delay:
+        if skip_delay:
+            self._log.info(
+                "\t{} failed with OOMKilled — skipping restart delay, restarting immediately.",
+                job_name,
+            )
+            self._restart_job(job_name, shutdown_event)
+        elif elapsed >= self._cfg.restart_delay:
             self._log.info(
                 "\t{} failed {:.0f}s ago (>= {}s). Deleting and recreating...",
                 job_name,
@@ -142,8 +149,9 @@ class JobRestartOperator:
                 remaining,
             )
 
-    def _log_pod_details(self, job_name: str) -> None:
-        """List pods for *job_name* and log exit codes + tail logs."""
+    def _get_pod_failure_reasons(self, job_name: str) -> set[str]:
+        """List pods for *job_name*, log exit codes + tail logs, and return termination reasons."""
+        reasons: set[str] = set()
         try:
             pods = self._core_v1.list_namespaced_pod(
                 self._cfg.namespace,
@@ -157,7 +165,8 @@ class JobRestartOperator:
                     if cs.state and cs.state.terminated:
                         exit_code = cs.state.terminated.exit_code
                         reason = cs.state.terminated.reason
-                        break
+                        if reason:
+                            reasons.add(reason)
                 try:
                     tail = self._core_v1.read_namespaced_pod_log(
                         pod_name,
@@ -176,6 +185,7 @@ class JobRestartOperator:
                 )
         except Exception:
             self._log.warning("\tCould not retrieve pod details for {}", job_name)
+        return reasons
 
     def _restart_job(self, job_name: str, shutdown_event: threading.Event) -> None:
         """Delete and recreate a Job from the cached manifest."""

{flickr_immich_k8s_sync_operator-0.0.1.dist-info → flickr_immich_k8s_sync_operator-0.0.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flickr-immich-k8s-sync-operator
-Version: 0.0.1
+Version: 0.0.3
 Summary: Operator for syncing photos from Flickr to Immich on Kubernetes
 Project-URL: Homepage, https://github.com/vroomfondel/flickr-immich-k8s-sync-operator
 Project-URL: Repository, https://github.com/vroomfondel/flickr-immich-k8s-sync-operator
@@ -26,12 +26,21 @@ Description-Content-Type: text/markdown
 [![mypy and pytests](https://github.com/vroomfondel/flickr-immich-k8s-sync-operator/actions/workflows/mypynpytests.yml/badge.svg)](https://github.com/vroomfondel/flickr-immich-k8s-sync-operator/actions/workflows/mypynpytests.yml)
 ![Cumulative Clones](https://img.shields.io/endpoint?logo=github&url=https://gist.githubusercontent.com/vroomfondel/ba86ae83a5d1cfffce03ce36d30fa02d/raw/flickr-immich-k8s-sync-operator_somestuff_clone_count.json)
 [![Docker Pulls](https://img.shields.io/docker/pulls/xomoxcc/flickr-immich-k8s-sync-operator?logo=docker)](https://hub.docker.com/r/xomoxcc/flickr-immich-k8s-sync-operator/tags)
+[![PyPI Downloads](https://static.pepy.tech/personalized-badge/flickr-immich-k8s-sync-operator?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=PyPi+Downloads)](https://pepy.tech/projects/flickr-immich-k8s-sync-operator)
+
+[![Gemini_Generated_Image_gwjk7ggwjk7ggwjk_250x250.png](Gemini_Generated_Image_gwjk7ggwjk7ggwjk_250x250.png)](https://hub.docker.com/r/xomoxcc/flickr-immich-k8s-sync-operator)
 
 Kubernetes operator that watches per-user Flickr download Jobs in a namespace,
 restarts failed Jobs after a configurable delay, and retrieves pod logs and exit
 codes for failed Jobs before restarting them. Designed to run alongside
 [Immich](https://immich.app/) (self-hosted photo management).
 
+### Operator in Action
+
+![Operator log output](Bildschirmfoto_2026-02-02_18-43-40_blurred.png)
+
+*The operator monitoring Flickr download Jobs in [k9s](https://k9scli.io/), detecting failures, and scheduling restarts.*
+
 ## Status
 
 **Beta (v0.0.1)** — the core job-restart loop is implemented and functional.
@@ -45,10 +54,19 @@ The project scaffolding (packaging, Docker image, CI) is in place.
 - On failure (after a configurable delay), **deletes** the Job with `Foreground` propagation policy and **recreates** it from a cached manifest
 - Logs pod exit codes and tail logs before every restart
 
+### How it works
+
+1. An Ansible playbook ([`kubectlstuff_flickr_downloader.yml`](https://github.com/vroomfondel/somestuff/blob/main/flickrdownloaderstuff/kubectlstuff_flickr_downloader.yml)) creates per-user Flickr download Jobs in the `flickr-downloader` namespace
+2. Each Job runs [`flickr_download`](https://github.com/beaufour/flickr-download) with `BACKOFF_EXIT_ON_429=true`, so it exits immediately on HTTP 429 rate-limit errors instead of sleeping
+3. Jobs mount host directories for config, backup, and cache per user
+4. This operator watches all configured Jobs for failure conditions
+5. When a Job fails, the operator logs pod exit codes and tail logs, waits `RESTART_DELAY` seconds (default 1 hour), then deletes and recreates the Job from a cached manifest
+6. The operator uses namespace-scoped RBAC with minimal permissions (Jobs, Pods, Pod logs)
+
 ## Prerequisites
 
 - A running Kubernetes cluster
-- Flickr download Jobs already deployed — the operator manages their lifecycle (restart on failure), not initial creation
+- Per-user Flickr download Jobs already deployed (e.g. via the Ansible playbook above) — the operator manages their lifecycle (restart on failure), not initial creation
 - An [Immich](https://immich.app/) instance (for planned sync functionality)
 
 ## Configuration
@@ -60,6 +78,7 @@ The project scaffolding (packaging, Docker image, CI) is in place.
 | `JOB_NAMES` | Comma-separated Job names to monitor (**required**) | — |
 | `CHECK_INTERVAL` | Seconds between check cycles | `60` |
 | `RESTART_DELAY` | Seconds to wait after failure before restart | `3600` |
+| `SKIP_DELAY_ON_OOM` | Skip restart delay when failure reason is `OOMKilled` | `false` |
 
 ## Kubernetes Deployment
 
@@ -126,7 +145,7 @@ spec:
       serviceAccountName: flickr-operator
       containers:
         - name: operator
-          image: flickr-immich-k8s-sync-operator:latest
+          image: xomoxcc/flickr-immich-k8s-sync-operator:latest
           env:
             - name: JOB_NAMES
               value: "flickr-downloader-alice,flickr-downloader-bob"
@@ -138,6 +157,8 @@ spec:
             #   value: "60"                      # default
             # - name: RESTART_DELAY
             #   value: "3600"                    # default
+            # - name: SKIP_DELAY_ON_OOM
+            #   value: "false"                   # default
           resources:
             requests:
               cpu: 50m

flickr_immich_k8s_sync_operator-0.0.3.dist-info/RECORD

@@ -0,0 +1,10 @@
+flickr_immich_k8s_sync_operator/__init__.py,sha256=lYbVbcSDvUYvYT-2dtVaBNc_X19jG-whK1BGt-43rVM,1086
+flickr_immich_k8s_sync_operator/__main__.py,sha256=uh9plJ6myhg9b4YPTT0_EnPQ7v9G5BDdLS89K1er57U,1366
+flickr_immich_k8s_sync_operator/config.py,sha256=8-0grb5goapBOU9EOIAvQX2mF8HnQbp3my834TYNXQc,2071
+flickr_immich_k8s_sync_operator/operator.py,sha256=7JQEgGPEGTFgUq-dkum1IJjF0W8jUAIE-oFmSOiymwY,7962
+flickr_immich_k8s_sync_operator/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+flickr_immich_k8s_sync_operator-0.0.3.dist-info/METADATA,sha256=yIUugWRITGQej1FRYHmjwMViXPrJIBtTf8n_WkhZ5mk,8705
+flickr_immich_k8s_sync_operator-0.0.3.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+flickr_immich_k8s_sync_operator-0.0.3.dist-info/entry_points.txt,sha256=2ka6kPb3391I_-DmcFWZj7UyCsjJZ3OOQ2xxdRO8Rfs,98
+flickr_immich_k8s_sync_operator-0.0.3.dist-info/licenses/LICENSE.md,sha256=RG51X65V_wNLuyG-RGcLXxFsKyZnlH5wNvK_5mMlOag,7560
+flickr_immich_k8s_sync_operator-0.0.3.dist-info/RECORD,,

flickr_immich_k8s_sync_operator-0.0.1.dist-info/RECORD

@@ -1,10 +0,0 @@
-flickr_immich_k8s_sync_operator/__init__.py,sha256=5Agx1JJrCUbtY8GWdBcO_t9HZeDqsxLbGl4Kbs2P5cg,1086
-flickr_immich_k8s_sync_operator/__main__.py,sha256=IYEbP3_Te17oGpMp2NCcMiUceWceKGKWXqk6ZelgOBA,1238
-flickr_immich_k8s_sync_operator/config.py,sha256=K0h0Mdh3ikh0UPloEZ_zCrsIY51n04tCp69JP5DZjrw,1754
-flickr_immich_k8s_sync_operator/operator.py,sha256=mpi04TRa0slmf5FeCN9pX_hxvOTLkuYz7yBIL7At5K0,7470
-flickr_immich_k8s_sync_operator/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-flickr_immich_k8s_sync_operator-0.0.1.dist-info/METADATA,sha256=2O77NBy0y9ayAFdB9lJT-4PzKLMx3FC1Nsr7t1dDuw4,6948
-flickr_immich_k8s_sync_operator-0.0.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-flickr_immich_k8s_sync_operator-0.0.1.dist-info/entry_points.txt,sha256=2ka6kPb3391I_-DmcFWZj7UyCsjJZ3OOQ2xxdRO8Rfs,98
-flickr_immich_k8s_sync_operator-0.0.1.dist-info/licenses/LICENSE.md,sha256=RG51X65V_wNLuyG-RGcLXxFsKyZnlH5wNvK_5mMlOag,7560
-flickr_immich_k8s_sync_operator-0.0.1.dist-info/RECORD,,