cloudformation-tool 1.3.4 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e68236a0ceae7d8423b08ad878d8800398f6f3d4035883961369db5cce9e69a
-  data.tar.gz: 2f0d5633efd0cd1a20caa428135e1e81f483855dfa77dedaabc9d3b8657a2d01
+  metadata.gz: cd10fcf36cd9e64d8079a81e20b17f095174d05d6fa1affd9876efb728baefd8
+  data.tar.gz: 16d68ab17edbbe9b1871bac34e04cd6e8aa04016d8bb24515a9c8a3877f81942
 SHA512:
-  metadata.gz: cfc5b645933403a7ec6b66151bcd0bb47e74324573ebe61455cbe10505e46c1ff7867960fd108b91f9a6302da8ae165ddd981f633f96175a149a74fcae6b8e70
-  data.tar.gz: 0ea95fa0ca26a6b3106f7ecd31b659025f7d7f7d76d15d0b19fd47475102135883165c5e8e655a4ceadade2ddde17ecf65fea73a1771a4a8c34f45d6f85f11b4
+  metadata.gz: 1230aada138e035ac0852273eef12483a1c34741a18f86807e294cf96a42d0ea800f4568dcc52aeb2b8740519f2a367bf74308ef99fe5f936c3e5a73ebf62e88
+  data.tar.gz: f613bb486a3144845924dfa74536c862095fffea4a0876372d24968b98f3a70fe29244cea2a749e7970f33139e94be980d857e379f902f9f9058b8af4dc688ca

data/README.md

@@ -103,27 +103,30 @@ multiple sub-templates, this is an error that would cause the tool to abort.
 
 ### Loading user data files
 
