elbas 0.27.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ba77ed5f65f5066df79abab27f088a338a0f1f46
-  data.tar.gz: 3fcf047a084ec476facacedf96dc41882b2ba90c
+SHA256:
+  metadata.gz: 001b685faad190688be4ec49c511781a58129cd94800172575d0a8d739755837
+  data.tar.gz: a7fa9684df82682256c2629bc294260d3aa6b6426663b17534613c26263bb782
 SHA512:
-  metadata.gz: 8602effc5044cbeaae866c39805db27e737471b015157f6a44b07a47e70be987624486c63d0919b8a428fde6c1f79666b9417e683fd6bbfa8264884f5316a17d
-  data.tar.gz: f3b212fc1e38e2015d7884e464d2679f9a271c4166b8c650743e75063a26789907e09d0e6df59156bf078107af49fabfc2a12358cd89a97f162532360ecabfd8
+  metadata.gz: 3a5b2534c8f036a8f3044beb836d2c33b0bf74f092b28fc3f71ce7e129b3c586f6cad1594e41f84ed68d93de4f0c4270b34ef530e11aa8b1583e1af8a9ed947d
+  data.tar.gz: d9a71090a1a53139e2cbf80c3b8fff0a27e91f28640f649793d3f48c35d5d581e5e0a828bb90999cb9cabbc3703b738b515ce1e4774dee286ca4b9a6c5b62e36

data/README.md

@@ -1,60 +1,50 @@
-# ELBAS (Elastic Load Balancer & AutoScaling)
+*Versions < 3 of ELBAS are no longer being maintained. I will only be maintaining the current feature-set which relies on Launch Templates and AWS SDK v3.*
 
-ELBAS was written to ease the deployment of Rails applications to AWS AutoScale groups. ELBAS will:
+# Capistrano ELBAS (Elastic Load Balancer & AutoScaling)
+
+ELBAS was written to ease the deployment of Rails applications to AWS AutoScale
+groups. During your Capistrano deployment, ELBAS will:
 
 - Deploy your code to each running instance connected to a given AutoScale group
 - After deployment, create an AMI from one of the running instances
-- Attach the AMI with the new code to a new AWS Launch Configuration
-- Update your AutoScale group to use the new launch configuration
-- Delete any old AMIs created by ELBAS
-- Delete any old launch configurations created by ELBAS
-
-This ensures that your current and future servers will be running the newly deployed code.
+- Update the AutoScale group's launch template with the AMI ID
+- Delete any outdated AMIs created by previous ELBAS deployments
 
 ## Installation
 
+Add to Gemfile, then `bundle`:
+
 `gem 'elbas'`
 
-Add this statement to your Capfile:
+Add to Capfile:
 
 `require 'elbas/capistrano'`
 
 ## Configuration
 
-Below are the Capistrano configuration options with their defaults:
+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']
-
-set :aws_no_reboot_on_create_ami, true
-set :aws_autoscale_instance_size, 'm1.small'
-
-set :aws_launch_configuration_detailed_instance_monitoring, true
-set :aws_launch_configuration_associate_public_ip, true
+set :aws_access_key, ENV['AWS_ACCESS_KEY_ID']
+set :aws_secret_key, ENV['AWS_SECRET_ACCESS_KEY']
+set :aws_region,     ENV['AWS_REGION']
 ```
 
 ## Usage
 
-Instead of using Capistrano's `server` method, use `autoscale` instead in `deploy/production.rb` (or
-whichever environment you're deploying to). Provide the name of your AutoScale group instead of a
-hostname:
+Instead of using Capistrano's `server` method, use `autoscale` instead in
+`deploy/<environment>.rb` (replace <environment> with your environment). Provide
+the name of your AutoScale group instead of a hostname:
 
 ```ruby
