man_eb_deployer 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d74b569ff1c09801c0da3f0ab3208623b3835a8ac4c832cb636f1b159e1188d3
+  data.tar.gz: 78ec8df9ad3a55664347c4611d6aebf051538a974e5298450c934d9b452ca0a7
+SHA512:
+  metadata.gz: 3b246aa4f92ca105e2f2c70328148a47171deffe3cedf3d260e1776d54c349774f7ded4ee7d050a4f06c8ea7713058a022bffea0e0151cd54768ddd346f5c307
+  data.tar.gz: 9c8631e9a8ad3b9fb12af285986896961ca1ace2ce7ac54878c9d5f69eb992b76e1e3bda51db94cf87c9023b9c105f9134a27d7be8dde72b7a34a785cf71fd47

data/.github/workflows/release.yml

@@ -0,0 +1,31 @@
+name: Release
+on:
+  workflow_dispatch: {}
+  push:
+    branches:
+      - master
+permissions:
+  contents: write
+  pull-requests: write
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: google-github-actions/release-please-action@v3
+        id: release
+        with:
+          release-type: ruby
+          package-name: man_eb_deployer
+          version-file: lib/eb_deployer/version.rb
+      - uses: actions/checkout@v4
+      - name: publish to rubygems
+        if: ${{ steps.release.outputs.release_created }}
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build eb_deployer.gemspec
+          gem push man_eb_deployer-*.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/test.yml

@@ -0,0 +1,16 @@
+name: Tests
+
+on:
+  pull_request: {}
+  workflow_dispatch: {}
+
+jobs:
+  test:
+    name: Unit Tests
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@52b8784594ec115fd17094752708121dc5dabb47
+      with:
+        bundler-cache: true
+    - run: bundle exec rake test

data/.gitignore

@@ -0,0 +1,12 @@
+/Gemfile.lock
+/pkg
+/test/tmp
+/tmp
+/.rvmrc
+/samples/jruby_rails4/jruby_rails4.war
+/samples/jruby_rails4/public/assets/*
+/TAGS
+/.aws
+/.bundle
+/vendor
+/*.gem

data/.ruby-gemset

@@ -0,0 +1 @@
+eb_deployer

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/CHANGELOG.md

@@ -0,0 +1,143 @@
+# Changelog
+
+## [0.8.0](https://github.com/manheim/eb_deployer/compare/v0.7.0...v0.8.0) (2023-10-17)
+
+
+### Features
+
+* explain fork transition in readme ([0ce9bbe](https://github.com/manheim/eb_deployer/commit/0ce9bbe1b905d3fadb749365b5e7fd7042f09fe7))
+
+
+### Bug Fixes
+
+* correct default branch ([f262778](https://github.com/manheim/eb_deployer/commit/f262778163b30f3e896af250561e80c96316404b))
+* update gitignore file ([15cabbb](https://github.com/manheim/eb_deployer/commit/15cabbb7d1bb64cc7d3e98e66ff245b3d0626e10))
+* update ruby version and simplify dependency management ([5b69e7e](https://github.com/manheim/eb_deployer/commit/5b69e7ede3b436df75e9ab94bae3d7f5308ea204))
+
+0.7.0
+=====
+
+* Add service specific AWS sdk gems
+* [#79](https://github.com/ThoughtWorksStudios/eb_deployer/pull/79): Environment updates can complete with errors
+* [#82](https://github.com/ThoughtWorksStudios/eb_deployer/pull/82): Added a line to force STDOUT output every line
+* [#85](https://github.com/ThoughtWorksStudios/eb_deployer/pull/85): Improve package not found error message
+* [#86](https://github.com/ThoughtWorksStudios/eb_deployer/pull/86): Fix to for inactive stack updates when instances are 0
+ 
+0.6.6
+=====
+
+* Add support for specifying (and overriding) a [stack policy](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) for the CloudFormation resource stack. (contributed by @jlabrecque)
+* Fix issue where deployment hangs if resource stack update fails and stack is rolled back, deployment will now fail when the resource stack update fails. (contributed by @jlabrecque)
+* Add support for creating environment base on a elasticbeanstalk template. (contributed by @djpate)
+
+0.6.5
+=====
+
+* #66: Making it possible to specify other accepted health states when deploying (@dziemid)
+
+0.6.4
+=====
+
+* fixes #65 - aws driver should be able to detect CNAME prefixes from both regionalized and legacy EB domains
+
+0.6.3
+=====
+
+* Wait until inactive environment status is ready before applying settings.
+
+0.6.0
+=====
+
+* Use aws-sdk 2.0
+* Ruby 2.2 support
+* Robust error handling on CloudFormation resource stack provisioning
+
+0.5.1
+=====
+
+* Fix issue: worker tier is picking up old version of aws-sqsd
+
+0.5.0
+=====
+
+* Worker tier support
+
+0.4.12
+======
+
+* Update default solution stacks.
+* Rails generator generates SECRET_KEY_BASE for rails 4 app.
+
+0.4.11
+======
+
+* Make gem depend on aws-sdk-v1 until we put in support for both v1 and v2
+
+0.4.10
+======
+
+* Fix #33
+
+0.4.9
+====
+
+* Ignore AWS::ElasticBeanstalk::Errors::OperationInProgressFailure error when delete application version
+
+0.4.8
+====
+* Raise an error if the environment launched with problems (contributed by kmanning)
+* Add --stack-name option that let's use choose the name of the cloud
+  formation stack to operate on (contributed by NET-A-PORTER)
+* Document typo/grammar fix (contributed by stig)
+* Retry on AWS API throttling error when operating on versions
+
+0.4.7
+====
+* Added blue-only deployment strategy (a variant of blue-green) that
+  skips the cname swap so that the newly deployed code remains on the
+  inactive "blue" instance. (contributed by jlabrecque)
+
+0.4.6
+====
+* Make elasticbeanstalk event polling robust against clock shifting problem.
+
+0.4.5
+====
+* Rails 3+ support: Rails Generator to install default configurations with
+	Postgres RDS resource and everything need for blue-green
+	deployment
+* Add ability to tag beanstalk environment (from @pmcfadden)
+
+0.4.4
+=====
+* Fix S3 upload on Windows.
+* Experimental support for "inactve_settings" options, which can be used to automatically scale down the inactive environment.
+* Update default solution stack name to latest supported JAVA stack.
+* Validate solution_stack option before creating environment and list available solution_stacks if not valid.
+
+0.4.3
+=====
+* Backoff and retry when AWS::ElasticBeanstalk::Errors::Throttling happens during polling events
+
+0.4.2
+=====
+* Allow provding different deploy strategy for different components.
+
+0.4.1
+=====
+* Remove options for delete all environments ("-d --all"), because it is too destructive and not recoverable.
+* Experimental support for multiple components deployment.
+
+0.4.0
+====
+* revert back all changes from 0.3.8 to 0.3.9. Elasticbeanstalk haven't relex the real unique constain. The actually contrain is you can not have environment name cross different application
+
+0.3.9
+====
+* Fix hang problem introduced in 0.3.8 when migrating old ElasticBeanstalk environment.
+* Fix issue #13 (Deployment via S3 object broken since 0.3.7)
+
+0.3.8
+=====
+* Change ElasticBeanstalk environment name pattern. Stop using sufix hash to make eb environment global unique. (Because ElasticBeanstalk does not require environment has globally uniqe name any more.)
+* Add migration logic so that if a ElasticBeanstalk environment with legcy name exists, eb_deployer will automaticly terminate it and replace it with ElasticBeanstalk environment has new name pattern.

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in eb_deployer.gemspec
+gemspec
+
+gem 'redcarpet', :platform => :mri
+gem 'yard'
+gem 'rake'
+gem 'railties', '~> 7.0'
+gem 'test-unit'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Thoughtworks Inc.
+
+MIT License
+
+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,138 @@
+# EbDeployer ![Tests](https://github.com/manheim/eb_deployer/actions/workflows/test.yml/badge.svg) [![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)
+
+Fork maintained by Manheim to upgrade Ruby version and dependencies.
+
+[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.
+
+[Deploy Service by EbDeployer](http://www.thoughtworks.com/mingle/infrastructure/2015/06/01/deploy-service-by-ebdeployer.html)
+
+## Installation
+
+    $ gem install eb_deployer
+
+## Usage
+
+### Step One: AWS Account Setup
+
+Create an AWS IAM user for deploy and give it privilege to operate Elastic Beanstalk. Download the access keys for executing the deployment tasks later. Ensure your command line is primed with appropriate access_keys using one of techniques mentioned on [aws blog](http://ruby.awsblog.com/blog/tag/config). For example using environment variable:
+
+    $ export AWS_ACCESS_KEY_ID=xxx
+    $ export AWS_SECRET_ACCESS_KEY=xxx
+
+
+### Step Two: Packaging
+
+You need to package your application for Elastic Beanstalk stack first. For Java app a warball is appropriate. For Ruby on Rails app a tar.gz file is good. You can also package a Rails/Sinatra app as a war ball using warbler and deploy to Java stack. (Please remember to run rake assets:precompile first for a rails app.)
+
+If you were deploying to Elastic Beanstalk Ruby stack, simply zip your codebase is good enough, for example:
+
+		$ git ls-files | zip your-app-name.zip -@
+
+### Step Three: Generate configuration and Configure deployment process
+
+    $ eb_deploy
+
+This will generate a default configuration at location 'config/eb_deployer.yml'. It is almost empty but working one. And it will generate settings for two environments 'development' and 'production'. Some options can be tweaked. The yml files includes documentation on how you can best suit it to your purpose.
+
+
+### Step Four: Fasten your seat belt
+run deploy
+
+    $ eb_deploy -p <package built> -e <environment>
+
+Then open aws console for Elastic Beanstalk to see the result of this deployment.
+
+
+### Configure Smoke Testing your stack
+
+EB_Deployer allows you to automate your deployment and then some. You can also add smoke tests to your deployment - thus ensuring that the app you deployed is also working correctly.
+Adding a smoke test suite is also simple. Check "smoke_test" section in your eb_deployer.yml. We show a simple curl based smoke test that helps you test if your app is up and responding to http.
+
+    smoke_test: |
+      curl_http_code = "curl -s -o /dev/null -w \"%{http_code}\" http://#{host_name}"
+      Timeout.timeout(600) do
+        until ['200', '302'].include?(`#{curl_http_code}`.strip)
+          sleep 5
+        end
+      end
+
+
+Any rakeable test suite can be run as part of the smoke test(selenium, cucumber, capybara, and so on.)
+You can add more smoke tests by calling arbitrary rake tasks (Please make sure check return status):
+
+    smoke_test: |
+      `rake test:smoke HOST_NAME=#{host_name}`
+      raise("Smoke failed!") unless $?.success?
+
+Smoke testing gets you one step closer to continuous delivery.
+
+### Blue-Green deployment
+Since every deployment now runs smoke test, you now have a better safety net around your deployments. This allows us to trigger automatic blue-green deployments.
+
+To do this you need not do anything special. So far we have deployed the application only once. Let's call this the 'green' stack. Any subsequent calls to deployment will deployment a copy of this application to a new stack - the 'blue' stack. Smoke tests will be run on it and once everything passes the 'blue'(new) stack will be switched to the 'green' stack. Thus your new code will now be on the active stack and the user will experience no downtime.
+
+Once this new stack is stable or has run for a while you can choose to delete the old stack. Or if you are doing continuous delivery you may be ready to another 'blue' deployment. You could just trigger another deployment and repeat this every hour/day/week... you get the idea.
+
+
+
+### Destroying a stack
+So you are done with this environment, you can destroy it easily as well.
+
+    # destroy one environment
+    $ eb_deployer -d -e <environment>
+
+
+and you are done!
+
+Later tutorials coming soon will cover
+* how to setup RDS or other AWS resource and share them between blue green environments
+
+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. 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'] %>
+
+
+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 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)
+
+[EbDeployer environment](https://github.com/ThoughtWorksStudios/eb_deployer/wiki/EbDeployer-environment)
+
+[Introduction to EbDeployer](https://www.thoughtworks.com/mingle/scaling/2014/06/13/introduction-to-eb-deployer.html)
+
+[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
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/ThoughtWorksStudios/eb_deployer/trend.png)](https://bitdeli.com/free "Bitdeli Badge")

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/*test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/TODOS.md

@@ -0,0 +1,11 @@
+* Support warmup_script option,  which runs after smoke test to enhance smoothness of DNS switching in Blue Green deployment.
+* Wait for all auto scaling group to reach MIN size before running smoke tests in Blue Green deployment. This will make sure DNS switching not generating 50x error under big load, even without warmup steps.
+* Refactoring: extract Config class wrapping config defaut and merging logic.
+* Make clear solution_stack is a creation only option in document
+* Updating an EB environment with a different solution_stack should give warning
+* Remove all old environment settings to keep settings always sync up
+* Make it possible to provide an environment specific components settings
+* Support smoke_test_script option
+* Document for how to use components
+* Document for how to use inactive-settings
+* Support bucket folders for different environments (e.g. tworker/dev,tworker/ci)

data/bin/eb_deploy

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+git_path = File.join(File.expand_path('../..', __FILE__), '.git')
+
+if File.exist?(git_path)
+  lib_path = File.expand_path('../../lib', __FILE__)
+  $:.unshift(lib_path)
+end
+
+STDOUT.sync = true # Forces output after every line.
+
+require 'eb_deployer'
+EbDeployer.cli

data/eb_deployer.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/eb_deployer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["wpc", "betarelease", "xli", "manheim"]
+  gem.email         = ["tooling@manheim.com "]
+  gem.description   = %q{For automating Blue-Green deployment flows on Elastic Beanstalk.}
+  gem.summary       = %q{Low friction deployments should be a breeze. Elastic Beanstalk provides a great foundation for performing Blue-Green deployments, and EbDeployer add a missing top to automate the whole flow out of the box.}
+  gem.homepage      = "https://github.com/manheim/eb_deployer"
+  gem.license       = 'MIT'
+
+  gem.add_runtime_dependency 'aws-sdk-cloudformation',  '~> 1.0'
+  gem.add_runtime_dependency 'aws-sdk-elasticbeanstalk',  '~> 1.0'
+  gem.add_runtime_dependency 'aws-sdk-s3',  '~> 1.0'
+
+  gem.files         = `git ls-files`.split($\).reject {|f| f =~ /^samples\// }
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "man_eb_deployer"
+  gem.require_paths = ["lib"]
+  gem.version       = EbDeployer::VERSION
+end

data/lib/eb_deployer/application.rb

@@ -0,0 +1,96 @@
+require 'yaml'
+module EbDeployer
+  class Application
+    attr_reader :name
+
+    def initialize(name, eb_driver, s3_driver, bucket = nil)
+      @name = name
+      @eb_driver = eb_driver
+      @s3_driver = s3_driver
+      @bucket = bucket || @name
+      raise "application name can only contain any combination of uppercase letters, lowercase letters, numbers, dashes (-)" unless @name =~ /^[a-zA-Z0-9.-]+$/
+    end
+
+    def create_version(version_label, package)
+      create_application_if_not_exists
+
+      source_bundle = if File.exist?(package)
+                        if File.extname(package) == '.yml'
+                          YAML.load(File.read(package))
+                        else
+                          package = Package.new(package, @bucket + ".packages", @s3_driver)
+                          package.upload
+                          package.source_bundle
+                        end
+                      elsif package =~ /:/
+                        bucket, obj_key = package.split(':')
+                        {'s3_bucket' => bucket, 's3_key' => obj_key}
+                      else
+                        raise "Neither the file exists nor it is a valid s3 url: #{package.inspect}"
+                      end
+
+      unless @eb_driver.application_version_labels(@name).include?(version_label)
+        log("Create application version with label #{version_label}")
+        @eb_driver.create_application_version(@name, version_label, source_bundle)
+      end
+    end
+
+    def delete(env_name_prefix)
+      if @eb_driver.application_exists?(@name)
+        available_envs = @eb_driver.environment_names_for_application(@name).select do |name|
+          name =~ /^#{env_name_prefix}-/
+        end
+
+        if available_envs.empty?
+          log("Environment #{env_name_prefix.inspect} does not exist in application #{@name.inspect}. Skipping delete.")
+          return
+        end
+
+        available_envs.each do |env|
+          log("Terminating environment #{env}")
+          @eb_driver.delete_environment(@name, env)
+        end
+      end
+    end
+
+    def versions
+      @eb_driver.application_versions(@name).map do |apv|
+        {
+          :version => apv[:version_label],
+          :date_created => apv[:date_created],
+          :date_updated => apv[:date_updated]
+        }
+      end
+    end
+
+    def remove(versions, delete_from_s3)
+      versions.each do |version|
+        begin
+          log("Removing #{version}")
+          @eb_driver.delete_application_version(@name, version, delete_from_s3)
+        rescue Aws::ElasticBeanstalk::Errors::SourceBundleDeletionFailure => e
+          log(e.message)
+        rescue Aws::ElasticBeanstalk::Errors::OperationInProgressFailure => e
+          log(e.message)
+        end
+      end
+    end
+
+    def clean_versions(version_prefix, retentions)
+      VersionCleaner.new(self, retentions).clean(version_prefix)
+    end
+
+    private
+
+    def create_application_if_not_exists
+      unless @eb_driver.application_exists?(@name)
+        log("Creating application")
+        @eb_driver.create_application(@name)
+      end
+    end
+
+    def log(msg)
+      puts "[#{Time.now.utc}][application:#{@name}] #{msg}"
+    end
+  end
+end