choria-mcorpc-support 2.21.1 → 2.23.1

data/lib/mcollective/agent/rpcutil.ddl

@@ -2,9 +2,9 @@ metadata    :name        => "rpcutil",
             :description => "General helpful actions that expose stats and internals to SimpleRPC clients",
             :author      => "R.I.Pienaar <rip@devco.net>",
             :license     => "Apache License, Version 2.0",
-            :version     => "1.0.0",
+            :version     => "0.19.0",
             :url         => "https://choria.io/",
-            :timeout     => 10
+            :timeout     => 2
 
 action "collective_info", :description => "Info about the main and sub collectives" do
     display :always
@@ -52,6 +52,10 @@ action "inventory", :description => "System Inventory" do
     output :data_plugins,
            :description => "List of data plugin names",
            :display_as => "Data Plugins"
+
+    output :machines,
+           :description => "Autonomous Agents",
+           :display_as => "Machines"
 end
 
 action "get_fact", :description => "Retrieve a single fact from the fact store" do
@@ -61,9 +65,9 @@ action "get_fact", :description => "Retrieve a single fact from the fact store"
            :prompt      => "The name of the fact",
            :description => "The fact to retrieve",
            :type        => :string,
-           :validation  => '^[\w\-\.]+$',
+           :validation  => '.+',
            :optional    => false,
-           :maxlength   => 40
+           :maxlength   => 512
 
      output :fact,
             :description => "The name of the fact being returned",

data/lib/mcollective/agent/rpcutil.json

