cfn_manage 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7428980b03e64834946d1af37c27d1a3f481d06e8a12a54037265d17938e93ef
-  data.tar.gz: 046e1384dc663242395149f15577e6540f875c9b7834498f70b4b35fd5df2cbc
+  metadata.gz: 343401ecc1402d26222f76e4bcff786ee798fcede9d1b67f6e37dc4a99527886
+  data.tar.gz: 95dfb13ac573a995ad875f341043b451d428b568f78f50496c95044cd2ccf1f4
 SHA512:
-  metadata.gz: 230c5b07ffa305d5473d69069d154344f43ca340a3cda4b70e3c85dd5132762e8e918be054b08379c0411ef16873aa6ca6f3f9e96d5d206babcd6cf704ef8b15
-  data.tar.gz: 1c39137b703a1d649cc02c09c9bc5b8ccf15ae5b8535bf1672f4e6d0f006be318b7098c96f106adfea64ed4ecc9200405efee1c1b751669d77775ead54e35f96
+  metadata.gz: f52ec460cd5f1ded3b1fb7080b82f309d508d25fac2e5e6cc05f6f4c0334f1858f72dd694a2f5f1529a9088f61cfc74c3d3f874b1fe07df9a011d800dd6ca2e5
+  data.tar.gz: 4d73d61e515e309ea5ee40b22728ce539b466319b10dcceef7a4106a1bf24cf06b2edfc43141fda9fee8656bfc00e5a7cdb3147bdac6e9145d7545836015b640

data/bin/cfn_manage

@@ -2,6 +2,7 @@
 require 'optparse'
 require 'cfn_manage/version'
 require 'cfn_manage/cf_common'
+require 'cfn_manage/globals'
 require 'cfn_manage/cf_start_stop_environment'
 require 'logger'
 
@@ -18,6 +19,7 @@ $options['AWS_ASSUME_ROLE'] = ENV['AWS_ASSUME_ROLE']
 
 # global logger
 $log = Logger.new(STDOUT)
+$log.level = Logger::INFO
 
 # always flush output
 STDOUT.sync = true
@@ -77,6 +79,24 @@ OptionParser.new do |opts|
   opts.on('--alarm [ALARM]') do |alarm|
     $options['ALARM'] = alarm
   end
+  
+  opts.on('--asg-wait-state [WAIT_STATE]') do |state|
+    allows_values = ['HealthyInASG','Running','HealthyInTargetGroup']
+    if !allows_values.include? state
+      STDERR.puts("#{type} is not a valid value for `--asg-wait-state`. Use one of #{allows_values.join(',')}")
+      exit 1
+    end
+    CfnManage.asg_wait_state = state
+  end
+
+  opts.on('--ecs-wait-state [WAIT_STATE]') do |state|
+    allows_values = ['Running','HealthyInTargetGroup']
+    if !allows_values.include? state
+      STDERR.puts("#{type} is not a valid value for `--ecs-wait-state`. Use one of #{allows_values.join(',')}")
+      exit 1
+    end
+    CfnManage.ecs_wait_state = state
+  end
 
   opts.on('-r [AWS_REGION]', '--region [AWS_REGION]') do |region|
     ENV['AWS_REGION'] = region
@@ -86,29 +106,80 @@ OptionParser.new do |opts|
     ENV['CFN_AWS_PROFILE'] = profile
   end
 
+  # Boolean options with support for command line and environment variables
+  
   opts.on('--dry-run') do
-    ENV['DRY_RUN'] = '1'
+    CfnManage.dry_run
+  end
+  
+  if ENV['DRY_RUN'] == '1'
+    CfnManage.dry_run
+  end
+  
+  opts.on('--debug') do
+    $log.level = Logger::DEBUG
+  end
+  
+  if ENV['CFN_DEBUG'] == '1'
+    $log.level = Logger::DEBUGß
   end
 
   opts.on('--continue-on-error') do
-    ENV['CFN_CONTINUE_ON_ERROR'] = '1'
+    CfnManage.continue_on_error
+  end
+  
+  if ENV['CFN_CONTINUE_ON_ERROR'] == '1'
+    CfnManage.continue_on_error
   end
 
   opts.on('--wait-async') do
-    ENV['WAIT_ASYNC'] = '1'
-    ENV['SKIP_WAIT'] = '1'
+    CfnManage.skip_wait
+    CfnManage.wait_async
+  end
+  
+  if ENV['WAIT_ASYNC'] == '1'
+    CfnManage.skip_wait
+    CfnManage.wait_async
   end
 
   opts.on('--skip-wait') do
