choria-mcorpc-support 2.21.1 → 2.23.1

data/lib/mcollective/agent/bolt_tasks.rb

@@ -0,0 +1,178 @@
+require "mcollective/util/choria"
+require "mcollective/util/tasks_support"
+
+module MCollective
+  module Agent
+    class Bolt_tasks < RPC::Agent
+      action "download" do
+        reply[:downloads] = 0
+
+        tasks = support_factory
+
+        reply.fail!("Received empty or invalid task file specification", 4) unless request[:files]
+
+        files = JSON.parse(request[:files])
+
+        if tasks.cached?(files)
+          reply[:downloads] = 0
+        elsif tasks.download_files(files)
+          reply[:downloads] = files.size
+        else
+          reply.fail!("Could not download task %s files: %s" % [request[:task], $!.to_s], 1)
+        end
+      end
+
+      action "run_and_wait" do
+        tasks = support_factory
+
+        unless tasks.tasks_compatible?
+          msg = "Cannot execute Bolt tasks as the node does not meet the minimum compatability requirements"
+          reply[:stdout] = make_error(msg, "choria/not_compatible", {}).to_json
+          reply.fail!(msg, 5)
+        end
+
+        reply[:task_id] = request.uniqid
+
+        task = {
+          "task" => request[:task],
+          "input_method" => request[:input_method],
+          "input" => request[:input],
+          "files" => JSON.parse(request[:files]),
+          "run_as" => request[:run_as]
+        }
+
+        unless tasks.cached?(task["files"])
+          msg = "Task %s is not available or does not match the specification" % task["task"]
+          reply[:stdout] = make_error(msg, "choria/invalid_cache", {}).to_json
+          reply.fail!(msg, 5)
+        end
+
+        status = nil
+
+        # Wait for near the timeout and on timeout give up and fetch the
+        # status so users can get good replies that include how things are
+        # near timeout
+        begin
+          Timeout.timeout(timeout - 2) do
+            status = tasks.run_task_command(reply[:task_id], task, true, request.caller)
+          end
+        rescue Timeout::Error
+          status = tasks.task_status(reply[:task_id])
+        ensure
+          reply_task_status(status) if status
+        end
+      end
+
+      action "run_no_wait" do
+        tasks = support_factory
+
+        unless tasks.tasks_compatible?
+          msg = "Cannot execute Bolt tasks as the node does not meet the minimum compatability requirements"
+          reply[:stdout] = make_error(msg, "choria/not_compatible", {}).to_json
+          reply.fail!(msg, 5)
+        end
+
+        reply[:task_id] = request.uniqid
+
+        task = {
+          "task" => request[:task],
+          "input_method" => request[:input_method],
+          "input" => request[:input],
+          "files" => JSON.parse(request[:files]),
+          "run_as" => request[:run_as]
+        }
+
+        status = tasks.run_task_command(reply[:task_id], task, false, request.caller)
+
+        unless status["wrapper_spawned"]
+          msg = "Could not spawn task %s: %s" % [request[:task], status["wrapper_error"]]
+          reply[:stdout] = make_error(msg, "choria/wrapper_failed", "error" => status["wrapper_error"]).to_json
+          reply.fail!(msg, 5)
+        end
+      end
+
+      action "task_status" do
+        tasks = support_factory
+
+        unless tasks.task_ran?(request[:task_id])
+          msg = "Task %s have not been run" % request[:task_id]
+          reply[:stdout] = make_error(msg, "choria/unknown_task", "taskid" => request[:task_id]).to_json
+          reply.fail!(msg, 3)
+        end
+
+        begin
+          status = tasks.task_status(request[:task_id])
+        rescue
+          reply[:stdout] = make_error($!.to_s, "choria/status_failed", "taskid" => request[:task_id]).to_json
+          reply.fail!($!.to_s, 5)
+        end
+
+        if caller_only_status? && request.caller != status["caller"]
+          reply[:stdout] = make_error($!.to_s, "choria/not_own_request", "taskid" => request[:task_id]).to_json
+          reply.fail!($!.to_s, 5)
+        end
+
+        reply_task_status(status)
+
+        reply.fail!("Could not spawn task %s: %s" % [request[:task], status["wrapper_error"]]) if reply.statuscode == 0 && !status["wrapper_spawned"]
+      end
+
+      def caller_only_status?
+        Util.str_to_bool(@config.pluginconf.fetch("choria.tasks.own_status_only", "true"))
+      end
+
+      def make_error(msg, kind, detail)
+        {
+          "_error" => {
+            "msg" => msg,
+            "kind" => kind,
+            "details" => detail
+          }
+        }
+      end
+
+      def support_factory
+        Util::Choria.new.tasks_support
+      end
+
+      # Performs an additional authorization and audit using the task name as action
+      def before_processing_hook(msg, connection)
+        original_action = request.action
+        task = request[:task]
+
+        begin
+          if ["run_and_wait", "run_no_wait"].include?(original_action) && task
+            request.action = task
+
+            begin
+              authorization_hook(request) if respond_to?("authorization_hook")
+            rescue
+              raise(RPCAborted, "You are not authorized to run Bolt Task %s" % task)
+            end
+
+            audit_request(request, connection)
+          end
+        ensure
+          request.action = original_action
+        end
+      end
+
+      def reply_task_status(status)
+        reply[:exitcode] = status["exitcode"]
+        reply[:stdout] = status["stdout"].to_json
+        reply[:stderr] = status["stderr"]
+        reply[:completed] = status["completed"]
+        reply[:runtime] = status["runtime"]
+        reply[:start_time] = status["start_time"].to_i
+        reply[:task] = status["task"]
+        reply[:callerid] = status["caller"]
+
+        if status["stdout"]["_error"]
+          reply.fail("%s: %s" % [status["stdout"]["_error"]["kind"], status["stdout"]["_error"]["msg"]])
+        elsif support_factory.task_failed?(status)
+          reply.fail("Task failed without any error details", 1)
+        end
+      end
+    end
+  end
+end

