Merge pull request #548 from GrahamDumpleton/lookup-service-failures

Better handling of resource processing order issues in lookup service.
educates · Aug 14, 2024 · e087051 · e087051
2 parents c4dd8d2 + 94ee55b
commit e087051
Show file tree

Hide file tree

Showing 10 changed files with 413 additions and 98 deletions.
diff --git a/lookup-service/service/caches/environments.py b/lookup-service/service/caches/environments.py
@@ -21,6 +21,7 @@ class WorkshopEnvironment:
 
     portal: "TrainingPortal"
     name: str
+    uid: str
     generation: int
     workshop: str
     title: str
@@ -37,6 +38,7 @@ def __init__(
         self,
         portal: "TrainingPortal",
         name: str,
+        uid: str,
         generation: int,
         workshop: str,
         title: str,
@@ -50,6 +52,7 @@ def __init__(
     ) -> None:
         self.portal = portal
         self.name = name
+        self.uid = uid
         self.generation = generation
         self.workshop = workshop
         self.title = title

diff --git a/lookup-service/service/handlers/clusters.py b/lookup-service/service/handlers/clusters.py
diff --git a/lookup-service/service/routes/clusters.py b/lookup-service/service/routes/clusters.py
@@ -102,6 +102,42 @@ async def api_get_v1_clusters_portals(request: web.Request) -> web.Response:
     return web.json_response(data)
 
 
+@login_required
+@roles_accepted("admin")
+async def api_get_v1_clusters_portals_details(request: web.Request) -> web.Response:
+    """Returns details for the specified portal running on a cluster."""
+
+    cluster_name = request.match_info["cluster"]
+    portal_name = request.match_info["portal"]
+
+    service_state = request.app["service_state"]
+    cluster_database = service_state.cluster_database
+
+    cluster = cluster_database.get_cluster(cluster_name)
+
+    if not cluster:
+        return web.Response(text="Cluster not available", status=403)
+
+    portal = cluster.get_portal(portal_name)
+
+    if not portal:
+        return web.Response(text="Portal not available", status=403)
+
+    details = {
+        "name": portal.name,
+        "uid": portal.uid,
+        "generation": portal.generation,
+        "labels": portal.labels,
+        "cluster": portal.cluster.name,
+        "url": portal.url,
+        "capacity": portal.capacity,
+        "allocated": portal.allocated,
+        "phase": portal.phase,
+    }
+
+    return web.json_response(details)
+
+
 @login_required
 @roles_accepted("admin")
 async def api_get_v1_clusters_portals_environments(
@@ -131,6 +167,7 @@ async def api_get_v1_clusters_portals_environments(
         "environments": [
             {
                 "name": environment.name,
+                "uid": environment.uid,
                 "generation": environment.generation,
                 "workshop": environment.workshop,
                 "title": environment.title,
@@ -182,6 +219,7 @@ async def api_get_v1_clusters_portals_environments_details(
 
     details = {
         "name": environment.name,
+        "uid": environment.uid,
         "generation": environment.generation,
         "workshop": environment.workshop,
         "title": environment.title,
@@ -350,6 +388,10 @@ async def api_get_v1_clusters_portals_environments_users_sessions(
     web.get("/api/v1/clusters/{cluster}", api_get_v1_clusters_details),
     web.get("/api/v1/clusters/{cluster}/kubeconfig", api_get_v1_clusters_kubeconfig),
     web.get("/api/v1/clusters/{cluster}/portals", api_get_v1_clusters_portals),
+    web.get(
+        "/api/v1/clusters/{cluster}/portals/{portal}",
+        api_get_v1_clusters_portals_details,
+    ),
     web.get(
         "/api/v1/clusters/{cluster}/portals/{portal}/environments",
         api_get_v1_clusters_portals_environments,

diff --git a/session-manager/handlers/trainingportal.py b/session-manager/handlers/trainingportal.py
@@ -86,6 +86,8 @@ def training_portal_create(name, uid, body, spec, status, patch, runtime, retry,
     # Calculate name for the portal namespace.
 
     portal_name = name
+    portal_uid = uid
+
     portal_namespace = f"{portal_name}-ui"
 
     # Calculate access details for the portal. The hostname used to access the
@@ -388,6 +390,7 @@ def training_portal_create(name, uid, body, spec, status, patch, runtime, retry,
             "labels": {
                 f"training.{OPERATOR_API_GROUP}/component": "portal",
                 f"training.{OPERATOR_API_GROUP}/portal.name": portal_name,
+                f"training.{OPERATOR_API_GROUP}/portal.uid": portal_uid,
                 f"training.{OPERATOR_API_GROUP}/policy.engine": CLUSTER_SECURITY_POLICY_ENGINE,
                 f"training.{OPERATOR_API_GROUP}/policy.name": "baseline",
             },
@@ -444,6 +447,7 @@ def training_portal_create(name, uid, body, spec, status, patch, runtime, retry,
                 "labels": {
                     f"training.{OPERATOR_API_GROUP}/component": "portal",
                     f"training.{OPERATOR_API_GROUP}/portal.name": portal_name,
+                    f"training.{OPERATOR_API_GROUP}/portal.uid": portal_uid,
                 },
             },
             "roleRef": {
@@ -472,6 +476,7 @@ def training_portal_create(name, uid, body, spec, status, patch, runtime, retry,
                 "labels": {
                     f"training.{OPERATOR_API_GROUP}/component": "portal",
                     f"training.{OPERATOR_API_GROUP}/portal.name": portal_name,
+                    f"training.{OPERATOR_API_GROUP}/portal.uid": portal_uid,
                 },
             },
             "roleRef": {
@@ -530,6 +535,7 @@ def training_portal_create(name, uid, body, spec, status, patch, runtime, retry,
             "labels": {
                 f"training.{OPERATOR_API_GROUP}/component": "portal",
                 f"training.{OPERATOR_API_GROUP}/portal.name": portal_name,
+                f"training.{OPERATOR_API_GROUP}/portal.uid": portal_uid,
             },
         },
     }
@@ -544,6 +550,7 @@ def training_portal_create(name, uid, body, spec, status, patch, runtime, retry,
             "labels": {
                 f"training.{OPERATOR_API_GROUP}/component": "portal",
                 f"training.{OPERATOR_API_GROUP}/portal.name": portal_name,
+                f"training.{OPERATOR_API_GROUP}/portal.uid": portal_uid,
             },
         },
         "type": "kubernetes.io/service-account-token",
@@ -557,6 +564,7 @@ def training_portal_create(name, uid, body, spec, status, patch, runtime, retry,
             "labels": {
                 f"training.{OPERATOR_API_GROUP}/component": "portal",
                 f"training.{OPERATOR_API_GROUP}/portal.name": portal_name,
+                f"training.{OPERATOR_API_GROUP}/portal.uid": portal_uid,
             },
         },
         "roleRef": {
@@ -584,6 +592,7 @@ def training_portal_create(name, uid, body, spec, status, patch, runtime, retry,
             "labels": {
                 f"training.{OPERATOR_API_GROUP}/component": "portal",
                 f"training.{OPERATOR_API_GROUP}/portal.name": portal_name,
+                f"training.{OPERATOR_API_GROUP}/portal.uid": portal_uid,
             },
         },
         "spec": {
@@ -604,6 +613,7 @@ def training_portal_create(name, uid, body, spec, status, patch, runtime, retry,
             "labels": {
                 f"training.{OPERATOR_API_GROUP}/component": "portal",
                 f"training.{OPERATOR_API_GROUP}/portal.name": portal_name,
+                f"training.{OPERATOR_API_GROUP}/portal.uid": portal_uid,
             },
         },
         "data": {
@@ -620,6 +630,7 @@ def training_portal_create(name, uid, body, spec, status, patch, runtime, retry,
             "labels": {
                 f"training.{OPERATOR_API_GROUP}/component": "portal",
                 f"training.{OPERATOR_API_GROUP}/portal.name": portal_name,
+                f"training.{OPERATOR_API_GROUP}/portal.uid": portal_uid,
                 f"training.{OPERATOR_API_GROUP}/portal.services.dashboard": "true",
             },
         },
@@ -633,6 +644,7 @@ def training_portal_create(name, uid, body, spec, status, patch, runtime, retry,
                         "deployment": "training-portal",
                         f"training.{OPERATOR_API_GROUP}/component": "portal",
                         f"training.{OPERATOR_API_GROUP}/portal.name": portal_name,
+                        f"training.{OPERATOR_API_GROUP}/portal.uid": portal_uid,
                         f"training.{OPERATOR_API_GROUP}/portal.services.dashboard": "true",
                     },
                 },
@@ -850,6 +862,7 @@ def training_portal_create(name, uid, body, spec, status, patch, runtime, retry,
             "labels": {
                 f"training.{OPERATOR_API_GROUP}/component": "portal",
                 f"training.{OPERATOR_API_GROUP}/portal.name": portal_name,
+                f"training.{OPERATOR_API_GROUP}/portal.uid": portal_uid,
             },
         },
         "spec": {
@@ -868,6 +881,7 @@ def training_portal_create(name, uid, body, spec, status, patch, runtime, retry,
             "labels": {
                 f"training.{OPERATOR_API_GROUP}/component": "portal",
                 f"training.{OPERATOR_API_GROUP}/portal.name": portal_name,
+                f"training.{OPERATOR_API_GROUP}/portal.uid": portal_uid,
             },
             "annotations": {},
         },
@@ -936,6 +950,7 @@ def training_portal_create(name, uid, body, spec, status, patch, runtime, retry,
                         "labels": {
                             f"training.{OPERATOR_API_GROUP}/component": "portal",
                             f"training.{OPERATOR_API_GROUP}/portal.name": portal_name,
+                            f"training.{OPERATOR_API_GROUP}/portal.uid": portal_uid,
                         },
                     },
                     "spec": {
@@ -969,6 +984,7 @@ def training_portal_create(name, uid, body, spec, status, patch, runtime, retry,
                     "labels": {
                         f"training.{OPERATOR_API_GROUP}/component": "portal",
                         f"training.{OPERATOR_API_GROUP}/portal.name": portal_name,
+                        f"training.{OPERATOR_API_GROUP}/portal.uid": portal_uid,
                     },
                 },
                 "spec": {
@@ -997,6 +1013,7 @@ def training_portal_create(name, uid, body, spec, status, patch, runtime, retry,
             "labels": {
                 f"training.{OPERATOR_API_GROUP}/component": "portal",
                 f"training.{OPERATOR_API_GROUP}/portal.name": portal_name,
+                f"training.{OPERATOR_API_GROUP}/portal.uid": portal_uid,
             },
         },
         "spec": {

diff --git a/session-manager/handlers/workshopallocation.py b/session-manager/handlers/workshopallocation.py
@@ -147,8 +147,16 @@ def workshop_allocation_create(
     portal_name = meta.get("labels", {}).get(
         f"training.{OPERATOR_API_GROUP}/portal.name", ""
     )
+    portal_uid = meta.get("labels", {}).get(
+        f"training.{OPERATOR_API_GROUP}/portal.uid", ""
+    )
 
     environment_name = spec["environment"]["name"]
+
+    environment_uid = meta.get("labels", {}).get(
+        f"training.{OPERATOR_API_GROUP}/environment.uid", ""
+    )
+
     workshop_namespace = environment_name
 
     session_name = spec["session"]["name"]
@@ -448,7 +456,9 @@ def workshop_allocation_create(
                 f"training.{OPERATOR_API_GROUP}/component.group": "objects",
                 f"training.{OPERATOR_API_GROUP}/workshop.name": workshop_name,
                 f"training.{OPERATOR_API_GROUP}/portal.name": portal_name,
+                f"training.{OPERATOR_API_GROUP}/portal.uid": portal_uid,
                 f"training.{OPERATOR_API_GROUP}/environment.name": environment_name,
+                f"training.{OPERATOR_API_GROUP}/environment.uid": environment_uid,
                 f"training.{OPERATOR_API_GROUP}/session.name": session_name,
                 f"training.{OPERATOR_API_GROUP}/session.objects": "true",
             }