feat: extend links feature for custom workflow views (#10677)

Signed-off-by: Jiacheng Xu <xjcmaxwellcjx@gmail.com>

api/jsonschema/schema.json

@@ -5225,7 +5225,7 @@
           "type": "string"
         },
         "scope": {
-          "description": "\"workflow\", \"pod\", \"pod-logs\", \"event-source-logs\", \"sensor-logs\" or \"chat\"",
+          "description": "\"workflow\", \"pod\", \"pod-logs\", \"event-source-logs\", \"sensor-logs\", \"workflow-list\" or \"chat\"",
           "type": "string"
         },
         "url": {

api/openapi-spec/swagger.json

@@ -9161,7 +9161,7 @@
           "type": "string"
         },
         "scope": {
-          "description": "\"workflow\", \"pod\", \"pod-logs\", \"event-source-logs\", \"sensor-logs\" or \"chat\"",
+          "description": "\"workflow\", \"pod\", \"pod-logs\", \"event-source-logs\", \"sensor-logs\", \"workflow-list\" or \"chat\"",
           "type": "string"
         },
         "url": {

docs/links.md

@@ -6,6 +6,7 @@ You can configure Argo Server to show custom links:
 
 * A "Get Help" button in the bottom right of the window linking to you organization help pages or chat room.
 * Deep-links to your facilities (e.g. logging facility) in the UI for both the workflow and each workflow pod.
+* Adds a button to the top of workflow view to navigate to customized views.
 
 Links can contain placeholder variables. Placeholder variables are indicated by the dollar sign and curly braces: `${variable}`.
 

docs/workflow-controller-configmap.yaml

@@ -73,6 +73,10 @@ data:
     - name: Get help
       scope: chat
       url: http://my-chat
+    # Adds a button to the top of workflow view to navigate to customized views.
+    - name: Completed Workflows
+      scope: workflow-list
+      url: http://workflows?label=workflows.argoproj.io/completed=true
 
   # uncomment following lines if you want to change navigation bar background color
   # navColor: red

manifests/quick-start-minimal.yaml

@@ -1420,6 +1420,9 @@ data:
     - name: Sensor Logs Link
       scope: sensor-logs
       url: http://logging-facility?namespace=${metadata.namespace}&podName=${metadata.name}&startedAt=${status.startedAt}&finishedAt=${status.finishedAt}
+    - name: Completed Workflows
+      scope: workflow-list
+      url: http://workflows?label=workflows.argoproj.io/completed=true
   metricsConfig: |
     enabled: true
     path: /metrics

manifests/quick-start-mysql.yaml

@@ -1420,6 +1420,9 @@ data:
     - name: Sensor Logs Link
       scope: sensor-logs
       url: http://logging-facility?namespace=${metadata.namespace}&podName=${metadata.name}&startedAt=${status.startedAt}&finishedAt=${status.finishedAt}
+    - name: Completed Workflows
+      scope: workflow-list
+      url: http://workflows?label=workflows.argoproj.io/completed=true
   metricsConfig: |
     enabled: true
     path: /metrics

manifests/quick-start-postgres.yaml

@@ -1420,6 +1420,9 @@ data:
     - name: Sensor Logs Link
       scope: sensor-logs
       url: http://logging-facility?namespace=${metadata.namespace}&podName=${metadata.name}&startedAt=${status.startedAt}&finishedAt=${status.finishedAt}
+    - name: Completed Workflows
+      scope: workflow-list
+      url: http://workflows?label=workflows.argoproj.io/completed=true
   metricsConfig: |
     enabled: true
     path: /metrics

manifests/quick-start/base/overlays/workflow-controller-configmap.yaml

@@ -40,6 +40,9 @@ data:
     - name: Sensor Logs Link
       scope: sensor-logs
       url: http://logging-facility?namespace=${metadata.namespace}&podName=${metadata.name}&startedAt=${status.startedAt}&finishedAt=${status.finishedAt}
+    - name: Completed Workflows
+      scope: workflow-list
+      url: http://workflows?label=workflows.argoproj.io/completed=true
 kind: ConfigMap
 metadata:
   name: workflow-controller-configmap

pkg/apis/workflow/v1alpha1/info.go

@@ -6,7 +6,7 @@ package v1alpha1
 type Link struct {
 	// The name of the link, E.g. "Workflow Logs" or "Pod Logs"
 	Name string `json:"name" protobuf:"bytes,1,opt,name=name"`
-	// "workflow", "pod", "pod-logs", "event-source-logs", "sensor-logs" or "chat"
+	// "workflow", "pod", "pod-logs", "event-source-logs", "sensor-logs", "workflow-list" or "chat"
 	Scope string `json:"scope" protobuf:"bytes,2,opt,name=scope"`
 	// The URL. Can contain "${metadata.namespace}", "${metadata.name}", "${status.startedAt}", "${status.finishedAt}" or any other element in workflow yaml, e.g. "${workflow.metadata.annotations.userDefinedKey}"
 	URL string `json:"url" protobuf:"bytes,3,opt,name=url"`

sdks/java/client/docs/IoArgoprojWorkflowV1alpha1Link.md

@@ -9,7 +9,7 @@ A link to another app.
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The name of the link, E.g. \"Workflow Logs\" or \"Pod Logs\" | 
-**scope** | **String** | \"workflow\", \"pod\", \"pod-logs\", \"event-source-logs\", \"sensor-logs\" or \"chat\" | 
+**scope** | **String** | \"workflow\", \"pod\", \"pod-logs\", \"event-source-logs\", \"sensor-logs\", \"workflow-list\" or \"chat\" | 
 **url** | **String** | The URL. Can contain \"${metadata.namespace}\", \"${metadata.name}\", \"${status.startedAt}\", \"${status.finishedAt}\" or any other element in workflow yaml, e.g. \"${io.argoproj.workflow.v1alpha1.metadata.annotations.userDefinedKey}\" |