capistrano3-aws-asg-deploy 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c0ff2751f645519ab855d88cb3ca43301f1c72f92de6b37fcb63625896896a8
+  data.tar.gz: edbac2f60cc2bf5ac30beea377d9cd9e6161cc5bf2f55e1cf3730c5dfb7e0556
+SHA512:
+  metadata.gz: f000fdb73e382cddc849584e2ca9de7891f43f921b26f51738b5f837e172664b896b6d06b6522785206a33c971b2ae1e62cf718286f09b5aa23eee5472b95712
+  data.tar.gz: 5daea3f3347c3f4b98a08cdde03b12856bbb635ffa7fcea0e1b2e537f389f644c23d31b197e1b5ffc6b48f5bf1d3f68a1a68fdd2a753cf2421fd3259d740de3f

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-aws-asg-deploy.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    capistrano3-aws-asg-deploy (1.0.2)
+      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.4.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.2.0)
+    aws-partitions (1.500.0)
+    aws-sdk-autoscaling (1.68.0)
+      aws-sdk-core (~> 3, >= 3.120.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-core (3.121.0)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.239.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-ec2 (1.261.0)
+      aws-sdk-core (~> 3, >= 3.120.0)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.4.0)
+      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.9)
+    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.6)
+    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-aws-asg-deploy!
+  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,80 @@
+[![Gem Downloads](http://img.shields.io/gem/dt/capistrano3-asg-deploy.svg)](https://rubygems.org/gems/capistrano3-asg-deploy) [![Gem Version](https://badge.fury.io/rb/capistrano3-asg-deploy.png)](http://badge.fury.io/rb/capistrano3-asg-deploy) [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
+# capistrano3-aws-asg-deploy
+Capistrano 3 plugin for AWS Auto Scaling deploys.
+
+This is a fork of [Aftab-Akram/capistrano3-asg-deploy](https://github.com/Aftab-Akram/capistrano3-asg-deploy), updated with new features and Capistrano 3 conventions.
+
+ I'm mainly building this gem to work with private ip address
+
+## Requirements
+
+* aws-sdk-ec2 ~> 1
+* aws-sdk-autoscaling ~> 1
+* capistrano ~> 3
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano3-aws-asg-deploy'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install capistrano3-aws-asg-deploy
+
+Add this line to your application's Capfile:
+
+```ruby
+require 'capistrano/autoscaling_deploy'
+```
+
+## Usage
+
+Set credentials with AmazonEC2FullAccess permission 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_deploy_roles, [:app, :web, :db]
+set :aws_deploy_user, 'USER FOR SSH CONNECTION'
+
+invoke 'autoscaling_deploy:setup_instances'
+```
+
+you can add more auto scaling configs to deploy to multiple auto scaling groups like a cluster
+
+## How this works
+
+This gem will fetch only running instances that have an auto scaling group name you specified
+
+It will then reject the roles of :db and the :primary => true for all servers found **but the first one**
+
+(from all auto scaling groups you have specified such as using more then once the auto scaling directive in your config - i.e cluster deploy)
+
+this is to make sure a single working task does not run in parallel
+
+you end up as if you defined the servers yourself like so:
+
+````ruby
+server ip_address1, :app, :db, :web, :primary => true
+server ip_address2, :app, :web
+server ip_address3, :app, :web
+````
+
+## Contributing
+
+1. Fork it ( https://github.com/maximbaibakov/capistrano3-aws-asg-deploy/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::AutoScalingDeploy::VERSION` for a quick test

data/Rakefile

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

data/capistrano3-aws-asg-deploy.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_deploy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano3-aws-asg-deploy'
+  spec.version       = Capistrano::AutoScalingDeploy::VERSION
+  spec.authors       = ['Maxim Baibakov']
+  spec.email         = ['maxim.baibakov@gmail.com']
+  spec.summary       = %q{Deploy to AWS Auto Scaling group.}
+  spec.description   = %q{Get all instances in an AutoScaling group by AutoScaling group name.}
+  spec.homepage      = 'https://github.com/maximbaibakov/capistrano3-aws-asg-deploy'
+  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_deploy/autoscaling_deploy.rb

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

data/lib/capistrano/autoscaling_deploy/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module AutoScalingDeploy
+    VERSION = '1.0.2'
+  end
+end

data/lib/capistrano/autoscaling_deploy.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,97 @@
+require 'active_support'
+require 'active_support/time'
+
+require 'aws-sdk-ec2'
+require 'aws-sdk-autoscaling'
+
+namespace :load do
+  task :defaults do
+    set :aws_autoscaling, true
+    set :aws_region, 'ap-northeast-1'
+    set :aws_deploy_roles, [:app, :web, :db]
+    set :aws_autoscale_ami_prefix, ''
+  end
+end
+
+namespace :deploy do
+  before :starting, :check_autoscaling_hooks do
+    invoke 'autoscaling_deploy:setup_instances' if fetch(:aws_autoscaling)
+  end
+end
+
+namespace :autoscaling_deploy do
+  desc 'Add server from Auto Scaling Group.'
+  task :setup_instances do
+    ec2_instances = fetch_ec2_instances
+    aws_deploy_roles = fetch(:aws_deploy_roles)
+    aws_deploy_user = fetch(:aws_deploy_user)
+
+    ec2_instances.each { |instance|
+      if ec2_instances.first == instance
+        server instance, user: aws_deploy_user, roles: aws_deploy_roles, primary: true
+        puts("First Server: #{instance} - #{aws_deploy_roles}")
+      else
+        server instance, user: aws_deploy_user, roles: sanitize_roles(aws_deploy_roles)
+        puts("Server: #{instance} - #{sanitize_roles(aws_deploy_roles)}")
+      end
+    }
+  end
+
+  def fetch_ec2_instances
+    region = fetch(:aws_region)
+    key = fetch(:aws_access_key_id)
+    secret = fetch(:aws_secret_access_key)
+    group_name = fetch(:aws_autoscaling_group_name)
+    puts("Fetching servers for Auto Scaling Group: #{group_name}")
+
+    instances = get_instances_ip(region, key, secret, group_name)
+
+    puts("Found #{instances.count} servers (#{instances.join(' , ')}) for Auto Scaling Group: #{group_name} ")
+
+    instances
+  end
+
+  # Get Autoscale Group Healthy Instance Private IP's
+  def get_instances_ip(region, key, secret, group_name)
+    credentials = {
+      region: region,
+      credentials: Aws::Credentials.new(key, secret)
+    }
+    instances_of_as = get_instances(credentials, group_name)
+    autoscaling_dns = []
+    ec2 = Aws::EC2::Resource.new(credentials)
+
+    instances_of_as.each do |instance|
+      if instance.health_status != 'Healthy'
+        puts "Autoscaling: Skipping unhealthy instance #{instance.instance_id}"
+      else
+        autoscaling_dns << ec2.instance(instance.instance_id).private_ip_address
+      end
+    end
+
+    autoscaling_dns
+  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
+
+  # remove :db (for migrations), remove  :primary => :true (for assets precompile) for primary server
+  def sanitize_roles(roles)
+    roles.inject([]) { |acc, role|
+      if !role.is_a?(Hash)
+        acc << role if role != :db
+      else
+        acc << role.reject { |k, v| k == :primary }
+      end
+      acc
+    }
+  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 'autoscale' do |mock|
+  # Do Test
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: capistrano3-aws-asg-deploy
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Maxim Baibakov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-04-13 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: Get all instances in an AutoScaling group by AutoScaling group name.
+email:
+- maxim.baibakov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- capistrano3-aws-asg-deploy.gemspec
+- lib/capistrano/autoscaling_deploy.rb
+- lib/capistrano/autoscaling_deploy/autoscaling_deploy.rb
+- lib/capistrano/autoscaling_deploy/version.rb
+- lib/capistrano/tasks/autoscaling.rake
+- lib/capistrano3-aws-asg-deploy.rb
+- test/autoscaling_test.rb
+homepage: https://github.com/maximbaibakov/capistrano3-aws-asg-deploy
+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.3.1
+signing_key: 
+specification_version: 4
+summary: Deploy to AWS Auto Scaling group.
+test_files:
+- test/autoscaling_test.rb