cfcm 0.0.5 → 0.0.6

data/README.md

@@ -1,17 +1,64 @@
-cloudfoundry-chaos-monkey
-=========================
+#cloudfoundry-chaos-monkey
 
 Chaos Monkey style service for Cloud Foundry
 
-Using Cloud Foundry Chaos Monkey
---------------------------------
+##Using Cloud Foundry Chaos Monkey
 
 First off, grab the Cloud Foundry Chaos Monkey gem
 
-`gem install cfcm`
+```gem install cfcm```
 
-and then unleash the monkey! In this example, we'll use CFCM on an application named `myapp`, keeping between 2 and 5 instances. We want CFCM to have a 30% chance of adding or removing an instance every 10 seconds. Adding and removeing instances is known as "soft mode", that is, this is equvilant to doing "vmc instane [app] -1". There is a "hard mode" planned that is a bit more chaotic.
+and then unleash the monkey! 
 
-`cfcm soft [email] [password] myapp --min 2 --max 5 -p 30 -f 10`
+### Soft Mode
+Soft mode will simply remove/add instances at random. This uses the standard VMC APIs and you can specify the minimum and maximum number of instances the app may have.
 
-It's as easy as that!
+In this example, we'll use CFCM on an application named `myapp`, keeping between 2 and 5 instances. We want CFCM to have a 30% chance of adding or removing an instance every 10 seconds. Adding and removeing instances is known as "soft mode", that is, this is equvilant to doing "vmc instane [app] -1".
+
+```cfcm soft [email] [password] myapp --min 2 --max 5 -p 30 -f 10```
+
+### Hard Mode
+
+Hard mode gets a bit more bananas. BOSH-inspired, there is an IaaS-layer shim that sits between CFCM and your virtual machines. Currently, the following IaaS layers are supported...
+
+- vSphere
+
+and the following are planned...
+
+- AWS
+- OpenStack
+- BOSH (I realize this is a bit odd, but this will allow some interesting things in addition to straight IaaS)
+
+As with BOSH, my goal is to allow the community to add their on IaaS layer. There's simply two commands that will be needed though; Power On and Power Off
+
+There are two files that will be needed to run Hard Mode, a config file and an input file. The config file will contain the configuration specific to the IaaS you're targeting. The input file will list the VMs that are valid targets for CFCM. For vSphere, an example ```config.yml``` file would look like...
+
+<pre>
+host: 127.0.0.1
+user: john_doe
+password: p@ssw0rd
+datacenter: Monkey Island
+</pre>
+
+and a sample ```input.list``` file would look like...
+
+<pre>
+cf-cfcm-testing-dea-001
+cf-cfcm-testing-dea-002
+cf-cfcm-testing-dea-003
+cf-cfcm-testing-dea-004
+cf-cfcm-testing-dea-005
+</pre>
+
+Note: These don't JUST have to be DEAs. Really, CFCM could be used to rip VMs out from any distributed systems. This could be other pieces of Cloud Foundry (Service Gateways, Cloud Controllers, Routers, etc.) or for something completely unrelated to Cloud Foundry (AD servers? Replica database servers?)
+
+Then to unleash the monkey on your infrastructure, attempting to hit the VMs every 10 seconds with a 30% chance of taking out a VM, run...
+
+```cfcm hard --iaas vsphere -c config.yml -i input.list -f 10 -p 30```
+
+## To-Do
+
+- Add option to add/remove more than one instance/VM at a time
+- Implement the remaining IaaS layers
+- Provide a proper interface for the community to insert an IaaS layer
+- Add the ability to specify min/max VMs to be powered on for Hard Mode, including if we should power VMs back on (i.e. We shut down a DEA last time, let's power it back on and power off a Router)

data/lib/cfcm/cli.rb

@@ -64,6 +64,7 @@ module CFCM
       method_option :config, :aliases => ["--config", "-c"], :type => :string, :desc => "Path to IaaS config YML file (See Documentation)"
       method_option :probability, :aliases => ["--probability", "-p"], :type => :numeric, :desc => "[1-100] Probablity for the Chaos Monkey to add/remove an instance (Default: 10)"
       method_option :frequency, :aliases => ["--frequency", "-f"], :type => :numeric, :desc => "Number of seconds between attempts to add/remove an instance (Default: 10)"
+      method_option :dry_run, :aliases => ["--dry-run", "-d"], :type => :boolean, :desc => "Simply output the actions that would be taken, do not perform them"
       def hard(probability = 10, frequency = 10)
         if (!options[:iaas] || !options[:input] || !options[:config])
           CFCM::Monkey::HardMonkey.new.show_help
@@ -79,8 +80,13 @@ module CFCM
           if options[:frequency]
             frequency = options[:frequency]
           end
-          
-          monkey = CFCM::Monkey::HardMonkey.new(options[:iaas], options[:config], options[:input], probability, frequency)
+          dry_run = false
+          if (options[:dry_run])
+            dry_run = true
+          end
+                    
+          puts "Awakening the monkey on your #{options[:iaas]} infrastructure with a #{probability}% chance of chaos every #{frequency} second#{frequency > 1? "s" : ""}"
+          monkey = CFCM::Monkey::HardMonkey.new(options[:iaas], options[:config], options[:input], probability, frequency, dry_run)
           monkey.start
         end
       end

data/lib/cfcm/monkey.rb

@@ -60,10 +60,11 @@ module CFCM
         puts "Description coming soon"
       end
       
-      def initialize(iaas, config_file, input_file, probability, frequency)
+      def initialize(iaas, config_file, input_file, probability, frequency, dry_run = false)
         
         @probability = probability
         @frequency = frequency
+        @dry_run = dry_run
         
         # Parse the config file
         @config = YAML.load_file(config_file)
@@ -90,7 +91,11 @@ module CFCM
             if (Random.rand(100) + 1) <= @probability
               vm = @input.sample
               puts "Sending Power Off to #{vm}"
-              @iaas_interface.power_off_vm(vm)
+              if @dry_run
+                puts "Power Off not sent -- runing in dry run mode"
+              else
+                @iaas_interface.power_off_vm(vm)
+              end
             end
           end
         end

data/lib/cfcm/version.rb

@@ -1,3 +1,3 @@
 module CFCM
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cfcm
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-05 00:00:00.000000000 Z
+date: 2012-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor