engineyard-visualvm 0.5.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+/.vagrant

data/Gemfile

@@ -0,0 +1,16 @@
+#--
+# Copyright (c) 2011 Engine Yard, Inc.
+# See the file LICENSE.txt included with the distribution for
+# software license details.
+#++
+
+source "http://rubygems.org"
+
+group :development do
+  gem "vagrant"
+  gem "chef"
+
+  gem "jmx", :platform => :jruby
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,23 @@
+engineyard-visualvm is provided under the terms of the MIT license.
+
+engineyard-visualvm (c) 2011 Engine Yard, Inc.
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation files
+(the "Software"), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of the Software,
+and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,102 @@
+# engineyard-visualvm
+
+`engineyard-visualvm` is a command-line utility for use with JRuby and
+Engine Yard Cloud that makes it easy to connect Visual VM on a desktop
+to a running JRuby or Java process in EY Cloud.
+
+## Usage
+
+To start Visual VM on your local machine to an already-running process:
+
+    # Connect by EY Cloud environment and account
+    $ ey-visualvm start --environment=jruby --account=example
+
+(If you need to see a list of available environments and their
+associated accounts, use the `ey environments` command from the
+[engineyard](/engineyard/engineyard) gem.)
+
+You can also use the `engineyard-visualvm` gem to connect Visual VM to
+any host where you have an available ssh connection.
+
+    # Connect by hostname:
+    $ ey-visualvm start --host=deploy@example.com      
+
+To connect to a server, the server must be booted with some additional
+JVM arguments. These can be generated on the server side with:
+
+    $ ey-visualvm jvmargs
+    -Dorg.jruby.ext.jmx.agent.port=5900 -javaagent:/path/to/engineyard-visualvm/agent.jar
+
+The server JVM binds to the loopback interface and listens on port
+5900 by default. If you want to use a different interface and/or port
+than the default, pass `--host=<host-or-ip>` or `--port=<port>` to
+`ey-visualvm jvmargs`.
+
+## Acceptance Test
+
+To verify that a JMX connection to a server can be established, we can
+use Vagrant and Chef to bootstrap a VM, start a JRuby process with JMX
+enabled, create an ssh tunnel to the Vagrant box, and use the `jmx`
+gem to connect to it from Ruby code. The code for this looks like
+this:
+
+```ruby
+require 'childprocess'
+require 'jmx'
+
+sh "vagrant ssh_config > ssh_config.tmp"
+sh "vagrant up"
+at_exit { sh "vagrant halt"; rm_f "ssh_config.tmp" }
+
+@host, @port = 'localhost', 5900
+
+ssh = ChildProcess.build("ssh", "-NL", "#{@port}:#{@host}:#{@port}", "-F", "ssh_config.tmp", "default")
+ssh.start
+at_exit { ssh.stop }
+
+require 'engineyard-visualvm'
+include EngineYard::VisualVM::Helpers
+server = JMX::MBeanServer.new jmx_service_url
+
+runtime_config_name = server.query_names('org.jruby:type=Runtime,name=*,service=Config').to_a.first
+puts "Found runtime #{runtime_config_name}"
+runtime_config = server[runtime_config_name]
+puts "Runtime version: #{runtime_config['VersionString']}"
+puts "OK"
+```
+
+To try it yourself, do the following:
+
+    # Ensure you have vagrant and jmx installed
+    $ bundle install
+
+    # Run the acceptance test
+    $ rake acceptance
+    vagrant ssh_config > ssh_config.tmp
+    vagrant up
+    # ... bunch of output as the VM boots and Chef runs...
+    [default] [Tue, 22 Nov 2011 19:52:41 -0800] INFO: execute[start server] ran successfully
+    [Tue, 22 Nov 2011 19:52:41 -0800] INFO: Chef Run complete in 35.157236 seconds
+    [Tue, 22 Nov 2011 19:52:41 -0800] INFO: Running report handlers
+    [Tue, 22 Nov 2011 19:52:41 -0800] INFO: Report handlers complete
+    : stdout
+    Found runtime org.jruby:type=Runtime,name=25292276,service=Config
+    Runtime version: jruby 1.6.5 (ruby-1.8.7-p330) (2011-10-25 9dcd388) (Java HotSpot(TM) Client VM 1.6.0_26) [linux-i386-java]
+    OK
+    vagrant halt
+    [default] Attempting graceful shutdown of linux...
+    rm -f ssh_config.tmp
+
+## Bits and Pieces
+
+- Gem: `gem install engineyard-visualvm`
+- Source: https://github.com/engineyard/engineyard-visualvm
+- License: MIT; see LICENSE.txt for details.
+
+## TODO
+
+- Prompt for a JVM to connect to if more than one JVM process is
+  running on the server
+- Data collected by `jstatd` is not yet supported, so things like the
+  Visual GC tab are not supported yet.
+- Additional utilities to make use of the JMX connection remotely

data/Rakefile

@@ -0,0 +1,76 @@
+#--
+# Copyright (c) 2011 Engine Yard, Inc.
+# See the file LICENSE.txt included with the distribution for
+# software license details.
+#++
+
+require "bundler/gem_tasks"
+require "rake/clean"
+
+desc "Compile and jar the agent extension class"
+begin
+  require 'ant'
+  jar_file = "lib/engineyard-visualvm/agent.jar"
+  directory "pkg/classes"
+  CLEAN << "pkg"
+
+  file jar_file => FileList['ext/**/*.java', 'pkg/classes'] do
+    rm_rf FileList['pkg/classes/**/*']
+    ant.javac :srcdir => "ext", :destdir => "pkg/classes",
+      :source => "1.5", :target => "1.5", :debug => true,
+      :classpath => "${java.class.path}:${sun.boot.class.path}",
+      :includeantRuntime => false
+
+    ant.jar :basedir => "pkg/classes", :destfile => jar_file, :includes => "**/*.class" do
+      manifest do
+        attribute :name => "Premain-Class", :value => "org.jruby.ext.jmx.Agent"
+      end
+    end
+  end
+
+  task :jar => jar_file
+rescue LoadError
+  task :jar do
+    puts "Run 'jar' with JRuby to re-compile the agent extension class"
+  end
+end
+
+# Make sure jar gets compiled before the gem is built
+task :build => :jar
+
+task :default => :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :spec => :jar
+
+begin
+  require 'childprocess'
+  require 'jmx'
+  task :acceptance => :build do
+    sh "vagrant ssh_config > ssh_config.tmp"
+    sh "vagrant up"
+    at_exit { sh "vagrant halt"; rm_f "ssh_config.tmp" }
+
+    @host, @port = 'localhost', 5900
+
+    ssh = ChildProcess.build("ssh", "-NL", "#{@port}:#{@host}:#{@port}", "-F", "ssh_config.tmp", "default")
+    ssh.start
+    at_exit { ssh.stop }
+
+    require 'engineyard-visualvm'
+    include EngineYard::VisualVM::Helpers
+    server = JMX::MBeanServer.new jmx_service_url
+
+    runtime_config_name = server.query_names('org.jruby:type=Runtime,name=*,service=Config').to_a.first
+    puts "Found runtime #{runtime_config_name}"
+    runtime_config = server[runtime_config_name]
+    puts "Runtime version: #{runtime_config['VersionString']}"
+    puts "OK"
+  end
+rescue LoadError
+  task :acceptance do
+    fail "Run 'acceptance' with JRuby to actually run the test"
+  end
+end

data/Vagrantfile

