choria-mcorpc-support 2.24.2 → 2.25.1

data/lib/mcollective/agent/rpcutil.json

@@ -2,10 +2,10 @@
   "$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",
+    "description": "Utility actions that expose information about the state of the running Server",
     "author": "R.I.Pienaar <rip@devco.net>",
-    "license": "Apache License, Version 2.0",
-    "version": "0.19.0",
+    "license": "Apache-2.0",
+    "version": "0.23.0",
     "url": "https://choria.io/",
     "timeout": 2
   },
@@ -18,11 +18,11 @@
         "agents": {
           "description": "List of agents on the server",
           "display_as": "Agents",
-          "default": null
+          "type": "array"
         }
       },
       "display": "always",
-      "description": "Inventory of all agents on the server"
+      "description": "Inventory of all agents on the server including versions, licenses and more"
     },
     {
       "action": "collective_info",
@@ -32,16 +32,16 @@
         "main_collective": {
           "description": "The main Collective",
           "display_as": "Main Collective",
-          "default": null
+          "type": "string"
         },
         "collectives": {
           "description": "All Collectives",
           "display_as": "All Collectives",
-          "default": null
+          "type": "array"
         }
       },
       "display": "always",
-      "description": "Info about the main and sub collectives",
+      "description": "Info about the main and sub collectives that the server belongs to",
       "aggregate": [
         {
           "function": "summary",
@@ -57,74 +57,74 @@
       },
       "output": {
         "threads": {
-          "description": "List of threads active in the daemon",
+          "description": "List of threads active in the Choria Server",
           "display_as": "Threads",
-          "default": null
+          "type": "array"
         },
         "agents": {
           "description": "List of agents loaded",
           "display_as": "Agents",
-          "default": null
+          "type": "array"
         },
         "pid": {
-          "description": "Process ID of the daemon",
+          "description": "Process ID of the Choria Server",
           "display_as": "PID",
-          "default": null
+          "type": "integer"
         },
         "times": {
-          "description": "Processor time consumed by the daemon",
+          "description": "Processor time consumed by the Choria Server",
           "display_as": "Times",
-          "default": null
+          "type": "hash"
         },
         "validated": {
-          "description": "Messages that passed security validation",
+          "description": "Count of messages that passed security validation",
           "display_as": "Security Validated",
-          "default": null
+          "type": "integer"
         },
         "unvalidated": {
-          "description": "Messages that failed security validation",
+          "description": "Count of messages that failed security validation",
           "display_as": "Failed Security",
-          "default": null
+          "type": "integer"
         },
         "passed": {
-          "description": "Passed filter checks",
+          "description": "Count of messages that passed filter checks",
           "display_as": "Passed Filter",
-          "default": null
+          "type": "integer"
         },
         "filtered": {
-          "description": "Didn't pass filter checks",
+          "description": "Count of message that didn't pass filter checks",
           "display_as": "Failed Filter",
-          "default": null
+          "type": "integer"
         },
         "starttime": {
-          "description": "Time the server started",
+          "description": "Time the Choria Server started in unix seconds",
           "display_as": "Start Time",
-          "default": null
+          "type": "integer"
         },
         "total": {
-          "description": "Total messages received",
+          "description": "Count of messages received by the Choria Server",
           "display_as": "Total Messages",
-          "default": null
+          "type": "integer"
         },
         "replies": {
-          "description": "Replies sent back to clients",
+          "description": "Count of replies sent back to clients",
           "display_as": "Replies",
-          "default": null
+          "type": "integer"
         },
         "configfile": {
           "description": "Config file used to start the daemon",
           "display_as": "Config File",
-          "default": null
+          "type": "string"
         },
         "version": {
-          "description": "MCollective Version",
+          "description": "Choria Server Version",
           "display_as": "Version",
-          "default": null
+          "type": "string"
         },
         "ttlexpired": {
-          "description": "Messages that did pass TTL checks",
+          "description": "Count of messages that did pass TTL checks",
           "display_as": "TTL Expired",
-          "default": null
+          "type": "integer"
         }
       },
       "display": "always",
@@ -151,22 +151,20 @@
           "prompt": "Configuration Item",
           "description": "The item to retrieve from the server",
           "type": "string",
-          "default": null,
           "optional": false,
           "validation": "^.+$",
-          "maxlength": 50
+          "maxlength": 120
         }
       },
       "output": {
         "item": {
           "description": "The config property being retrieved",
           "display_as": "Property",
-          "default": null
+          "type": "string"
         },
         "value": {
           "description": "The value that is in use",
-          "display_as": "Value",
-          "default": null
+          "display_as": "Value"
         }
       },
       "display": "always",