-    ENV['SKIP_WAIT'] = '1'
+    CfnManage.skip_wait
+  end
+  
+  if ENV['SKIP_WAIT'] == '1'
+    CfnManage.skip_wait
   end
 
   opts.on('--ignore-missing-ecs-config') do
-    ENV['IGNORE_MISSING_ECS_CONFIG'] = '1'
+    CfnManage.ignore_missing_ecs_config
+  end
+  
+  if ENV['IGNORE_MISSING_ECS_CONFIG'] == '1'
+    CfnManage.ignore_missing_ecs_config
   end
 
   opts.on('--asg-suspend-termination') do
-    ENV['ASG_SUSPEND_TERMINATION'] = '1'
+    CfnManage.asg_suspend_termination
+  end
+  
+  if ENV['ASG_SUSPEND_TERMINATION'] == '1'
+    CfnManage.asg_suspend_termination
+  end
+  
+  opts.on('--tags') do
+    CfnManage.find_tags
+  end
+  
+  if ENV['CFN_TAGS'] == '1'
+    CfnManage.find_tags
+  end
+  
+  opts.on('--ecs-wait-container-instances') do
+    CfnManage.ecs_wait_container_instances
+  end
+  
+  if ENV['ECS_WAIT_CONTAINER_INSTANCES'] == '1'
+    CfnManage.ecs_wait_container_instances
   end
 
 end.parse!

data/bin/usage.txt

@@ -71,6 +71,10 @@ General options:
     Applicable only to [start|stop-environment] commands. If dry run is enabled
     info about assets being started / stopped will ne only printed to standard output,
     without any action taken.
+    
+--debug
+
+    Displays debug logs
 
 --continue-on-error
 
@@ -96,3 +100,30 @@ General options:
 --asg-suspend-termination
 
     Will stop instances in the autoscaling group(s) instead of the default behaviour of termination.
+
+--asg-wait-state
+    
+    Allowed values ['HealthyInASG','Running','HealthyInTargetGroup']
+    Default: 'HealthyInASG'
+    
+    'HealthyInASG' - waits for all instances to reach a healthy state in the asg
+    'Running' - waits for all instances to reach the EC2 running state
+    'HealthyInTargetGroup' - waits for all instances to reach a healthy state in all asg assocated target groups
+
+--ecs-wait-state
+    
+    Allowed values ['Running','HealthyInTargetGroup']
+    Default: 'Skip'
+    
+    'Running' - waits for all ecs services in cluster to reach the running state
+    'HealthyInTargetGroup' - waits for all ecs services in cluster to reach a healthy state in all assocated target groups
+            
+--tags
+
+    will query resource tags for individual resource settings.
+        `cfn_manage:priority` for prefered starting order
+    will default to defined resource order if no tag is found or resource doesn't support tags
+    
+--ecs-wait-container-instances
+    
+    waits for a container instance to be active in the ecs cluster before starting services

data/lib/cfn_manage/cf_start_stop_environment.rb

@@ -1,41 +1,35 @@
-require 'aws-sdk-ec2'
+require 'json'
+require 'yaml'
+
 require 'aws-sdk-s3'
-require 'aws-sdk-ec2'
 require 'aws-sdk-cloudformation'
-require 'aws-sdk-rds'
-require 'aws-sdk-cloudwatch'
-require 'aws-sdk-autoscaling'
-require 'aws-sdk-ecs'
-require 'aws-sdk-docdb'
 
 require 'cfn_manage/cf_common'
 require 'cfn_manage/aws_credentials'
-require 'json'
-require 'yaml'
+require 'cfn_manage/tag_finder'
 require 'cfn_manage/start_stop_handler_factory'
 
 module CfnManage
   module CloudFormation
     class EnvironmentRunStop
 
-      @cf_client = nil
-      @stack_name = nil
-      @s3_client = nil
-      @s3_bucket = nil
-      @credentials = nil
-      @dry_run = false
-
-      @@resource_start_priorities = {
-          'AWS::RDS::DBInstance' => '100',
-          'AWS::RDS::DBCluster' => '100',
-          'AWS::DocDB::DBCluster' => '100',
-          'AWS::AutoScaling::AutoScalingGroup' => '200',
-          'AWS::EC2::Instance' => '200',
-          'AWS::EC2::SpotFleet' => '200',
-          'AWS::Transfer::Server' => '200',
-          'AWS::ECS::Cluster' => '250',
-          'AWS::CloudWatch::Alarm' => '300'
+      DEFAULT_PRIORITIES = {
+        'AWS::RDS::DBInstance' => '100',
+        'AWS::RDS::DBCluster' => '100',
+        'AWS::DocDB::DBCluster' => '100',
+        'AWS::AutoScaling::AutoScalingGroup' => '200',
+        'AWS::EC2::Instance' => '200',
+        'AWS::EC2::SpotFleet' => '200',
+        'AWS::Transfer::Server' => '200',
+        'AWS::ECS::Cluster' => '250',
+        'AWS::CloudWatch::Alarm' => '300'
       }
+      
+      TAGGED_RESOURCES = %w(
+        AWS::AutoScaling::AutoScalingGroup
+        AWS::EC2::Instance
+        AWS::ECS::Cluster
+      )
 
       def initialize()
         @environment_resources = []
@@ -46,10 +40,6 @@ module CfnManage
         if not @credentials.nil?
           @cf_client = Aws::CloudFormation::Client.new(credentials: @credentials, retry_limit: 20)
         end
-        @dry_run = (ENV.key?('DRY_RUN') and ENV['DRY_RUN'] == '1')
-        @skip_wait = (ENV.key?('SKIP_WAIT') and ENV['SKIP_WAIT'] == '1')
-        @wait_async = (ENV.key?('WAIT_ASYNC') and ENV['WAIT_ASYNC'] == '1')
-        @continue_on_error = (ENV.key? 'CFN_CONTINUE_ON_ERROR' and ENV['CFN_CONTINUE_ON_ERROR'] == '1')
       rescue NoMethodError => e
         puts "Got No Method Error on CloudFormation::initialize, this often means that you're missing a AWS_DEFAULT_REGION"
       rescue Aws::Sigv4::Errors::MissingCredentialsError => e
@@ -62,7 +52,7 @@ module CfnManage
         Common.visit_stack(@cf_client, stack_name, method(:collect_resources), true)
         do_start_assets
         configuration = { stack_running: true }
-        save_item_configuration("environment_data/stack-#{stack_name}", configuration) unless @dry_run
+        save_item_configuration("environment_data/stack-#{stack_name}", configuration) unless CfnManage.dry_run?
         $log.info("Environment #{stack_name} started")
       end
 
@@ -72,19 +62,31 @@ module CfnManage
         Common.visit_stack(@cf_client, stack_name, method(:collect_resources), true)
         do_stop_assets
         configuration = { stack_running: false }
-        save_item_configuration("environment_data/stack-#{stack_name}", configuration) unless @dry_run
+        save_item_configuration("environment_data/stack-#{stack_name}", configuration) unless CfnManage.dry_run?
         $log.info("Environment #{stack_name} stopped")
       end
 
       def start_resource(resource_id,resource_type)
+        priority = DEFAULT_PRIORITIES[resource_type]
+        options = {}
+        
+        if CfnManage.find_tags?
+          tags = CfnManage::TagFiner.new(resource_id)
+          tags.get_tags(resource_type)  
+          priority = !tags.priority.nil? ? tags.priority : priority
+          options = tags.options
+          $log.debug("setting options #{options} for #{resource_id}")
+        end
+        
         start_stop_handler = CfnManage::StartStopHandlerFactory.get_start_stop_handler(
             resource_type,
             resource_id,
-            @skip_wait
+            options
         )
+        
         @environment_resources << {
             id: resource_id,
-            priority: @@resource_start_priorities[resource_type],
+            priority: priority,
             handler: start_stop_handler,
             type: resource_type
         }
@@ -92,14 +94,25 @@ module CfnManage
       end
 
       def stop_resource(resource_id,resource_type)
+        priority = DEFAULT_PRIORITIES[resource_type]
+        options = {}
+        
+        if CfnManage.find_tags?
+          tags = CfnManage::TagFiner.new(resource_id)
+          tags.get_tags(resource_type)  
+          priority = !tags.priority.nil? ? tags.priority : priority
+          options = tags.options
+        end
+        
         start_stop_handler = CfnManage::StartStopHandlerFactory.get_start_stop_handler(
             resource_type,
             resource_id,
-            @skip_wait
+            options
         )
+
         @environment_resources << {
             id: resource_id,
-            priority: @@resource_start_priorities[resource_type],
+            priority: priority,
             handler: start_stop_handler,
             type: resource_type
         }
@@ -116,7 +129,7 @@ module CfnManage
             begin
               $log.info("Stopping resource #{resource[:id]}")
               # just print out information if running a dry run, otherwise start assets
-              if not @dry_run
+              if !CfnManage.dry_run?
                 configuration = resource[:handler].stop()
                 if configuration.class == Hash
                   s3_prefix = "environment_data/resource/#{resource[:id]}"
@@ -130,13 +143,13 @@ module CfnManage
               $log.error("An exception occurred during stop operation against resource #{resource[:id]}")
               $log.error("#{e.to_s}")
               $log.error(e.backtrace.join("\n\t"))
-              if not @continue_on_error
+              if not CfnManage.continue_on_error?
                 raise e
               end
             end
           end
 
-          if not @dry_run and @wait_async
+          if not CfnManage.dry_run? and CfnManage.wait_async?
             priority.each do |resource|
               begin
                 resource[:handler].wait('stopped')
@@ -144,7 +157,7 @@ module CfnManage
                 $log.error("An exception occurred during wait operation against resource #{resource[:id]}")
                 $log.error("#{e.to_s}")
                 $log.error(e.backtrace.join("\n\t"))
-                if not @continue_on_error
+                if not CfnManage.continue_on_error?
                   raise e
                 end
               end
@@ -164,11 +177,11 @@ module CfnManage
             begin
               $log.info("Starting resource #{resource[:id]}")
               # just print out information if running a dry run, otherwise start assets
-              if not @dry_run
+              if !CfnManage.dry_run?
                 # read configuration
                 s3_prefix = "environment_data/resource/#{resource[:id]}"
                 configuration = get_object_configuration(s3_prefix)
-
+                
                 # start
                 resource[:handler].start(configuration)
               else
@@ -179,13 +192,13 @@ module CfnManage
                 $log.error("An exception occurred during start operation against resource #{resource[:id]}")
                 $log.error("#{e.to_s}")
                 $log.error(e.backtrace.join("\n\t"))
-                if not @continue_on_error
+                if not CfnManage.continue_on_error?
                   raise e
                 end
             end
           end
 
-          if not @dry_run and @wait_async
+          if not CfnManage.dry_run? and CfnManage.wait_async?
             priority.each do |resource|
               begin
                 resource[:handler].wait('available')
@@ -193,7 +206,7 @@ module CfnManage
                 $log.error("An exception occurred during wait operation against resource #{resource[:id]}")
                 $log.error("#{e.to_s}")
                 $log.error(e.backtrace.join("\n\t"))
-                if not @continue_on_error
+                if not CfnManage.continue_on_error?
                   raise e
                 end
               end
@@ -208,30 +221,45 @@ module CfnManage
         resrouces = @cf_client.describe_stack_resources(stack_name: stack_name)
         resrouces['stack_resources'].each do |resource|
           start_stop_handler = nil
-          begin
+          
+          resource_id = resource['physical_resource_id']
+          resource_type = resource['resource_type']
+          priority = DEFAULT_PRIORITIES[resource_type]
+          options = {}
+          
+          if CfnManage.find_tags? && TAGGED_RESOURCES.include?(resource_type)
+            tags = CfnManage::TagFinder.new(resource_id)
+            tags.get_tags(resource_type)  
+            options = tags.options
+            priority = options[:priority] if options.has_key?(:priority)
+            $log.debug("setting options #{options} for #{resource_id}")
+          end
+          
+          begin    
             start_stop_handler = CfnManage::StartStopHandlerFactory.get_start_stop_handler(
-                resource['resource_type'],
-                resource['physical_resource_id'],
-                @skip_wait
+                resource_type,
+                resource_id,
+                options
             )
           rescue Exception => e
-            $log.error("Error creating start-stop handler for resource of type #{resource['resource_type']}" +
+            $log.error("Error creating start-stop handler for resource of type #{resource['resource_type']} " +
                 "and with id #{resource['physical_resource_id']}:#{e}")
           end
-          if not start_stop_handler.nil?
-            resource_id = resource['physical_resource_id']
+          
+          if !start_stop_handler.nil?
+            $log.debug("priority set to #{priority} for resource id: #{resource_id}, type: #{resource_type}")
             @environment_resources << {
                 id: resource_id,
-                priority: @@resource_start_priorities[resource['resource_type']],
+                priority: priority,
                 handler: start_stop_handler,
-                type: resource['resource_type']
+                type: resource_type
             }
           end
         end
       end
 
       def get_object_configuration(s3_prefix)
-        configuration = nil
+        configuration = {}
         begin
           key = "#{s3_prefix}/latest/config.json"
           $log.info("Reading object configuration from s3://#{@s3_bucket}/#{key}")
@@ -267,4 +295,4 @@ module CfnManage
 
     end
   end
-end
+end