choria-mcorpc-support 2.22.1 → 2.23.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe21f29a02c82194f42269a70b3bbcf8d93a8cd6
-  data.tar.gz: c1ce8445e163f31010ad687d8e26c527fe27ee64
+  metadata.gz: fff08a7753f5e78a94c1369d2e98f6c653cad214
+  data.tar.gz: 2ba0b1d4bcc180f2d1571cd37c6a0a7feb2a1143
 SHA512:
-  metadata.gz: 0acc8d8acffecf2185a7486cf7772e66bc4c1662541b2f2795cc3ac2f2eee32cc2511787730ce7c2464da21423fe30dddee891c95eefef86082e7747afc953d1
-  data.tar.gz: 3c08ae6ce075e9953a68db9c40439ce448cf555a0e0cc6be30f42a806a065efd6e5a4d0b7bf2a957976e2751f63a996157f46d973279caef26dafdfbbd469924
+  metadata.gz: 5f212091a5f6d261dc430bf8690052403cbe78dcc934e76770eaebaf502ce14c9e05beaffcddc292e4f3e27cc3f4f9ba707ff618aa5bb9a22077b8785dd4bce2
+  data.tar.gz: e00f158a8257f4ffbded4fa79842bf1c6616b4a82b1c6803eabdfc7f4dc418ec860aef17aec279cac5577349161cb9e1e59f710fbaa98e3224a396faf3659b22

data/lib/mcollective.rb

@@ -54,7 +54,7 @@ module MCollective
   require "mcollective/util"
   require "mcollective/validator"
 
-  VERSION = "2.22.1".freeze
+  VERSION = "2.23.0".freeze
 
   def self.version
     VERSION

data/lib/mcollective/agent/bolt_tasks.ddl

@@ -0,0 +1,235 @@
+metadata :name => "bolt_tasks",
+         :description => "Downloads and runs Puppet Tasks",
+         :author => "R.I.Pienaar <rip@devco.net>",
+         :license => "Apache-2.0",
+         :version => "0.19.0",
+         :url => "https://choria.io",
+         :timeout => 60
+
+requires :mcollective => "2.11.0"
+
+action "download", :description => "Downloads a Puppet Task into a local cache" do
+  input :task,
+        :prompt      => "Task Name",
+        :description => "The name of a task, example apache or apache::reload",
+        :type        => :string,
+        :validation  => :bolt_task_name,
+        :optional    => false,
+        :maxlength   => 100
+
+  input :environment,
+        :prompt      => "Puppet Environment",
+        :description => "The environment the task should be fetched from",
+        :type        => :string,
+        :validation  => '\A[a-z][a-z0-9_]*\z',
+        :optional    => false,
+        :default     => "production",
+        :maxlength   => 100
+
+  input :files,
+        :prompt      => "Task Files Specification",
+        :description => "The specification of files to download according to v3 api in JSON format",
+        :type        => :string,
+        :optional    => false,
+        :validation  => '\A\[.+\]\z',
+        :maxlength   => 4000
+
+  output :downloads,
+         :description => "The number of files downloaded",
+         :display_as  => "Files Downloaded"
+
+  summarize do
+    aggregate summary(:downloads)
+  end
+end
+
+action "run_and_wait", :description => "Runs a Puppet Task that was previously downloaded, wait for it to finish" do
+  input :task,
+        :prompt      => "Task Name",
+        :description => "The name of a task, example apache or apache::reload",
+        :type        => :string,
+        :validation  => :bolt_task_name,
+        :optional    => false,
+        :maxlength   => 100
+
+  input :input_method,
+        :prompt      => "Input Method",
+        :description => "The input method to use",
+        :type        => :list,
+        :list        => ["powershell", "stdin", "environment", "both"],
+        :optional    => true,
+        :default     => nil
+
+  input :files,
+        :prompt      => "Task Files Specification",
+        :description => "The specification of files to download according to v3 api in JSON format",
+        :type        => :string,
+        :optional    => false,
+        :validation  => '\A\[.+\]\z',
+        :maxlength   => 4000
+
+  input :input,
+        :prompt      => "Task Input",
+        :description => "JSON String containing input variables",
+        :type        => :string,
+        :validation  => '^.+$',
+        :optional    => false,
+        :default     => "{}",
+        :maxlength   => 102400
+
+  output :task_id,
+         :description => "The ID the task was created with",
+         :display_as  => "Task ID",
+         :default     => nil
+
+  output :task,
+         :description => "Task name",
+         :display_as  => "Task",
+         :default     => nil
+
+  output :callerid,
+         :description => "User who initiated the task",
+         :display_as  => "User",
+         :default     => nil
+
+  output :exitcode,
+         :description => "Task exit code",
+         :display_as  => "Exit Code",
+         :default     => 127
+
+  output :stdout,
+         :description => "Standard Output from the command",
+         :display_as  => "STDOUT",
+         :default     => nil
+
+  output :stderr,
+         :description => "Standard Error from the command",
+         :display_as  => "STDERR",
+         :default     => nil
+
+  output :completed,
+         :description => "Did the task complete",
+         :display_as  => "Completed",
+         :default     => false
+
+  output :runtime,
+         :description => "Time taken to run the command",
+         :display_as  => "Runtime",
+         :default     => 0
+
+  output :start_time,
+         :description => "When the task was started in UTC time",
+         :display_as  => "Start Time"
+
+  summarize do
+    aggregate average(:runtime)
+    aggregate summary(:task)
+    aggregate summary(:callerid)
+    aggregate summary(:exitcode)
+    aggregate summary(:completed)
+    aggregate summary(:task_id)
+  end
+end
+
+action "run_no_wait", :description => "Runs a Puppet Task that was previously downloaded do not wait for it to finish" do
+  input :task,
+        :prompt      => "Task Name",
+        :description => "The name of a task, example apache or apache::reload",
+        :type        => :string,
+        :validation  => :bolt_task_name,
+        :optional    => false,
+        :maxlength   => 100
+
+  input :input_method,
+        :prompt      => "Input Method",
+        :description => "The input method to use",
+        :type        => :list,
+        :list        => ["powershell", "stdin", "environment", "both"],
+        :optional    => true,
+        :default     => nil
+
+  input :files,
+        :prompt      => "Task Files Specification",
+        :description => "The specification of files to download according to v3 api in JSON format",
+        :type        => :string,
+        :optional    => false,
+        :validation  => '\A\[.+\]\z',
+        :maxlength   => 4000
+
+  input :input,
+        :prompt      => "Task Input",
+        :description => "JSON String containing input variables",
+        :type        => :string,
+        :validation  => '^.+$',
+        :optional    => true,
+        :default     => "{}",
+        :maxlength   => 102400
+
+  output :task_id,
+         :description => "The ID the task was created with",
+         :display_as  => "Task ID",
+         :default     => nil
+
+  summarize do
+    aggregate summary(:task_id)
+  end
+end
+
+action "task_status", :description => "Request the status of a previously ran task" do
+  display :always
+
+  input :task_id,
+        :prompt      => "Task ID",
+        :description => "The Task ID to retrieve",
+        :type        => :string,
+        :validation  => '^[a-z,0-9]{32}$',
+        :optional    => false,
+        :maxlength   => 32
+
+  output :task,
+         :description => "Task name",
+         :display_as  => "Task",
+         :default     => nil
+
+  output :callerid,
+         :description => "User who initiated the task",
+         :display_as  => "User",
+         :default     => nil
+
+  output :exitcode,
+         :description => "Task exit code",
+         :display_as  => "Exit Code",
+         :default     => 127
+
+  output :stdout,
+         :description => "Standard Output from the command",
+         :display_as  => "STDOUT",
+         :default     => nil
+
+  output :stderr,
+         :description => "Standard Error from the command",
+         :display_as  => "STDERR",
+         :default     => nil
+
+  output :completed,
+         :description => "Did the task complete",
+         :display_as  => "Completed",
+         :default     => false
+
+  output :runtime,
+         :description => "Time taken to run the command",
+         :display_as  => "Runtime",
+         :default     => 0
+
+  output :start_time,
+         :description => "When the task was started in UTC time",
+         :display_as  => "Start Time"
+
+  summarize do
+    aggregate average(:runtime)
+    aggregate summary(:task)
+    aggregate summary(:callerid)
+    aggregate summary(:exitcode)
+    aggregate summary(:completed)
+  end
+end

