openstax_aws 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75f65f32cd2e572d1e83f624977186c7aee220c6d51924333fa08af2255543ad
-  data.tar.gz: bf3969a29e8fb4ff94b54bbd9685581cdff28f9c160f3ebe0fa26b92f4875575
+  metadata.gz: 7754f428f875d2a03d7e007352ab1c98107838904fd56ec7b0b7e188f62cf3fd
+  data.tar.gz: 862cfac082c78ac44a42190634cac16e2d05b2eaf5f9445950928d9883bd53b8
 SHA512:
-  metadata.gz: 76287d75f76a51cbeb635e6013f5e896174537fcba6352f5febba64c562c3cb857f82aa2a03f71af9583c5db3e8527bf0298e4e2759db9ac658b7a13c0fa6c14
-  data.tar.gz: f86924695c16ce1b3729e9a405e36603761477aa4c7af798ea50bd5faeffcaf18d3caca056db5f8d72127c8bf9c7edfd464d46a7e109f8597d1437ecffb2788f
+  metadata.gz: dfb2f7012992c090625da1ba7906f475d43042456e8c241e54624123f12a28ac36effa58cab39de0beede13643f4513441da7e1154edfaa2f1783e97ea8927dc
+  data.tar.gz: 309ed6f57c82ea3d42a9860f44a7ad80bec3d524ae5deac7546ed870e4cb572b904cba75a76df9e4d80c0834e6393b1b85d41a53d5bb9bc4619da8fc20ea0b1d

data/CHANGELOG.md

@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.5.0] - 2022-06-14
+- Automatically tag CloudWatch alarms and EventBridge rules after stacks are created or updated
+
+## [1.4.0] - 2022-05-11
+- ???
+
+## [1.3.0] - 2021-03-23
+- ???
+
 ## [1.2.0] - 2021-01-12
 
 - Added additional method to MskCluster resource, to return sorted list of bootstrap brokers

data/lib/openstax/aws/alarm.rb

@@ -0,0 +1,48 @@
+module OpenStax::Aws
+  class Alarm
+    attr_reader :raw_alarm
+
+    delegate_missing_to :@raw_alarm
+
+    def self.physical_resource_id_attribute
+      :name
+    end
+
+    def initialize(region:, name:)
+      @raw_alarm = ::Aws::CloudWatch::Alarm.new(
+        name: name,
+        client: Aws::CloudWatch::Client.new(region: region)
+      )
+    end
+
+    def tags
+      client.list_tags_for_resource(resource_arn: raw_alarm.alarm_arn).tags
+    end
+
+    def tag_resource(new_tags)
+      client.tag_resource resource_arn: raw_alarm.alarm_arn, tags: new_tags
+    end
+
+    def logger
+      OpenStax::Aws.configuration.logger
+    end
+
+    def add_tags_not_handled_by_cloudformation(stack_tags)
+      missing_tags = stack_tags.map(&:to_h) - tags.map(&:to_h)
+
+      return if missing_tags.empty?
+
+      logger.debug "Tagging #{name}..."
+      attempt = 1
+      begin
+        tag_resource missing_tags
+      rescue Aws::CloudWatch::Errors::Throttling
+        retry_in = attempt**2
+        logger.debug "Tagging #{name} failed... retrying in #{retry_in} seconds"
+        sleep retry_in
+        attempt += 1
+        retry
+      end
+    end
+  end
+end

data/lib/openstax/aws/auto_scaling_group.rb

@@ -1,14 +1,19 @@
 module OpenStax::Aws
   class AutoScalingGroup
-    attr_reader :raw_asg
+    attr_reader :raw_asg, :region
 
     delegate_missing_to :@raw_asg
 
+    def self.physical_resource_id_attribute
+      :name
+    end
+
     def initialize(name:, region:)
       @raw_asg = Aws::AutoScaling::AutoScalingGroup.new(
         name: name,
         client: Aws::AutoScaling::Client.new(region: region)
       )
+      @region = region
     end
 
     def increase_desired_capacity(by:)
@@ -24,5 +29,17 @@ module OpenStax::Aws
     def desired_capacity
       raw_asg.desired_capacity
     end
+
+    def alarms
+      client.describe_policies(
+        auto_scaling_group_name: raw_asg.name
+      ).flat_map(&:scaling_policies).flat_map(&:alarms).map do |alarm|
+        OpenStax::Aws::Alarm.new region: region, name: alarm.alarm_name
+      end
+    end
+
+    def add_tags_not_handled_by_cloudformation(stack_tags)
+      alarms.each { |alarm| alarm.add_tags_not_handled_by_cloudformation stack_tags }
+    end
   end
 end

data/lib/openstax/aws/event_rule.rb

@@ -0,0 +1,34 @@
+module OpenStax::Aws
+  class EventRule
+    attr_reader :raw_rule, :client
+
+    delegate_missing_to :@raw_rule
+
+    def self.physical_resource_id_attribute
+      :name
+    end
+
+    def initialize(name:, region:)
+      @client = Aws::EventBridge::Client.new region: region
+      # There is no real rule wrapper in the SDK but the DescribeRuleResponse can be used
+      @raw_rule = client.describe_rule name: name
+    end
+
+    def tags
+      client.list_tags_for_resource(resource_arn: raw_rule.arn).tags
+    end
+
+    def tag_resource(new_tags)
+      client.tag_resource resource_arn: raw_rule.arn, tags: new_tags
+    end
+
+    def add_tags_not_handled_by_cloudformation(stack_tags)
+      missing_tags = stack_tags.map(&:to_h) - tags.map(&:to_h)
+
+      return if missing_tags.empty?
+
+      OpenStax::Aws.configuration.logger.debug "Tagging #{name}..."
+      tag_resource missing_tags
+    end
+  end
+end

data/lib/openstax/aws/msk_cluster.rb

@@ -5,6 +5,10 @@ module OpenStax::Aws
 
     delegate_missing_to :@client
 
+    def self.physical_resource_id_attribute
+      :cluster_arn
+    end
+
     def initialize(cluster_arn:, region:)
       @cluster_arn = cluster_arn
       @client = ::Aws::Kafka::Client.new(region: region)
@@ -20,4 +24,3 @@ module OpenStax::Aws
 
   end
 end
-

data/lib/openstax/aws/rds_instance.rb

@@ -5,6 +5,10 @@ module OpenStax::Aws
 
     delegate_missing_to :@raw
 
+    def self.physical_resource_id_attribute
+      :db_instance_identifier
+    end
+
     def initialize(db_instance_identifier:, region:)
       @raw = Aws::RDS::DBInstance.new(
         db_instance_identifier,
@@ -14,12 +18,11 @@ module OpenStax::Aws
 
     def set_master_password(password:)
       raw.modify({
-        apply_immediately: true, 
+        apply_immediately: true,
         master_user_password: password
       })
-  
+
     end
 
   end
 end
-

data/lib/openstax/aws/resource_factory.rb

@@ -0,0 +1,36 @@
+module OpenStax::Aws
+  class ResourceFactory
+    # All classes listed here should implement the self.physical_resource_id method
+    ALL_TYPES = {
+      'AWS::AutoScaling::AutoScalingGroup' => OpenStax::Aws::AutoScalingGroup,
+      'AWS::CloudWatch::Alarm' => OpenStax::Aws::Alarm,
+      'AWS::Events::Rule' => OpenStax::Aws::EventRule,
+      'AWS::RDS::DBInstance' => OpenStax::Aws::RdsInstance,
+      'AWS::MSK::Cluster' => OpenStax::Aws::MskCluster
+    }
+
+    attr_reader :region, :types
+
+    def initialize(region:, types: nil)
+      @region = region
+      @types = types.nil? ? ALL_TYPES : ALL_TYPES.select { |type, _| types.include? type }
+    end
+
+    def from_stack_resource_or_summary(stack_resource)
+      klass = types[stack_resource.resource_type]
+      return if klass.nil?
+
+      klass.new(
+        region: region,
+        klass.physical_resource_id_attribute => stack_resource.physical_resource_id
+      )
+    end
+
+    def from_stack_resource_or_summary!(stack_resource)
+      from_stack_resource_or_summary(stack_resource).tap do |resource|
+        raise "'#{stack_resource.resource_type}' is not yet implemented in `ResourceFactory`" \
+          if resource.nil?
+      end
+    end
+  end
+end

data/lib/openstax/aws/stack.rb

@@ -86,9 +86,15 @@ module OpenStax::Aws
       }
 
       logger.info("Creating #{name} stack...")
-      client.create_stack(options) if !dry_run
 
-      wait_for_creation if wait
+      if !dry_run
+        client.create_stack(options)
+
+        if wait
+          wait_for_creation
+          tag_resources_not_handled_by_cloudformation
+        end
+      end
     end
 
     def parameters_for_update(overrides: {})
@@ -218,14 +224,24 @@ module OpenStax::Aws
           logger.info("Executing change set")
           change_set.execute
           reset_cached_remote_state
-        end
 
-        wait_for_update if wait
+          wait_for_update if wait
+        end
       end
 
+      # We can still tag resources even if there are no changes according to CloudFormation
+      tag_resources_not_handled_by_cloudformation if wait && !dry_run
+
       change_set
     end
 
+    def tag_resources_not_handled_by_cloudformation
+      stack_tags = self.class.format_hash_as_tag_parameters @tags
+      resources(
+        [ 'AWS::CloudWatch::Alarm', 'AWS::Events::Rule', 'AWS::AutoScaling::AutoScalingGroup' ]
+      ).each { |resource| resource.add_tags_not_handled_by_cloudformation(stack_tags) }
+    end
+
     def delete(retain_resources: [], wait: false)
       logger.info("**** DRY RUN ****") if dry_run
 
@@ -289,20 +305,20 @@ module OpenStax::Aws
 
     def resource(logical_id)
       stack_resource = aws_stack.resource(logical_id)
+      resource_factory = OpenStax::Aws::ResourceFactory.new region: region
+      resource_factory.from_stack_resource_or_summary! stack_resource
+    end
 
-      case stack_resource.resource_type
-      when "AWS::AutoScaling::AutoScalingGroup"
-        name = stack_resource.physical_resource_id
-        client = Aws::AutoScaling::Client.new(region: region)
-        Aws::AutoScaling::AutoScalingGroup.new(name: name, client: client)
-      when "AWS::RDS::DBInstance"
-        db_instance_identifier = stack_resource.physical_resource_id
-        OpenStax::Aws::RdsInstance.new(db_instance_identifier: db_instance_identifier, region: region)
-      when "AWS::MSK::Cluster"
-        msk_cluster_arn = stack_resource.physical_resource_id
-        OpenStax::Aws::MskCluster.new(cluster_arn: msk_cluster_arn, region: region)
-      else
-        raise "'#{stack_resource.resource_type}' is not yet implemented in `Stack#resource`"
+    def resources(types = nil)
+      resource_factory = OpenStax::Aws::ResourceFactory.new region: region, types: types
+
+      Enumerator.new do |yielder|
+        client.list_stack_resources(stack_name: name).each do |response|
+          response.stack_resource_summaries.each do |stack_resource_summary|
+            resource = resource_factory.from_stack_resource_or_summary stack_resource_summary
+            yielder << resource unless resource.nil?
+          end
+        end
       end
     end
 

data/lib/openstax/aws/version.rb

@@ -1,5 +1,5 @@
 module OpenStax
   module Aws
-    VERSION = "1.4.0"
+    VERSION = "1.5.0"
   end
 end

data/lib/openstax_aws.rb

@@ -1,7 +1,9 @@
 require "aws-sdk-autoscaling"
 require "aws-sdk-cloudformation"
 require "aws-sdk-cloudfront"
+require "aws-sdk-cloudwatch"
 require "aws-sdk-ec2"
+require "aws-sdk-eventbridge"
 require "aws-sdk-kafka"
 require "aws-sdk-rds"
 require "aws-sdk-s3"
@@ -143,10 +145,13 @@ require "openstax/aws/stack_status"
 require "openstax/aws/stack_factory"
 require "openstax/aws/deployment_base"
 require "openstax/aws/ec2_instance_data"
+require "openstax/aws/alarm"
 require "openstax/aws/auto_scaling_group"
 require "openstax/aws/auto_scaling_instance"
-require "openstax/aws/rds_instance"
+require "openstax/aws/event_rule"
 require "openstax/aws/msk_cluster"
+require "openstax/aws/rds_instance"
+require "openstax/aws/resource_factory"
 require "openstax/aws/packer_1_2_5"
 require "openstax/aws/packer_1_4_1"
 require "openstax/aws/packer_factory"

data/openstax_aws.gemspec

@@ -32,7 +32,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "aws-sdk-autoscaling", "~> 1"
   spec.add_dependency "aws-sdk-cloudformation", "~> 1"
   spec.add_dependency "aws-sdk-cloudfront", "~> 1"
+  spec.add_dependency "aws-sdk-cloudwatch", "~> 1"
   spec.add_dependency "aws-sdk-ec2", "~> 1"
+  spec.add_dependency "aws-sdk-eventbridge", "~> 1"
   spec.add_dependency "aws-sdk-kafka", "~> 1"
   spec.add_dependency "aws-sdk-rds", "~> 1"
   spec.add_dependency "aws-sdk-s3", "~> 1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstax_aws
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-11 00:00:00.000000000 Z
+date: 2022-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-autoscaling
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-cloudwatch
+  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-ec2
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-eventbridge
+  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-kafka
   requirement: !ruby/object:Gem::Requirement
@@ -289,6 +317,7 @@ files:
 - bin/templates/aws_ruby_development.yml
 - examples/deployment.rb
 - ideas.md
+- lib/openstax/aws/alarm.rb
 - lib/openstax/aws/auto_scaling_group.rb
 - lib/openstax/aws/auto_scaling_instance.rb
 - lib/openstax/aws/build_image_command_1.rb
@@ -296,6 +325,7 @@ files:
 - lib/openstax/aws/deployment_base.rb
 - lib/openstax/aws/distribution.rb
 - lib/openstax/aws/ec2_instance_data.rb
+- lib/openstax/aws/event_rule.rb
 - lib/openstax/aws/extensions.rb
 - lib/openstax/aws/git_helper.rb
 - lib/openstax/aws/image.rb
@@ -304,6 +334,7 @@ files:
 - lib/openstax/aws/packer_1_4_1.rb
 - lib/openstax/aws/packer_factory.rb
 - lib/openstax/aws/rds_instance.rb
+- lib/openstax/aws/resource_factory.rb
 - lib/openstax/aws/s3_text_file.rb
 - lib/openstax/aws/sam_stack.rb
 - lib/openstax/aws/secrets.rb