refactor: tpl-exit-handler to tpl-log-notification

Author: amfage

templates/common/README.md

@@ -1,10 +1,10 @@
 # Common Templates
 
-- [Exit Handler](##exit-handler---tpl-exit-handler)
+- [Exit Handler](##exit-handler---tpl-log-notification)
 - [Get Location](##get-location---tpl-get-location)
 - [Read File](##read-file---tpl-read-file)
 
-## Exit Handler - `tpl-exit-handler`
+## Exit Handler - `tpl-log-notification`
 
 Template for handling a workflow `onExit`.
 See <https://argo-workflows.readthedocs.io/en/latest/walk-through/exit-handlers/>
@@ -56,7 +56,7 @@ The script ran by this template is generating a log, including the status of the
 The information to pass to this `WorkflowTemplate` is the status and the parameters of the workflow (`workflow.status` & `workflow.parameters`).
 
 As the `onExit` event [does not handle a `templateRef`](https://github.com/argoproj/argo-workflows/issues/3188),
-an additional template called by the `onExit` event has to be added to the templates so it can finally call the `tpl-exit-handler` template.
+an additional template called by the `onExit` event has to be added to the templates so it can finally call the `tpl-log-notification` template.
 
 ```yaml
 apiVersion: argoproj.io/v1alpha1
@@ -84,7 +84,7 @@ spec:
       steps:
         - - name: exit
             templateRef:
-              name: tpl-exit-handler
+              name: tpl-log-notification
               template: main
             arguments:
               parameters:

templates/common/exit.handler.yml templates/common/log.notification.ymltemplates/common/exit.handler.yml renamed to templates/common/log.notification.yml

@@ -4,7 +4,7 @@ apiVersion: argoproj.io/v1alpha1
 kind: WorkflowTemplate
 metadata:
   # Template to log the workflow status and its parameters.
-  name: tpl-exit-handler
+  name: tpl-log-notification
 spec:
   templateDefaults:
     container:
@@ -15,6 +15,9 @@ spec:
     - name: main
       inputs:
         parameters:
+          - name: msg
+            description: Message use for logging
+            default: 'Workflow:Done'
           - name: workflow_status
             description: Status of the workflow
           - name: workflow_parameters
@@ -34,8 +37,8 @@ spec:
               time: Date.now(),
               level: 20,
               pid: 1,
-              msg: 'Workflow:Done',
-              workflowStatus: '{{inputs.parameters.workflow_status}}', 
+              msg: '{{inputs.parameters.msg}}',
+              workflowStatus: '{{inputs.parameters.workflow_status}}',
               parameters,
             }),
           );

workflows/basemaps/charts-import-cogify.yml

@@ -213,11 +213,11 @@ spec:
 
     - name: exit-handler
       retryStrategy:
-        limit: '0' # `tpl-exit-handler` retries itself
+        limit: '0' # `tpl-log-notification` retries itself
       steps:
         - - name: exit
             templateRef:
-              name: tpl-exit-handler
+              name: tpl-log-notification
               template: main
             arguments:
               parameters:

workflows/basemaps/imagery-import-cogify.yml

@@ -243,11 +243,11 @@ spec:
 
     - name: exit-handler
       retryStrategy:
-        limit: '0' # `tpl-exit-handler` retries itself
+        limit: '0' # `tpl-log-notification` retries itself
       steps:
         - - name: exit
             templateRef:
-              name: tpl-exit-handler
+              name: tpl-log-notification
               template: main
             arguments:
               parameters:

workflows/basemaps/topo-maps-standardising.yml

@@ -314,11 +314,11 @@ spec:
 
     - name: exit-handler
       retryStrategy:
-        limit: '0' # `tpl-exit-handler` retries itself
+        limit: '0' # `tpl-log-notification` retries itself
       steps:
         - - name: exit
             templateRef:
-              name: tpl-exit-handler
+              name: tpl-log-notification
               template: main
             arguments:
               parameters:

workflows/basemaps/vector-etl-shortbread.yaml

@@ -358,11 +358,11 @@ spec:
 
     - name: exit-handler
       retryStrategy:
-        limit: '0' # `tpl-exit-handler` retries itself
+        limit: '0' # `tpl-log-notification` retries itself
       steps:
         - - name: exit
             templateRef:
-              name: tpl-exit-handler
+              name: tpl-log-notification
               template: main
             arguments:
               parameters:

workflows/basemaps/vector-etl.yaml

@@ -139,11 +139,11 @@ spec:
 
     - name: exit-handler
       retryStrategy:
-        limit: '0' # `tpl-exit-handler` retries itself
+        limit: '0' # `tpl-log-notification` retries itself
       steps:
         - - name: exit
             templateRef:
-              name: tpl-exit-handler
+              name: tpl-log-notification
               template: main
             arguments:
               parameters:

workflows/cron/cron-copy-restore.yaml

@@ -42,11 +42,11 @@ spec:
                     value: '{{workflow.parameters.reports_location}}'
       - name: exit-handler
         retryStrategy:
-          limit: '0' # `tpl-exit-handler` retries itself
+          limit: '0' # `tpl-log-notification` retries itself
         steps:
           - - name: exit
               templateRef:
-                name: tpl-exit-handler
+                name: tpl-log-notification
                 template: main
               arguments:
                 parameters:

workflows/cron/cron-national-merged-dem-hillshades-coastal.yaml

@@ -82,11 +82,11 @@ spec:
 
       - name: exit-handler
         retryStrategy:
-          limit: '0' # `tpl-exit-handler` retries itself
+          limit: '0' # `tpl-log-notification` retries itself
         steps:
           - - name: exit
               templateRef:
-                name: tpl-exit-handler
+                name: tpl-log-notification
                 template: main
               arguments:
                 parameters:

workflows/cron/cron-national-merged-dem-hillshades.yaml

@@ -82,11 +82,11 @@ spec:
 
       - name: exit-handler
         retryStrategy:
-          limit: '0' # `tpl-exit-handler` retries itself
+          limit: '0' # `tpl-log-notification` retries itself
         steps:
           - - name: exit
               templateRef:
-                name: tpl-exit-handler
+                name: tpl-log-notification
                 template: main
               arguments:
                 parameters: