eb_deployer 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a339b19fefcb73b8a72dc75be71acdd5c687e51d
-  data.tar.gz: 20ab402493ce588c41f77193d65ff54bad160f05
+  metadata.gz: 737e66cde134b8ec8983b1dfc500adedab3cf526
+  data.tar.gz: 9e54bffac3fbd172d2f4d36a15aa4dc9502d6210
 SHA512:
-  metadata.gz: 029d124d285bcf266aa87313399ad9eb6badcf08a4f305b89ae0811dbbe7ec9dc29c8896f8965108fca94aea22b028cba32f175c80f93f9b276f86a0fee38a50
-  data.tar.gz: 75e13ca3c1f39f06a81b0db7be58b1d2da79852aeceb4d06af9ad5d5379d90696534c0168e6382cf2ecdd320ce00a210c7d5bd26876492a5ae27ea19b5bd941d
+  metadata.gz: 1efa091565e68ddee6a383bb6c9b343199a40aaf4f381a8bd96faac1b38c4a390aba3fce924e6e45b79d5fe165fbace47dea0d81246b96050de6123f4aff905a
+  data.tar.gz: 678ceb2f2fa5f752b133edabbb451c8a9fb5d459bf86e51e95c20065b985cd047aa85f6ac5008065ee84e52521778771f7bc6226ae51c26b52f9385e51c19972

data/README.md