@@ -0,0 +1,333 @@
+{
+  "$schema": "https://choria.io/schemas/mcorpc/ddl/v1/agent.json",
+  "metadata": {
+    "name": "rpcutil",
+    "description": "General helpful actions that expose stats and internals to SimpleRPC clients",
+    "author": "R.I.Pienaar <rip@devco.net>",
+    "license": "Apache License, Version 2.0",
+    "version": "0.19.0",
+    "url": "https://choria.io/",
+    "timeout": 2
+  },
+  "actions": [
+    {
+      "action": "agent_inventory",
+      "input": {
+      },
+      "output": {
+        "agents": {
+          "description": "List of agents on the server",
+          "display_as": "Agents",
+          "default": null
+        }
+      },
+      "display": "always",
+      "description": "Inventory of all agents on the server"
+    },
+    {
+      "action": "collective_info",
+      "input": {
+      },
+      "output": {
+        "main_collective": {
+          "description": "The main Collective",
+          "display_as": "Main Collective",
+          "default": null
+        },
+        "collectives": {
+          "description": "All Collectives",
+          "display_as": "All Collectives",
+          "default": null
+        }
+      },
+      "display": "always",
+      "description": "Info about the main and sub collectives",
+      "aggregate": [
+        {
+          "function": "summary",
+          "args": [
+            "collectives"
+          ]
+        }
+      ]
+    },
+    {
+      "action": "daemon_stats",
+      "input": {
+      },
+      "output": {
+        "threads": {
+          "description": "List of threads active in the daemon",
+          "display_as": "Threads",
+          "default": null
+        },
+        "agents": {
+          "description": "List of agents loaded",
+          "display_as": "Agents",
+          "default": null
+        },
+        "pid": {
+          "description": "Process ID of the daemon",
+          "display_as": "PID",
+          "default": null
+        },
+        "times": {
+          "description": "Processor time consumed by the daemon",
+          "display_as": "Times",
+          "default": null
+        },
+        "validated": {
+          "description": "Messages that passed security validation",
+          "display_as": "Security Validated",
+          "default": null
+        },
+        "unvalidated": {
+          "description": "Messages that failed security validation",
+          "display_as": "Failed Security",
+          "default": null
+        },
+        "passed": {
+          "description": "Passed filter checks",
+          "display_as": "Passed Filter",
+          "default": null
+        },
+        "filtered": {
+          "description": "Didn't pass filter checks",
+          "display_as": "Failed Filter",
+          "default": null
+        },
+        "starttime": {
+          "description": "Time the server started",
+          "display_as": "Start Time",
+          "default": null
+        },
+        "total": {
+          "description": "Total messages received",
+          "display_as": "Total Messages",
+          "default": null
+        },
+        "replies": {
+          "description": "Replies sent back to clients",
+          "display_as": "Replies",
+          "default": null
+        },
+        "configfile": {
+          "description": "Config file used to start the daemon",
+          "display_as": "Config File",
+          "default": null
+        },
+        "version": {
+          "description": "MCollective Version",
+          "display_as": "Version",
+          "default": null
+        },
+        "ttlexpired": {
+          "description": "Messages that did pass TTL checks",
+          "display_as": "TTL Expired",
+          "default": null
+        }
+      },
+      "display": "always",
+      "description": "Get statistics from the running daemon",
+      "aggregate": [
+        {
+          "function": "summary",
+          "args": [
+            "version"
+          ]
+        },
+        {
+          "function": "summary",
+          "args": [
+            "agents"
+          ]
+        }
+      ]
+    },
+    {
+      "action": "get_config_item",
+      "input": {
+        "item": {
+          "prompt": "Configuration Item",
+          "description": "The item to retrieve from the server",
+          "type": "string",
+          "default": null,
+          "optional": false,
+          "validation": "^.+$",
+          "maxlength": 50
+        }
+      },
+      "output": {
+        "item": {
+          "description": "The config property being retrieved",
+          "display_as": "Property",
+          "default": null
+        },
+        "value": {
+          "description": "The value that is in use",
+          "display_as": "Value",
+          "default": null
+        }
+      },
+      "display": "always",
+      "description": "Get the active value of a specific config property",
+      "aggregate": [
+        {
+          "function": "summary",
+          "args": [
+            "value"
+          ]
+        }
+      ]
+    },
+    {
+      "action": "get_data",
+      "input": {
+        "source": {
+          "prompt": "Data Source",
+          "description": "The data plugin to retrieve information from",
+          "type": "string",
+          "default": null,
+          "optional": false,
+          "validation": "^\\w+$",
+          "maxlength": 50
+        },
+        "query": {
+          "prompt": "Query",
+          "description": "The query argument to supply to the data plugin",
+          "type": "string",
+          "default": null,
+          "optional": true,
+          "validation": "^.+$",
+          "maxlength": 200
+        }
+      },
+      "output": {
+      },
+      "display": "always",
+      "description": "Get data from a data plugin"
+    },
+    {
+      "action": "get_fact",
+      "input": {
+        "fact": {
+          "prompt": "The name of the fact",
+          "description": "The fact to retrieve",
+          "type": "string",
+          "default": null,
+          "optional": false,
+          "validation": ".+",
+          "maxlength": 512
+        }
+      },
+      "output": {
+        "fact": {
+          "description": "The name of the fact being returned",
+          "display_as": "Fact",
+          "default": null
+        },
+        "value": {
+          "description": "The value of the fact",
+          "display_as": "Value",
+          "default": null
+        }
+      },
+      "display": "always",
+      "description": "Retrieve a single fact from the fact store",
+      "aggregate": [
+        {
+          "function": "summary",
+          "args": [
+            "value"
+          ]
+        }
+      ]
+    },
+    {
+      "action": "get_facts",
+      "input": {
+        "facts": {
+          "prompt": "Comma-separated list of facts",
+          "description": "Facts to retrieve",
+          "type": "string",
+          "default": null,
+          "optional": false,
+          "validation": "^\\s*[\\w\\.\\-]+(\\s*,\\s*[\\w\\.\\-]+)*$",
+          "maxlength": 200
+        }
+      },
+      "output": {
+        "values": {
+          "description": "List of values of the facts",
+          "display_as": "Values",
+          "default": null
+        }
+      },
+      "display": "always",
+      "description": "Retrieve multiple facts from the fact store"
+    },
+    {
+      "action": "inventory",
+      "input": {
+      },
+      "output": {
+        "agents": {
+          "description": "List of agent names",
+          "display_as": "Agents",
+          "default": null
+        },
+        "facts": {
+          "description": "List of facts and values",
+          "display_as": "Facts",
+          "default": null
+        },
+        "classes": {
+          "description": "List of classes on the system",
+          "display_as": "Classes",
+          "default": null
+        },
+        "version": {
+          "description": "MCollective Version",
+          "display_as": "Version",
+          "default": null
+        },
+        "main_collective": {
+          "description": "The main Collective",
+          "display_as": "Main Collective",
+          "default": null
+        },
+        "collectives": {
+          "description": "All Collectives",
+          "display_as": "All Collectives",
+          "default": null
+        },
+        "data_plugins": {
+          "description": "List of data plugin names",
+          "display_as": "Data Plugins",
+          "default": null
+        },
+        "machines": {
+          "description": "Autonomous Agents",
+          "display_as": "Machines",
+          "default": null
+        }
+      },
+      "display": "always",
+      "description": "System Inventory"
+    },
+    {
+      "action": "ping",
+      "input": {
+      },
+      "output": {
+        "pong": {
+          "description": "The local timestamp",
+          "display_as": "Timestamp",
+          "default": null
+        }
+      },
+      "display": "always",
+      "description": "Responds to requests for PING with PONG"
+    }
+  ]
+}

