From 2f446a9fc68b6304e5b35d5acc73ed2295dd6004 Mon Sep 17 00:00:00 2001
From: Phil Renaud <phil@riotindustries.com>
Date: Wed, 22 Nov 2023 17:08:40 -0500
Subject: [PATCH 1/4] An example job with a few interesting actions

---
 ui/app/utils/default-job-templates.js |  14 +++
 ui/app/utils/default_jobs/actions.js  | 130 ++++++++++++++++++++++++++
 2 files changed, 144 insertions(+)
 create mode 100644 ui/app/utils/default_jobs/actions.js

diff --git a/ui/app/utils/default-job-templates.js b/ui/app/utils/default-job-templates.js
index 1d89de7cc57..3cfec453edb 100644
--- a/ui/app/utils/default-job-templates.js
+++ b/ui/app/utils/default-job-templates.js
@@ -7,6 +7,7 @@ import helloWorld from './default_jobs/hello-world';
 import parameterized from './default_jobs/parameterized';
 import serviceDiscovery from './default_jobs/service-discovery';
 import variables from './default_jobs/variables';
+import actions from './default_jobs/actions';
 
 export default [
   {
@@ -22,6 +23,19 @@ export default [
       },
     ],
   },
+  {
+    id: 'nomad/job-templates/default/actions',
+    keyValues: [
+      {
+        key: 'template',
+        value: actions,
+      },
+      {
+        key: 'description',
+        value: 'A raw exec job that shows off Nomad Actions',
+      },
+    ],
+  },
   {
     id: 'nomad/job-templates/default/parameterized-job',
     keyValues: [
diff --git a/ui/app/utils/default_jobs/actions.js b/ui/app/utils/default_jobs/actions.js
new file mode 100644
index 00000000000..89987beb1fe
--- /dev/null
+++ b/ui/app/utils/default_jobs/actions.js
@@ -0,0 +1,130 @@
+/**
+ * Copyright (c) HashiCorp, Inc.
+ * SPDX-License-Identifier: BUSL-1.1
+ */
+
+export default `job "job-with-actions" {
+  # Specifies the datacenter where this job should be run
+  # This can be omitted and it will default to ["*"]
+  datacenters = ["*"]
+
+  # Run the job only on Linux or MacOS.
+  constraint {
+    attribute = "\${attr.kernel.name}"
+    operator  = "set_contains_any"
+    value     = "darwin,linux"
+  }
+
+  group "my_group" {
+    # Specifies the number of instances of this group that should be running.
+    # Use this to scale or parallelize your job.
+    count = 3
+
+    task "sleepy" {
+      driver = "raw_exec"
+
+      # The "command" stanza specifies the command to run.
+      # This command will run a .sh file generated from the template stanza below,
+      # which will sleep for 2 seconds and repeat until the job is stopped.
+      config {
+        command = "\${NOMAD_TASK_DIR}/sleepy.sh"
+      }
+
+      resources {
+        memory = 16
+        cpu = 16
+      }
+
+      template {
+        data = <<EOH
+#!/bin/bash
+SLEEP_SECS=2
+interruptable_sleep() { for i in $(seq 1 $((2*\${1}))); do sleep .5; done; }
+sigint() { echo "$(date) - SIGTERM received; Ending."; exit 0; }
+trap 'sigint'  INT
+echo "$(date) - Starting. SLEEP_SECS=\${SLEEP_SECS}"
+while true; do echo "$(date) - Sleeping for \${SLEEP_SECS} seconds."; interruptable_sleep \${SLEEP_SECS}; done
+EOH
+        destination = "local/sleepy.sh"
+      }
+
+      # Action blocks can be used to run arbitrary commands on an allocation,
+      # such as to collect logs, clear caches, migrate databases, or debug issues.
+
+      # This action will run a simple echo command every second.
+      # Where the other actions run and exit upon completion, this action will run
+      # until it is manually stopped with an escape character or socket closure.
+      action "echo time" {
+        command = "/bin/sh"
+        args    = ["-c", "counter=0; while true; do echo \\"Running for \${counter} seconds\\"; counter=$((counter + 1)); sleep 1; done"]
+      }
+      
+      # These next two actions use the nomad CLI to get information about the job and allocation.
+      # The NOMAD_JOB_NAME and NOMAD_ALLOC_ID environment variables are made available to running
+      # tasks and can be used in jobspecs.
+      action "get-job-info" {
+        command = "/bin/sh"
+        args    = ["-c",
+          <<EOT
+          nomad job status \${NOMAD_JOB_NAME}
+          EOT
+        ]
+      }
+
+      action "get alloc info" {
+        command = "/bin/sh"
+        args    = ["-c",
+          <<EOT
+          nomad alloc status \${NOMAD_ALLOC_ID}
+          EOT
+        ]
+      }
+
+      # This final action will fetch the latest Nomad changelog and parse it to get the latest 3 versions
+      # and the number of items under each section using curl and awk. This is meant to demonstrate
+      # how actions can be used to fetch information or perform other tasks that are not directly related
+      # to the running task.
+      action "fetch-latest-nomad-changelog" {
+        command = "/bin/sh"
+        args    = ["-c", 
+          <<EOT
+          curl -s https://raw.githubusercontent.com/hashicorp/nomad/main/CHANGELOG.md | 
+          awk 'BEGIN{
+              RS="## "; FS="\\n"; 
+              section=""; count=0
+          }
+          {
+              if (count < 3 && NR > 1){
+                  split($1, versionInfo, /[()]/);
+                  version=versionInfo[1];
+                  gsub(" ", "", version);
+                  releaseDate=versionInfo[2];
+                  urlVersion=version; gsub("\\\\.", "", urlVersion);
+                  urlDate=releaseDate; gsub(" ", "-", urlDate); gsub(",", "", urlDate);
+                  for(i=1; i<=NF; i++){
+                      if($i ~ /^[A-Z ]+:$/){
+                          gsub(":", "", $i);
+                          section=$i;
+                          itemCount[section]=0;
+                      }
+                      if(section && $i ~ /^\\*/){
+                          itemCount[section]++;
+                      }
+                  }
+                  printf "Version: %s\\nRelease Date: %s\\n", version, releaseDate;
+                  for (s in itemCount) {
+                      printf "%d %s, ", itemCount[s], s;
+                  }
+                  printf "\\nLink: https://github.com/hashicorp/nomad/blob/main/CHANGELOG.md#%s-%s\\n\\n", urlVersion, tolower(urlDate);
+                  delete itemCount;
+                  count++;
+              }
+          }'
+          EOT
+        ]
+      }
+
+    }
+  }
+}
+`;

From fe5f82e8912736e643461581e98c7ef953b2f658 Mon Sep 17 00:00:00 2001
From: Phil Renaud <phil@riotindustries.com>
Date: Mon, 27 Nov 2023 00:26:12 -0500
Subject: [PATCH 2/4] A pretty different example job

---
 ui/app/utils/default-job-templates.js |   3 +-
 ui/app/utils/default_jobs/actions.js  | 189 +++++++++++++-------------
 2 files changed, 97 insertions(+), 95 deletions(-)

diff --git a/ui/app/utils/default-job-templates.js b/ui/app/utils/default-job-templates.js
index 3cfec453edb..02d18ab97c6 100644
--- a/ui/app/utils/default-job-templates.js
+++ b/ui/app/utils/default-job-templates.js
@@ -32,7 +32,8 @@ export default [
       },
       {
         key: 'description',
-        value: 'A raw exec job that shows off Nomad Actions',
+        value:
+          'Nomad Actions let job authors describe commands that can be run in one click from the UI or one command from the CLI. This example job shows how to use them to simulate development on a Redis instance.',
       },
     ],
   },
diff --git a/ui/app/utils/default_jobs/actions.js b/ui/app/utils/default_jobs/actions.js
index 89987beb1fe..766b017affb 100644
--- a/ui/app/utils/default_jobs/actions.js
+++ b/ui/app/utils/default_jobs/actions.js
@@ -3,128 +3,129 @@
  * SPDX-License-Identifier: BUSL-1.1
  */
 
-export default `job "job-with-actions" {
-  # Specifies the datacenter where this job should be run
-  # This can be omitted and it will default to ["*"]
+export default `job "redis-actions" {
   datacenters = ["*"]
 
-  # Run the job only on Linux or MacOS.
-  constraint {
-    attribute = "\${attr.kernel.name}"
-    operator  = "set_contains_any"
-    value     = "darwin,linux"
-  }
-
-  group "my_group" {
-    # Specifies the number of instances of this group that should be running.
-    # Use this to scale or parallelize your job.
-    count = 3
+  group "cache" {
+    count = 1
+    network {
+      port "db" {}
+    }
 
-    task "sleepy" {
-      driver = "raw_exec"
+    task "redis" {
+      driver = "docker"
 
-      # The "command" stanza specifies the command to run.
-      # This command will run a .sh file generated from the template stanza below,
-      # which will sleep for 2 seconds and repeat until the job is stopped.
       config {
-        command = "\${NOMAD_TASK_DIR}/sleepy.sh"
+        image = "redis:3.2"
+        ports = ["db"]
+        command = "/bin/sh"
+        args = ["-c", "redis-server --port \${NOMAD_PORT_db} & /local/db_log.sh"]
       }
 
       resources {
-        memory = 16
-        cpu = 16
+        cpu = 500
+        memory = 256
+      }
+
+      service {
+        name = "redis-service"
+        port = "db"
+        provider = "nomad"
+
+        check {
+          name     = "alive"
+          type     = "tcp"
+          port     = "db"
+          interval = "10s"
+          timeout  = "2s"
+        }
       }
 
       template {
-        data = <<EOH
-#!/bin/bash
-SLEEP_SECS=2
-interruptable_sleep() { for i in $(seq 1 $((2*\${1}))); do sleep .5; done; }
-sigint() { echo "$(date) - SIGTERM received; Ending."; exit 0; }
-trap 'sigint'  INT
-echo "$(date) - Starting. SLEEP_SECS=\${SLEEP_SECS}"
-while true; do echo "$(date) - Sleeping for \${SLEEP_SECS} seconds."; interruptable_sleep \${SLEEP_SECS}; done
-EOH
-        destination = "local/sleepy.sh"
+        data = <<EOF
+          #!/bin/sh
+          while true; do
+            echo "$(date): Current DB Size: $(redis-cli -p \${NOMAD_PORT_db} DBSIZE)"
+            sleep 3
+          done
+EOF
+        destination = "local/db_log.sh"
+        perms = "0755"
+      }
+
+      # Adds a random key/value to the Redis database
+      action "add-random-key" {
+        command = "/bin/sh"
+        args    = ["-c", "key=$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 13); value=$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 13); redis-cli -p \${NOMAD_PORT_db} SET $key $value; echo Key $key added with value $value"]
       }
 
-      # Action blocks can be used to run arbitrary commands on an allocation,
-      # such as to collect logs, clear caches, migrate databases, or debug issues.
+      # Adds a random key/value with a "temp_" prefix to the Redis database
+      action "add-random-temporary-key" {
+        command = "/bin/sh"
+        args    = ["-c", "key=temp_$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 13); value=$(head /dev/urandom | tr -dc A-Za-z0-9 | head -c 13); redis-cli -p \${NOMAD_PORT_db} SET $key $value; echo Key $key added with value $value"]
+      }
 
-      # This action will run a simple echo command every second.
-      # Where the other actions run and exit upon completion, this action will run
-      # until it is manually stopped with an escape character or socket closure.
-      action "echo time" {
+      # Lists all keys currently stored in the Redis database.
+      action "list-keys" {
         command = "/bin/sh"
-        args    = ["-c", "counter=0; while true; do echo \\"Running for \${counter} seconds\\"; counter=$((counter + 1)); sleep 1; done"]
+        args    = ["-c", "redis-cli -p \${NOMAD_PORT_db} KEYS '*'"]
       }
-      
-      # These next two actions use the nomad CLI to get information about the job and allocation.
-      # The NOMAD_JOB_NAME and NOMAD_ALLOC_ID environment variables are made available to running
-      # tasks and can be used in jobspecs.
-      action "get-job-info" {
+
+      # Retrieves various stats about the Redis server
+      action "get-redis-stats" {
         command = "/bin/sh"
-        args    = ["-c",
-          <<EOT
-          nomad job status \${NOMAD_JOB_NAME}
-          EOT
-        ]
+        args    = ["-c", "redis-cli -p \${NOMAD_PORT_db} INFO"]
+      }
+
+      # Performs a latency check of the Redis server.
+      # This action is a non-terminating action, meaning it will run indefinitely until it is stopped.
+      # Pass an escape sequence (Ctrl-C) to stop the action.
+      action "health-check" {
+        command = "/bin/sh"
+        args    = ["-c", "redis-cli -p \${NOMAD_PORT_db} --latency"]
       }
 
-      action "get alloc info" {
+      # Deletes all keys with a 'temp_' prefix
+      action "flush-temp-keys" {
         command = "/bin/sh"
-        args    = ["-c",
-          <<EOT
-          nomad alloc status \${NOMAD_ALLOC_ID}
-          EOT
+        args    = ["-c", <<EOF
+          keys_to_delete=$(redis-cli -p \${NOMAD_PORT_db} --scan --pattern 'temp_*')
+          if [ -n "$keys_to_delete" ]; then
+            # Count the number of keys to delete
+            deleted_count=$(echo "$keys_to_delete" | wc -l)
+            # Execute the delete command
+            echo "$keys_to_delete" | xargs redis-cli -p \${NOMAD_PORT_db} DEL
+          else
+            deleted_count=0
+          fi
+          remaining_keys=$(redis-cli -p \${NOMAD_PORT_db} DBSIZE)
+          echo "$deleted_count temporary keys removed; $remaining_keys keys remaining in database"
+EOF
         ]
       }
 
-      # This final action will fetch the latest Nomad changelog and parse it to get the latest 3 versions
-      # and the number of items under each section using curl and awk. This is meant to demonstrate
-      # how actions can be used to fetch information or perform other tasks that are not directly related
-      # to the running task.
-      action "fetch-latest-nomad-changelog" {
+
+      # Toggles saving to disk (RDB persistence). When enabled, allocation logs will indicate a save every 60 seconds.
+      action "toggle-save-to-disk" {
         command = "/bin/sh"
-        args    = ["-c", 
-          <<EOT
-          curl -s https://raw.githubusercontent.com/hashicorp/nomad/main/CHANGELOG.md | 
-          awk 'BEGIN{
-              RS="## "; FS="\\n"; 
-              section=""; count=0
-          }
-          {
-              if (count < 3 && NR > 1){
-                  split($1, versionInfo, /[()]/);
-                  version=versionInfo[1];
-                  gsub(" ", "", version);
-                  releaseDate=versionInfo[2];
-                  urlVersion=version; gsub("\\\\.", "", urlVersion);
-                  urlDate=releaseDate; gsub(" ", "-", urlDate); gsub(",", "", urlDate);
-                  for(i=1; i<=NF; i++){
-                      if($i ~ /^[A-Z ]+:$/){
-                          gsub(":", "", $i);
-                          section=$i;
-                          itemCount[section]=0;
-                      }
-                      if(section && $i ~ /^\\*/){
-                          itemCount[section]++;
-                      }
-                  }
-                  printf "Version: %s\\nRelease Date: %s\\n", version, releaseDate;
-                  for (s in itemCount) {
-                      printf "%d %s, ", itemCount[s], s;
-                  }
-                  printf "\\nLink: https://github.com/hashicorp/nomad/blob/main/CHANGELOG.md#%s-%s\\n\\n", urlVersion, tolower(urlDate);
-                  delete itemCount;
-                  count++;
-              }
-          }'
-          EOT
+        args    = ["-c", <<EOF
+          current_config=$(redis-cli -p \${NOMAD_PORT_db} CONFIG GET save | awk 'NR==2');
+          if [ -z "$current_config" ]; then
+            # Enable saving to disk (example: save after 60 seconds if at least 1 key changed)
+            redis-cli -p \${NOMAD_PORT_db} CONFIG SET save "60 1";
+            echo "Saving to disk enabled: 60 seconds interval if at least 1 key changed";
+          else
+            # Disable saving to disk
+            redis-cli -p \${NOMAD_PORT_db} CONFIG SET save "";
+            echo "Saving to disk disabled";
+          fi;
+EOF
         ]
       }
 
+
     }
   }
+
 }
 `;

From 9319d666b2f5bc2bc00c3150b6c4b81b3cc33f0d Mon Sep 17 00:00:00 2001
From: Phil Renaud <phil@riotindustries.com>
Date: Mon, 27 Nov 2023 09:40:53 -0500
Subject: [PATCH 3/4] Tests updated with const'd number of default templates

---
 ui/tests/acceptance/job-run-test.js | 18 ++++++++++++++----
 1 file changed, 14 insertions(+), 4 deletions(-)

diff --git a/ui/tests/acceptance/job-run-test.js b/ui/tests/acceptance/job-run-test.js
index 97d021c12e7..09391a36f16 100644
--- a/ui/tests/acceptance/job-run-test.js
+++ b/ui/tests/acceptance/job-run-test.js
@@ -29,6 +29,8 @@ const newJobName = 'new-job';
 const newJobTaskGroupName = 'redis';
 const newJobNamespace = 'default';
 
+const NUMBER_OF_DEFAULT_TEMPLATES = 5;
+
 let managementToken, clientToken;
 
 const jsonJob = (overrides) => {
@@ -245,7 +247,10 @@ module('Acceptance | job run', function (hooks) {
       // Assert
       assert
         .dom('[data-test-template-card]')
-        .exists({ count: 4 }, 'A list of default job templates is rendered.');
+        .exists(
+          { count: NUMBER_OF_DEFAULT_TEMPLATES },
+          'A list of default job templates is rendered.'
+        );
 
       await click('[data-test-create-new-button]');
       assert.equal(currentRouteName(), 'jobs.run.templates.new');
@@ -331,7 +336,10 @@ module('Acceptance | job run', function (hooks) {
       // Assert
       assert
         .dom('[data-test-template-card]')
-        .exists({ count: 4 }, 'A list of default job templates is rendered.');
+        .exists(
+          { count: NUMBER_OF_DEFAULT_TEMPLATES },
+          'A list of default job templates is rendered.'
+        );
 
       await click('[data-test-create-new-button]');
       assert.equal(currentRouteName(), 'jobs.run.templates.new');
@@ -380,7 +388,10 @@ module('Acceptance | job run', function (hooks) {
       // Assert
       assert
         .dom('[data-test-template-card]')
-        .exists({ count: 4 }, 'A list of default job templates is rendered.');
+        .exists(
+          { count: NUMBER_OF_DEFAULT_TEMPLATES },
+          'A list of default job templates is rendered.'
+        );
 
       await click('[data-test-create-new-button]');
       assert.equal(currentRouteName(), 'jobs.run.templates.new');
@@ -576,7 +587,6 @@ module('Acceptance | job run', function (hooks) {
 
     test('default templates', async function (assert) {
       assert.expect(4);
-      const NUMBER_OF_DEFAULT_TEMPLATES = 4;
 
       await visit('/jobs/run/templates');
 

From d84df43d8a396f4deac04732f9fbfe573cc84bf8 Mon Sep 17 00:00:00 2001
From: Phil Renaud <phil@riotindustries.com>
Date: Mon, 4 Dec 2023 10:44:06 -0500
Subject: [PATCH 4/4] Removed default jobspec params and formatted

---
 .changelog/19153.txt                 |  3 ++
 ui/app/utils/default_jobs/actions.js | 46 ++++++++++++----------------
 2 files changed, 23 insertions(+), 26 deletions(-)
 create mode 100644 .changelog/19153.txt

diff --git a/.changelog/19153.txt b/.changelog/19153.txt
new file mode 100644
index 00000000000..6c9da374e1c
--- /dev/null
+++ b/.changelog/19153.txt
@@ -0,0 +1,3 @@
+```release-note:improvement
+ui: Added a new example template with Task Actions
+```
diff --git a/ui/app/utils/default_jobs/actions.js b/ui/app/utils/default_jobs/actions.js
index 766b017affb..cd65feab831 100644
--- a/ui/app/utils/default_jobs/actions.js
+++ b/ui/app/utils/default_jobs/actions.js
@@ -4,10 +4,8 @@
  */
 
 export default `job "redis-actions" {
-  datacenters = ["*"]
 
   group "cache" {
-    count = 1
     network {
       port "db" {}
     }
@@ -16,20 +14,32 @@ export default `job "redis-actions" {
       driver = "docker"
 
       config {
-        image = "redis:3.2"
-        ports = ["db"]
+        image   = "redis:7"
+        ports   = ["db"]
         command = "/bin/sh"
-        args = ["-c", "redis-server --port \${NOMAD_PORT_db} & /local/db_log.sh"]
+        args    = ["-c", "redis-server --port \${NOMAD_PORT_db} & /local/db_log.sh"]
+      }
+
+      template {
+        data        = <<EOF
+          #!/bin/sh
+          while true; do
+            echo "$(date): Current DB Size: $(redis-cli -p \${NOMAD_PORT_db} DBSIZE)"
+            sleep 3
+          done
+EOF
+        destination = "local/db_log.sh"
+        perms       = "0755"
       }
 
       resources {
-        cpu = 500
-        memory = 256
+        cpu    = 128
+        memory = 128
       }
 
       service {
-        name = "redis-service"
-        port = "db"
+        name     = "redis-service"
+        port     = "db"
         provider = "nomad"
 
         check {
@@ -41,18 +51,6 @@ export default `job "redis-actions" {
         }
       }
 
-      template {
-        data = <<EOF
-          #!/bin/sh
-          while true; do
-            echo "$(date): Current DB Size: $(redis-cli -p \${NOMAD_PORT_db} DBSIZE)"
-            sleep 3
-          done
-EOF
-        destination = "local/db_log.sh"
-        perms = "0755"
-      }
-
       # Adds a random key/value to the Redis database
       action "add-random-key" {
         command = "/bin/sh"
@@ -79,7 +77,7 @@ EOF
 
       # Performs a latency check of the Redis server.
       # This action is a non-terminating action, meaning it will run indefinitely until it is stopped.
-      # Pass an escape sequence (Ctrl-C) to stop the action.
+      # Pass a signal interruption (Ctrl-C) to stop the action.
       action "health-check" {
         command = "/bin/sh"
         args    = ["-c", "redis-cli -p \${NOMAD_PORT_db} --latency"]
@@ -104,7 +102,6 @@ EOF
         ]
       }
 
-
       # Toggles saving to disk (RDB persistence). When enabled, allocation logs will indicate a save every 60 seconds.
       action "toggle-save-to-disk" {
         command = "/bin/sh"
@@ -122,10 +119,7 @@ EOF
 EOF
         ]
       }
-
-
     }
   }
-
 }
 `;