awshark 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f014eaddd54562cad6064bc0b28a9fde800b7144f3be26e4af11f02a99d1f13
-  data.tar.gz: 258b5c71b20180623ca66646d4081c38d8c14e590a1b2a2773193523423dc614
+  metadata.gz: 944b9d2229c69abfd14fae195f1ba6ffad83e48b1f8a6d8b250ba1958a600330
+  data.tar.gz: d1b9886e347b3eb551f765f1788e556751aca04b17ae95e034d9b4ffbd83936b
 SHA512:
-  metadata.gz: 42970eec188f9fe6a4f561a2d42b01387b08c98f26ee93e0352d83f1fda165f119ae09909fbbb62c80e5380ca259a8d667bb46cf416e742db333051da4891204
-  data.tar.gz: ecf2602e7bb5cf37ebd508d3bb95d44eff004214f38bb6fa19475ee38d6b094093c6572c17acb3d48ca59d6b018a39129019d450e80aa7a6db4d84d0cc4b7c17
+  metadata.gz: 348b4502d6989094798ad96470f219d2207bbf1acaeef6aeaffde67ae1d25a10efc371f6bf9c7f00a0ba64b5c0fc137bf40379bb49b547792038eee73baec9b5
+  data.tar.gz: 3b014bab2c44409f4c1c25f3359f7fc8f4ce6d00e7b1c0fcc9ac286f287e91b3309e0b51b3c29720a32668fdae636fb53e94c618e2507b3086b6e47710afa2cd

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## Changelog
 
+#### 1.4.0
+- [new] add `awshark cf save` to save Cloud Formation templates as file
+
 #### 1.3.0
 - [new] add `awshark ec2 authorize` and `unauthorize`
 

data/README.md

@@ -18,37 +18,46 @@ Use `AWS_PROFILE=PROFILE` and/or `AWS_REGION=REGION` to configure the internal A
 
 #### S3 commands
 
-List all S3 buckets
+List all S3 buckets with number of objects and total size.
+(Data depends on AWS Cloudwatch Metrics so there is a time difference to the actual data.)
 ```
 awshark s3 list
 ```
 
-List all objects in a specific S3 bucket
+List all objects in a specific S3 bucket.
 ```
 awshark s3 objects BUCKET_NAME fonts/
 ```
 
 #### EC2 commands
 
-List all EC2 instances in a region
+List all EC2 instances in a region.
 ```
 awshark ec2 list
 ```
 
 #### ECS commands
 
-List all EC2 instances in a region
+List all ECS services in a region.
 ```
 awshark ecs list
 ```
 
 #### Cloud Formation commands
 
-Update (diff) Cloud Formation stack
+Display changes to AWS Cloud Formation stack.
+```
+awshark cf diff TEMPLATE_PATH --stage=STAGE --bucket=S3_BUCKET.bundesimmo.de
+```
+
+Update or create AWS Cloud Formation stack.
 ```
 awshark cf deploy TEMPLATE_PATH --stage=STAGE --bucket=S3_BUCKET.bundesimmo.de
+```
 
-awshark cf diff TEMPLATE_PATH --stage=STAGE --bucket=S3_BUCKET.bundesimmo.de
+Save AWS Cloud Formation stack as file `STACK_NAME-STAGE.json`.
+```
+awshark cf save TEMPLATE_PATH --stage=STAGE
 ```
 
 For a further information visit the [Wiki](https://github.com/jdahlke/awshark/wiki).

data/lib/awshark/cloud_formation/manager.rb

@@ -46,6 +46,12 @@ module Awshark
         raise e
       end
 
+      def save_stack_template
+        filename = "#{stack.name}.json"
+        File.open(filename, 'w') { |f| f.write(template.body) }
+        filename
+      end
+
       def tail_stack_events
         stack.reload
         stack_events = StackEvents.new(stack)

data/lib/awshark/cloud_formation/subcommand.rb

@@ -63,6 +63,22 @@ module Awshark
         puts diff
       end
 
+      desc 'save', 'Save AWS CloudFormation JSON template as file'
+      long_desc <<-LONGDESC
+        Save AWS CloudFormation JSON template as file TEMPLATE_PATH/cloudformation-stage.json
+
+        Example: `awshark cf save TEMPLATE_PATH`
+      LONGDESC
+      def save(template_path)
+        process_class_options
+
+        manager = create_manager(template_path)
+        print_stack_information(manager.stack)
+
+        filename = manager.save_stack_template
+        printf "Written CloudFormation JSON template to: %<name>s\n\n", name: filename
+      end
+
       private
 
       def create_manager(template_path)

data/lib/awshark/ec2/subcommand.rb

@@ -50,7 +50,7 @@ module Awshark
              desc: 'Security group to allow access to.'
       option :username,
              type: :string,
-             desc: 'Ports to register. Only uses ports from 1 to 65535.'
+             desc: 'Optional user name (defaults to whoami).'
       def authorize
         process_class_options
 
@@ -72,7 +72,7 @@ module Awshark
              desc: 'Security group to remove access from.'
       option :username,
              type: :string,
-             desc: 'Ports to register. Only uses ports from 1 to 65535.'
+             desc: 'Optional user name (defaults to whoami).'
       def unauthorize
         process_class_options
 

data/lib/awshark/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Awshark
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: awshark
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Joergen Dahlke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-10 00:00:00.000000000 Z
+date: 2022-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport