added docs

Signed-off-by: Neil South <[email protected]>

Author: neildsouth

docs/api/rest/task-manager/argo-template.md

@@ -0,0 +1,193 @@
+<!--
+  ~ Copyright 2022 MONAI Consortium
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~ http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+-->
+
+# Task Manager - Argo Template API
+
+The template endpoint provides the following APIs to post a new template to Argo plugin of 
+the Task Manager.
+
+
+## POST /argo/template
+
+Posts a new template to Argo and returns the resultant template.
+
+### Parameters
+
+body, json string of the wrapped template 
+
+### Responses
+
+Response Content Type: JSON
+
+- the actual Argo resultant template.
+
+| Code | Description                     |
+| ---- | ------------------------------- |
+| 200  | template posted sucsessfully.   |
+| 400  | bad json or template post error |
+| 500  | Internal service error.         |
+
+### Example Request
+
+file saved locally as workflowtemplate.json
+```json
+{
+	"Namespace": "argo",
+	"serverDryRun": false,
+	"submitOptions": {
+		"parameters": [
+			"name=value"
+		]
+	},
+	"template": {
+		"metadata": {
+			"name": "fantastic-tiger",
+			"namespace": "argo",
+			"labels": {
+				"example": "true"
+			}
+		},
+		"spec": {
+			"workflowMetadata": {
+				"labels": {
+					"example": "true"
+				}
+			},
+			"entrypoint": "argosay",
+			"arguments": {
+				"parameters": [
+					{
+						"name": "message",
+						"value": "hello argo"
+					}
+				]
+			},
+			"templates": [
+				{
+					"name": "argosay",
+					"inputs": {
+						"parameters": [
+							{
+								"name": "message",
+								"value": "{{workflow.parameters.message}}"
+							}
+						]
+					},
+					"container": {
+						"name": "main",
+						"image": "argoproj/argosay:v2",
+						"command": [
+							"/argosay"
+						],
+						"args": [
+							"echo",
+							"{{inputs.parameters.message}}"
+						]
+					}
+				}
+			],
+			"ttlStrategy": {
+				"secondsAfterCompletion": 300
+			},
+			"podGC": {
+				"strategy": "OnPodCompletion"
+			}
+		}
+	}
+}
+```
+
+```bash
+curl -d @workflowtemplate.json 'http://localhost:5000/argo/template'
+```
+
+### Example Response
+
+```json
+{
+	"metadata": {
+		"creationTimestamp": "2023-03-23T17:28:34+00:00",
+		"generation": 1,
+		"labels": {
+			"example": "true",
+			"workflows.argoproj.io/creator": "system-serviceaccount-argo-argo-argo-workflows-server"
+		},
+		"managedFields": [
+			{
+				"apiVersion": "argoproj.io/v1alpha1",
+				"fieldsType": "FieldsV1",
+				"fieldsV1": {},
+				"manager": "argo",
+				"operation": "Update",
+				"time": "2023-03-23T17:28:34+00:00"
+			}
+		],
+		"name": "fantastic-tiger",
+		"namespace": "argo",
+		"resourceVersion": "12030505",
+		"uid": "e7609791-2d30-4dae-a47e-f1796846068d"
+	},
+	"spec": {
+		"arguments": {
+			"parameters": [
+				{
+					"name": "message",
+					"value": "hello argo"
+				}
+			]
+		},
+		"entrypoint": "argosay",
+		"podGC": {
+			"strategy": "OnPodCompletion"
+		},
+		"templates": [
+			{
+				"container": {
+					"args": [
+						"echo",
+						"{{inputs.parameters.message}}"
+					],
+					"command": [
+						"/argosay"
+					],
+					"image": "argoproj/argosay:v2",
+					"name": "main",
+					"resources": {}
+				},
+				"inputs": {
+					"parameters": [
+						{
+							"name": "message",
+							"value": "{{workflow.parameters.message}}"
+						}
+					]
+				},
+				"metadata": {},
+				"name": "argosay",
+				"outputs": {}
+			}
+		],
+		"ttlStrategy": {
+			"secondsAfterCompletion": 300
+		},
+		"workflowMetadata": {
+			"labels": {
+				"example": "true"
+			}
+		}
+	}
+}
+```

docs/changelog.md

@@ -24,3 +24,5 @@ Enhanced the ArgoClient -> Argo_Get_WorkflowLogsAsync method to decode the json
 Added Mongo Migraions, to allow changes without breaking current stored entries
 
 Added resource constraints to the generated ARGO templates, so these can operate within a Kubernetes cluster with a Resource Quota in the ARGO namespace.
+
+Added ability for plugins (currently Argo) to have controllers, any dll marked with the new Monai.Deploy.WorkflowManager.Shared.PlugInAttribute will have any controllers added to TaskManager

src/TaskManager/Plug-ins/Argo/Controllers/TemplateController.cs

@@ -13,20 +13,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-using System.Runtime.InteropServices;
 using System.Text;
-using Amazon.Runtime.Internal.Util;
 using Argo;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
-using Microsoft.AspNetCore.Mvc.Formatters;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 using Monai.Deploy.WorkflowManager.Configuration;
-using MongoDB.Bson.IO;
-
-
 
 namespace Monai.Deploy.WorkflowManager.TaskManager.Argo.Controllers
 {
@@ -50,12 +44,6 @@ public TemplateController(
 
         }
 
-        [HttpGet]
-        public ActionResult<IEnumerable<int>> Values()
-        {
-            return StatusCode(200, new List<int> { 12, 155, 12, 9 });
-        }
-
         [HttpPost]
         public async Task<ActionResult<WorkflowTemplate>> CreateArgoTemplate()
         {