data/lib/mcollective/agent/scout.ddl

@@ -0,0 +1,169 @@
+metadata :name        => "scout",
+         :description => "Choria Scout Agent Management API",
+         :author      => "R.I.Pienaar <rip@devco.net>",
+         :license     => "Apache-2.0",
+         :version     => "0.0.1",
+         :url         => "https://choria.io",
+         :provider    => "golang",
+         :timeout     => 5
+
+
+action "checks", :description => "Obtain a list of checks and their current status" do
+  display :ok
+
+
+
+  output :checks,
+         :description => "Details about each check",
+         :type        => "array",
+         :display_as  => "Checks"
+
+end
+
+action "resume", :description => "Resume active checking of one or more checks" do
+  display :failed
+
+  input :checks,
+        :prompt      => "Checks",
+        :description => "Check to resume, empty means all",
+        :type        => :array,
+        :optional    => true
+
+
+
+
+  output :failed,
+         :description => "List of checks that could not be resumed",
+         :type        => "array",
+         :display_as  => "Failed"
+
+  output :skipped,
+         :description => "List of checks that was skipped",
+         :type        => "array",
+         :display_as  => "Skipped"
+
+  output :transitioned,
+         :description => "List of checks that were resumed",
+         :type        => "array",
+         :display_as  => "Triggered"
+
+end
+
+action "maintenance", :description => "Pause checking of one or more checks" do
+  display :failed
+
+  input :checks,
+        :prompt      => "Checks",
+        :description => "Check to pause, empty means all",
+        :type        => :array,
+        :optional    => true
+
+
+
+
+  output :failed,
+         :description => "List of checks that could not be paused",
+         :type        => "array",
+         :display_as  => "Failed"
+
+  output :skipped,
+         :description => "List of checks that was skipped",
+         :type        => "array",
+         :display_as  => "Skipped"
+
+  output :transitioned,
+         :description => "List of checks that were paused",
+         :type        => "array",
+         :display_as  => "Triggered"
+
+end
+
+action "goss_validate", :description => "Performs a Goss validation using a specific file" do
+  display :failed
+
+  input :file,
+        :prompt      => "Goss File",
+        :description => "Path to the Goss validation specification",
+        :type        => :string,
+        :validation  => '.+',
+        :maxlength   => 256,
+        :optional    => false
+
+
+  input :vars,
+        :prompt      => "Vars File",
+        :description => "Path to a file to use as template variables",
+        :type        => :string,
+        :validation  => '.+',
+        :maxlength   => 256,
+        :optional    => true
+
+
+
+
+  output :failures,
+         :description => "The number of tests that failed",
+         :type        => "integer",
+         :display_as  => "Failed Tests"
+
+  output :results,
+         :description => "The full test results",
+         :type        => "array",
+         :display_as  => "Results"
+
+  output :runtime,
+         :description => "The time it took to run the tests, in seconds",
+         :type        => "integer",
+         :display_as  => "Runtime"
+
+  output :success,
+         :description => "Indicates if the test passed",
+         :type        => "string",
+         :display_as  => "Success"
+
+  output :summary,
+         :description => "A human friendly test result",
+         :type        => "string",
+         :display_as  => "Summary"
+
+  output :tests,
+         :description => "The number of tests that were run",
+         :type        => "integer",
+         :display_as  => "Tests"
+
+  summarize do
+    aggregate summary(:tests, :format => "%s Test Cases on %d node(s)")
+    aggregate summary(:failures, :format => "%s Failed Cases on %d node(s)")
+    aggregate summary(:success, :format => "%s Passed Cases on %d node(s)")
+  end
+end
+
+action "trigger", :description => "Force an immediate check of one or more checks" do
+  display :failed
+
+  input :checks,
+        :prompt      => "Checks",
+        :description => "Check to trigger, empty means all",
+        :type        => :array,
+        :optional    => true
+
+
+
+
+  output :failed,
+         :description => "List of checks that could not be triggered",
+         :type        => "array",
+         :display_as  => "Failed"
+
+  output :skipped,
+         :description => "List of checks that was skipped",
+         :type        => "array",
+         :display_as  => "Skipped"
+
+  output :transitioned,
+         :description => "List of checks that were triggered",
+         :type        => "array",
+         :display_as  => "Triggered"
+
+end
+