vagrant-orchestrate 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc2a1392e8001d976648512c3639ccf0bfa02422
-  data.tar.gz: d2fca53a34f4ebbb9353d5bcf084034cff22f47f
+  metadata.gz: aa8ac72aee45a656c1a9e60a575c995075ddb053
+  data.tar.gz: a242a2fbad92acb639515f796ca8543989f07f05
 SHA512:
-  metadata.gz: e432897d4477f5907b39f65ed709899a194cc5a537c808ca83cf15ee6206a6c8f5118b059c2ab673ebce14fce864979fb75dee4d4b2bc947232fec7934fffcb0
-  data.tar.gz: e010c6132a1ee981a681228c111edae7b0318d52d17d059b9744a251257e13093a708ce309c375f5d31f9e0ccc8b81df51c3843ddc716f37bec315d22ff568a5
+  metadata.gz: f6f36cc9190db80c3f91676533aa0e0f3856e0547dc88b62fda842ad3a413d0a4ca1389104bf2aa764d9946753e1b1bb895a76ee0d20a36255ef30a94ec3ea29
+  data.tar.gz: 303e98568405ab411a3e405d35c0b7aee9c1144480385afbc48f726ee05f0343ea50b95fbebd7c262f296415b71e40d73a282012690d943ecaf2304b0bf28ceb

data/.rubocop.yml

@@ -5,6 +5,9 @@ AllCops:
 Metrics/LineLength:
   Max: 120
 
+Metrics/ClassLength:
+  Max: 150
+
 Style/Documentation:
   Enabled: false
 

data/README.md

@@ -262,7 +262,7 @@ The push command is currently limited by convention to vagrant machines that use
 
 #### Deployment Strategy
 
-Vagrant Orchestrate supports several deployment [strategies](docs/strategies.md), including parallel and
+Vagrant Orchestrate supports several deployment [strategies](docs/strategy.md) including parallel, canary and
 blue-green.
 
 You can push changes to all of your servers in parallel with

data/docs/strategy.md

@@ -1,29 +1,13 @@
 # Deployment Strategies
 
-Vagrant Orchestrate supports several deployment strategies, including parallel and
+Vagrant Orchestrate supports several deployment strategies including parallel and
 blue-green. Here we'll cover how to use the various strategies as well as describing
 situations when each might be useful.
 
-## Specifying a strategy
-
-### Command line
-
-Strategies can be passed on the command line with the `--strategy` parameter
-
-    $ vagrant orchestrate push --strategy parallel
-
-### Vagrantfile configuration
-
-Alternatively, you can specify the deployment strategy in your Vagrantfile
-
-    config.orchestrate.strategy = :parallel
-
-Command line parameters take precedence over Vagrantfile set configuration values.
-
 ## Strategies
 
 ### Serial (default)
-This will deploy to the target servers one at a time. This can be useful if you
+Deploy to the target servers one at a time. This can be useful if you
 have a small number servers, or if you need to keep the majority of your servers
 online in order to support your application's load.
 
@@ -33,8 +17,8 @@ online in order to support your application's load.
 
 
 ### Parallel
-This strategy will deploy to all of the target servers at the same time. This is
-useful if you want to minimize the amount of time that an overall deployment takes.
+Deploy to all of the target servers at the same time. This is
+useful if you want to minimize the total amount of time that an deployment takes.
 Depending on how you've written your provisioners, this could cause downtime for
 the application that is being deployed.
 
@@ -43,8 +27,7 @@ the application that is being deployed.
     config.orchestrate.strategy = :parallel
 
 ### Canary
