feat: add new service cache and migrations (#759)

* feat: initial implementation for postgres cache

* squashme: Apply suggestions from code review

* address comments

* add new service and migrations

* fix mypy

* feat: use new cache in code

* move server_options to app_config to fix wrong import direction

(components -> bases should be the other way around)

* fix tests

* make api client work with notebooks fixtures

* add watcher in test fixtures and fix k3d tests

* address comments and fix deployment

* make k8s_objects.name unique

---------

Co-authored-by: Tasko Olevski <olevski90@gmail.com>

Author: Panaetius

bases/renku_data_services/k8s_cache/__init__.py

@@ -0,0 +1 @@
+"""Kubernetes Cache."""

bases/renku_data_services/k8s_cache/config.py

@@ -0,0 +1,46 @@
+"""K8s cache config."""
+
+from dataclasses import dataclass
+from typing import Self
+
+from kubernetes.client.api_client import os
+
+from renku_data_services.db_config.config import DBConfig
+from renku_data_services.k8s_watcher.db import K8sDbCache
+
+
+@dataclass
+class _K8sConfig:
+    """Defines the k8s client and namespace."""
+
+    renku_namespace: str = "default"
+
+    @classmethod
+    def from_env(cls) -> Self:
+        return cls(renku_namespace=os.environ.get("KUBERNETES_NAMESPACE", "default"))
+
+
+@dataclass
+class Config:
+    """K8s cache config."""
+
+    db: DBConfig
+    k8s: _K8sConfig
+    _k8s_cache: K8sDbCache | None = None
+
+    @property
+    def k8s_cache(self) -> K8sDbCache:
+        """The DB adapter for the k8s cache."""
+        if not self._k8s_cache:
+            self._k8s_cache = K8sDbCache(
+                session_maker=self.db.async_session_maker,
+            )
+        return self._k8s_cache
+
+    @classmethod
+    def from_env(cls, prefix: str = "") -> "Config":
+        """Create a config from environment variables."""
+        db = DBConfig.from_env(prefix)
+        k8s_config = _K8sConfig.from_env()
+
+        return cls(db=db, k8s=k8s_config)

bases/renku_data_services/k8s_cache/main.py

@@ -0,0 +1,37 @@
+"""The entrypoint for the k8s cache service."""
+
+import asyncio
+import logging
+
+import kr8s
+
+from renku_data_services.k8s_cache.config import Config
+from renku_data_services.k8s_watcher.db import Cluster, K8sWatcher, k8s_object_handler
+from renku_data_services.k8s_watcher.models import ClusterId
+from renku_data_services.notebooks.constants import AMALTHEA_SESSION_KIND, JUPYTER_SESSION_KIND
+
+
+async def main() -> None:
+    """K8s cache entrypoint."""
+
+    logging.basicConfig(format="%(asctime)s %(levelname)s %(message)s", level=logging.INFO)
+    config = Config.from_env()
+
+    kr8s_api = await kr8s.asyncio.api()
+    clusters = [Cluster(id=ClusterId("renkulab"), namespace=config.k8s.renku_namespace, api=kr8s_api)]
+
+    watcher = K8sWatcher(
+        handler=k8s_object_handler(config.k8s_cache),
+        clusters={c.id: c for c in clusters},
+        kinds=[AMALTHEA_SESSION_KIND, JUPYTER_SESSION_KIND],
+    )
+    await watcher.start()
+    logging.info("started watching resources")
+    # create file for liveness probe
+    with open("/tmp/cache_ready", "w") as f:
+        f.write("ready")
+    await watcher.wait()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

development/.keep …s/renku_data_services/k8s_cache/py.typeddevelopment/.keep renamed to bases/renku_data_services/k8s_cache/py.typed development/.keep renamed to bases/renku_data_services/k8s_cache/py.typed

@@ -23,3 +23,7 @@ charts:
         contextPath: .
         dockerfilePath: projects/secrets_storage/Dockerfile
         valuesPath: secretsStorage.image
+      data-service-k8s-watcher:
+        contextPath: .
+        dockerfilePath: projects/k8s_watcher/Dockerfile
+        valuesPath: dataService.k8sWatcher.image

chartpress.yaml

@@ -36,6 +36,11 @@
 import renku_data_services.storage
 import renku_data_services.users
 from renku_data_services import errors
+from renku_data_services.app_config.server_options import (
+    ServerOptions,
+    ServerOptionsDefaults,
+    generate_default_resource_pool,
+)
 from renku_data_services.authn.dummy import DummyAuthenticator, DummyUserStore
 from renku_data_services.authn.gitlab import GitlabAuthenticator
 from renku_data_services.authn.keycloak import KcUserStore, KeycloakAuthenticator
@@ -44,11 +49,6 @@
 from renku_data_services.connected_services.db import ConnectedServicesRepository
 from renku_data_services.crc import models
 from renku_data_services.crc.db import ResourcePoolRepository, UserRepository
-from renku_data_services.data_api.server_options import (
-    ServerOptions,
-    ServerOptionsDefaults,
-    generate_default_resource_pool,
-)
 from renku_data_services.data_connectors.db import (
     DataConnectorRepository,
     DataConnectorSecretRepository,

components/renku_data_services/app_config/config.py

@@ -0,0 +1 @@
+"""K8s watcher and k8s clients."""