capistrano-asg-rolling 0.1.0

data/lib/capistrano/asg/rolling/plugin.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'capistrano/plugin'
+
+module Capistrano
+  module ASG
+    module Rolling
+      # Load this Capistrano Plugin in your Capfile:
+      #
+      # require 'capistrano/asg/rolling'
+      # install_plugin Capistrano::ASG::Rolling::Plugin
+      #
+      class Plugin < Capistrano::Plugin
+        def set_defaults
+          set_if_empty :aws_access_key_id, ENV['AWS_ACCESS_KEY_ID']
+          set_if_empty :aws_secret_access_key, ENV['AWS_SECRET_ACCESS_KEY']
+          set_if_empty :aws_region, ENV['AWS_REGION']
+
+          set_if_empty :asg_rolling_group_name, ENV['asg_name']
+          set_if_empty :asg_rolling_use_private_ip_address, true
+          set_if_empty :asg_rolling_verbose, true
+        end
+
+        def register_hooks
+          Capistrano::DSL.stages.each do |stage|
+            after stage, 'rolling:setup'
+          end
+
+          after 'deploy', 'rolling:update'
+          after 'deploy:failed', 'rolling:cleanup'
+
+          after 'rolling:update', 'rolling:cleanup'
+          after 'rolling:create_ami', 'rolling:cleanup'
+
+          # Register an exit hook to do some cleanup when Capistrano
+          # terminates without calling our after cleanup hook.
+          at_exit { cleanup }
+        end
+
+        def define_tasks
+          eval_rakefile File.expand_path('../tasks/rolling.rake', __dir__)
+        end
+
+        def logger
+          @logger ||= Logger.new(verbose: config.verbose?)
+        end
+
+        def config
+          Capistrano::ASG::Rolling::Configuration
+        end
+
+        def cleanup
+          instances = config.instances.auto_terminate
+          return if instances.empty?
+
+          logger.info 'Terminating instance(s)...'
+          instances.terminate
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/asg/rolling/snapshot.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module ASG
+    module Rolling
+      # AWS EC2 EBS snapshot.
+      class Snapshot
+        include AWS
+
+        attr_reader :id
+
+        def initialize(id)
+          @id = id
+        end
+
+        def delete
+          aws_ec2_client.delete_snapshot(snapshot_id: id)
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/asg/rolling/ssh.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module ASG
+    module Rolling
+      # SSH availability test.
+      module SSH
+        module_function
+
+        def test?(ip_address, user, ssh_options)
+          options = ssh_options || {}
+          options[:timeout] = 10
+
+          ::Net::SSH.start(ip_address, user, options) do |ssh|
+            ssh.exec!('echo hello')
+          end
+
+          true
+        rescue ::Net::SSH::ConnectionTimeout, ::Net::SSH::Proxy::ConnectError, Errno::ECONNREFUSED, Errno::ETIMEDOUT
+          false
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/asg/rolling/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module ASG
+    module Rolling
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/capistrano/asg/rolling.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'capistrano/all'
+
+require 'capistrano/asg/rolling/aws'
+require 'capistrano/asg/rolling/ami'
+require 'capistrano/asg/rolling/autoscale_group'
+require 'capistrano/asg/rolling/autoscale_groups'
+require 'capistrano/asg/rolling/configuration'
+require 'capistrano/asg/rolling/dsl'
+require 'capistrano/asg/rolling/exception'
+require 'capistrano/asg/rolling/instance'
+require 'capistrano/asg/rolling/instances'
+require 'capistrano/asg/rolling/launch_template'
+require 'capistrano/asg/rolling/logger'
+require 'capistrano/asg/rolling/parallel'
+require 'capistrano/asg/rolling/plugin'
+require 'capistrano/asg/rolling/snapshot'
+require 'capistrano/asg/rolling/ssh'
+require 'capistrano/asg/rolling/version'

