cloudformation-tool 1.2.2 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15f7ca4dd9a56c71678b984eee089dea7b320bf9e0e7b3d02f72f6d52c3b0182
-  data.tar.gz: 519a9758535c8323f472b512128a96f676eaa611147a0202a09542eb5bee8418
+  metadata.gz: c6667d6553e4525f298bb9b2fd517a7045d50f8ed88273fe7bf43ca1e5b588ed
+  data.tar.gz: f8b8ebc3884b92222e8fe67e60f6fdea325cc60b0130eecb36b45edb83e7f209
 SHA512:
-  metadata.gz: f3b0164a2992ee13b4a0278f17fd396f7e4e49718b2c5b7a524894fc1a6002ea070295d3127d646d782b4f3b6d0de85641791ad91932d63b099a1e23b30d79b9
-  data.tar.gz: 41bc98433f5ec0eae331b6733c1f6b26dbdaf25e320b0c57c1763148efd3b62798808f1db612f84c8817210db0555e8caf7c6c709a3960849462a2052fd1baf6
+  metadata.gz: 1db7a23fd37bb5ac7f5ab7437b5a62b8fe3d57e0c26a9ac48389641f08042c683f6ecf8eea482a88e08bf68e9ed7fc1c51415db6da54feb1f434a6ab41fb0d42
+  data.tar.gz: ade2265d6bf3652212ecf11125028239494e4ce0318345a88366a2f53440e7b3efde861eb0cfdb946e262438931a5968d3a0e6354376fb17c6aded89a590dfc8

data/README.md