@@ -0,0 +1,94 @@
+Vagrant::Config.run do |config|
+  # All Vagrant configuration is done here. The most common configuration
+  # options are documented and commented below. For a complete reference,
+  # please see the online documentation at vagrantup.com.
+
+  # Every Vagrant virtual environment requires a box to build off of.
+  config.vm.box = "base"
+
+  # The url from where the 'config.vm.box' box will be fetched if it
+  # doesn't already exist on the user's system.
+  # config.vm.box_url = "http://domain.com/path/to/above.box"
+
+  # Boot with a GUI so you can see the screen. (Default is headless)
+  # config.vm.boot_mode = :gui
+
+  # Assign this VM to a host only network IP, allowing you to access it
+  # via the IP.
+  config.vm.network "33.33.33.10"
+
+  # Forward a port from the guest to the host, which allows for outside
+  # computers to access the VM, whereas host only networking does not.
+  # config.vm.forward_port "http", 80, 8080
+
+  # Share an additional folder to the guest VM. The first argument is
+  # an identifier, the second is the path on the guest to mount the
+  # folder, and the third is the path on the host to the actual folder.
+  # config.vm.share_folder "v-data", "/vagrant_data", "../data"
+
+  # Enable provisioning with Puppet stand alone.  Puppet manifests
+  # are contained in a directory path relative to this Vagrantfile.
+  # You will need to create the manifests directory and a manifest in
+  # the file base.pp in the manifests_path directory.
+  #
+  # An example Puppet manifest to provision the message of the day:
+  #
+  # # group { "puppet":
+  # #   ensure => "present",
+  # # }
+  # #
+  # # File { owner => 0, group => 0, mode => 0644 }
+  # #
+  # # file { '/etc/motd':
+  # #   content => "Welcome to your Vagrant-built virtual machine!
+  # #               Managed by Puppet.\n"
+  # # }
+  #
+  # config.vm.provision :puppet do |puppet|
+  #   puppet.manifests_path = "manifests"
+  #   puppet.manifest_file  = "base.pp"
+  # end
+
+  # Enable provisioning with chef solo, specifying a cookbooks path (relative
+  # to this Vagrantfile), and adding some recipes and/or roles.
+  #
+  # config.vm.provision :chef_solo do |chef|
+  #   chef.cookbooks_path = "cookbooks"
+  #   chef.add_recipe "mysql"
+  #   chef.add_role "web"
+  #
+  #   # You may also specify custom JSON attributes:
+  #   chef.json = { :mysql_password => "foo" }
+  # end
+  config.vm.provision :chef_solo do |chef|
+    chef.cookbooks_path = "cookbooks"
+    chef.add_recipe("vagrant_main")
+  end
+
+  # Enable provisioning with chef server, specifying the chef server URL,
+  # and the path to the validation key (relative to this Vagrantfile).
+  #
+  # The Opscode Platform uses HTTPS. Substitute your organization for
+  # ORGNAME in the URL and validation key.
+  #
+  # If you have your own Chef Server, use the appropriate URL, which may be
+  # HTTP instead of HTTPS depending on your configuration. Also change the
+  # validation key to validation.pem.
+  #
+  # config.vm.provision :chef_client do |chef|
+  #   chef.chef_server_url = "https://api.opscode.com/organizations/ORGNAME"
+  #   chef.validation_key_path = "ORGNAME-validator.pem"
+  # end
+  #
+  # If you're using the Opscode platform, your validator client is
+  # ORGNAME-validator, replacing ORGNAME with your organization name.
+  #
+  # IF you have your own Chef Server, the default validation client name is
+  # chef-validator, unless you changed the configuration.
+  #
+  #   chef.validation_client_name = "ORGNAME-validator"
+end
+
+# Local Variables:
+# mode: ruby
+# End:

data/bin/ey-visualvm

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+#
+# Copyright (c) 2011 Engine Yard, Inc.
+# See the file LICENSE.txt included with the distribution for
+# software license details.
+
+require 'engineyard-visualvm'
+
+EngineYard::VisualVM::CLI.start

data/cookbooks/apt/README.md

