capistrano3-asg-ami 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f05db1b87ff821af3c5662e1b9254aaceb8003441274dd0db07ca89413ff9329
+  data.tar.gz: bfc831f2669d3e7a561086a5848a27b3d4edfe7eeadf94cf3bc4469d7b3b2b4f
+SHA512:
+  metadata.gz: ab3f284e86c3e951f273747771f53e6e9fc7d694b0e13f96447c1611337317b71d623fbd85b0c88d828748ea2790ddb974b75fad0bd349b52c84ecd95042e479
+  data.tar.gz: 4c2e9a1d1c2f324dff6d7cbd201b7c857cec533cb7fae1cd54b45acdea6e24500b32cf058546e7a0b8062bd7065c2ea3b8968790d18c83788cf11a59e5dbd88b

data/.gitignore

@@ -0,0 +1,53 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# RubyMine folder
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in capistrano3-asg-ami.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    capistrano3-asg-ami (1.0.0)
+      activesupport (>= 4.0.0)
+      aws-sdk-autoscaling (~> 1)
+      aws-sdk-ec2 (~> 1)
+      capistrano (> 3.0.0)
+      capistrano-bundler (~> 2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (6.1.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    airbrussh (1.4.0)
+      sshkit (>= 1.6.1, != 1.7.0)
+    aws-eventstream (1.1.0)
+    aws-partitions (1.430.0)
+    aws-sdk-autoscaling (1.55.0)
+      aws-sdk-core (~> 3, >= 3.112.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-core (3.112.0)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.239.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-ec2 (1.225.0)
+      aws-sdk-core (~> 3, >= 3.112.0)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.2.2)
+      aws-eventstream (~> 1, >= 1.0.2)
+    capistrano (3.16.0)
+      airbrussh (>= 1.0.0)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 1.9.0)
+    capistrano-bundler (2.0.1)
+      capistrano (~> 3.1)
+    concurrent-ruby (1.1.8)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    jmespath (1.4.0)
+    minitest (5.14.4)
+    net-scp (3.0.0)
+      net-ssh (>= 2.6.5, < 7.0.0)
+    net-ssh (6.1.0)
+    rake (13.0.3)
+    sshkit (1.21.2)
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1.4)
+  capistrano3-asg-ami!
+  rake
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Aftab Akram
+
+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,83 @@
+[![Gem Version](https://badge.fury.io/rb/capistrano3-asg-ami.png)](http://badge.fury.io/rb/capistrano3-asg-ami)
+# capistrano3-asg-ami
+Capistrano 3 plugin for updating AWS [Launch Template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) [AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html) with [autoscale group](https://aws.amazon.com/about-aws/whats-new/2018/01/introducing-aws-auto-scaling/) first healthy instance.
+
+## Requirements
+
+* aws-sdk-ec2 ~> 1
+* aws-sdk-autoscaling ~> 1
+* capistrano ~> 3
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano3-asg-ami'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install capistrano3-asg-ami
+
+Add this line to your application's Capfile:
+
+```ruby
+require 'capistrano/autoscaling'
+```
+
+## Usage
+
+Create [IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction.html) with [AmazonEC2FullAccess](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_examples_ec2_region.html) permission and Set credentials in the capistrano deploy script / stage files add the following lines
+
+```ruby
+set :aws_region, 'ap-northeast-1'
+set :aws_access_key_id, 'YOUR AWS KEY ID'
+set :aws_secret_access_key, 'YOUR AWS SECRET KEY'
+set :aws_autoscaling_group_name, 'YOUR NAME OF AUTO SCALING GROUP NAME'
+set :aws_launch_template_id, 'lt-03f39c5689155e374'
+set :aws_autoscale_ami_prefix, 'server-name-'
+set :aws_keep_prev_no_of_ami, 1
+```
+
+To call this task after deploy,  in your desire capistrano environment file
+add the following in deploy section
+
+```ruby
+ namespace :deploy do
+    after :finishing, 'autoscaling:update_ami'
+ end
+```
+
+And to update autoscale group launch template manually
+
+```ruby
+    cap [stage] autoscaling:update_ami
+```
+i.e [stage] can be staging or production
+
+## How this works
+
+1. Fetch only running instances that have an auto scaling group name you specified
+2. Create AMI with first healthy instance
+3. Tag AMI with autoscale group name
+4. Wait for AMI to be available for use
+5. Update Launch template with update AMI
+6. Deleting stale images base on (aws_keep_prev_no_of_ami) variable
+   if not set will only keep the latest one
+   and delete the other AMI tagged with autoscale group name
+
+
+## Contributing
+
+1. Fork it ( https://github.com/Aftab-Akram/capistrano3-asg-ami/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+To test while developoing just `bundle console` on the project root directory and execute
+`Capistrano::AutoScaling::VERSION` for a quick test

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/capistrano3-asg-ami.gemspec

@@ -0,0 +1,29 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/autoscaling/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano3-asg-ami'
+  spec.version       = Capistrano::AutoScaling::VERSION
+  spec.authors       = ['Aftab Akram']
+  spec.email         = ['aftabakram04@gmail.com']
+  spec.summary       = %q{Capistrano 3 plugin for updating AWS Launch Template AMI}
+  spec.description   = %q{Capistrano 3 plugin for updating AWS Launch Template AMI with autoscale group first healthy instance.}
+  spec.homepage      = 'https://github.com/Aftab-Akram/capistrano3-asg-ami'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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.add_development_dependency 'bundler', '~> 2.1.4'
+  spec.add_development_dependency 'rake'
+
+  spec.add_dependency 'aws-sdk-ec2', '~> 1'
+  spec.add_dependency 'aws-sdk-autoscaling', '~> 1'
+  spec.add_dependency 'capistrano', '> 3.0.0'
+  spec.add_dependency 'activesupport', '>= 4.0.0'
+  spec.add_dependency 'capistrano-bundler', '~> 2'
+end

data/lib/capistrano/autoscaling/autoscaling.rb

@@ -0,0 +1 @@
+load File.expand_path('../../tasks/autoscaling.rake', __FILE__)

data/lib/capistrano/autoscaling/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module AutoScaling
+    VERSION = '1.0.0'
+  end
+end

data/lib/capistrano/autoscaling.rb

@@ -0,0 +1,2 @@
+require 'capistrano/bundler'
+load File.expand_path('../tasks/autoscaling.rake', __FILE__)

data/lib/capistrano/tasks/autoscaling.rake

@@ -0,0 +1,136 @@
+require 'active_support'
+require 'active_support/time'
+
+require 'aws-sdk-ec2'
+require 'aws-sdk-autoscaling'
+
+
+namespace :autoscaling do
+
+  desc 'Update AMI from Auto Scaling Group.'
+  task :update_ami do
+    region = fetch(:aws_region)
+    key = fetch(:aws_access_key_id)
+    secret = fetch(:aws_secret_access_key)
+    group_name = fetch(:aws_autoscaling_group_name)
+
+    credentials = {
+      region: region,
+      credentials: Aws::Credentials.new(key, secret)
+    }
+    instances_of_as = get_instances(credentials, group_name)
+
+    instances_of_as.each { |instance|
+      if instance.health_status != 'Healthy'
+        puts "Autoscaling: Skipping unhealthy instance #{instance.instance_id}"
+      else
+        update_ami(credentials, instance.instance_id, group_name)
+      end
+    }
+  end
+
+  # Get Autoscale Group Instance Info
+  def get_instances(credentials, group_name)
+    as = Aws::AutoScaling::Client.new(credentials)
+    instances_of_as = as.describe_auto_scaling_groups(
+      auto_scaling_group_names: [group_name],
+      max_records: 1,
+    ).auto_scaling_groups[0].instances
+
+    instances_of_as
+  end
+
+  # 1- Create AMI
+  # 2- Tag AMI with autoscale group name
+  # 3- Wait for AMI to be available for use
+  # 4- Update Launch template with update AMI
+  # 5- Deleting stale images base on (aws_keep_prev_no_of_ami) variable
+  #    if not set will only keep the latest one
+  #    and delete the other AMI tag with autoscale group name
+  def update_ami(credentials, instance_id, group_name)
+    ec2 = Aws::EC2::Resource.new(credentials)
+    ec_instance = ec2.instance(instance_id)
+    ami_prefix = fetch(:aws_autoscale_ami_prefix) || ''
+    launch_template_id = fetch(:aws_launch_template_id)
+    aws_keep_prev_no_of_ami = fetch(:aws_keep_prev_no_of_ami) || 1
+    return if launch_template_id.nil?
+    return unless fetch(:asg_ami_id).nil?
+
+    puts "Creating AMI# #{ami_prefix}#{Time.current.strftime("%F--%H-%M")} with first healthy instance"
+    resp = ec_instance.create_image(
+      name: "#{ami_prefix}#{Time.current.strftime("%F--%H-%M")}",
+    )
+    set :asg_ami_id, resp.id # Saving AMI ID in current context to avoid duplicate AMI's
+
+    puts "Tagging AMI# #{ami_prefix}#{Time.current.strftime("%F--%H-%M")} with autoscale group name"
+    resp.create_tags({
+                       tags: [
+                         {
+                           key: 'autoscaling_group_name',
+                           value: group_name
+                         },
+                       ],
+                     })
+
+    puts "\n================================================================="
+    puts 'Lanuch Template will only be updated if image is available for use.'
+    puts 'In case connection broken, or any unexpected error'
+    puts 'Either re-run the script OR update launch template at AWS with latest AMI id when AMI available'
+    puts '================================================================='
+    puts "\nWating for AMI# #{resp.id} to be available. This will take some time 4-8 minutes(appox) 😴"
+    ec2_client = Aws::EC2::Client.new(credentials)
+    ec2_client.wait_until(:image_available, { image_ids: [resp.id] })
+
+    puts "Updating Launch Template# #{launch_template_id}  with latest AMI# #{resp.id}"
+    ec2_client.create_launch_template_version({
+                                                launch_template_data: {
+                                                  image_id: resp.id,
+                                                },
+                                                launch_template_id: launch_template_id,
+                                                source_version: '$Latest',
+                                                version_description: 'updateAMI',
+                                              })
+    puts "Launch Template# #{launch_template_id} with latest AMI updated"
+
+    puts "Keeping #{aws_keep_prev_no_of_ami}# latest AMI's and cleaning the rest"
+    cleaning_ami(credentials, group_name)
+    puts 'AMI updated Finished'
+  end
+
+  def cleaning_ami(credentials, group_name)
+    ec2 = Aws::EC2::Resource.new(credentials)
+    aws_keep_prev_no_of_ami = fetch(:aws_keep_prev_no_of_ami) || 1
+    images = amis_by_group_name_tag(ec2, group_name)
+    images = images.sort_by { |x| Date.parse x.creation_date }.reverse
+    return unless images.count > aws_keep_prev_no_of_ami
+
+    images = images[aws_keep_prev_no_of_ami..-1] || []
+    images.each do |ami|
+      snapshots = snapshots_attached_to(ec2, ami)
+      puts "Deleting #{ami.id}# AMI"
+      ami.deregister
+
+      puts "Deleting #{ami.id}# AMI snapshots"
+      delete_snapshots(snapshots)
+
+      puts "#{ami.id}# AMI deleted"
+    end
+  end
+
+  def amis_by_group_name_tag(ec2, group_name)
+    ec2.images(owners: ['self']).to_a.select do |image|
+      image.tags.any? { |k| k.key == 'autoscaling_group_name' && k.value == group_name }
+    end
+  end
+
+  def snapshots_attached_to(ec2, image)
+    ids = image.block_device_mappings.map(&:ebs).compact.map(&:snapshot_id)
+    ec2.snapshots(snapshot_ids: ids)
+  end
+
+  def delete_snapshots(snapshots)
+    snapshots.each do |snapshot|
+      snapshot.delete unless snapshot.nil?
+    end
+  end
+end

data/test/autoscaling_test.rb

@@ -0,0 +1,18 @@
+require File.expand_path('../lib/localytics', File.dirname(__FILE__))
+require File.expand_path('test_helper', File.dirname(__FILE__))
+
+require 'cutest'
+require 'mocha/api'
+include Mocha::API
+
+prepare do
+  # Prepare Test
+end
+
+setup do
+  # Setup test
+end
+
+test 'autoscaling' do |mock|
+  # Do Test
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: capistrano3-asg-ami
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aftab Akram
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ec2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-autoscaling
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: capistrano-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Capistrano 3 plugin for updating AWS Launch Template AMI with autoscale
+  group first healthy instance.
+email:
+- aftabakram04@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- capistrano3-asg-ami.gemspec
+- lib/capistrano/autoscaling.rb
+- lib/capistrano/autoscaling/autoscaling.rb
+- lib/capistrano/autoscaling/version.rb
+- lib/capistrano/tasks/autoscaling.rake
+- lib/capistrano3-asg-ami.rb
+- test/autoscaling_test.rb
+homepage: https://github.com/Aftab-Akram/capistrano3-asg-ami
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Capistrano 3 plugin for updating AWS Launch Template AMI
+test_files:
+- test/autoscaling_test.rb