data/lib/mcollective/agent/bolt_tasks.json

@@ -0,0 +1,347 @@
+{
+  "$schema": "https://choria.io/schemas/mcorpc/ddl/v1/agent.json",
+  "metadata": {
+    "name": "bolt_tasks",
+    "description": "Downloads and runs Puppet Tasks",
+    "author": "R.I.Pienaar <rip@devco.net>",
+    "license": "Apache-2.0",
+    "version": "0.19.0",
+    "url": "https://choria.io",
+    "timeout": 60
+  },
+  "actions": [
+    {
+      "action": "download",
+      "input": {
+        "task": {
+          "prompt": "Task Name",
+          "description": "The name of a task, example apache or apache::reload",
+          "type": "string",
+          "default": null,
+          "optional": false,
+          "validation": "bolt_task_name",
+          "maxlength": 100
+        },
+        "environment": {
+          "prompt": "Puppet Environment",
+          "description": "The environment the task should be fetched from",
+          "type": "string",
+          "default": "production",
+          "optional": false,
+          "validation": "\\A[a-z][a-z0-9_]*\\z",
+          "maxlength": 100
+        },
+        "files": {
+          "prompt": "Task Files Specification",
+          "description": "The specification of files to download according to v3 api in JSON format",
+          "type": "string",
+          "default": null,
+          "optional": false,
+          "validation": "\\A\\[.+\\]\\z",
+          "maxlength": 4000
+        }
+      },
+      "output": {
+        "downloads": {
+          "description": "The number of files downloaded",
+          "display_as": "Files Downloaded",
+          "default": null
+        }
+      },
+      "display": "failed",
+      "description": "Downloads a Puppet Task into a local cache",
+      "aggregate": [
+        {
+          "function": "summary",
+          "args": [
+            "downloads"
+          ]
+        }
+      ]
+    },
+    {
+      "action": "run_and_wait",
+      "input": {
+        "task": {
+          "prompt": "Task Name",
+          "description": "The name of a task, example apache or apache::reload",
+          "type": "string",
+          "default": null,
+          "optional": false,
+          "validation": "bolt_task_name",
+          "maxlength": 100
+        },
+        "input_method": {
+          "prompt": "Input Method",
+          "description": "The input method to use",
+          "type": "list",
+          "default": null,
+          "optional": true,
+          "list": [
+            "powershell",
+            "stdin",
+            "environment",
+            "both"
+          ]
+        },
+        "files": {
+          "prompt": "Task Files Specification",
+          "description": "The specification of files to download according to v3 api in JSON format",
+          "type": "string",
+          "default": null,
+          "optional": false,
+          "validation": "\\A\\[.+\\]\\z",
+          "maxlength": 4000
+        },
+        "input": {
+          "prompt": "Task Input",
+          "description": "JSON String containing input variables",
+          "type": "string",
+          "default": "{}",
+          "optional": false,
+          "validation": "^.+$",
+          "maxlength": 102400
+        }
+      },
+      "output": {
+        "task_id": {
+          "description": "The ID the task was created with",
+          "display_as": "Task ID",
+          "default": null
+        },
+        "task": {
+          "description": "Task name",
+          "display_as": "Task",
+          "default": null
+        },
+        "callerid": {
+          "description": "User who initiated the task",
+          "display_as": "User",
+          "default": null
+        },
+        "exitcode": {
+          "description": "Task exit code",
+          "display_as": "Exit Code",
+          "default": 127
+        },
+        "stdout": {
+          "description": "Standard Output from the command",
+          "display_as": "STDOUT",
+          "default": null
+        },
+        "stderr": {
+          "description": "Standard Error from the command",
+          "display_as": "STDERR",
+          "default": null
+        },
+        "completed": {
+          "description": "Did the task complete",
+          "display_as": "Completed",
+          "default": false
+        },
+        "runtime": {
+          "description": "Time taken to run the command",
+          "display_as": "Runtime",
+          "default": 0
+        },
+        "start_time": {
+          "description": "When the task was started in UTC time",
+          "display_as": "Start Time",
+          "default": null
+        }
+      },
+      "display": "failed",
+      "description": "Runs a Puppet Task that was previously downloaded, wait for it to finish",
+      "aggregate": [
+        {
+          "function": "average",
+          "args": [
+            "runtime"
+          ]
+        },
+        {
+          "function": "summary",
+          "args": [
+            "task"
+          ]
+        },
+        {
+          "function": "summary",
+          "args": [
+            "callerid"
+          ]
+        },
+        {
+          "function": "summary",
+          "args": [
+            "exitcode"
+          ]
+        },
+        {
+          "function": "summary",
+          "args": [
+            "completed"
+          ]
+        },
+        {
+          "function": "summary",
+          "args": [
+            "task_id"
+          ]
+        }
+      ]
+    },
+    {
+      "action": "run_no_wait",
+      "input": {
+        "task": {
+          "prompt": "Task Name",
+          "description": "The name of a task, example apache or apache::reload",
+          "type": "string",
+          "default": null,
+          "optional": false,
+          "validation": "bolt_task_name",
+          "maxlength": 100
+        },
+        "input_method": {
+          "prompt": "Input Method",
+          "description": "The input method to use",
+          "type": "list",
+          "default": null,
+          "optional": true,
+          "list": [
+            "powershell",
+            "stdin",
+            "environment",
+            "both"
+          ]
+        },
+        "files": {
+          "prompt": "Task Files Specification",
+          "description": "The specification of files to download according to v3 api in JSON format",
+          "type": "string",
+          "default": null,
+          "optional": false,
+          "validation": "\\A\\[.+\\]\\z",
+          "maxlength": 4000
+        },
+        "input": {
+          "prompt": "Task Input",
+          "description": "JSON String containing input variables",
+          "type": "string",
+          "default": "{}",
+          "optional": true,
+          "validation": "^.+$",
+          "maxlength": 102400
+        }
+      },
+      "output": {
+        "task_id": {
+          "description": "The ID the task was created with",
+          "display_as": "Task ID",
+          "default": null
+        }
+      },
+      "display": "failed",
+      "description": "Runs a Puppet Task that was previously downloaded do not wait for it to finish",
+      "aggregate": [
+        {
+          "function": "summary",
+          "args": [
+            "task_id"
+          ]
+        }
+      ]
+    },
+    {
+      "action": "task_status",
+      "input": {
+        "task_id": {
+          "prompt": "Task ID",
+          "description": "The Task ID to retrieve",
+          "type": "string",
+          "default": null,
+          "optional": false,
+          "validation": "^[a-z,0-9]{32}$",
+          "maxlength": 32
+        }
+      },
+      "output": {
+        "task": {
+          "description": "Task name",
+          "display_as": "Task",
+          "default": null
+        },
+        "callerid": {
+          "description": "User who initiated the task",
+          "display_as": "User",
+          "default": null
+        },
+        "exitcode": {
+          "description": "Task exit code",
+          "display_as": "Exit Code",
+          "default": 127
+        },
+        "stdout": {
+          "description": "Standard Output from the command",
+          "display_as": "STDOUT",
+          "default": null
+        },
+        "stderr": {
+          "description": "Standard Error from the command",
+          "display_as": "STDERR",
+          "default": null
+        },
+        "completed": {
+          "description": "Did the task complete",
+          "display_as": "Completed",
+          "default": false
+        },
+        "runtime": {
+          "description": "Time taken to run the command",
+          "display_as": "Runtime",
+          "default": 0
+        },
+        "start_time": {
+          "description": "When the task was started in UTC time",
+          "display_as": "Start Time",
+          "default": null
+        }
+      },
+      "display": "always",
+      "description": "Request the status of a previously ran task",
+      "aggregate": [
+        {
+          "function": "average",
+          "args": [
+            "runtime"
+          ]
+        },
+        {
+          "function": "summary",
+          "args": [
+            "task"
+          ]
+        },
+        {
+          "function": "summary",
+          "args": [
+            "callerid"
+          ]
+        },
+        {
+          "function": "summary",
+          "args": [
+            "exitcode"
+          ]
+        },
+        {
+          "function": "summary",
+          "args": [
+            "completed"
+          ]
+        }
+      ]
+    }
+  ]
+}