data/lib/mcollective/agent/choria_util.ddl

@@ -0,0 +1,152 @@
+metadata    :name        => "choria_util",
+            :description => "Choria Utilities",
+            :author      => "R.I.Pienaar <rip@devco.net>",
+            :license     => "Apache-2.0",
+            :version     => "0.19.0",
+            :url         => "https://choria.io",
+            :timeout     => 2
+
+requires :mcollective => "2.9.0"
+
+action "machine_transition", :description => "Attempts to force a transition in a hosted Choria Autonomous Agent" do
+  input :instance,
+        :prompt => "Instance ID",
+        :description => "Machine Instance ID",
+        :type => :string,
+        :validation => '^.+-.+-.+-.+-.+$',
+        :maxlength => 36,
+        :optional => true
+
+  input :version,
+        :prompt => "Version",
+        :description => "Machine Version",
+        :type => :string,
+        :validation => '^\d+\.\d+\.\d+$',
+        :maxlength => 20,
+        :optional => true
+
+  input :name,
+        :prompt => "Name",
+        :description => "Machine Name",
+        :type => :string,
+        :validation => '^[a-zA-Z][a-zA-Z0-9_-]+',
+        :maxlength => 128,
+        :optional => true
+
+  input :path,
+        :prompt => "Path",
+        :description => "Machine Path",
+        :type => :string,
+        :validation => '.+',
+        :maxlength => 512,
+        :optional => true
+
+  input :transition,
+        :prompt => "Transition Name",
+        :description => "The transition event to send to the machine",
+        :type => :string,
+        :validation => '^[a-zA-Z][a-zA-Z0-9_-]+$',
+        :maxlength => 128,
+        :optional => false
+
+  output :success,
+         :description => "Indicates if the transition was successfully accepted",
+         :display_as => "Accepted"
+end
+
+action "machine_states", :description => "States of the hosted Choria Autonomous Agents" do
+  display :always
+
+  output :machine_names,
+         :description => "List of running machine names",
+         :display_as => "Machine Names"
+
+  output :machine_ids,
+         :description => "List of running machine IDs",
+         :display_as => "Machine IDs"
+
+  output :states,
+         :description => "Hash map of machine statusses indexed by machine ID",
+         :display_as => "Machine States"
+
+  summarize do
+    aggregate summary(:machine_names)
+  end
+end
+
+action "info", :description => "Choria related information from the running Daemon and Middleware" do
+  output :security,
+         :description => "Security Provider plugin",
+         :display_as => "Security Provider"
+
+  output :secure_protocol,
+         :description => "If the protocol is running with PKI security enabled",
+         :display_as => "Protocol Secure"
+
+  output :connector,
+         :description => "Connector plugin",
+         :display_as => "Connector"
+
+  output :connector_tls,
+         :description => "If the connector is running with TLS security enabled",
+         :display_as => "Connector TLS"
+
+  output :path,
+         :description => "Active OS PATH",
+         :display_as => "Path"
+
+  output :choria_version,
+         :description => "Choria version",
+         :display_as => "Choria Version"
+
+  output :client_version,
+         :description => "Middleware client library version",
+         :display_as => "Middleware Client Library Version"
+
+  output :client_flavour,
+         :description => "Middleware client gem flavour",
+         :display_as => "Middleware Client Flavour"
+
+  output :client_options,
+         :description => "Active Middleware client gem options",
+         :display_as => "Middleware Client Options"
+
+  output :connected_server,
+         :description => "Connected middleware server",
+         :display_as => "Connected Broker"
+
+  output :client_stats,
+         :description => "Middleware client gem statistics",
+         :display_as => "Middleware Client Stats"
+
+  output :facter_domain,
+         :description => "Facter domain",
+         :display_as => "Facter Domain"
+
+  output :facter_command,
+         :description => "Command used for Facter",
+         :display_as => "Facter"
+
+  output :srv_domain,
+         :description => "Configured SRV domain",
+         :display_as => "SRV Domain"
+
+  output :using_srv,
+         :description => "Indicates if SRV records are considered",
+         :display_as => "SRV Used"
+
+  output :middleware_servers,
+         :description => "Middleware Servers configured or discovered",
+         :display_as => "Middleware"
+
+  summarize do
+    aggregate summary(:choria_version)
+    aggregate summary(:client_version)
+    aggregate summary(:client_flavour)
+    aggregate summary(:connected_server)
+    aggregate summary(:srv_domain)
+    aggregate summary(:using_srv)
+    aggregate summary(:secure_protocol)
+    aggregate summary(:connector_tls)
+  end
+end

data/lib/mcollective/agent/choria_util.json

@@ -0,0 +1,244 @@
+{
+  "$schema": "https://choria.io/schemas/mcorpc/ddl/v1/agent.json",
+  "metadata": {
+    "name": "choria_util",
+    "description": "Choria Utilities",
+    "author": "R.I.Pienaar <rip@devco.net>",
+    "license": "Apache-2.0",
+    "version": "0.19.0",
+    "url": "https://choria.io",
+    "timeout": 2
+  },
+  "actions": [
+    {
+      "action": "info",
+      "input": {
+      },
+      "output": {
+        "security": {
+          "description": "Security Provider plugin",
+          "display_as": "Security Provider",
+          "default": null
+        },
+        "secure_protocol": {
+          "description": "If the protocol is running with PKI security enabled",
+          "display_as": "Protocol Secure",
+          "default": null
+        },
+        "connector": {
+          "description": "Connector plugin",
+          "display_as": "Connector",
+          "default": null
+        },
+        "connector_tls": {
+          "description": "If the connector is running with TLS security enabled",
+          "display_as": "Connector TLS",
+          "default": null
+        },
+        "path": {
+          "description": "Active OS PATH",
+          "display_as": "Path",
+          "default": null
+        },
+        "choria_version": {
+          "description": "Choria version",
+          "display_as": "Choria Version",
+          "default": null
+        },
+        "client_version": {
+          "description": "Middleware client library version",
+          "display_as": "Middleware Client Library Version",
+          "default": null
+        },
+        "client_flavour": {
+          "description": "Middleware client gem flavour",
+          "display_as": "Middleware Client Flavour",
+          "default": null
+        },
+        "client_options": {
+          "description": "Active Middleware client gem options",
+          "display_as": "Middleware Client Options",
+          "default": null
+        },
+        "connected_server": {
+          "description": "Connected middleware server",
+          "display_as": "Connected Broker",
+          "default": null
+        },
+        "client_stats": {
+          "description": "Middleware client gem statistics",
+          "display_as": "Middleware Client Stats",
+          "default": null
+        },
+        "facter_domain": {
+          "description": "Facter domain",
+          "display_as": "Facter Domain",
+          "default": null
+        },
+        "facter_command": {
+          "description": "Command used for Facter",
+          "display_as": "Facter",
+          "default": null
+        },
+        "srv_domain": {
+          "description": "Configured SRV domain",
+          "display_as": "SRV Domain",
+          "default": null
+        },
+        "using_srv": {
+          "description": "Indicates if SRV records are considered",
+          "display_as": "SRV Used",
+          "default": null
+        },
+        "middleware_servers": {
+          "description": "Middleware Servers configured or discovered",
+          "display_as": "Middleware",
+          "default": null
+        }
+      },
+      "display": "failed",
+      "description": "Choria related information from the running Daemon and Middleware",
+      "aggregate": [
+        {
+          "function": "summary",
+          "args": [
+            "choria_version"
+          ]
+        },
+        {
+          "function": "summary",
+          "args": [
+            "client_version"
+          ]
+        },
+        {
+          "function": "summary",
+          "args": [
+            "client_flavour"
+          ]
+        },
+        {
+          "function": "summary",
+          "args": [
+            "connected_server"
+          ]
+        },
+        {
+          "function": "summary",
+          "args": [
+            "srv_domain"
+          ]
+        },
+        {
+          "function": "summary",
+          "args": [
+            "using_srv"
+          ]
+        },
+        {
+          "function": "summary",
+          "args": [
+            "secure_protocol"
+          ]
+        },
+        {
+          "function": "summary",
+          "args": [
+            "connector_tls"
+          ]
+        }
+      ]
+    },
+    {
+      "action": "machine_states",
+      "input": {
+      },
+      "output": {
+        "machine_names": {
+          "description": "List of running machine names",
+          "display_as": "Machine Names",
+          "default": null
+        },
+        "machine_ids": {
+          "description": "List of running machine IDs",
+          "display_as": "Machine IDs",
+          "default": null
+        },
+        "states": {
+          "description": "Hash map of machine statusses indexed by machine ID",
+          "display_as": "Machine States",
+          "default": null
+        }
+      },
+      "display": "always",
+      "description": "States of the hosted Choria Autonomous Agents",
+      "aggregate": [
+        {
+          "function": "summary",
+          "args": [
+            "machine_names"
+          ]
+        }
+      ]
+    },
+    {
+      "action": "machine_transition",
+      "input": {
+        "instance": {
+          "prompt": "Instance ID",
+          "description": "Machine Instance ID",
+          "type": "string",
+          "default": null,
+          "optional": true,
+          "validation": "^.+-.+-.+-.+-.+$",
+          "maxlength": 36
+        },
+        "version": {
+          "prompt": "Version",
+          "description": "Machine Version",
+          "type": "string",
+          "default": null,
+          "optional": true,
+          "validation": "^\\d+\\.\\d+\\.\\d+$",
+          "maxlength": 20
+        },
+        "name": {
+          "prompt": "Name",
+          "description": "Machine Name",
+          "type": "string",
+          "default": null,
+          "optional": true,
+          "validation": "^[a-zA-Z][a-zA-Z0-9_-]+",
+          "maxlength": 128
+        },
+        "path": {
+          "prompt": "Path",
+          "description": "Machine Path",
+          "type": "string",
+          "default": null,
+          "optional": true,
+          "validation": ".+",
+          "maxlength": 512
+        },
+        "transition": {
+          "prompt": "Transition Name",
+          "description": "The transition event to send to the machine",
+          "type": "string",
+          "default": null,
+          "optional": false,
+          "validation": "^[a-zA-Z][a-zA-Z0-9_-]+$",
+          "maxlength": 128
+        }
+      },
+      "output": {
+        "success": {
+          "description": "Indicates if the transition was successfully accepted",
+          "display_as": "Accepted",
+          "default": null
+        }
+      },
+      "display": "failed",
+      "description": "Attempts to force a transition in a hosted Choria Autonomous Agent"
+    }
+  ]
+}