data/lib/capistrano/asg/tasks/rolling.rake

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+namespace :rolling do
+  desc 'Setup servers to be used for (rolling) deployment'
+  task :setup do
+    config.autoscale_groups.each do |group|
+      if group.rolling?
+        logger.info "Auto Scaling Group: **#{group.name}**, rolling deployment strategy."
+
+        # If we've already launched an instance with this image, then skip it.
+        next unless config.instances.with_image(group.launch_template.image_id).empty?
+
+        instance = Capistrano::ASG::Rolling::Instance.run(autoscaling_group: group, overrides: config.instance_overrides)
+        logger.info "Launched Instance: **#{instance.id}**"
+        config.instances << instance
+
+        logger.verbose "Adding server: **#{instance.ip_address}**"
+
+        # Add server to the Capistrano server list.
+        server(instance.ip_address, group.properties)
+      else
+        logger.info "Auto Scaling Group: **#{group.name}**, standard deployment strategy."
+
+        group.instances.each_with_index do |instance, index| # rubocop:disable Lint/ShadowingOuterLocalVariable
+          if index.zero? && group.properties.key?(:primary_roles)
+            server_properties = group.properties.dup
+            server_properties[:roles] = server_properties.delete(:primary_roles)
+          else
+            server_properties = group.properties
+          end
+
+          logger.verbose "Adding server: **#{instance.ip_address}**"
+
+          # Add server to the Capistrano server list.
+          server(instance.ip_address, server_properties)
+        end
+      end
+    end
+
+    unless config.instances.empty?
+      logger.info 'Waiting for SSH to be available...'
+      config.instances.wait_for_ssh
+    end
+  end
+
+  desc 'Update Auto Scaling Groups: create AMIs, update Launch Templates and start Instance Refresh'
+  task :update do
+    unless config.instances.empty?
+      logger.info 'Stopping instance(s)...'
+      config.instances.stop
+
+      logger.info 'Creating AMI(s)...'
+      amis = config.instances.create_ami(description: revision_log_message)
+
+      logger.info 'Updating Launch Template(s) with the new AMI(s)...'
+      launch_templates = config.autoscale_groups.update_launch_templates(amis: amis, description: revision_log_message)
+
+      logger.info 'Triggering Instance Refresh on Auto Scaling Group(s)...'
+      launch_templates.each do |launch_template|
+        config.autoscale_groups.with_launch_template(launch_template).start_instance_refresh
+      end
+
+      config.launch_templates.merge(launch_templates)
+    end
+  end
+
+  desc 'Clean up old Launch Template versions and AMIs and terminate instances'
+  task :cleanup do
+    unless config.launch_templates.empty?
+      logger.info 'Cleaning up old Launch Template version(s) and AMI(s)...'
+      config.launch_templates.each do |launch_template|
+        launch_template.previous_versions.drop(config.keep_versions).each do |version|
+          next if version.default_version?
+
+          # Need to retrieve AMI before deleting the Launch Template version.
+          ami = version.ami
+
+          logger.verbose "Deleting Launch Template version **#{version.version}**..."
+          version.delete
+
+          if ami.exists?
+            logger.verbose "Deleting AMI **#{version.ami.id}** and snapshots..."
+            ami.delete
+          end
+        end
+      end
+    end
+
+    instances = config.instances.auto_terminate
+    if instances.any?
+      logger.info 'Terminating instance(s)...'
+      instances.terminate
+    end
+  end
+
+  desc 'Launch Instances by marking instances to not automatically terminate'
+  task :launch_instances do
+    if config.instances.any?
+      config.instances.each do |instance|
+        instance.auto_terminate = false
+      end
+    else
+      logger.error 'No instances have been launched. Are you using a configuration with rolling deployments?'
+    end
+  end
+
+  desc 'Create an AMI from an Instance in the Auto Scaling Groups'
+  task :create_ami do
+    config.autoscale_groups.each do |group|
+      logger.info 'Selecting instance to create AMI from...'
+
+      # Pick a random instance, put it in standby and create an AMI.
+      instance = group.instances.sample
+      if instance
+        logger.info "Instance **#{instance.id}** entering standby state..."
+        group.enter_standby(instance)
+
+        logger.info 'Creating AMI...'
+        ami = instance.create_ami(description: revision_log_message)
+
+        logger.info "Instance **#{instance.id}** exiting standby state..."
+        group.exit_standby(instance)
+
+        logger.info 'Updating Launch Template with the new AMI...'
+        launch_template = group.launch_template
+        launch_template.create_version(image_id: ami.id, description: revision_log_message)
+
+        config.launch_templates << launch_template
+      else
+        logger.error 'Unable to create AMI. No instance with a valid state was found in the Auto Scaling Group.'
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-asg-rolling
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kentaa
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-autoscaling
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.39'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.39'
+- !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: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  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'
+description:
+email:
+- developers@kentaa.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capistrano-asg-rolling.gemspec
+- lib/capistrano/asg/rolling.rb
+- lib/capistrano/asg/rolling/ami.rb
+- lib/capistrano/asg/rolling/autoscale_group.rb
+- lib/capistrano/asg/rolling/autoscale_groups.rb
+- lib/capistrano/asg/rolling/aws.rb
+- lib/capistrano/asg/rolling/configuration.rb
+- lib/capistrano/asg/rolling/dsl.rb
+- lib/capistrano/asg/rolling/exception.rb
+- lib/capistrano/asg/rolling/instance.rb
+- lib/capistrano/asg/rolling/instances.rb
+- lib/capistrano/asg/rolling/launch_template.rb
+- lib/capistrano/asg/rolling/logger.rb
+- lib/capistrano/asg/rolling/parallel.rb
+- lib/capistrano/asg/rolling/plugin.rb
+- lib/capistrano/asg/rolling/snapshot.rb
+- lib/capistrano/asg/rolling/ssh.rb
+- lib/capistrano/asg/rolling/version.rb
+- lib/capistrano/asg/tasks/rolling.rake
+homepage: https://github.com/KentaaNL/capistrano-asg-rolling
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: Capistrano plugin for performing rolling updates to AWS Auto Scaling Groups
+  using Instance Refresh
+test_files: []