feat: /createPodGroup, the pods of one pod group in a single call

cmd/interlink/main.go

@@ -190,6 +190,7 @@ func main() {
 	mutex := http.NewServeMux()
 	mutex.HandleFunc("/status", interLinkAPIs.StatusHandler)
 	mutex.HandleFunc("/create", interLinkAPIs.CreateHandler)
+	mutex.HandleFunc("/createPodGroup", interLinkAPIs.CreatePodGroupHandler)
 	mutex.HandleFunc("/delete", interLinkAPIs.DeleteHandler)
 	mutex.HandleFunc("/pinglink", interLinkAPIs.Ping)
 	mutex.HandleFunc("/getLogs", interLinkAPIs.GetLogsHandler)

cmd/openapi-gen/main.go

@@ -38,6 +38,20 @@ func main() {
 		panic(err)
 	}
 
+	// CREATE POD GROUP
+	createPodGroupOp, err := reflector.NewOperationContext(http.MethodPost, "/createPodGroup")
+	if err != nil {
+		panic(err)
+	}
+
+	createPodGroupOp.AddReqStructure(new(interlink.PodGroupCreateRequests))
+	createPodGroupOp.AddRespStructure(new([]interlink.CreateStruct), func(cu *openapi.ContentUnit) { cu.HTTPStatus = http.StatusOK })
+
+	err = reflector.AddOperation(createPodGroupOp)
+	if err != nil {
+		panic(err)
+	}
+
 	// DELETE
 	deleteOp, err := reflector.NewOperationContext(http.MethodPost, "/delete")
 	if err != nil {

docs/docs/guides/02-develop-a-plugin.md

@@ -151,6 +151,26 @@ Retrieves logs from a specific container.
 **Query Parameters**: Pod UID, container name, log options **Response**:
 Container logs (plain text)
 
+### POST /createPodGroup (optional)
+
+Creates the pods of one pod group as a single job. A plugin that implements it
+lists `pod-group-create` in the `capabilities` of its ping answer, and it is
+used only then; status, logs and delete stay per pod.
+
+**Request Body**: `RetrievedPodGroupData` **Response**: `List[CreateStruct]`,
+one per pod in the order of the request, all with the job ID of the group
+
+```json
+{
+  "groupUID": "workload-uid",
+  "pods": [...]  // each pod as sent to /create, in rank order
+}
+```
+
+The order of the pods gives their ranks; rank 0 is the head. Answer 400 with a
+text body for a bad request or a permanent refusal, and 503 when the group
+cannot be taken now.
+
 ## Developing with the Python SDK
 
 ### Basic Plugin Structure

docs/openapi/plugin-openapi.json

@@ -44,6 +44,48 @@
         }
       }
     },
+    "/createPodGroup": {
+      "post": {
+        "summary": "Create Pod Group",
+        "operationId": "create_pod_group_createPodGroup_post",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/RetrievedPodGroupData"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "items": {
+                    "$ref": "#/components/schemas/CreateStruct"
+                  },
+                  "type": "array",
+                  "title": "Response Create Pod Group Createpodgroup Post"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/delete": {
       "post": {
         "summary": "Delete Pod",
@@ -984,6 +1026,27 @@
         ],
         "title": "PodVolume"
       },
+      "RetrievedPodGroupData": {
+        "properties": {
+          "groupUID": {
+            "type": "string",
+            "title": "Group Uid"
+          },
+          "pods": {
+            "items": {
+              "$ref": "#/components/schemas/Pod"
+            },
+            "type": "array",
+            "title": "Pods"
+          }
+        },
+        "type": "object",
+        "required": [
+          "groupUID",
+          "pods"
+        ],
+        "title": "RetrievedPodGroupData"
+      },
       "Secret": {
         "properties": {
           "metadata": {

pkg/interlink/api/create.go

@@ -148,27 +148,14 @@
 		log.G(h.Ctx).Infof("Updated JobScript successfully (len=%d)", len(data.JobScript))
 
 	case h.Config.JobScriptTemplate != "":
-
-		tmp, err := template.ParseFiles(h.Config.JobScriptTemplate)
-		if err != nil {
-			statusCode = http.StatusInternalServerError
-			log.G(h.Ctx).Error(err)
-			w.WriteHeader(statusCode)
-			types.SetSpanError(span, statusCode, err)
-			return
-		}
-
-		var tpl bytes.Buffer
-		err = tmp.Execute(&tpl, data)
+		data.JobScript, err = renderJobScript(h.Config.JobScriptTemplate, data)
 		if err != nil {
 			statusCode = http.StatusInternalServerError
 			log.G(h.Ctx).Error(err)
 			w.WriteHeader(statusCode)
 			types.SetSpanError(span, statusCode, err)
 			return
 		}
-
-		data.JobScript = tpl.String()
 	}
 
 	// updated to handle single data
@@ -199,17 +186,31 @@
 		return
 	}
 
 	log.G(h.Ctx).Info("InterLink: forwarding Create call to sidecar")
 
 	ForwardAccessToken(r, req)
 	_, err = ReqWithError(ctx, req, w, start, span, true, false, sessionContext, h.ClientHTTP)
 	if err != nil {
 		// ReqWithError has already marked the span as failed.
 		log.L.Error(err)
 		return
 	}
 
 	// The return code was already recorded by ReqWithError, so only the outcome
 	// is set here.
 	types.SetSpanOK(span, 0)
 }
+
+// renderJobScript fills the job script template at path with the data of one pod.
+func renderJobScript(path string, data types.RetrievedPodData) (string, error) {
+	tmp, err := template.ParseFiles(path)
+	if err != nil {
+		return "", err
+	}
+
+	var tpl bytes.Buffer
+	if err := tmp.Execute(&tpl, data); err != nil {
+		return "", err
+	}
+	return tpl.String(), nil
+}