@@ -0,0 +1,122 @@
+Description
+===========
+
+This cookbook includes recipes to execute apt-get update to ensure the local APT package cache is up to date or manage apt-cacher and cacher clients. It also includes a LWRP for managing APT repositories in /etc/apt/sources.list.d.
+
+Recipes
+=======
+
+default
+-------
+
+This recipe installs the `update-notifier-common` package to provide the timestamp file used to only run `apt-get update` if the cache is less than one day old.
+
+This recipe should appear first in the run list of Debian or Ubuntu nodes to ensure that the package cache is up to date before managing any `package` resources with Chef.
+
+This recipe also sets up a local cache directory for preseeding packages.
+
+cacher
+------
+
+Installs the apt-cacher package and service so the system can provide APT caching. You can check the usage report at http://{hostname}:3142/report. The cacher recipe includes the `cacher-client` recipe, so it helps seed itself.
+
+cacher-client
+-------------
+Configures the node to use the apt-cacher server as a client.
+
+Resources/Providers
+===================
+
+This LWRP provides an easy way to manage additional APT repositories. Adding a new repository will notify running the `execute[apt-get-update]` resource.
+
+# Actions
+
+- :add: creates a repository file and builds the repository listing
+- :remove: removes the repository file
+
+# Attribute Parameters
+
+- repo_name: name attribute. The name of the channel to discover
+- uri: the base of the Debian distribution
+- distribution: this is usually your release's codename...ie something like `karmic`, `lucid` or `maverick`
+- components: package groupings..when it doubt use `main`
+- deb_src: whether or not to add the repository as a source repo as well
+- key_server: the GPG keyserver where the key for the repo should be retrieved
+- key: if a `key_server` is provided, this is assumed to be the fingerprint, otherwise it is the URI to the GPG key for the repo
+
+# Examples
+
+    # add the Zenoss repo
+    apt_repository "zenoss" do
+      uri "http://dev.zenoss.org/deb"
+      components ["main","stable"]
+      action :add
+    end
+    
+    # add the Nginx PPA; grab key from keyserver
+    apt_repository "nginx-php" do
+      uri "http://ppa.launchpad.net/nginx/php5/ubuntu"
+      distribution node['lsb']['codename']
+      components ["main"]
+      keyserver "keyserver.ubuntu.com"
+      key "C300EE8C"
+      action :add
+    end
+    
+    # add the Cloudkick Repo
+    apt_repository "cloudkick" do
+      uri "http://packages.cloudkick.com/ubuntu"
+      distribution node['lsb']['codename']
+      components ["main"]
+      key "http://packages.cloudkick.com/cloudkick.packages.key"
+      action :add
+    end
+    
+    # remove Zenoss repo
+    apt_repository "zenoss" do
+      action :remove
+    end
+    
+Usage
+=====
+
+Put `recipe[apt]` first in the run list. If you have other recipes that you want to use to configure how apt behaves, like new sources, notify the execute resource to run, e.g.:
+
+    template "/etc/apt/sources.list.d/my_apt_sources.list" do
+      notifies :run, resources(:execute => "apt-get update"), :immediately
+    end
+
+The above will run during execution phase since it is a normal template resource, and should appear before other package resources that need the sources in the template.
+
+Put `recipe[apt::cacher]` in the run_list for a server to provide APT caching and add `recipe[apt::cacher-client]` on the rest of the Debian-based nodes to take advantage of the caching server.
+
+Changes
+=======
+
+## v1.2.0:
+
+* COOK-136: Limit apt-get update to one run per day unless notified.
+* COOK-471: ignore failure on apt-get update
+* COOK-533: add support for deb and `deb_src` repos with `apt_repository`
+
+License and Author
+==================
+
+Author:: Joshua Timberman (<joshua@opscode.com>)
+Author:: Matt Ray (<matt@opscode.com>)
+Author:: Seth Chisamore (<schisamo@opscode.com>)
+
+Copyright 2009-2011 Opscode, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+