@@ -187,7 +185,6 @@
           "prompt": "Data Source",
           "description": "The data plugin to retrieve information from",
           "type": "string",
-          "default": null,
           "optional": false,
           "validation": "^\\w+$",
           "maxlength": 50
@@ -202,8 +199,7 @@
           "maxlength": 200
         }
       },
-      "output": {
-      },
+      "output": {},
       "display": "always",
       "description": "Get data from a data plugin"
     },
@@ -224,7 +220,7 @@
         "fact": {
           "description": "The name of the fact being returned",
           "display_as": "Fact",
-          "default": null
+          "type": "string"
         },
         "value": {
           "description": "The value of the fact",
@@ -247,7 +243,7 @@
       "action": "get_facts",
       "input": {
         "facts": {
-          "prompt": "Comma-separated list of facts",
+          "prompt": "Comma-separated list of facts to retrieve",
           "description": "Facts to retrieve",
           "type": "string",
           "default": null,
@@ -260,7 +256,7 @@
         "values": {
           "description": "List of values of the facts",
           "display_as": "Values",
-          "default": null
+          "type": "hash"
         }
       },
       "display": "always",
@@ -274,41 +270,42 @@
         "agents": {
           "description": "List of agent names",
           "display_as": "Agents",
-          "default": null
+          "type": "array"
         },
         "facts": {
           "description": "List of facts and values",
           "display_as": "Facts",
-          "default": null
+          "type": "hash"
         },
         "classes": {
           "description": "List of classes on the system",
           "display_as": "Classes",
-          "default": null
+          "type": "array"
         },
         "version": {
-          "description": "MCollective Version",
+          "description": "Choria Server Version",
           "display_as": "Version",
-          "default": null
+          "type": "string"
         },
         "main_collective": {
           "description": "The main Collective",
           "display_as": "Main Collective",
-          "default": null
+          "type": "string"
         },
         "collectives": {
           "description": "All Collectives",
           "display_as": "All Collectives",
-          "default": null
+          "type": "array"
         },
         "data_plugins": {
           "description": "List of data plugin names",
           "display_as": "Data Plugins",
-          "default": null
+          "type": "array"
         },
         "machines": {
           "description": "Autonomous Agents",
-          "display_as": "Machines"
+          "display_as": "Machines",
+          "type": "hash"
         }
       },
       "display": "always",
@@ -320,9 +317,9 @@
       },
       "output": {
         "pong": {
-          "description": "The local timestamp",
+          "description": "The local Unix timestamp",
           "display_as": "Timestamp",
-          "default": null
+          "type": "string"
         }
       },
       "display": "always",

data/lib/mcollective/agent/scout.ddl

@@ -2,7 +2,7 @@ metadata :name        => "scout",
          :description => "Choria Scout Agent Management API",
          :author      => "R.I.Pienaar <rip@devco.net>",
          :license     => "Apache-2.0",
-         :version     => "0.0.1",
+         :version     => "0.23.0",
          :url         => "https://choria.io",
          :provider    => "golang",
          :timeout     => 5

data/lib/mcollective/agent/scout.json

@@ -5,7 +5,7 @@
     "author": "R.I.Pienaar <rip@devco.net>",
     "timeout": 5,
     "name": "scout",