-When specifying a user-data block for a `LaunchConfiguration` resource or an `Instance`
-resource, the user-data can be loaded from an external YAML file (only YAML formatted user-data
-is currently supported, sorry) by specifying the `UserData` element as a map with the single
-field `File` that is set with the relative path to the user-data file. The user-data file is
-expected to be a cloud-init configuration file with the default extension `.init`.
-
-Alternatively, the field `FileTemplate` can be used under `UserData` to load an external cloud-init configuration file that includes variable place holders for the
-(CloudFormation intrinsic function Sub)[http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-sub.html]. The `FileTemplate` mode supports all
-the features described above as well as it performs the parsing detailed below, except
-compression and S3 offloading - as doing so prevents CloudFormation from performing the
-substitution operation. As a result, if the resulting cloud-init file is larger than 16KB
-you should expect that the template will fail to create the server.
+When specifying a user-data block for a `LaunchConfiguration` resource, `Instance`
+resource, or a `LaunchTemplate` resource, the user-data can be loaded from an external
+YAML file (only YAML formatted user-data is currently supported, sorry) by specifying the
+`UserData` element as a map with the single field `File` that is set with the relative
+path to the user-data file. The user-data file is expected to be a cloud-init configuration
+file with the default extension `.init` (but there really aren't any filename requirements).
+
+Alternatively, the field `FileTemplate` can be used under `UserData` to load an external
+cloud-init configuration file that includes variable place holders for the
+(CloudFormation intrinsic function Sub)[http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-sub.html].
+The `FileTemplate` mode supports all the features described above as well as it performs
+the parsing detailed below, except compression and S3 offloading - as doing so prevents
+CloudFormation from performing the substitution operation. As a result, if the resulting
+cloud-init file is larger than 16KB you should expect that the template will fail to create
+the stack.
 
 #### User data file parsing
 
 The reference file will be loaded and parsed as a ("Cloud Config data" file)[http://cloudinit.readthedocs.io/en/latest/topics/format.html#cloud-config-data]
-with the special `write_files` and `write_directories` enhancement (see below). The result is then checked that it
-does not exceed the user-data size limitation. If the file is bigger than can fit in the AWS
-user-data block, it will first be compressed using gzip and if it is still too large, it will
-be uploaded to S3 and the user-data block will be set with a cloud-init download reference to
-the S3 object.
+with the special `write_files` and `write_directories` enhancement (see below). 
+The result is then checked that it does not exceed the user-data size limitation.
+If the file is bigger than can fit in the AWS user-data block, it will first be compressed
+using gzip and if it is still too large, it will be uploaded to S3 and the user-data block
+will be set with a cloud-init download reference to the S3 object.
 
 ##### Enhanced `write_files`
 

data/lib/cloud_formation_tool/cli/compile.rb

@@ -4,11 +4,16 @@ module CloudFormationTool
     class Compile < Clamp::Command
       include ParamSupport
       
+      option "--user-data-size", "SIZE", "Maximum size of VM user data", default: $MAX_USER_DATA_SIZE do |s|
+        Integer(s)
+      end
+      
       parameter 'FILE', 'Template main file'
       
       add_param_options
       
       def execute
+      	$MAX_USER_DATA_SIZE = user_data_size
         if file.end_with? '.init'
           puts CloudInit.new(file).encode(false) # make sure cloud-init files obey AWS user-data restrictions, but are also printable
         else

data/lib/cloud_formation_tool/cli/main.rb

@@ -1,6 +1,7 @@
 require 'clamp'
 require 'io/console'
 
+$MAX_USER_DATA_SIZE = 16384
 
 module CloudFormationTool
   module CLI
@@ -53,8 +54,9 @@ module CloudFormationTool
       subcommand 'delete', "Delete an existing stack", Delete
       subcommand 'servers', 'List stack resources', Servers
       subcommand 'groups', 'List stack Autoscaling groups', Groups
+      subcommand 'services', 'List stack Fargate services', Services
       subcommand 'recycle', 'Recycle servers in an auto scaling group', Recycle
-      subcommand 'scale', 'Set the number of desired servesr in an auto scaling group', Scale
+      subcommand 'scale', 'Set the number of desired servers in an auto scaling group', Scale
       subcommand 'invalidate', 'Invalidate CloudFront caches in the stack', Invalidate
       subcommand 'output', 'Retrieve output values from the stack', Output
     end

data/lib/cloud_formation_tool/cli/services.rb

@@ -0,0 +1,25 @@
+module CloudFormationTool
+  module CLI
+    
+    class Services < Clamp::Command
+      include CloudFormationTool
+      
+      parameter "STACK_NAME", "Name of the stack to list Fargate services from"
+      
+      def execute
+        st = CloudFormation::Stack.new(stack_name)
+        output = st.fargate_services.collect do |res|
+          {
+            name: res.logical_resource_id,
+            res: res.physical_resource_id,
+            len: res.logical_resource_id.length
+          }
+        end
+        width = output.collect { |g| g[:name].length }.max
+        output.collect do |svc|
+          puts svc[:name].ljust(width, ' ') + "\t => " + svc[:res]
+        end
+      end
+    end
+  end
+end

data/lib/cloud_formation_tool/cloud_formation/stack.rb

@@ -126,6 +126,44 @@ module CloudFormationTool
         end
       end
       
+      def fargate_services
+        output = []
+        resources do |res|
+          output << res if res.resource_type == 'AWS::ECS::Service'
+        end
+        output.collect do |res|
+          res.extend(CloudFormationTool)
+          res.instance_eval do
+            def arn
+              physical_resource_id
+            end
+            def cluster_name
+              self.arn.split(/:/).last.split('/')[1]
+            end
+            def service_name
+              self.arn.split(/:/).last.split('/')[2]
+            end
+            def service
+              svc = awsecs.describe_services(cluster: cluster_name, services: [ service_name ], include: [ 'TAGS' ]).services.first
+              svc.instance_eval do
+                def client= ecsclient
+                  @client = ecsclient
+                end
+                def client
+                  @client
+                end
+              end
+              svc.client = awsecs
+              svc
+            end
+            def task_definition
+              awsecs.describe_task_definition(task_definition: service.task_definition).task_definition
+            end
+          end
+          res
+        end
+      end
+      
       def cdns
         output = []
         resources do |res|

data/lib/cloud_formation_tool/cloud_formation.rb

@@ -13,6 +13,7 @@ module CloudFormationTool
     attr_reader :basedir
     
     def initialize(path)
+      $MAX_USER_DATA_SIZE = 16384 if $MAX_USER_DATA_SIZE.nil?
       log "Loading #{path}"
       @path = path
       @path = "#{@path}/cloud-formation.yaml" if File.directory? @path
@@ -23,7 +24,7 @@ module CloudFormationTool
       begin
         text = File.read(@path)
         # remove comments because white space seen between comments can seriously psych Psych
-        text.gsub!(/^#.*\n/s,'')
+        text.gsub!(/^#.*\n/,'')
         text = fixShorthand(text)
         @data = YAML.load(text).to_h
       rescue Psych::SyntaxError => e
@@ -167,7 +168,7 @@ module CloudFormationTool
         restype = data['Type'] if restype.nil? and data.key?('Type')
         data.inject({}) do |dict, (key, val)|
           dict[key] = case restype
-            when 'AWS::AutoScaling::LaunchConfiguration'
+            when 'AWS::AutoScaling::LaunchConfiguration', 'AWS::EC2::LaunchTemplate'
               if (key == "UserData") and (val["File"]) 
                 # Support LaunchConfiguration UserData from file
                 CloudInit.new("#{@basedir}/#{val["File"]}").to_base64

data/lib/cloud_formation_tool/cloud_init.rb

@@ -45,11 +45,11 @@ module CloudFormationTool
     def encode(allow_gzip = true)
       yamlout = compile
       usegzip = false
-      if allow_gzip and yamlout.size > 16000 # max AWS EC2 user data size - try compressing it
+      if allow_gzip and yamlout.size > $MAX_USER_DATA_SIZE # max AWS EC2 user data size - try compressing it
         yamlout = Zlib::Deflate.new(nil, 31).deflate(yamlout, Zlib::FINISH) # 31 is the magic word to have deflate create a gzip compatible header
         usegzip = true
       end
-      if yamlout.size > 16384 # still to big, we should upload to S3 and create an include file
+      if yamlout.size > $MAX_USER_DATA_SIZE # still to big, we should upload to S3 and create an include file
         url = upload  make_filename('init'),
                       yamlout, mime_type: 'text/cloud-config', gzip: usegzip
         log "Wrote cloud config to #{url}"

data/lib/cloud_formation_tool/version.rb

@@ -1,3 +1,3 @@
 module CloudFormationTool
-  VERSION = '1.3.4'
+  VERSION = '1.5.1'
 end

data/lib/cloud_formation_tool.rb

@@ -95,6 +95,11 @@ module CloudFormationTool
     $__aws_as ||= Aws::AutoScaling::Client.new aws_config
   end
   
+  def awsecs
+    require 'aws-sdk-ecs'
+    $__aws_ecs ||= Aws::ECS::Client.new aws_config
+  end
+  
   def awscdn
     require 'aws-sdk-cloudfront'
     $__aws_cdn ||= Aws::CloudFront::Client.new aws_config

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cloudformation-tool
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.5.1
 platform: ruby
 authors:
 - Oded Arbel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2021-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ecs
+  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-autoscaling
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +178,7 @@ files:
 - lib/cloud_formation_tool/cli/recycle.rb
 - lib/cloud_formation_tool/cli/scale.rb
 - lib/cloud_formation_tool/cli/servers.rb
+- lib/cloud_formation_tool/cli/services.rb
 - lib/cloud_formation_tool/cli/status.rb
 - lib/cloud_formation_tool/cloud_formation.rb
 - lib/cloud_formation_tool/cloud_formation/cloud_front_distribution.rb
@@ -193,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: A pre-compiler tool for CloudFormation YAML templates