-autoscale 'production', user: 'apps', roles: [:app, :web, :db]
+autoscale 'my-autoscale-group', user: 'apps', roles: [:app, :web, :db]
 ```
 
-That's it! Run `cap production deploy`. ELBAS will print the following log statements during your
-deployment:
+Run `cap production deploy`.
 
-```
-"ELBAS: Adding server: ec2-XX-XX-XX-XXX.compute-1.amazonaws.com"
-"ELBAS: Creating EC2 AMI from i-123abcd"
-"ELBAS: Created AMI: ami-123456"
-"ELBAS: Creating an EC2 Launch Configuration for AMI: ami-123456"
-"ELBAS: Created Launch Configuration: elbas-lc-ENVIRONMENT-UNIX_TIMESTAMP"
-"ELBAS: Attaching Launch Configuration to AutoScale Group"
-"ELBAS: Deleting old launch configuration: elbas-lc-production-123456"
-"ELBAS: Deleting old image: ami-999999"
-```
+**As of version 3, your AWS setup must use launch templates as opposed to launch
+configurations.** This allows ELBAS to simply create a new launch template version
+with the new AMI ID after a deployment. It no longer needs to update your
+AutoScale group or mess around with network settings, instance sizes, etc., as
+that information is all contained within the launch template. Failure to use a
+launch template will result in a `Elbas::Errors::NoLaunchTemplate` error.

data/elbas.gemspec

@@ -4,26 +4,29 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'elbas/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "elbas"
+  spec.name          = 'elbas'
   spec.version       = Elbas::VERSION
-  spec.authors       = ["Logan Serman"]
-  spec.email         = ["logan.serman@metova.com"]
+  spec.authors       = ['Logan Serman']
+  spec.email         = ['loganserman@gmail.com']
   spec.summary       = 'Capistrano plugin for deploying to AWS AutoScale Groups.'
-  spec.description   = "#{spec.summary} Deploys to all instances in a group, creates a fresh AMI post-deploy, and attaches the AMI to your AutoScale Group."
-  spec.homepage      = "http://github.com/metova/elbas"
-  spec.license       = "MIT"
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/lserman/capistrano-elbas'
+  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.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "webmock"
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'webmock-rspec-helper'
+
+  spec.add_dependency 'aws-sdk-autoscaling', '~> 1'
+  spec.add_dependency 'aws-sdk-ec2', '~> 1'
 
-  spec.add_dependency 'aws-sdk-v1', '~> 1'
   spec.add_dependency 'capistrano', '> 3.0.0'
   spec.add_dependency 'activesupport', '>= 4.0.0'
 end

data/lib/elbas.rb

@@ -1,17 +1,23 @@
-require 'aws-sdk-v1'
 require 'capistrano/all'
 require 'active_support/concern'
 
+require 'aws-sdk-autoscaling'
+require 'aws-sdk-ec2'
+
 require 'elbas/version'
-require 'elbas/retryable'
-require 'elbas/taggable'
 require 'elbas/logger'
-require 'elbas/aws/credentials'
-require 'elbas/aws/autoscaling'
-require 'elbas/aws/ec2'
-require 'elbas/aws_resource'
-require 'elbas/ami'
-require 'elbas/launch_configuration'
+require 'elbas/retryable'
+
+require 'elbas/errors/no_launch_template'
+
+require 'elbas/aws/base'
+require 'elbas/aws/taggable'
+require 'elbas/aws/instance_collection'
+require 'elbas/aws/instance'
+require 'elbas/aws/autoscale_group'
+require 'elbas/aws/launch_template'
+require 'elbas/aws/ami'
+require 'elbas/aws/snapshot'
 
 module Elbas
 end

data/lib/elbas/aws/ami.rb

@@ -0,0 +1,71 @@
+module Elbas
+  module AWS
+    class AMI < Base
+      include Taggable
+
+      DEPLOY_ID_TAG = 'ELBAS-Deploy-id'.freeze
+      DEPLOY_GROUP_TAG = 'ELBAS-Deploy-group'.freeze
+
+      attr_reader :id, :snapshots
+
+      def initialize(id, snapshots = [])
+        @id = id
+        @aws_counterpart = ::Aws::EC2::Image.new id
+
+        @snapshots = snapshots.map do |snapshot|
+          Elbas::AWS::Snapshot.new snapshot&.ebs&.snapshot_id
+        end
+      end
+
+      def deploy_id
+        tags[DEPLOY_ID_TAG]
+      end
+
+      def deploy_group
+        tags[DEPLOY_GROUP_TAG]
+      end
+
+      def ancestors
+        aws_amis_in_deploy_group.select { |aws_ami|
+          deploy_id_from_aws_tags(aws_ami.tags) != deploy_id
+        }.map { |aws_ami|
+          self.class.new aws_ami.image_id, aws_ami.block_device_mappings
+        }
+      end
+
+      def delete
+        aws_client.deregister_image image_id: id
+        snapshots.each(&:delete)
+      end
+
+      def self.create(instance, no_reboot: true)
+        ami = instance.aws_counterpart.create_image({
+          name: "ELBAS-ami-#{Time.now.to_i}",
+          instance_id: instance.id,
+          no_reboot: no_reboot
+        })
+
+        new ami.id
+      end
+
+      private
+        def aws_namespace
+          ::Aws::EC2
+        end
+
+        def aws_amis_in_deploy_group
+          aws_client.describe_images({
+            owners: ['self'],
+            filters: [{
+              name: "tag:#{DEPLOY_GROUP_TAG}",
+              values: [deploy_group],
+            }]
+          }).images
+        end
+
+        def deploy_id_from_aws_tags(tags)
+          tags.detect { |tag| tag.key == DEPLOY_ID_TAG }&.value
+        end
+    end
+  end
+end

data/lib/elbas/aws/autoscale_group.rb

@@ -0,0 +1,43 @@
+module Elbas
+  module AWS
+    class AutoscaleGroup < Base
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+        @aws_counterpart = query_autoscale_group_by_name(name)
+      end
+
+      def instance_ids
+        aws_counterpart.instances.map(&:instance_id)
+      end
+
+      def instances
+        InstanceCollection.new instance_ids
+      end
+
+      def launch_template
+        raise Elbas::Errors::NoLaunchTemplate unless aws_counterpart.launch_template
+
+        LaunchTemplate.new(
+          aws_counterpart.launch_template.launch_template_id,
+          aws_counterpart.launch_template.launch_template_name,
+          aws_counterpart.launch_template.version,
+        )
+      end
+
+      private
+        def aws_namespace
+          ::Aws::AutoScaling
+        end
+
+        def query_autoscale_group_by_name(name)
+          aws_client
+            .describe_auto_scaling_groups(auto_scaling_group_names: [name])
+            .auto_scaling_groups
+            .first
+        end
+
+    end
+  end
+end

data/lib/elbas/aws/base.rb

@@ -0,0 +1,39 @@
+module Elbas
+  module AWS
+    class Base
+      include Capistrano::DSL
+
+      attr_reader :aws_counterpart
+
+      def aws_client(namespace = aws_namespace)
+        @aws_client ||= begin
+          options = {}
+          options[:region] = aws_region if aws_region
+          options[:credentials] = aws_credentials if aws_credentials.set?
+
+          namespace::Client.new options
+        end
+      end
+
+      def aws_credentials
+        fetch :aws_credentials, ::Aws::Credentials.new(aws_access_key, aws_secret_key)
+      end
+
+      def aws_access_key
+        fetch :aws_access_key
+      end
+
+      def aws_secret_key
+        fetch :aws_secret_key
+      end
+
+      def aws_region
+        fetch :aws_region
+      end
+
+      def self.aws_client(namespace = aws_namespace)
+        Base.new.aws_client namespace
+      end
+    end
+  end
+end

data/lib/elbas/aws/instance.rb

@@ -0,0 +1,24 @@
+module Elbas
+  module AWS
+    class Instance
+      STATE_RUNNING = 16.freeze
+
+      attr_reader :aws_counterpart, :id, :state
+
+      def initialize(id, public_dns, state)
+        @id = id
+        @public_dns = public_dns
+        @state = state
+        @aws_counterpart = ::Aws::EC2::Instance.new id
+      end
+
+      def hostname
+        @public_dns
+      end
+
+      def running?
+        state == STATE_RUNNING
+      end
+    end
+  end
+end

data/lib/elbas/aws/instance_collection.rb

@@ -0,0 +1,36 @@
+module Elbas
+  module AWS
+    class InstanceCollection < Base
+      include Enumerable
+
+      attr_reader :instances
+
+      def initialize(ids)
+        @ids = ids
+        @instances = query_instances_by_ids(ids).map do |i|
+          Instance.new(i.instance_id, i.public_dns_name, i.state.code)
+        end
+      end
+
+      def running
+        select(&:running?)
+      end
+
+      def each(&block)
+        instances.each(&block)
+      end
+
+      private
+        def aws_namespace
+          ::Aws::EC2
+        end
+
+        def query_instances_by_ids(ids)
+          aws_client
+            .describe_instances(instance_ids: @ids)
+            .reservations[0]
+            .instances
+        end
+    end
+  end
+end

data/lib/elbas/aws/launch_template.rb

@@ -0,0 +1,32 @@
+module Elbas
+  module AWS
+    class LaunchTemplate < Base
+      attr_reader :id, :name, :version
+
+      def initialize(id, name, version)
+        @id = id
+        @name = name
+        @version = version
+      end
+
+      def update(ami)
+        latest = aws_client.create_launch_template_version({
+          launch_template_data: { image_id: ami.id },
+          launch_template_id: self.id,
+          source_version: self.version
+        }).launch_template_version
+
+        self.class.new(
+          latest&.launch_template_id,
+          latest&.launch_template_name,
+          latest&.version_number
+        )
+      end
+
+      private
+        def aws_namespace
+          ::Aws::EC2
+        end
+    end
+  end
+end

data/lib/elbas/aws/snapshot.rb

@@ -0,0 +1,21 @@
+module Elbas
+  module AWS
+    class Snapshot < Base
+      attr_reader :id
+
+      def initialize(id)
+        @id = id
+      end
+
+      def delete
+        return unless id
+        aws_client.delete_snapshot snapshot_id: id
+      end
+
+      private
+        def aws_namespace
+          ::Aws::EC2
+        end
+    end
+  end
+end