@@ -216,6 +216,102 @@ specifying the S3 bucket and object key, either of the following fields may be u
       Role: !GetAtt [ LambdaExecutionRole, Arn ]
 ```
 
+### Nested Stacks Modules
+
+The CloudFormation pre-compiler supports loading local templates as "nested stacks" using the
+CloudFormation `AWS::CloudFormation::Stack` resource type.
+
+Instead of first pre-deploying a template to S3 to be used for a nested stack, use the
+`Template` property (instead of the `TemplateURL` property) to point to a local
+sub-template. The sub-template will be compiled separately and deployed automatically to
+an S3 bucket before deploying the compiled template to CloudFormation.
+
+The `monitor` tool (also used during `create` operation) supports nested stacks by
+automatically detecting nested stack updates in the main stack's event stream and will
+start streaming the nested stack events - this allows the user to more easily locate problems
+with nested stacks.
+
+Currently there's no automatic resolution of references between nested and parent stacks, so
+make sure to set up nested stack parameters for all resources that should be referenced from
+the parent stack.
+
+#### Example
+
+`cloud-formation.yaml`:
+
+```
+AWSTemplateFormatVersion: "2010-09-09"
+Description: "CloudFormation template with nested stacks"
+Parameters:
+  DomainName:
+    Description: "The DNS domain name for the system"
+    Type: String
+    Default: example.com
+  AMI:
+    Description: "The AMI ID for the image to deploy"
+    Type: String
+    Default: ami-af4333cf
+
+Resources:
+  VPC:
+    Type: AWS::EC2::VPC
+    Properties:
+      CidrBlock: 172.20.0.0/16
+      EnableDnsSupport: true
+      EnableDnsHostnames: true
+  SecurityGroupExample:
+    Type: AWS::EC2::SecurityGroup
+    Properties:
+      VpcId: !Ref VPC 
+      GroupDescription: example security group
+      SecurityGroupIngress:
+        - { IpProtocol: icmp, CidrIp: 0.0.0.0/0, FromPort: -1, ToPort: -1 }
+        - { IpProtocol: tcp, CidrIp: 0.0.0.0/0, FromPort: 22, ToPort: 22 }
+  ServiceStack:
+    Type: AWS::CloudFormation::Stack
+    Properties:
+      Template: service.yaml
+      Parameters:
+        DomainName: !Ref DomainName
+        AMI: !Ref AMI
+        VPC: !Ref VPC
+```
+
+`service.yaml`:
+
+```
+AWSTemplateFormatVersion: "2010-09-09"
+Description: "Service nested stack"
+Parameters:
+  DomainName:
+    Description: "The DNS domain name for the system"
+    Type: String
+  AMI:
+    Description: "The AMI ID for the image to deploy"
+    Type: String
+  VPC:
+    Description: "The VPC into which to deploy the service"
+    Type: String
+
+Resources:
+  Subnet:
+    Type: AWS::EC2::Subnet
+    Properties:
+      AvailabilityZone: !Select [ 0, !GetAZs { Ref: "AWS::Region" } ]
+      CidrBlock: 172.20.0.0/24
+      MapPublicIpOnLaunch: true
+      VpcId: !Ref VPC
+  Ec2Instance: 
+    Type: AWS::EC2::Instance
+    Properties: 
+      ImageId: !Ref AMI
+      KeyName: "secret" 
+      NetworkInterfaces: 
+        - AssociatePublicIpAddress: "true"
+          DeviceIndex: "0"
+          SubnetId: !Ref Subnet 
+```
+
 ## Caching
 
 Some resource compilation may require uploading to S3, such as Lambda code or cloud-init setup

data/lib/cloud_formation_tool/cli/main.rb

@@ -31,7 +31,7 @@ module CloudFormationTool
       
       option [ "-d", "--debug" ], :flag, "Enable debug logging" do
         logger.level = Logger::Severity::DEBUG
-        logger.formatter = logger.default_formatter
+        logger.formatter = nil
       end
       
       option [ "-q", "--quiet" ], :flag, "Enable debug logging" do

data/lib/cloud_formation_tool/cloud_formation.rb

@@ -183,6 +183,12 @@ module CloudFormationTool
               else
                 load_files(val, restype)
               end
+            when 'AWS::CloudFormation::Stack'
+              if key == 'Properties' and val.key?('Template')
+                NestedStack.new(val, self).to_cloudformation
+              else
+                load_files(val, restype)
+              end
             else
               load_files(val, restype)
           end

data/lib/cloud_formation_tool/cloud_formation/nested_stack.rb

@@ -0,0 +1,25 @@
+module CloudFormationTool
+  class CloudFormation
+    
+    class NestedStack
+      include Storable
+      
+      def initialize(props, tpl)
+        @tpl = tpl
+        @data = props
+        if props.key?('Template')
+          path = props['Template']
+          path = if path.start_with? "/" then path else "#{@tpl.basedir}/#{path}" end
+          @content = CloudFormation.new(path).to_yaml
+          @data['TemplateURL'] = upload(make_filename('yaml'), @content, mime_type: 'text/yaml', gzip: false)
+          @data.delete('Template')
+        end
+      end
+      
+      def to_cloudformation
+        @data
+      end
+
+    end
+  end
+end

data/lib/cloud_formation_tool/cloud_formation/stack.rb

@@ -15,6 +15,7 @@ module CloudFormationTool
         @name = name
         @seenev = Set.new
         @watch_timeouts = 0
+        @nested_stacks = Hash[]
       end
       
       def delete
@@ -133,6 +134,7 @@ module CloudFormationTool
       end
       
       def monitor(start_time = nil)
+        @nested_stacks = Hash[]
         done = false
         begin
           until done
@@ -140,26 +142,65 @@ module CloudFormationTool
               next if @seenev.add?(ev.event_id).nil?
               text = "#{ev.timestamp.strftime "%Y-%m-%d %H:%M:%S"}| " + %w(
                 resource_type:40
-                logical_resource_id:38
+                logical_resource_id:42
                 resource_status
               ).collect { |field|
                 (name,size) = field.split(":")
                 size ||= 1
-                ev.send(name.to_sym).ljust(size.to_i, ' ')
+                (if name == 'logical_resource_id' and ev.stack_name != self.name
+                  logical_nested_stack_name(ev.stack_name) + "|"
+                else
+                  ''
+                end + ev.send(name.to_sym)).ljust(size.to_i, ' ')
               }.join("  ")
               text += " " + ev.resource_status_reason if ev.resource_status =~ /_FAILED/
               if start_time.nil? or start_time < ev.timestamp
                 puts text
               end
-              done = (ev.resource_type == "AWS::CloudFormation::Stack" and ev.resource_status =~ /(_COMPLETE|_FAILED)$/)
+              check_nested_stack(ev)
+              done = is_final_event(ev)
             end
+            sleep 1
           end
         rescue CloudFormationTool::Errors::StackDoesNotExistError => e
           puts "Stack #{name} does not exist"
         end
       end
       
+      def logical_nested_stack_name(phys_name)
+        @nested_stacks[phys_name] || 'unknown'
+      end
+      
+      def nested_stack_name(ev)
+        ev.physical_resource_id.split('/')[1]
+      end
+      
+      def check_nested_stack(ev)
+        return unless ev.resource_type == "AWS::CloudFormation::Stack" and
+          ev.logical_resource_id != self.name # not nested stack
+        return if @nested_stacks.has_key? ev.logical_resource_id # seeing the first or last nested stack event - ignoring
+        @nested_stacks[nested_stack_name(ev)] = ev.logical_resource_id
+      end
+      
+      def is_final_event(ev)
+        ev.resource_type == "AWS::CloudFormation::Stack" and
+        ev.resource_status =~ /(_COMPLETE|_FAILED)$/ and
+        ev.logical_resource_id == self.name
+      end
+      
+      def tracked_stacks
+        [ self.name ] + @nested_stacks.keys.compact
+      end
+      
       def each
+        tracked_stacks.each do |name|
+          events_for(name) do |ev|
+            yield ev
+          end
+        end
+      end
+      
+      def events_for(stack_name)
         token = nil
         sleep(if @_last_poll_time.nil?
           0
@@ -172,7 +213,7 @@ module CloudFormationTool
             end
           end)
         begin
-          resp = awscf.describe_stack_events stack_name: name, next_token: token
+          resp = awscf.describe_stack_events stack_name: stack_name, next_token: token
           @watch_timeouts = 0
           resp.stack_events.each do |ev|
             yield ev
@@ -188,7 +229,11 @@ module CloudFormationTool
           end
         rescue Aws::CloudFormation::Errors::ValidationError => e
           if e.message =~ /does not exist/
-            raise CloudFormationTool::Errors::StackDoesNotExistError, "Stack does not exist"
+            if stack_name == self.name
+              raise CloudFormationTool::Errors::StackDoesNotExistError, "Stack does not exist"
+            end
+            # ignore "does not exist" errors on nested stacks - we may try to poll them before
+            # they actually exist. We'll just try later
           else
             raise e
           end

data/lib/cloud_formation_tool/version.rb

@@ -1,3 +1,3 @@
 module CloudFormationTool
-  VERSION = '1.2.2'
+  VERSION = '1.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudformation-tool
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.1
 platform: ruby
 authors:
 - Oded Arbel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-23 00:00:00.000000000 Z
+date: 2019-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -168,6 +168,7 @@ files:
 - lib/cloud_formation_tool/cloud_formation.rb
 - lib/cloud_formation_tool/cloud_formation/cloud_front_distribution.rb
 - lib/cloud_formation_tool/cloud_formation/lambda_code.rb
+- lib/cloud_formation_tool/cloud_formation/nested_stack.rb
 - lib/cloud_formation_tool/cloud_formation/stack.rb
 - lib/cloud_formation_tool/cloud_init.rb
 - lib/cloud_formation_tool/errors.rb
@@ -192,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: A pre-compiler tool for CloudFormation YAML templates