@@ -1,11 +1,9 @@
-# EbDeployer [![Build Status](https://snap-ci.com/ThoughtWorksStudios/eb_deployer/branch/master/build_image)](https://snap-ci.com/ThoughtWorksStudios/eb_deployer/branch/master) [![Build Status](https://travis-ci.org/ThoughtWorksStudios/eb_deployer.png?branch=master)](https://travis-ci.org/ThoughtWorksStudios/eb_deployer) [![Gem Version](https://badge.fury.io/rb/eb_deployer.svg)](http://badge.fury.io/rb/eb_deployer)
+# EbDeployer [![Build Status](https://snap-ci.com/ThoughtWorksStudios/eb_deployer/branch/master/build_image)](https://snap-ci.com/ThoughtWorksStudios/eb_deployer/branch/master) [![Build Status](https://travis-ci.org/ThoughtWorksStudios/eb_deployer.png?branch=master)](https://travis-ci.org/ThoughtWorksStudios/eb_deployer) [![Gem Version](https://badge.fury.io/rb/eb_deployer.svg)](http://badge.fury.io/rb/eb_deployer) [![Dependency Status](https://www.versioneye.com/ruby/eb_deployer/0.6.1/badge.svg)](https://www.versioneye.com/ruby/eb_deployer/0.6.1)
 
 [Built with :yellow_heart: and :coffee: in San Francisco](http://www.thoughtworks.com/mingle/team/)
 
 Low friction deployments should be a breeze. Elastic Beanstalk provides a great foundation for performing Blue-Green deployments, and EbDeployer add a missing link to automate the whole flow out of box.
 
-EbDeployer thus allows you to do continuous delivery on AWS.
-
 [Deploy Service by EbDeployer](http://www.thoughtworks.com/mingle/infrastructure/2015/06/01/deploy-service-by-ebdeployer.html)
 
 ## Installation
@@ -93,18 +91,26 @@ Take a look at code if you can not wait for the documentation.
 
 ### eb_deploy.yml configuration file
 
-Like Rails database.yml file, EbDeployer will read eb_deploy.yml file as ERB template file. So you can trade it as standard ERB template file, and substitute Ruby script.
+Like Rails database.yml file, EbDeployer will read eb_deploy.yml file as ERB template file. So you can trade it as standard ERB template file, and substitute Ruby script. For example, the following eb_deployer.yml file partial configures DBPassword parameter for your CloudFormation template from an environment variable:
+
+    resources:
+      template: config/my_rds.json
+      inputs:
+        DBPassword: <%= ENV['MYDBPASSWORD'] %>
 
-By default, EbDeployer provides the following methods:
+
+EbDeployer also provides the following help methods for convenience:
 
 1. random_hash: it basically is `SecureRandom.hex[0..9]`
 2. package_digest: it is your eb package file digest
-3. environment: environment name you passed in when executing eb_deploy script.
+3. environment: environment name you passed in when executing eb_deploy script using -e option.
 
 ## More
 
 [Automated zero downtime deployment to AWS Elastic Beanstalk for Rails with EbDeployer](http://helabs.com/blog/2015/05/19/automated-zero-downtime-deployment-to-aws-elastic-beanstalk-for-rails-with-eb-deployer/?utm_content=buffer12098&utm_medium=social&utm_source=twitter.com&utm_campaign=buffer)
 
+Co-presented session with Amazon ElasticBeanstalk team at AWS re:Invent 2013: [slideshare](http://www.slideshare.net/AmazonWebServices/aws-elastic-beanstalk-under-the-hood-dmg301-aws-reinvent-2013-28428616) and [video (starting at 27:46)](http://www.youtube.com/watch?v=U06-QLd4FL4)
+
 [Deploy Service by EbDeployer](http://www.thoughtworks.com/mingle/infrastructure/2015/06/01/deploy-service-by-ebdeployer.html)
 
 [Rails 3/4 Support](https://github.com/ThoughtWorksStudios/eb_deployer/wiki/Rails-3-Support)
@@ -113,10 +119,11 @@ By default, EbDeployer provides the following methods:
 
 [Introduction to EbDeployer](http://getmingle.io/scaling/2014/06/13/introduction-to-eb-deployer.html)
 
-AWS re:Invent 2013: [slideshare](http://www.slideshare.net/AmazonWebServices/aws-elastic-beanstalk-under-the-hood-dmg301-aws-reinvent-2013-28428616) and [video (starting at 27:46)](http://www.youtube.com/watch?v=U06-QLd4FL4)
-
 [Papertrail Solution for Rails Applications on ElasticBeanstalk
 ](http://www.thoughtworks.com/mingle/infrastructure/2015/06/10/simple-solution-for-papertrail-on-elasticbeanstalk.html)
+
+[Elastic Beanstalk Tips and Tricks](https://github.com/ThoughtWorksStudios/eb_deployer/wiki/Elastic-Beanstalk-Tips-and-Tricks) (* recommended to read for new Elastic Beanstalk users )
+
 ## Contributing
 
 1. Fork it

data/lib/eb_deployer/application.rb

@@ -68,9 +68,9 @@ module EbDeployer
         begin
           log("Removing #{version}")
           @eb_driver.delete_application_version(@name, version, delete_from_s3)
-        rescue AWS::ElasticBeanstalk::Errors::SourceBundleDeletionFailure => e
+        rescue Aws::ElasticBeanstalk::Errors::SourceBundleDeletionFailure => e
           log(e.message)
-        rescue AWS::ElasticBeanstalk::Errors::OperationInProgressFailure => e
+        rescue Aws::ElasticBeanstalk::Errors::OperationInProgressFailure => e
           log(e.message)
         end
       end

data/lib/eb_deployer/deployment_strategy/blue_green.rb

@@ -6,13 +6,16 @@ module EbDeployer
       end
 
       def test_compatibility(env_create_options)
+        @create_opts = env_create_options
         tier = env_create_options[:tier]
+
         if tier && tier.downcase == 'worker'
           raise "Blue green deployment is not supported for Worker tier"
         end
       end
 
       def deploy(version_label, env_settings, inactive_settings=[])
+
         if !ebenvs.any?(&method(:active_ebenv?))
           ebenv('a', @component.cname_prefix).
             deploy(version_label, env_settings)
@@ -24,7 +27,32 @@ module EbDeployer
 
         inactive_ebenv.deploy(version_label, env_settings)
         active_ebenv.swap_cname_with(inactive_ebenv)
-        unless inactive_settings.empty?
+
+        blue_green_terminate_inactive       = @create_opts[:blue_green_terminate_inactive]
+        blue_green_terminate_inactive_wait  = @create_opts[:blue_green_terminate_inactive_wait]
+        blue_green_terminate_inactive_sleep = @create_opts[:blue_green_terminate_inactive_sleep]
+
+        if blue_green_terminate_inactive
+          active_ebenv.log("Waiting #{blue_green_terminate_inactive_wait}s before terminating environment...")
+
+          # Loop until timeout reached or environment becomes Red
+          count = 0
+          loop do
+            break if count >= blue_green_terminate_inactive_wait or inactive_ebenv.health_state != 'Green'
+            sleep blue_green_terminate_inactive_sleep
+            count += blue_green_terminate_inactive_sleep
+          end
+
+          if inactive_ebenv.health_state == 'Green'
+            active_ebenv.log("Active environment healthy, terminating inactive (black) environment")
+            active_ebenv.terminate
+          else
+            active_ebenv.log("Active environment changed state to unhealthy. Existing (black) environment will not be terminated")
+          end
+
+        end
+
+        unless inactive_settings.empty? || blue_green_terminate_inactive
           active_ebenv.log("applying inactive settings...")
           active_ebenv.apply_settings(inactive_settings)
         end

data/lib/eb_deployer/eb_environment.rb

@@ -61,6 +61,10 @@ module EbDeployer
       end
     end
 
+    def health_state
+      @bs.environment_health_state(@app, @name)
+    end
+
     private
 
     def configured_tier

data/lib/eb_deployer/utils.rb

@@ -4,7 +4,7 @@ module EbDeployer
 
     # A util deal with throttling exceptions
     # example:
-    #  backoff(AWS::EC2::Errors::RequestLimitExceeded) do
+    #  backoff(Aws::EC2::Errors::RequestLimitExceeded) do
     #     ...
     #  end
     def backoff(error_class, retry_limit=9, &block)

data/lib/eb_deployer/version.rb

@@ -1,3 +1,3 @@
 module EbDeployer
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

data/lib/eb_deployer.rb

@@ -95,7 +95,7 @@ module EbDeployer
   #   will terminate the old elastic beanstalk environment and recreate on
   #   deploy. For blue-green deployment it terminate the inactive environment
   #   first then recreate it. This is useful to avoiding configuration drift and
-  #   accumulating state on the EC2 instances. Also it has the benifit of keeping
+  #   accumulating state on the EC2 instances. Also it has the benefit of keeping
   #   your EC2 instance system package upto date, because everytime EC2 instance
   #   boot up from AMI it does a system update.
   #
@@ -204,6 +204,9 @@ module EbDeployer
         :cname_prefix =>  opts[:cname_prefix],
         :smoke_test => opts[:smoke_test],
         :phoenix_mode => opts[:phoenix_mode],
+        :blue_green_terminate_inactive => opts[:blue_green_terminate_inactive] || false,
+        :blue_green_terminate_inactive_wait => opts[:blue_green_terminate_inactive_wait] || 600,
+        :blue_green_terminate_inactive_sleep => opts[:blue_green_terminate_inactive_sleep] || 15,
         :tags => opts[:tags],
         :tier => opts[:tier]
       }
@@ -302,7 +305,7 @@ module EbDeployer
         require 'aws-sdk'
         logger = Logger.new($stdout)
         logger.level = Logger::DEBUG
-        Aws.config[:logger] = logger
+        Aws.config.update(:logger => logger)
       end
 
       opts.on("-h", "--help", "help")  do

data/lib/generators/eb_deployer/install/install_generator.rb

@@ -59,7 +59,7 @@ YAML
       end
 
       def solution_stack_name
-        AWS::ElasticBeanstalk.Client.new.list_available_solution_stacks[:solution_stacks].find do |s|
+        Aws::ElasticBeanstalk.Client.new.list_available_solution_stacks[:solution_stacks].find do |s|
           s =~ /Amazon Linux/ && s =~ /running Ruby 2.1 \(Passenger Standalone\)/
         end
       rescue

data/lib/generators/eb_deployer/install/templates/eb_deployer.yml.erb

@@ -37,6 +37,21 @@ common:
   # you override it to 'on' for production environment.
   # phoenix_mode: false
 
+  # Terminates the inactive stack upon successful blue-green deployment.
+  # This is useful if you require HA deployment but don't want the cost of running
+  # a stack that is not in use. See https://github.com/ThoughtWorksStudios/eb_deployer/pull/44/
+  # for other strategies that can be employed.
+  # Note: As EB Deployer uses DNS to switch between stacks, this should be used only if you
+  #       both put in a sufficient wait period and accept the risk that traffic may still be
+  #       going to the inactive stack when it is terminated, due to client DNS caching, for example.
+  #blue_green_terminate_inactive: false
+
+  # How long to wait before terminating the inactive stack if 'blue_green_terminate_inactive' is set to true.
+  #blue_green_terminate_inactive_wait: 600
+
+  # How often to check for changes to the inactive stack during the 'blue_green_terminate_inactive_wait' period.
+  #blue_green_terminate_inactive_sleep: 15
+
   # Specifies the maximum number of versions to keep. Older versions are removed
   # and deleted from the S3 source bucket as well. If specified as zero or not
   # specified, all versions will be kept.  If a version_prefix is given, only removes

data/test/blue_green_deploy_test.rb

@@ -39,6 +39,13 @@ class BlueGreenDeployTest < DeployTest
                   'simple-production-inactive.elasticbeanstalk.com'], smoked_host
   end
 
+  def test_blue_green_deploy_should_blue_green_terminate_inactive_env_if_blue_green_terminate_inactive_is_enabled
+    do_deploy(42, :blue_green_terminate_inactive => true, :blue_green_terminate_inactive_wait => 1, :blue_green_terminate_inactive_sleep => 1)
+    do_deploy(43, :blue_green_terminate_inactive => true, :blue_green_terminate_inactive_wait => 0, :blue_green_terminate_inactive_sleep => 0)
+
+    inactive_env = t('production-a', 'simple')
+    assert_equal [inactive_env], @eb.environments_been_deleted('simple')
+  end
 
   def test_blue_green_deployment_should_delete_and_recreate_inactive_env_if_phoenix_mode_is_enabled
     do_deploy(42, :phoenix_mode => true)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eb_deployer
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - wpc
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-27 00:00:00.000000000 Z
+date: 2015-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk