rboss 0.1.0 → 0.2.0

data/README.md

@@ -0,0 +1,197 @@
+rboss
+=============
+
+Use this tool to create profiles for JBoss Application Server and use twiddle to scan
+a running JBoss AS or execute scripts.
+
+
+Installation
+-----------
+
+    gem install rboss
+
+Using twiddle
+-----------
+
+### Basics
+
+Simply do a "cd" to your JBoss Home and use it
+
+    twiddle --help
+
+You can scan resources like: datasources, queues, connectors, webapps, ...
+
+    twiddle --datasources --webapps
+    twiddle --all
+
+If you don't need to scan for resources, you can specify them for monitoring:
+
+    twiddle --webapps jmx-console,admin-console
+
+Combine with "watch" to get a simple and instantly monitoring:
+
+    watch --interval=1 twiddle --webapps jmx-console,admin-console
+
+Retrieve property values with --get:
+
+    twiddle --get webapp:jmx-console,maxSessions
+    twiddle --get server_info,FreeMemory
+
+Set values with --set:
+
+    twiddle --set connector:http-127.0.0.1-8080,maxThreads,350
+
+Execute commands with --invoke:
+
+    twiddle --invoke server,shutdown
+    twiddle --invoke web_deployment:jmx-console,stop
+
+Using jboss-profile
+-----------
+
+### Basics
+
+Simply do a "cd" to your JBoss Home and use it
+
+    jboss-profile --help
+
+All configuration can be stored in a single yaml file containing an array of components
+and its configuration:
+
+    - deploy_folder: deploy/datasources
+    - deploy_folder: deploy/apps
+    - jmx
+    - run_conf:
+        :heap_size: 1024m
+        :perm_size: 512m
+        :debug: :socket
+
+You can specify any command-line arguments directly in yaml file:
+
+    - :params:
+        :jboss_home: /home/user/jboss/org/jboss-5
+        :type: org
+        :version: 5.1
+        :base_profile: all
+        :profile: my_profile
+
+### Configuring deploy folders
+
+Use "deploy_folder" component and the desired folder. If the folder starts with a "/" or
+doesn't start with "deploy", the entries in VFS will be added.
+
+    # Will be in $JBOSS_HOME/server/$PROFILE/deploy/application
+    - deploy_folder: deploy/applications
+    # Will be in $JBOSS_HOME/server/$PROFILE/custom/application
+    - deploy_folder: custom/applications
+    - deploy_folder: /opt/deploy
+
+### Configuring jmx
+
+Use "jmx" component:
+
+    # user and password are "admin" by default
+    - jmx
+    - jmx:
+        :user: admin
+        :password: admin
+
+Basically, this will add an entry in the jmx-console-users.properties (depends on JBoss type).
+For JBoss org, this will enable security in jmx-console since the enterprise versions have
+jmx-console security by default.
+
+### Configuring datasources
+
+Use a "datasource" component
+
+Configuration:
+
+:folder => a folder where this datasource will be saved (default: $JBOSS_HOME/server/$CONFIG/deploy)
+if a relative path is given, it will be appended to default value
+:encrypt => a flag to indicate if the password should be encrypted (default: false)
+:type => the type of the datasource
+:name => a name for saving the file (default: :type)
+:attributes => a Hash with the attributes that will be changed in template (the only required is :jndi_name)
+
+Any attribute that is not present in datasource xml will be created using this template: <key>value</key>.
+
+For converting the symbol attributes, the above rules are used taking by example a
+value ":database_url":
+
+1. The value "database_url"
+2. The value "database-url"
+3. The value "DatabaseUrl"
+4. The value "DATABASE_URL"
+
+The key for finding the correct datasource is the configuration attribute :type, which is
+used to search in $JBOSS_HOME/docs/examples/jca for the file.
+
+Any key that is not found in the datasource template will be added. If it is a Symbol,
+the underlines will be converted to hyphens.
+
+For saving the file, the configuration :name will be used in the form "${name}-ds.xml".
+
+Example:
+
+    - datasource:
+      :type: postgres
+      :attributes:
+        :user_name: postgres
+        :password: postgres
+        :connection_url: jdbc:postgresql://localhost:5432/sample_database
+        :min_pool_size: 5
+        :max_pool_size: 15
+
+### Replacing hypersonic
+
+The same as Datasouce, but use the "default_ds" component instead.
+
+    - default_ds:
+      :type: postgres
+      :attributes:
+        :user_name: postgres
+        :password: postgres
+        :connection_url: jdbc:postgresql://localhost:5432/jboss_db
+        :min_pool_size: 5
+        :max_pool_size: 15
+
+### Installing mod_cluster
+
+Use a "mod_cluster" component
+
+Configuration:
+
+:path => where the mod_cluster.sar is located
+:folder => where the mod_cluster.sar should be installed (default: $JBOSS_HOME/server/$CONFIG/deploy)
+
+The additional configurations are the entries in the bean ModClusterConfig (mod_cluster-jboss-beans.xml)
+and can be in a String form (using the entry name) or in a Symbol form (using ruby nomenclature - :sticky_session)
+
+### Configuring run.conf
+
+### Slimming
+
+Use a "slimming" component.
+
+Configuration:
+
+Use an array with the services to remove, the current supported are:
+
+* Admin Console       => :admin_console
+* Web Console         => :web_console
+* Mail Service        => :mail
+* Bsh Deployer        => :bsh_deployer
+* Hot Deploy          => :hot_deploy
+* JUDDI               => :juddi
+* UUID Key Generator  => :key_generator
+* Scheduling          => :scheduling
+* JMX Console         => :jmx_console
+* JBoss WS            => :jboss_ws
+* JMX Remoting        => :jmx_remoting
+* ROOT Page           => :root_page
+
+Any slimmed service will be removed logically by using a ".rej" suffix in the files/directories.
+
+### Configuring jbossweb
+
+### Configuring connectors

data/bin/jboss-profile

@@ -28,7 +28,6 @@ require 'yaml'
 require 'logger'
 
 params = {}
-params[:jboss_home] = Dir.pwd unless ENV["JBOSS_HOME"]
 config = nil
 create = true
 
@@ -71,6 +70,12 @@ end
 opts.on("-h", "--help", "Shows this help message") { puts opts; exit }
 opts.parse!(ARGV) rescue abort 'Invalid Option! Use --help or -h for usage help.'
 
+if params.empty?
+  puts opts
+  exit
+end
+
+params[:jboss_home] ||= Dir.pwd unless ENV["JBOSS_HOME"]
 profile = JBoss::Profile::new params
 
 if config

data/bin/twiddle

@@ -54,7 +54,7 @@ opts.on('--eval EXPRESSION',
         'Evaluates the given expression using the vars twiddle and monitor') do |expression|
   eval_expression = expression
 end
-opts.on('--show-all', 'Shows all resources available') do
+opts.on('--all', 'Shows all resources available') do
   [
     :server_info,
     :deployments,
@@ -97,6 +97,18 @@ opts.on('--system-properties [name_a, name_b, name_c, ...]', Array,
         'Defines the System properties to show or scan if not specified') do |properties|
   resources[:system_properties] = properties || :all
 end
+opts.on('--set resource_type[:resource_name],property,value', Array,
+        'Sets a value to a resource that the monitor knows') do |set|
+  resources[:set] = set
+end
+opts.on('--get resource_type[:resource_name],property', Array,
+        'Gets a value to a resource that the monitor knows') do |get|
+  resources[:get] = get
+end
+opts.on('--invoke resource_type[:resource_name],method,[,args...]', Array,
+        'Invokes a resoruce method') do |invoke|
+  resources[:invoke] = invoke
+end
 opts.on('--list', 'Only lists the required info (datasources, queues, ...)') do
   list_only = true
 end
@@ -123,6 +135,37 @@ eval File.read(exec_file), binding, exec_file if exec_file
 
 puts (eval eval_expression, binding) if eval_expression
 
+def extract resource
+  mbean, name = resource.split(/:/)
+end
+
+if resources[:set]
+  array = resources[:set]
+  raise "Wrong number of arguments" if array.size != 3
+  mbean, name = extract array[0]
+  puts twiddle.set :mbean => mbean.to_sym,
+              :name => name,
+              :property => array[1],
+              :value => array[2]
+end
+if resources[:get]
+  array = resources[:get]
+  raise "Wrong number of arguments" if array.size != 2
+  mbean, name = extract array[0]
+  puts twiddle.get :mbean => mbean.to_sym,
+                   :name => name,
+                   :property => array[1]
+end
+if resources[:invoke]
+  array = resources[:invoke]
+  raise "Wrong number of arguments" if array.size < 2
+  mbean, name = extract array[0]
+  puts twiddle.invoke :mbean => mbean.to_sym,
+                      :name => name,
+                      :method => array[1],
+                      :args => array[2..-1]
+end
+
 if resources[:server_info]
   puts "Server Info:"
   monitor.properties[:server].each do |property|

data/lib/rboss/twiddle/base_monitor.rb

@@ -50,6 +50,28 @@ module JBoss
         monitor.mbean id
       end
 
+      def get params
+        mbean = extract params
+        mbean[params[:property]]
+      end
+
+      def set params
+        mbean = extract params
+        mbean[params[:property]] = params[:value]
+      end
+
+      def invoke params
+        mbean = extract params
+        mbean.send params[:method], *params[:args]
+      end
+
+      private
+
+      def extract params
+        mbean = monitor.mbean params[:mbean]
+        mbean.with params[:name]
+      end
+
     end
 
   end

data/lib/rboss/twiddle/mbean.rb

@@ -47,7 +47,7 @@ module JBoss
       resource = @resource
       env = @env
       query = eval("\"#{pattern}\"")
-      result = @twiddle.invoke(:get, query, property)
+      result = @twiddle.execute(:get, query, property)
       def result.value
         self.split(/=/)[1]
       end
@@ -58,7 +58,7 @@ module JBoss
       resource = @resource
       env = @env
       query = eval("\"#{pattern}\"")
-      @twiddle.invoke :set, query, property, value
+      @twiddle.execute :set, query, property, value
     end
 
     def method_missing(method, *args, &block)
@@ -69,7 +69,7 @@ module JBoss
       resource = @resource
       env = @env
       query = eval("\"#{pattern} #{method}\"")
-      return_value = @twiddle.invoke :invoke, query, args
+      return_value = @twiddle.execute :invoke, query, args
       if block_given?
         block.call return_value
       end

data/lib/rboss/twiddle/monitor.rb

@@ -33,6 +33,9 @@ module JBoss
             :pattern => 'jboss.web:type=Manager,host=localhost,path=/#{resource}',
             :properties => %W(activeSessions maxActive)
           },
+          :web_deployment => {
+            :pattern => 'jboss.web.deployment:war=/#{resource}'
+          },
           :connector => {
             :pattern => 'jboss.web:type=ThreadPool,name=#{resource}',
             :properties => %W(maxThreads currentThreadCount currentThreadsBusy)
@@ -115,12 +118,7 @@ module JBoss
         end
       end
 
-      def mbean mbean_id = nil
-        return get current_scan unless mbean_id
-        mbeans[mbean_id]
-      end
-
-      def get mbean_id
+      def mbean mbean_id
         mbean = mbeans[mbean_id]
         if @current_resource
           mbean.with @current_resource
@@ -128,8 +126,6 @@ module JBoss
         mbean
       end
 
-      alias_method :[], :get
-
       def method_missing(method, *args, &block)
         mbean_id = method
         mbean = mbeans[mbean_id]

data/lib/rboss/twiddle/scanner.rb

@@ -81,7 +81,7 @@ module JBoss
       private
 
       def _query_ query, &block
-        result = @twiddle.invoke(:query, query)
+        result = @twiddle.execute(:query, query)
         return [] if result["No MBean matches for query"]
         result = result.split /\s+/
         block ? result.collect(&block) : result

data/lib/rboss/twiddle/twiddle.rb

@@ -53,16 +53,12 @@ module JBoss
         @jboss_home
       end
 
-      def invoke command, *arguments
-        execute(shell command, arguments)
-      end
-
       def shell operation, *arguments
         "#{command} #{operation} #{arguments.join " "}"
       end
 
-      def execute shell
-        `#{shell}`.chomp
+      def execute command, *arguments
+        `#{shell command, arguments}`.chomp
       end
 
     end

data/lib/rboss/version.rb

@@ -21,5 +21,5 @@
 # THE SOFTWARE.
 
 module RBoss
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/rboss.gemspec

@@ -7,9 +7,10 @@ Gem::Specification.new do |s|
   s.version     = RBoss::VERSION
   s.authors     = ["Ataxexe"]
   s.email       = ["ataxexe@gmail.com"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/ataxexe/rboss"
   s.summary     = %q{A Ruby way to do a JBoss work!}
-  s.description = %q{This gem help you to create a JBoss profile and some other things like building twiddle scripts}
+  s.description = %q{A tool to create profiles for JBoss Application Server and use
+ twiddle to scan a running JBoss AS or execute scripts.}
 
   s.rubyforge_project = "rboss"
 

metadata

@@ -2,7 +2,7 @@
 name: rboss
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Ataxexe
@@ -10,10 +10,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-11 00:00:00 Z
+date: 2011-08-13 00:00:00 Z
 dependencies: []
 
-description: This gem help you to create a JBoss profile and some other things like building twiddle scripts
+description: |-
+  A tool to create profiles for JBoss Application Server and use
+   twiddle to scan a running JBoss AS or execute scripts.
 email: 
 - ataxexe@gmail.com
 executables: 
@@ -26,6 +28,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- README.md
 - Rakefile
 - bin/jboss-profile
 - bin/twiddle
@@ -74,7 +77,7 @@ files:
 - test/mbean_test.rb
 - test/test_helper.rb
 - test/test_suite.rb
-homepage: ""
+homepage: https://github.com/ataxexe/rboss
 licenses: []
 
 post_install_message: