capistrano-asg-rolling 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 517d95aa2350605f6a9fb472c3c5b293916946747936f2850219f65f6eb4b439
-  data.tar.gz: 159c94f7e0c371d0e7d1877fbc73ad40e923fc6e8c24e22ab586b7c603c98999
+  metadata.gz: 3f61a7cc3d942cd53ef2efb22eadcfb60cced1deab57b0ef19398bc7efe78242
+  data.tar.gz: 258611f43a7123defb8aabf8a05dd732bc79cd9fdd4443003b81f1db19969b88
 SHA512:
-  metadata.gz: 628c4200fb0e4e81370829d700bc0206a81390ad4392d97459c20f8c358a72a1882bcacd829cb69dcb816f9c2f5ed39ef5f8c05c35e7abc7231defa41fce98c0
-  data.tar.gz: 688a2886933cb90fd2781946e09fd54bd8d72fbbe450256fdd8c16302465007652c34194047a9a49e87226a7a0f823aeba6f5ddc9f210102edf1e6622afa495c
+  metadata.gz: ab36e35b6afcd985cb4d23d4b08f5486c85a74f006b5c9e80cce9cca7b80fb8cb172333c3a750391ec4d57807d60943c2b1b6d7e685cb97730f517958b506e2e
+  data.tar.gz: bb22aef2c396ebfa35c5843caa3929e1ba2c03aba7284de2334bf631e864432083636b1963ea7a5355a89e20b272497272842acc72e0fcee7087354a2bdaf949

data/.github/workflows/test.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0', '3.1', '3.2']
+        ruby-version: ['2.7', '3.0', '3.1', '3.2', '3.3']
 
     steps:
     - uses: actions/checkout@v2

data/.rubocop.yml

@@ -2,6 +2,7 @@ require:
   - rubocop-performance
   - rubocop-rake
   - rubocop-rspec
+  - rubocop-rspec_rails
 
 AllCops:
   NewCops: enable
@@ -21,6 +22,9 @@ Metrics/AbcSize:
 Metrics/BlockLength:
   Enabled: false
 
+Metrics/BlockNesting:
+  Max: 4
+
 Metrics/ClassLength:
   Enabled: false
 
@@ -35,3 +39,6 @@ RSpec/IndexedLet:
 
 RSpec/MultipleExpectations:
   Max: 5
+
+Style/GuardClause:
+  Enabled: false

data/Gemfile

@@ -7,7 +7,8 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in capistrano-asg-rolling.gemspec
 gemspec
 
-gem 'rubocop', '~> 1.56.3'
-gem 'rubocop-performance', '~> 1.19.0'
-gem 'rubocop-rake', '~> 0.6.0'
-gem 'rubocop-rspec', '~> 2.24.0'
+gem 'rubocop', '~> 1.58'
+gem 'rubocop-performance', '~> 1.20'
+gem 'rubocop-rake', '~> 0.6'
+gem 'rubocop-rspec', '~> 3.0'
+gem 'rubocop-rspec_rails', '~> 2.30'

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    capistrano-asg-rolling (0.4.0)
-      aws-sdk-autoscaling (~> 1, >= 1.67.0)
+    capistrano-asg-rolling (0.5.0)
+      aws-sdk-autoscaling (~> 1, >= 1.100.0)
       aws-sdk-ec2 (~> 1)
       capistrano (~> 3)
       concurrent-ruby (~> 1)
@@ -10,101 +10,104 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.5)
-      public_suffix (>= 2.0.2, < 6.0)
-    airbrussh (1.5.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    airbrussh (1.5.3)
       sshkit (>= 1.6.1, != 1.7.0)
     ast (2.4.2)
-    aws-eventstream (1.2.0)
-    aws-partitions (1.830.0)
-    aws-sdk-autoscaling (1.98.0)
-      aws-sdk-core (~> 3, >= 3.184.0)
-      aws-sigv4 (~> 1.1)
-    aws-sdk-core (3.184.0)
-      aws-eventstream (~> 1, >= 1.0.2)
-      aws-partitions (~> 1, >= 1.651.0)
+    aws-eventstream (1.3.0)
+    aws-partitions (1.989.0)
+    aws-sdk-autoscaling (1.121.0)
+      aws-sdk-core (~> 3, >= 3.207.0)
       aws-sigv4 (~> 1.5)
+    aws-sdk-core (3.209.1)
+      aws-eventstream (~> 1, >= 1.3.0)
+      aws-partitions (~> 1, >= 1.651.0)
+      aws-sigv4 (~> 1.9)
       jmespath (~> 1, >= 1.6.1)
-    aws-sdk-ec2 (1.410.0)
-      aws-sdk-core (~> 3, >= 3.184.0)
-      aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.6.0)
+    aws-sdk-ec2 (1.481.0)
+      aws-sdk-core (~> 3, >= 3.207.0)
+      aws-sigv4 (~> 1.5)
+    aws-sigv4 (1.10.0)
       aws-eventstream (~> 1, >= 1.0.2)
-    base64 (0.1.1)
-    capistrano (3.17.3)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    capistrano (3.19.1)
       airbrussh (>= 1.0.0)
       i18n
       rake (>= 10.0.0)
       sshkit (>= 1.9.0)
-    concurrent-ruby (1.2.2)
-    crack (0.4.5)
+    concurrent-ruby (1.3.4)
+    crack (1.0.0)
+      bigdecimal
       rexml
-    diff-lcs (1.5.0)
-    hashdiff (1.0.1)
-    i18n (1.14.1)
+    diff-lcs (1.5.1)
+    hashdiff (1.1.1)
+    i18n (1.14.6)
       concurrent-ruby (~> 1.0)
     jmespath (1.6.2)
-    json (2.6.3)
+    json (2.7.2)
     language_server-protocol (3.17.0.3)
     net-scp (4.0.0)
       net-ssh (>= 2.6.5, < 8.0.0)
-    net-ssh (7.2.0)
-    parallel (1.23.0)
-    parser (3.2.2.3)
+    net-sftp (4.0.0)
+      net-ssh (>= 5.0.0, < 8.0.0)
+    net-ssh (7.3.0)
+    ostruct (0.6.0)
+    parallel (1.26.3)
+    parser (3.3.5.0)
       ast (~> 2.4.1)
       racc
-    public_suffix (5.0.3)
-    racc (1.7.1)
+    public_suffix (5.1.1)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.8.1)
-    rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.8)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.1)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
-    rubocop (1.56.4)
-      base64 (~> 0.1.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.66.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.3)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.1, < 2.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
-      parser (>= 3.2.1.0)
-    rubocop-capybara (2.19.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.24.0)
-      rubocop (~> 1.33)
-    rubocop-performance (1.19.1)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
+    rubocop-ast (1.32.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.22.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.24.1)
-      rubocop (~> 1.33)
-      rubocop-capybara (~> 2.17)
-      rubocop-factory_bot (~> 2.22)
+    rubocop-rspec (3.1.0)
+      rubocop (~> 1.61)
+    rubocop-rspec_rails (2.30.0)
+      rubocop (~> 1.61)
+      rubocop-rspec (~> 3, >= 3.0.1)
     ruby-progressbar (1.13.0)
-    sshkit (1.21.5)
+    sshkit (1.23.1)
+      base64
       net-scp (>= 1.1.2)
+      net-sftp (>= 2.1.2)
       net-ssh (>= 2.8.0)
-    unicode-display_width (2.4.2)
-    webmock (3.19.1)
+      ostruct
+    unicode-display_width (2.6.0)
+    webmock (3.24.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -117,10 +120,11 @@ DEPENDENCIES
   capistrano-asg-rolling!
   rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop (~> 1.56.3)
-  rubocop-performance (~> 1.19.0)
-  rubocop-rake (~> 0.6.0)
-  rubocop-rspec (~> 2.24.0)
+  rubocop (~> 1.58)
+  rubocop-performance (~> 1.20)
+  rubocop-rake (~> 0.6)
+  rubocop-rspec (~> 3.0)
+  rubocop-rspec_rails (~> 2.30)
   webmock (~> 3.11)
 
 BUNDLED WITH

data/README.md

@@ -16,25 +16,22 @@ Instead of deploying to live servers, capistrano-asg-rolling will create a tempo
 - Delete any outdated Launch Template versions, AMIs and snapshots created by previous deployments.
 - Terminate the no longer needed instances.
 
-## Caveats
+## Important
 
-#### Instance refresh limitations
+### Instance refresh
 
-Please be aware of the limitations of using instance refresh, in particular "Instances terminated before launch": https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html#instance-refresh-limitations
+To better understand how Instance Refresh replaces instances, make sure to read the documentation:
+https://docs.aws.amazon.com/autoscaling/ec2/userguide/instance-refresh-overview.html
 
-#### Launch Templates
+### Launch Templates
 
 This gem depends on Auto Scaling Groups with Launch Templates. Using an Auto Scaling Group with a Launch Configuration is not supported, and will raise an `Capistrano::ASG::Rolling::NoLaunchTemplate`.
 
 Instance refresh uses the desired configuration to update the Launch Template version of the Auto Scaling Group after a succesful deployment. Setting the Launch Template version to `Latest` on the Auto Scaling Group is not needed.
 
-#### Experimental
+### Experimental
 
-This gem is experimental, it works for our configuration / use case, but might not for yours.
-
-The configuration options are not considered stable and might be changed or removed in future releases.
-
-The gem could have a better / fancier name.
+Please note that this gem works well for our configuration / use case, but it might not fit yours. Any feedback using GitHub issues / pull requests, is much appreciated.
 
 ## Installation
 
@@ -133,16 +130,21 @@ autoscale 'app-autoscale-group', rolling: true    # default: use rolling deploym
 autoscale 'web-autoscale-group', rolling: false   # override: use normal deployment
 ```
 
-### Deploy with a custom percentage of minimum healthy instances during the instance refresh
+### Deploy with custom percentage of minimum/maximum healthy instances during the instance refresh
+
+The instance refresh is triggered without specifying a value for the minimum / maximum healthy percentages. This means that either the default
+values will be used (minimum: 90%, maximum: 100%) or the percentages set in the instance maintenance policy for the Auto Scaling Group.
+You can tune both the minimum and maximum values to have more control about the desired capacity that must be healthy to proceed with replacing instances.
 
-The instance refresh is triggered by default with a requirement of 100% minimum healthy instances. ie. One instance is replaced at a time, and must be healthy and in-service before the next is replaced. This can mean that instance refreshes take a long time to complete, especially with larger numbers of instances with large warmup values. Reducing this value allows more instances to be terminated and new instances to be brought up at once during the instance refresh. eg. a value of 0 would terminate all instances in the autoscaling group and replace them at once.
+For example: reducing the minimum healthy percentage allows more instances to be terminated and new instances to be brought up at once during the instance refresh. eg. a value of 0 would terminate all instances in the autoscaling group and replace them at once.
 
-You can configure the minimum healthy percentage per autoscaling group using the `healthy_percentage` option:
+You can configure the minimum healthy percentage per autoscaling group using the `min_healthy_percentage` option, and the maximum healthy percentage using the `max_healthy_percentage` option. Please note that if you specify `max_healthy_percentage`, you must also specify `min_healthy_percentage`.
 
 ```ruby
 # config/deploy/<stage>.rb
-autoscale 'app-autoscale-group', user: 'deployer'                           # default: use standard deployment with 100% minimum healthy instances
-autoscale 'web-autoscale-group', user: 'deployer', healthy_percentage: 75   # override: allow 25% of instances to be terminated and replaced at once
+autoscale 'app-autoscale-group',                                                           # use default percentages or percentages set in the instance maintenance policy
+autoscale 'web-autoscale-group', min_healthy_percentage: 75                                # allow 25% of instances to be terminated and replaced at once
+autoscale 'web-autoscale-group', min_healthy_percentage: 100, max_healthy_percentage: 110  # allow for 10% above desired capacity during instance refresh
 ```
 
 ### Custom stage
@@ -172,6 +174,46 @@ autoscale 'web-autoscale-group', rolling: true, user: 'deployer'
 
 With these two stages, you can run any tasks with `cap production <task name>` and rolling deployments with `cap production_rolling deploy`.
 
+## Useful commands
+
+### Test deployment
+
+Do a test deployment: run the deploy task, but do not trigger the update ASG task and do not automatically terminate instances.
+
+```bash
+cap <stage> rolling:deploy_test
+```
+
+### Launch instances
+
+Just launch instance(s) defined in the Auto Scale Group(s) launch template.
+This instance is not attached to the Auto Scale Group and needs to be terminated manually.
+
+```bash
+cap <stage> rolling:launch_instances
+```
+
+### Create AMI of instance in ASG
+
+Pick an instance in the Auto Scale Group(s), put it into standby and stop it.
+Then create an AMI and a new launch template. Then start the instance and put it into service again.
+
+```bash
+cap <stage> rolling:create_ami
+```
+
+## Filtering
+
+You can filter any command to run on a specific Auto Scale Group by using the parameter `asg_name`.
+
+For example, the command:
+
+```bash
+cap <stage> deploy asg_name=app-autoscale-group
+```
+
+Will do a deployment only on the Auto Scale Group with the name `app-autoscale-group`.
+
 ## IAM policy
 
 The following IAM permissions are required:
@@ -185,6 +227,7 @@ The following IAM permissions are required:
             "Action": [
                 "autoscaling:DescribeAutoScalingGroups",
                 "autoscaling:DescribeAutoScalingInstances",
+                "autoscaling:DescribeInstanceRefreshes",
                 "autoscaling:EnterStandby",
                 "autoscaling:ExitStandby",
                 "autoscaling:StartInstanceRefresh",
@@ -198,6 +241,7 @@ The following IAM permissions are required:
                 "ec2:DescribeInstances",
                 "ec2:DescribeLaunchTemplateVersions",
                 "ec2:RunInstances",
+                "ec2:StartInstances",
                 "ec2:StopInstances",
                 "ec2:TerminateInstances"
             ],

data/capistrano-asg-rolling.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'webmock', '~> 3.11'
 
-  spec.add_dependency 'aws-sdk-autoscaling', '~> 1', '>= 1.67.0'
+  spec.add_dependency 'aws-sdk-autoscaling', '~> 1', '>= 1.100.0'
   spec.add_dependency 'aws-sdk-ec2', '~> 1'
   spec.add_dependency 'capistrano', '~> 3'
   spec.add_dependency 'concurrent-ruby', '~> 1'

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

@@ -13,12 +13,21 @@ module Capistrano
         LIFECYCLE_STATE_STANDBY = 'Standby'
 
         COMPLETED_REFRESH_STATUSES = %w[Successful Failed Cancelled RollbackSuccessful RollbackFailed].freeze
+        FAILED_REFRESH_STATUS = 'Failed'
 
         attr_reader :name, :properties, :refresh_id
 
         def initialize(name, properties = {})
           @name = name
           @properties = properties
+
+          if properties[:healthy_percentage]
+            properties[:min_healthy_percentage] = properties.delete(:healthy_percentage)
+
+            Kernel.warn('WARNING: the property `healthy_percentage` is deprecated and will be removed in a future release. Please update to `min_healthy_percentage`.')
+          end
+
+          validate_properties!
         end
 
         def exists?
@@ -42,8 +51,12 @@ module Capistrano
           aws_autoscaling_group.health_check_grace_period
         end
 
-        def healthy_percentage
-          properties.fetch(:healthy_percentage, 100)
+        def min_healthy_percentage
+          properties.fetch(:min_healthy_percentage, nil)
+        end
+
+        def max_healthy_percentage
+          properties.fetch(:max_healthy_percentage, nil)
         end
 
         def start_instance_refresh(launch_template)
@@ -58,18 +71,23 @@ module Capistrano
             },
             preferences: {
               instance_warmup: instance_warmup_time,
-              min_healthy_percentage: healthy_percentage,
-              skip_matching: true
-            }
+              skip_matching: true,
+              min_healthy_percentage: min_healthy_percentage,
+              max_healthy_percentage: max_healthy_percentage
+            }.compact
           ).instance_refresh_id
         rescue Aws::AutoScaling::Errors::InstanceRefreshInProgress => e
-          raise Capistrano::ASG::Rolling::InstanceRefreshFailed, e
+          raise Capistrano::ASG::Rolling::StartInstanceRefreshError, e
         end
 
         InstanceRefreshStatus = Struct.new(:status, :percentage_complete) do
           def completed?
             COMPLETED_REFRESH_STATUSES.include?(status)
           end
+
+          def failed?
+            status == FAILED_REFRESH_STATUS
+          end
         end
 
         def latest_instance_refresh
@@ -136,6 +154,21 @@ module Capistrano
         def aws_autoscaling_group
           @aws_autoscaling_group ||= ::Aws::AutoScaling::AutoScalingGroup.new(name: name, client: aws_autoscaling_client)
         end
+
+        def validate_properties!
+          raise ArgumentError, 'Property `min_healthy_percentage` must be between 0-100.' if min_healthy_percentage && !(0..100).cover?(min_healthy_percentage)
+
+          if max_healthy_percentage
+            raise ArgumentError, 'Property `max_healthy_percentage` must be between 100-200.' unless (100..200).cover?(max_healthy_percentage)
+
+            if min_healthy_percentage
+              diff = max_healthy_percentage - min_healthy_percentage
+              raise ArgumentError, 'The difference between `min_healthy_percentage` and `max_healthy_percentage` must not be greater than 100.' if diff > 100
+            else
+              raise ArgumentError, 'Property `min_healthy_percentage` must be specified when using `max_healthy_percentage`.'
+            end
+          end
+        end
       end
     end
   end

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

@@ -13,10 +13,17 @@ module Capistrano
       class NoLaunchTemplate < Capistrano::ASG::Rolling::Exception
       end
 
+      class StartInstanceRefreshError < Capistrano::ASG::Rolling::Exception
+      end
+
+      # Exception when the instance refresh failed on one of the ASGs.
       class InstanceRefreshFailed < Capistrano::ASG::Rolling::Exception
+        def initialize
+          super('Failed to update Auto Scaling Group(s)')
+        end
       end
 
-      # Exception when instance terminate fails.
+      # Exception when instance terminate has failed.
       class InstanceTerminateFailed < Capistrano::ASG::Rolling::Exception
         attr_reader :instance
 
@@ -25,6 +32,13 @@ module Capistrano
           super(exception)
         end
       end
+
+      # Exception when no instances could be launched.
+      class NoInstancesLaunched < Capistrano::ASG::Rolling::Exception
+        def initialize
+          super('No instances have been launched. Are you using a configuration with rolling deployments?')
+        end
+      end
     end
   end
 end

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

@@ -81,6 +81,11 @@ module Capistrano
           Configuration.use_private_ip_address? ? private_ip_address : public_ip_address
         end
 
+        def start
+          aws_ec2_client.start_instances(instance_ids: [id])
+          aws_ec2_client.wait_until(:instance_running, instance_ids: [id])
+        end
+
         def stop
           aws_ec2_client.stop_instances(instance_ids: [id])
           aws_ec2_client.wait_until(:instance_stopped, instance_ids: [id])
@@ -96,10 +101,7 @@ module Capistrano
         end
 
         def create_ami(name: nil, description: nil, tags: nil)
-          ami_tags = {
-            'Name' => autoscale_group.name_tag,
-            'capistrano-asg-rolling:version' => Capistrano::ASG::Rolling::VERSION
-          }
+          ami_tags = { 'Name' => autoscale_group.name_tag }
           ami_tags.merge!(tags) if tags
 
           AMI.create(instance: self, name: name || ami_name, description: description, tags: ami_tags)

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

@@ -11,10 +11,9 @@ module Capistrano
 
         def run(work)
           result = Concurrent::Array.new
-          threads = []
 
-          work.each do |w|
-            threads << Thread.new do
+          threads = work.map do |w|
+            Thread.new do
               result << yield(w)
             end
           end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Capistrano
+  module ASG
+    module Rolling
+      # Helper for creating tags from Capistrano specific variables.
+      module Tags
+        module_function
+
+        # The tags to add to an AMI.
+        def ami_tags
+          application_tags.merge(deployment_tags).merge(gem_tags)
+        end
+
+        # Tags related to the current application / stage.
+        def application_tags
+          {
+            application: fetch(:application),
+            stage: fetch(:stage)
+          }.compact.transform_keys { |tag| "capistrano-asg-rolling:#{tag}" }
+        end
+
+        # Tags related to the current deployment, such as git revisions.
+        def deployment_tags
+          {
+            branch: fetch(:branch),
+            user: fetch(:local_user),
+            revision: fetch(:current_revision),
+            release: fetch(:release_timestamp)
+          }.compact.transform_keys { |tag| "capistrano-asg-rolling:deployment-#{tag}" }
+        end
+
+        # Tags related to the current gem version.
+        def gem_tags
+          {
+            'capistrano-asg-rolling:gem-version' => Capistrano::ASG::Rolling::VERSION
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module Capistrano
   module ASG
     module Rolling
-      VERSION = '0.4.0'
+      VERSION = '0.5.0'
     end
   end
 end

data/lib/capistrano/asg/rolling.rb

@@ -18,4 +18,5 @@ require 'capistrano/asg/rolling/parallel'
 require 'capistrano/asg/rolling/plugin'
 require 'capistrano/asg/rolling/snapshot'
 require 'capistrano/asg/rolling/ssh'
+require 'capistrano/asg/rolling/tags'
 require 'capistrano/asg/rolling/version'

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

@@ -50,7 +50,7 @@ namespace :rolling do
       config.instances.stop
 
       logger.info 'Creating AMI(s)...'
-      amis = config.instances.create_ami(description: revision_log_message)
+      amis = config.instances.create_ami(description: revision_log_message, tags: Capistrano::ASG::Rolling::Tags.ami_tags)
 
       logger.info 'Updating Launch Template(s) with the new AMI(s)...'
       launch_templates = config.autoscale_groups.launch_templates
@@ -62,7 +62,7 @@ namespace :rolling do
           group.start_instance_refresh(launch_template)
 
           logger.verbose "Successfully started Instance Refresh on Auto Scaling Group **#{group.name}**."
-        rescue Capistrano::ASG::Rolling::InstanceRefreshFailed => e
+        rescue Capistrano::ASG::Rolling::StartInstanceRefreshError => e
           logger.info "Failed to start Instance Refresh on Auto Scaling Group **#{group.name}**: #{e.message}"
         end
       end
@@ -91,7 +91,7 @@ namespace :rolling do
           end
 
           # Only clean up when AMI was tagged by us.
-          next if exists && !ami.tag?('capistrano-asg-rolling:version')
+          next if exists && (!ami.tag?('capistrano-asg-rolling:version') || !ami.tag?('capistrano-asg-rolling:gem-version'))
 
           logger.verbose "Deleting Launch Template **#{version.name}** version **#{version.version}**..."
           version.delete
@@ -124,8 +124,7 @@ namespace :rolling do
         instance.auto_terminate = false
       end
     else
-      logger.error 'No instances have been launched. Are you using a configuration with rolling deployments?'
-      exit 1
+      raise Capistrano::ASG::Rolling::NoInstancesLaunched
     end
   end
 
@@ -138,8 +137,7 @@ namespace :rolling do
         instance.auto_terminate = false
       end
     else
-      logger.error 'No instances have been launched. Are you using a configuration with rolling deployments?'
-      exit 1
+      raise Capistrano::ASG::Rolling::NoInstancesLaunched
     end
 
     invoke 'deploy'
@@ -156,8 +154,14 @@ namespace :rolling do
         logger.info "Instance **#{instance.id}** entering standby state..."
         group.enter_standby(instance)
 
+        logger.info 'Stopping instance...'
+        instance.stop
+
         logger.info 'Creating AMI...'
-        ami = instance.create_ami(description: revision_log_message)
+        ami = instance.create_ami(description: revision_log_message, tags: Capistrano::ASG::Rolling::Tags.ami_tags)
+
+        logger.info 'Starting instance...'
+        instance.start
 
         logger.info "Instance **#{instance.id}** exiting standby state..."
         group.exit_standby(instance)
@@ -175,27 +179,31 @@ namespace :rolling do
 
   desc 'Get status of instance refresh'
   task :instance_refresh_status do
-    return unless config.wait_for_instance_refresh?
-
-    groups = config.autoscale_groups.to_h { |group| [group.name, group] }
-
-    while groups.any?
-      groups.each do |name, group|
-        refresh = group.latest_instance_refresh
-        if refresh.nil? || refresh.completed?
-          logger.info "Auto Scaling Group: **#{name}**, completed with status '#{refresh.status}'." if refresh.completed?
-          groups.delete(name)
-        elsif !refresh.percentage_complete.nil?
-          logger.info "Auto Scaling Group: **#{name}**, #{refresh.percentage_complete}% completed, status '#{refresh.status}'."
-        else
-          logger.info "Auto Scaling Group: **#{name}**, status '#{refresh.status}'."
+    if config.wait_for_instance_refresh?
+      groups = config.autoscale_groups.to_h { |group| [group.name, group] }
+      completed_groups = []
+
+      while groups.any?
+        groups.each do |name, group|
+          refresh = group.latest_instance_refresh
+          if refresh.nil? || refresh.completed?
+            logger.info "Auto Scaling Group: **#{name}**, completed with status '#{refresh.status}'." if refresh.completed?
+            completed_groups.push groups.delete(name)
+          elsif !refresh.percentage_complete.nil?
+            logger.info "Auto Scaling Group: **#{name}**, #{refresh.percentage_complete}% completed, status '#{refresh.status}'."
+          else
+            logger.info "Auto Scaling Group: **#{name}**, status '#{refresh.status}'."
+          end
         end
+        next if groups.empty?
+
+        wait_for = config.instance_refresh_polling_interval
+        logger.info "Instance refresh(es) not completed, waiting #{wait_for} seconds..."
+        sleep wait_for
       end
-      next if groups.empty?
 
-      wait_for = config.instance_refresh_polling_interval
-      logger.info "Instance refresh(es) not completed, waiting #{wait_for} seconds..."
-      sleep wait_for
+      failed = completed_groups.any? { |group| group.latest_instance_refresh.failed? }
+      raise Capistrano::ASG::Rolling::InstanceRefreshFailed if failed
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-asg-rolling
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Kentaa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-29 00:00:00.000000000 Z
+date: 2024-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,7 +75,7 @@ dependencies:
         version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.67.0
+        version: 1.100.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -85,7 +85,7 @@ dependencies:
         version: '1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.67.0
+        version: 1.100.0
 - !ruby/object:Gem::Dependency
   name: aws-sdk-ec2
   requirement: !ruby/object:Gem::Requirement
@@ -165,6 +165,7 @@ files:
 - lib/capistrano/asg/rolling/plugin.rb
 - lib/capistrano/asg/rolling/snapshot.rb
 - lib/capistrano/asg/rolling/ssh.rb
+- lib/capistrano/asg/rolling/tags.rb
 - lib/capistrano/asg/rolling/version.rb
 - lib/capistrano/asg/tasks/rolling.rake
 homepage: https://github.com/KentaaNL/capistrano-asg-rolling
@@ -187,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Capistrano plugin for performing rolling updates to AWS Auto Scaling Groups