-The canary strategy will deploy to a single server, provide an opportunity to
-test the deployed server, and then deploy the remainder of the servers in parallel.
+Deploy to a single server, pause to allow for testing, and then deploy the remainder of the servers in parallel.
 This is a great opportunity to test one node of your cluster before blasting your
 changes out to them all. This can be particularly useful when combined with post
 provision [trigger](https://github.com/emyl/vagrant-triggers) to run a smoke test.
@@ -56,36 +39,58 @@ provision [trigger](https://github.com/emyl/vagrant-triggers) to run a smoke tes
 ### Blue Green
 The [Blue Green](http://martinfowler.com/bliki/BlueGreenDeployment.html) deployment
 strategy deploys to half of the cluster in parallel, then the other half, with
-a pause in between. This doesn't manage any of your load balancing or networking
-configuraiton for you, but if your application has a healthcheck that your load
+a pause in between. This won't manage any of your load balancing or networking
+configuration for you, but if your application has a healthcheck that your load
 balancer respects, it should be easy to turn it off at the start of your provisioning
 and back on at the end. If your application can serve the load on half of its nodes
 then this will be the best blend of getting the deployment done quickly and maintaining
-a working application.
+a running application. If the total number of target servers is odd then the smaller
+number will be deployed to first.
 
     $ vagrant orchestrate push --strategy blue_green
 
     config.orchestrate.strategy = :blue_green
 
 ### Canary Blue Green
-This strategy simply combines the two immediately above - deploying to a single
-server, pausing, then to half the cluster in parallel, pausing, and then the remainder,
-also in parallel. Good if you have a large number of servers and want to do a
+Combines the two immediately above - deploying to a single
+server, pausing, then to half of the remaining cluster in parallel, pausing, and then the other half,
+also in parallel. This is good if you have a large number of servers and want to do a
 smoke test of a single server before committing to pushing to half of your farm.
 
     $ vagrant orchestrate push --strategy canary_blue_green
 
 		config.orchestrate.strategy = :canary_blue_green
 
+## Specifying a strategy
+
+### Command line
+
+Strategies can be passed on the command line with the `--strategy` parameter
+
+    $ vagrant orchestrate push --strategy parallel
+
+### Vagrantfile configuration
+
+Alternatively, you can specify the deployment strategy in your Vagrantfile
+
+    config.orchestrate.strategy = :parallel
+
+Command line parameters take precedence over configuration values set in the Vagrantfile.
+
+
 ## Suppressing Prompts
 In order to automate the deployment process, it can be very useful to suppress
 prompts. You can achieve that in two ways:
 
-From the command line, add the `--force` or `-f` parameter
+From the command line, add the `--force` or `-f` parameters
 
     $ vagrant orchestrate push --strategy canary -f
 
 
-Within your vagrantfile, set the `force_push` setting to true
+Within your Vagrantfile, set the `force_push` setting to true
 
     config.orchestrate.force_push = true
+
+## Support for other strategies
+If you have ideas for other strategies that you think would be broadly useful,
+open an issue and we'll discuss.

data/lib/vagrant-orchestrate/command/push.rb

@@ -1,6 +1,7 @@
 require "optparse"
 require "vagrant"
 
+# Borrowed from http://stackoverflow.com/questions/12374645/splitting-an-array-into-equal-parts-in-ruby
 class Array
   def in_groups(num_groups)
     return [] if num_groups == 0
@@ -39,7 +40,6 @@ module VagrantPlugins
             end
           end
 
-          # Parse the options
           argv = parse_options(opts)
           return unless argv
 
@@ -54,16 +54,17 @@ module VagrantPlugins
 
           if machines.empty?
             @env.ui.info("No servers with :managed provider found. Skipping.")
-            return
+            return 0
           end
 
-          # This environment variable is used as a signal to the filtermanaged
-          # action so that we don't filter managed commands that are really just
-          # the implementation of a push action.
-
           options[:parallel] = true
           strategy = options[:strategy] || @env.vagrantfile.config.orchestrate.strategy
           @env.ui.info("Pushing to managed servers using #{strategy} strategy.")
+
+          # Handle a couple of them more tricky edges.
+          strategy = :serial if machines.size == 1
+          strategy = :blue_green if strategy.to_sym == :canary_blue_green && machines.size == 2
+
           case strategy.to_sym
           when :serial
             options[:parallel] = false
@@ -75,12 +76,12 @@ module VagrantPlugins
             result = deploy(options, machines.take(1), machines.drop(1))
           when :blue_green
             # Split into two (almost) equal groups
-            groups = machines.in_groups(2)
+            groups = split(machines)
             result = deploy(options, groups.first, groups.last)
           when :canary_blue_green
             # A single canary and then two equal groups
             canary = machines.take(1)
-            groups = machines.drop(1).in_groups(2)
+            groups = split(machines.drop(1))
             result = deploy(options, canary, groups.first, groups.last)
           else
             @env.ui.error("Invalid deployment strategy specified")
@@ -90,12 +91,23 @@ module VagrantPlugins
           return 1 unless result
           0
         end
-        # rubocop:enable Metrics/AbcSize, MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+        def split(machines)
+          groups = machines.in_groups(2)
+          # Move an item from the first to second group if they are unbalanced so that
+          # the smaller group is pushed to first.
+          groups.last.unshift(groups.first.pop) if groups.any? && groups.first.size > groups.last.size
+          groups
+        end
 
         def deploy(options, *groups)
+          groups.select! { |g| g.size > 0 }
           groups.each_with_index do |machines, index|
-            @logger.debug("Orchestrating push to group number #{index + 1} of #{groups.size}.")
-            @logger.debug(" -- Hosts: #{machines.collect { |m| m.name.to_s }.join(',')}")
+            next if machines.empty?
+            if groups.size > 1
+              @env.ui.info("Orchestrating push to group number #{index + 1} of #{groups.size}.")
+              @env.ui.info(" -- Hosts: #{machines.collect { |m| m.name.to_s }.join(',')}")
+            end
             ENV["VAGRANT_ORCHESTRATE_COMMAND"] = "PUSH"
             begin
               batchify(machines, :up, options)
@@ -108,16 +120,19 @@ module VagrantPlugins
             end
 
             # Don't prompt on the last group, that would be annoying
-            unless index == groups.size - 1 || options[:force]
+            if index == groups.size - 1 || options[:force]
+              @logger.debug("Suppressing prompt because --force specified.") if options[:force]
+            else
               return false unless prompt_for_continue
             end
           end
         end
+        # rubocop:enable Metrics/AbcSize, MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
         def prompt_for_continue
           result = @env.ui.ask("Deployment paused for manual review. Would you like to continue? (y/n)")
           if result.upcase != "Y"
-            @env.ui.info("Deployment push action by user")
+            @env.ui.info("Deployment push action cancelled by user")
             return false
           end
           true

data/lib/vagrant-orchestrate/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Orchestrate
-    VERSION = "0.4.0"
+    VERSION = "0.4.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-orchestrate
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Christopher Baldauf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-25 00:00:00.000000000 Z
+date: 2015-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler