capistrano-autoscale-hannah 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 37a7f2e1a67b257817b60b0d96b555d4e675b4a7f571e9e40784884b5c755935
+  data.tar.gz: 43a96392b008a1f4964dbf4a0f20101d6e889b1e7307750fb1548cc5845f81b5
+SHA512:
+  metadata.gz: b63ac6c1b20a777a589ad981bca9089899117adc0c979ed6a3cff8e84dba2aa0d6382bc00c168e50980da9adfa609bef0780b52ac286619fd373be70c93e782f
+  data.tar.gz: 9ae10046c10028cb55916e97bef4d94f876c294c74b8571c680e5949bfcd126cfb603f863476b43fd2822499b1f78ad97c533aa52ec31d901ebea3870e6eee05

data/.gitignore

@@ -0,0 +1,23 @@
+bin/
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+.ruby-version
+.ruby-gemset
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,39 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Layout/HashAlignment:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 27
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 28
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/Documentation:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/StderrPuts:
+  Enabled: false
+
+Style/SymbolArray:
+  EnforcedStyle: brackets

data/.travis.yml

@@ -0,0 +1,13 @@
+os: linux
+dist: xenial
+language: ruby
+cache: bundler
+before_install:
+  - gem update --system
+  - gem install bundler -v '< 2'
+  - bundle --version
+rvm:
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-autoscale.gemspec
+gemspec
+
+gem 'rubocop', '~> 0.80.1'

data/Gemfile.lock

@@ -0,0 +1,208 @@
+PATH
+  remote: .
+  specs:
+    capistrano-autoscale (1.0.0)
+      aws-sdk-autoscaling (~> 1)
+      aws-sdk-ec2 (~> 1)
+      capistrano (~> 3.9, > 3.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.4.3)
+      actionpack (= 5.2.4.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.4.3)
+      actionpack (= 5.2.4.3)
+      actionview (= 5.2.4.3)
+      activejob (= 5.2.4.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.4.3)
+      actionview (= 5.2.4.3)
+      activesupport (= 5.2.4.3)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.4.3)
+      activesupport (= 5.2.4.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.4.3)
+      activesupport (= 5.2.4.3)
+      globalid (>= 0.3.6)
+    activemodel (5.2.4.3)
+      activesupport (= 5.2.4.3)
+    activerecord (5.2.4.3)
+      activemodel (= 5.2.4.3)
+      activesupport (= 5.2.4.3)
+      arel (>= 9.0)
+    activestorage (5.2.4.3)
+      actionpack (= 5.2.4.3)
+      activerecord (= 5.2.4.3)
+      marcel (~> 0.3.1)
+    activesupport (5.2.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    airbrussh (1.4.0)
+      sshkit (>= 1.6.1, != 1.7.0)
+    arel (9.0.0)
+    ast (2.4.1)
+    aws-eventstream (1.1.0)
+    aws-partitions (1.338.0)
+    aws-sdk-autoscaling (1.43.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-core (3.103.0)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.239.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-ec2 (1.174.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.2.1)
+      aws-eventstream (~> 1, >= 1.0.2)
+    builder (3.2.4)
+    capistrano (3.14.1)
+      airbrussh (>= 1.0.0)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    concurrent-ruby (1.1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.9.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    hashdiff (1.0.1)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    jmespath (1.4.0)
+    loofah (2.6.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    net-scp (3.0.0)
+      net-ssh (>= 2.6.5, < 7.0.0)
+    net-ssh (6.1.0)
+    nio4r (2.5.2)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    public_suffix (4.0.5)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.4.3)
+      actioncable (= 5.2.4.3)
+      actionmailer (= 5.2.4.3)
+      actionpack (= 5.2.4.3)
+      actionview (= 5.2.4.3)
+      activejob (= 5.2.4.3)
+      activemodel (= 5.2.4.3)
+      activerecord (= 5.2.4.3)
+      activestorage (= 5.2.4.3)
+      activesupport (= 5.2.4.3)
+      bundler (>= 1.3.0)
+      railties (= 5.2.4.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (5.2.4.3)
+      actionpack (= 5.2.4.3)
+      activesupport (= 5.2.4.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.80.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sshkit (1.21.0)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.1)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    webmock-rspec-helper (0.0.5)
+      rails (>= 3.0.0)
+      rspec
+      webmock
+    websocket-driver (0.7.2)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  capistrano-autoscale!
+  rake (~> 13.0)
+  rspec (~> 3.0, > 3.0)
+  rubocop (~> 0.80.1)
+  webmock (~> 3.8)
+  webmock-rspec-helper (~> 0.0.5)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Logan Serman
+
+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,84 @@
+# Capistrano Autoscale
+
+[![Build Status](https://travis-ci.org/KentaaNL/capistrano-autoscale.svg?branch=master)](https://travis-ci.org/KentaaNL/capistrano-autoscale)
+
+This is a fork of [lserman/capistrano-elbas](https://github.com/lserman/capistrano-elbas), with several improvements.
+
+Capistrano-autoscale was written to ease the deployment of Rails applications to AWS Auto Scaling
+Groups. During your Capistrano deployment, capistrano-autoscale will:
+
+- Suspend Launch & Terminate processes on the Auto Scaling Group.
+- Deploy your code to each running instance connected to a given Auto Scaling Group.
+- After deployment, create an AMI from one of the running instances.
+- Create a new Launch Template version with the AMI ID based on the current Auto Scaling Group's Launch Template.
+- Delete any outdated Launch Template versions, AMIs and snapshots created by previous deployments.
+- Resume Launch & Terminate processes on the Auto Scaling Group.
+
+## Installation
+
+Add to Gemfile, then run `bundle`:
+
+`gem 'capistrano-autoscale', require: false, git: 'https://github.com/KentaaNL/capistrano-autoscale.git'`
+
+Add to Capfile:
+
+`require 'capistrano/autoscale'`
+
+## Configuration
+
+Setup AWS credentials:
+
+```ruby
+set :aws_access_key_id,     ENV['AWS_ACCESS_KEY_ID']
+set :aws_secret_access_key, ENV['AWS_SECRET_ACCESS_KEY']
+set :aws_region,            ENV['AWS_REGION']
+```
+
+To configure the prefix that AMIs will get (defaults to stage name):
+
+```ruby
+set :aws_autoscale_ami_prefix, "my-ami"
+```
+
+To add custom tags to AMIs and snapshots you can specify a hash:
+
+```ruby
+set :aws_autoscale_ami_tags, { "Environment" => "Sandbox" }
+set :aws_autoscale_snapshot_tags, { "Environment" => "Sandbox" }
+```
+
+By default, the Launch & Terminate processes will be suspended during deployment. To disable this:
+
+```ruby
+set :aws_autoscale_suspend_processes, false
+```
+
+After deployment, any outdated Launch Template versions, AMIs and snapshots will be deleted. By default, the number of `keep_releases` will be kept. To change this, set:
+
+```ruby
+set :aws_autoscale_cleanup_old_versions, true
+set :aws_autoscale_keep_versions, 8
+```
+
+## Usage
+
+Instead of using Capistrano's `server` method, use `autoscale` instead in
+`deploy/<environment>.rb` (replace &lt;environment&gt; with your environment). Provide
+the name of your Auto Scaling group instead of a hostname:
+
+```ruby
+autoscale 'my-autoscale-group', user: 'apps', roles: [:app, :web, :db]
+```
+
+If you have multiple autoscaling groups to deploy to, specify each of them:
+
+```ruby
+autoscale 'app-autoscale-group', user: 'apps', roles: [:app, :web]
+autoscale 'worker-autoscale-group', user: 'apps', roles: [:worker]
+```
+
+Run `cap production deploy`.
+
+Note: Your Auto Scaling Group must use Launch Templates as opposed to Launch Configurations.
+This allows capistrano-autoscale to simply create a new Launch Template version with the new AMI ID after a deployment.
+Failure to use a Launch Template will result in a `Capistrano::Autoscale::Errors::NoLaunchTemplate` error.

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:spec, :rubocop]

data/capistrano-autoscale.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/autoscale/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-autoscale-hannah'
+  spec.version       = Capistrano::Autoscale::VERSION
+  spec.authors       = ['François Fitzpatrick']
+  spec.email         = ['francois.fitzpatrick@gmail.com']
+  spec.summary       = 'Capistrano plugin for deploying to AWS Auto Scaling Groups with enhanced features.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/ID-Soft/capistrano-autoscale'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0', '> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.8'
+  spec.add_development_dependency 'webmock-rspec-helper', '~> 0.0.5'
+
+  spec.add_dependency 'aws-sdk-autoscaling', '~> 1'
+  spec.add_dependency 'aws-sdk-ec2', '~> 1'
+  spec.add_dependency 'capistrano', '~> 3.9', '> 3.9'
+end

data/lib/capistrano/autoscale/aws/ami.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module Autoscale
+    module AWS
+      class AMI < Base
+        include Taggable
+
+        DEPLOY_GROUP_TAG = 'Autoscale-Deploy-group'
+
+        attr_reader :aws_counterpart, :id, :snapshots
+
+        def initialize(id, block_device_mappings = [])
+          @id = id
+          @aws_counterpart = ::Aws::EC2::Image.new id, client: ec2_client
+
+          @snapshots = block_device_mappings.map do |mapping|
+            Capistrano::Autoscale::AWS::Snapshot.new mapping&.ebs&.snapshot_id
+          end
+        end
+
+        def deploy_group
+          tags[DEPLOY_GROUP_TAG]
+        end
+
+        def delete
+          ec2_client.deregister_image image_id: id
+          snapshots.each(&:delete)
+        end
+
+        def self.create(instance, prefix: 'autoscale', no_reboot: false)
+          name = "#{prefix}-#{Time.now.to_i}"
+
+          image = instance.aws_counterpart.create_image(
+            name: name,
+            instance_id: instance.id,
+            no_reboot: no_reboot
+          )
+          image = image.wait_until_exists
+
+          block_device_mappings = nil
+          # Wait until block_device_mappings/snapshots are available.
+          loop do
+            block_device_mappings = image.block_device_mappings
+            snapshot_ids = block_device_mappings.map { |mapping| mapping.ebs&.snapshot_id }.compact
+            break if !snapshot_ids.empty? || image.state == 'failed'
+
+            sleep 1
+            image.load
+          end
+
+          raise Capistrano::Autoscale::Errors::CreateImageFailed, image if image.state == 'failed'
+
+          ami = new image.id, block_device_mappings
+          ami.tag 'Name', name
+          ami.snapshots.each { |snapshot| snapshot.tag 'Name', name }
+          ami
+        end
+
+        def create_tags(deploy_group)
+          tag(DEPLOY_GROUP_TAG, deploy_group)
+
+          aws_autoscale_ami_tags.each { |key, value| tag(key, value) }
+
+          snapshots.each(&:create_tags)
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/autoscale/aws/autoscale_group.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module Autoscale
+    module AWS
+      class AutoscaleGroup < Base
+        SUSPEND_PROCESSES = %w[Launch Terminate].freeze
+
+        LIFECYCLE_STATE_IN_SERVICE = 'InService'
+        LIFECYCLE_STATE_STANDBY = 'Standby'
+
+        AMI_PREFIX_TAG = 'Autoscale-Ami-Prefix'
+
+        attr_reader :name, :aws_counterpart
+
+        def initialize(name)
+          @name = name
+          @aws_counterpart = Aws::AutoScaling::AutoScalingGroup.new name: name, client: autoscaling_client
+
+          raise Capistrano::Autoscale::Errors::NoAutoScalingGroup, name unless @aws_counterpart.exists?
+        end
+
+        def instances
+          instance_ids = aws_counterpart.instances.map(&:instance_id)
+          InstanceCollection.new(instance_ids)
+        end
+
+        def instances_in_service
+          instance_ids = aws_counterpart.instances.select { |i| i.lifecycle_state == LIFECYCLE_STATE_IN_SERVICE }.map(&:instance_id)
+          InstanceCollection.new(instance_ids)
+        end
+
+        def launch_template
+          lts = aws_launch_template || aws_launch_template_specification
+          raise Capistrano::Autoscale::Errors::NoLaunchTemplate unless lts
+
+          LaunchTemplate.new(
+            lts.launch_template_id,
+            lts.launch_template_name,
+            lts.version,
+            false,
+            nil
+          )
+        end
+
+        def suspend
+          aws_counterpart.suspend_processes(scaling_processes: SUSPEND_PROCESSES)
+        end
+
+        def resume
+          aws_counterpart.resume_processes(scaling_processes: SUSPEND_PROCESSES)
+        end
+
+        def suspended?
+          aws_counterpart.suspended_processes.map(&:process_name).any? { |name| SUSPEND_PROCESSES.include?(name) }
+        end
+
+        def tags
+          aws_counterpart.tags.map { |tag| [tag.key, tag.value] }.to_h
+        end
+
+        def ami_prefix
+          tags[AMI_PREFIX_TAG]
+        end
+
+        def enter_standby(instance)
+          instance = aws_counterpart.instances.select { |i| i.id == instance.id }.first
+          instance.enter_standby(should_decrement_desired_capacity: true)
+
+          loop do
+            break if instance.lifecycle_state == LIFECYCLE_STATE_STANDBY
+
+            sleep 1
+            instance.load
+          end
+        end
+
+        def exit_standby(instance)
+          instance = aws_counterpart.instances.select { |i| i.id == instance.id }.first
+          instance.exit_standby
+        end
+
+        private
+
+        def aws_launch_template
+          aws_counterpart.launch_template
+        end
+
+        def aws_launch_template_specification
+          aws_counterpart.mixed_instances_policy&.launch_template
+            &.launch_template_specification
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/autoscale/aws/base.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module Autoscale
+    module AWS
+      class Base
+        include Capistrano::DSL
+
+        def ec2_client
+          @ec2_client ||= ::Aws::EC2::Client.new(aws_options)
+        end
+
+        def autoscaling_client
+          @autoscaling_client ||= ::Aws::AutoScaling::Client.new(aws_options)
+        end
+
+        def aws_options
+          options = {}
+          options[:region] = aws_region if aws_region
+          options[:credentials] = aws_credentials if aws_credentials.set?
+          options
+        end
+
+        def aws_credentials
+          fetch :aws_credentials, ::Aws::Credentials.new(aws_access_key_id, aws_secret_access_key)
+        end
+
+        def aws_access_key_id
+          fetch :aws_access_key_id
+        end
+
+        def aws_secret_access_key
+          fetch :aws_secret_access_key
+        end
+
+        def aws_region
+          fetch :aws_region
+        end
+
+        def aws_autoscale_ami_tags
+          fetch :aws_autoscale_ami_tags
+        end
+
+        def aws_autoscale_snapshot_tags
+          fetch :aws_autoscale_snapshot_tags
+        end
+      end
+    end
+  end
+end