-    "version": "0.0.1",
+    "version": "0.23.0",
     "url": "https://choria.io",
     "description": "Choria Scout Agent Management API",
     "provider": "golang"

data/lib/mcollective/application/plugin.rb

@@ -8,18 +8,14 @@ mco plugin package [options] <directory>
        mco plugin info <directory>
        mco plugin doc <plugin>
        mco plugin doc <type/plugin>
-       mco plugin generate agent <pluginname> [actions=val,val]
+       mco plugin generate client <ddl> <target>
+       mco plugin generate ddl <json_output> <ruby_output>
 
           info : Display plugin information including package details.
        package : Create all available plugin packages.
            doc : Display documentation for a specific plugin.
     END_OF_USAGE
 
-    option :pluginname,
-           :description => "Plugin name",
-           :arguments => ["-n", "--name NAME"],
-           :type => String
-
     option :postinstall,
            :description => "Post install script",
            :arguments => ["--postinstall POSTINSTALL"],
@@ -66,7 +62,7 @@ mco plugin package [options] <directory>
            :type => :array
 
     option :format,
-           :description => "Package output format. Defaults to rpmpackage or debpackage",
+           :description => "Package output format. Defaults to forge",
            :arguments => ["--format OUTPUTFORMAT"],
            :type => String
 
@@ -80,41 +76,11 @@ mco plugin package [options] <directory>
            :arguments => ["--template HELPTEMPLATE"],
            :type => String
 
-    option :description,
-           :description => "Plugin description",
-           :arguments => ["--description DESCRIPTION"],
-           :type => String
-
-    option :author,
-           :description => "The author of the plugin",
-           :arguments => ["--author AUTHOR"],
-           :type => String
-
-    option :license,
-           :description => "The license under which the plugin is distributed",
-           :arguments => ["--license LICENSE"],
-           :type => String
-
     option :version,
            :description => "The version of the plugin",
            :arguments => ["--pluginversion VERSION"],
            :type => String
 
-    option :url,
-           :description => "Url at which information about the plugin can be found",
-           :arguments => ["--url URL"],
-           :type => String
-
-    option :timeout,
-           :description => "The plugin's timeout",
-           :arguments => ["--timeout TIMEOUT"],
-           :type => Integer
-
-    option :actions,
-           :description => "Actions to be generated for an Agent Plugin",
-           :arguments => ["--actions [ACTIONS]"],
-           :type => Array
-
     option :keep_artifacts,
            :description => "Don't remove artifacts after building packages",
            :arguments => ["--keep-artifacts"],
@@ -131,53 +97,12 @@ mco plugin package [options] <directory>
         configuration[:action] = ARGV.delete_at(0)
 
         configuration[:target] = ARGV.delete_at(0) || "."
-
-        if configuration[:action] == "generate"
-          unless ARGV[0] && ARGV[0].match(/(actions|outputs)=(.+)/i)
-            if configuration[:pluginname] # rubocop:disable Metrics/BlockNesting
-              ARGV.delete_at(0)
-            else
-              configuration[:pluginname] = ARGV.delete_at(0)
-            end
-          end
-
-          ARGV.each do |argument|
-            if argument.match(/(actions|outputs)=(.+)/i)
-              configuration[$1.downcase.to_sym] = $2.split(",")
-            else
-              raise "Could not parse --arg '#{argument}'"
-            end
-          end
-        end
       end
     end
 
-    # Display info about plugin
-    def info_command
-      plugin = prepare_plugin
-      packager = PluginPackager["#{configuration[:format].capitalize}Packager"]
-      packager.new(plugin).package_information
-    end
-
     # Generate a plugin skeleton
     def generate_command
-      raise "undefined plugin type. cannot generate plugin. valid types are 'agent'" if configuration["target"] == "."
-
-      unless configuration[:pluginname]
-        puts "No plugin name specified. Using 'new_plugin'"
-        configuration[:pluginname] = "new_plugin"
-      end
-
-      load_plugin_config_values
-
-      case configuration[:target].downcase
-      when "agent"
-        Generators::AgentGenerator.new(configuration[:pluginname], configuration[:actions], configuration[:pluginname],
-                                       configuration[:description], configuration[:author], configuration[:license],
-                                       configuration[:version], configuration[:url], configuration[:timeout])
-      else
-        raise "invalid plugin type. cannot generate plugin '#{configuration[:target]}'"
-      end
+      puts "CRITICAL: mco plugin generate is deprecated, please use 'choria plugin generate'"
     end
 
     # Package plugin
@@ -211,75 +136,10 @@ mco plugin package [options] <directory>
     end
 
     # Show application list and plugin help
-    def doc_command # rubocop:disable Metrics/MethodLength
-      known_plugin_types = [
-        ["Agents", :agent],
-        ["Aggregate", :aggregate],
-        ["Connectors", :connector],
-        ["Discovery Methods", :discovery],
-        ["Validator Plugins", :validator]
-      ]
-
-      if configuration.include?(:target) && configuration[:target] != "."
-        if configuration[:target] =~ /^(.+?)\/(.+)$/
-          ddl = load_plugin_ddl($2.to_sym, $1)
-        else
-          found_plugin_type = nil
-
-          known_plugin_types.each do |plugin_type|
-            PluginManager.find(plugin_type[1], "ddl").each do |ddlf|
-              pluginname = ddlf.gsub(/_#{plugin_type[1]}$/, "")
-
-              abort "Duplicate plugin name found, please specify a full path like agent/rpcutil" if pluginname == configuration[:target] && found_plugin_type
-
-              found_plugin_type = plugin_type[1] if pluginname == configuration[:target]
-            end
-          end
-
-          abort "Could not find a plugin named '%s' in any supported plugin type" % configuration[:target] unless found_plugin_type
-          ddl = load_plugin_ddl(configuration[:target], found_plugin_type)
-        end
-
-        if ddl
-          puts ddl.help(configuration[:rpctemplate])
-        else
-          abort "Could not find a '%s' plugin named '%s'" % configuration[:target].split("/")
-        end
-
-      else
-        puts "Please specify a plugin. Available plugins are:"
-        puts
-
-        load_errors = []
-
-        known_plugin_types.each do |plugin_type|
-          puts "%s:" % plugin_type[0]
-
-          PluginManager.find(plugin_type[1], "ddl").each do |ddlf|
-            begin
-              help = DDL.new(ddlf, plugin_type[1], false)
+    def doc_command
+      puts "WARNING: mco plugin doc is deprecated, please use choria plugin doc"
 
-              next unless help.client_activated?
-
-              help.loadddlfile
-              pluginname = ddlf.gsub(/_#{plugin_type[1]}$/, "")
-              puts "  %-25s %s" % [pluginname, help.meta[:description]]
-            rescue => e
-              load_errors << [plugin_type[1], ddlf, e]
-            end
-          end
-
-          puts
-        end
-
-        unless load_errors.empty?
-          puts "Plugin Load Errors:"
-
-          load_errors.each do |e|
-            puts "  %-25s %s" % ["#{e[0]}/#{e[1]}", Util.colorize(:yellow, e[2])]
-          end
-        end
-      end
+      exec("choria plugin doc %s" % [configuration[:target]])
     end
 
     # Creates the correct package plugin object.
@@ -341,18 +201,6 @@ mco plugin package [options] <directory>
       File.basename(plugintype[0])
     end
 
-    # Load preset metadata values from config if they are present
-    # This makes it possible to override metadata values in a local
-    # client config file.
-    #
-    # Example : plugin.metadata.license = Apache 2
-    def load_plugin_config_values
-      config = Config.instance
-      [:pluginname, :description, :author, :license, :version, :url, :timeout].each do |confoption|
-        configuration[confoption] = config.pluginconf["metadata.#{confoption}"] unless configuration[confoption]
-      end
-    end
-
     def main
       abort "No action specified, please run 'mco help plugin' for help" unless configuration.include?(:action)