aws-ec2 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cf9927e8f80013a840c32371fdd48096c1f349002f3f9ee6141a369a326c002
-  data.tar.gz: c8985115802338c38fab0d24f7d95f1dad7021eef7d15c874b53c1b3ef2e23e3
+  metadata.gz: c555a3e325c610710e0db4ab6839ae08a29020f96c06b740c5283b383d4c34a5
+  data.tar.gz: 3deb2d4cf2bbf39fb48dea6050ed1be67d2b3dcb4b68298bde8ad2bfc4ed8517
 SHA512:
-  metadata.gz: dc87b7836701be0468190525dcf22e3373f5ba0bf9dc2d7050af88ec443de2c0bd83853bfe36683030d8e653f8edf9ac854d68ede7cab351a959f82cb3db3ffb
-  data.tar.gz: 77de0393c45ccffaa18527d585465ea9864d76739b4fd73550884496fff5d0b55be51ab2a4677c64e0b75e68dd2e54315aacd21c3c07afa461fda1a4ce168fd1
+  metadata.gz: 81e3a1e2e6186fb146aa3377afab79430170853bb579c3782a877be38592a33dd0c4980d7bc68c7f992be5b4e4f31e85537b989459fe80b49395c9bcebf3bdaa
+  data.tar.gz: 51dacb024e89a664e3c0b642a21220a67108a264f35d39d41ff25f9f9ece4acfec906e9f3ac01300238efc38b3ec9061ba3f4aba04af03ec40cc8009c7604f7e

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.8.0]
+- aws-ec2 upload_scripts command
+- rename aws-ec2 compile to aws-ec2 compile_scripts
+
 ## [0.7.0]
 - Rid of name to profile convention, check profile exists and report to user
   if it does not exist. This is a more expected interface.

data/lib/aws-ec2.rb

@@ -17,8 +17,6 @@ module AwsEc2
   autoload :Core, "aws_ec2/core"
   autoload :Dotenv, "aws_ec2/dotenv"
   autoload :Hook, "aws_ec2/hook"
-  autoload :Compile, "aws_ec2/compile"
-  autoload :S3, "aws_ec2/s3"
 
   extend Core
 end

data/lib/aws_ec2/cli.rb

@@ -1,6 +1,5 @@
 module AwsEc2
   class CLI < Command
-    class_option :verbose, type: :boolean
     class_option :noop, type: :boolean
     class_option :profile, desc: "profile name to use"
 
@@ -20,10 +19,17 @@ module AwsEc2
       Ami.new(options.merge(name: name)).run
     end
 
-    desc "compile", "compiles app/scripts and app/user-data to tmp folder"
-    long_desc Help.text(:compile)
-    def compile
-      Compile.new(options).compile
+    desc "compile_scripts", "compiles app/scripts and app/user-data to tmp folder"
+    long_desc Help.text(:compile_scripts)
+    def compile_scripts
+      Script::Compile.new(options).compile
+    end
+
+    desc "upload_scripts", "compiles and uploads scripts to s3"
+    long_desc Help.text(:upload_scripts)
+    option :compile, type: :boolean, default: true, desc: "compile scripts before uploading"
+    def upload_scripts
+      Script::Upload.new(options).upload
     end
   end
 end

data/lib/aws_ec2/create.rb

@@ -28,7 +28,7 @@ module AwsEc2
     #   scripts_s3_bucket: my-bucket
     def sync_scripts_to_s3
       if AwsEc2.config["scripts_s3_bucket"]
-        S3.new(@options).upload
+        Script::Upload.new(@options).upload
       end
     end
 

data/lib/aws_ec2/help/ami.md

@@ -2,10 +2,12 @@ Examples:
 
   $ aws-ec2 ami myrubyami --profile ruby --noop
 
-The launches an EC2 instance with using the profile running it's user-data script.  An ami creation script is appended to the end of the user-data script. The ami creation script uses the AWS CLI `aws ec2 create-image` command to create an AMI.  It is useful to include to timestamp as a part of the ami name with the date command.
+Launches an EC2 instance to create an AMI.  An AMI creation script is appended to the end of the user-data script. The AMI creation script calls `aws ec2 create-image` and causes the instance to reboot at the end.
+
+It is useful to include to timestamp as a part of the AMI name with the date command.
 
   $ aws-ec2 ami $(date "+ruby-2.5.0_%Y-%m-%d-%H-%M") --profile ruby --noop
 
-Note, it is recommended to use the `set -e` option in your user-data script so that if the script fails, the ami creation script is never reached and instance is left behind so you can debug.
+The instance also automatically gets terminated and cleaned up by a termination script appended to user-data.
 
-The instance also automatically gets terminated and cleaned up.
+It is recommended to use the `set -e` option in your user-data script so that if the script fails, the AMI creation script is never reached and the instance is left behind so you can debug.

data/lib/aws_ec2/help/compile_scripts.md

@@ -0,0 +1,5 @@
+Examples:
+
+  $ aws-ec2 compile_scripts
+
+Compiles app/scripts and app/user-data files to the tmp folder. Useful for inspection.

data/lib/aws_ec2/help/create.md

@@ -2,10 +2,6 @@ Examples:
 
   $ aws-ec2 create my-instance
 
-If you want to create an ami at the end of of a successful user-data script run you can use the `--ami` option. Example:
+To see the snippet of code that gets added to the user-data script you can use the `--noop` option and then view the generated /tmp/aws-ec2/user-data.txt.
 
-  $ aws-ec2 create my-instance --ami myname
-
-To see the snippet of code that gets added to the user-data script you can use the aws-ec2 userdata command.
-
-  $ aws-ec2 userdata myscript --ami myname
+  $ aws-ec2 create myscript --noop

data/lib/aws_ec2/help/upload_scripts.md

@@ -0,0 +1,9 @@
+Examples:
+
+  $ aws-ec2 upload_scripts
+
+Compiles the app/scripts and app/user-data files to the tmp folder. Then uploads the files to an s3 bucket that is configured in config/[AWS_EC2_ENV].yml.  Example scripts_s3_bucket config:
+
+```yaml
+scripts_s3_bucket: my-bucket # enables auto sync to s3
+```

data/lib/aws_ec2/script.rb

@@ -1,5 +1,8 @@
 module AwsEc2
   class Script
+    autoload :Compile, "aws_ec2/script/compile"
+    autoload :Upload, "aws_ec2/script/upload"
+
     def initialize(options={})
       @options = options
     end

data/lib/aws_ec2/{compile.rb → script/compile.rb}

@@ -1,8 +1,9 @@
 require 'fileutils'
 
-module AwsEc2
-  class Compile < Base
-    include TemplateHelper
+# Class for aws-ec2 compile_scripts command
+class AwsEc2::Script
+  class Compile < AwsEc2::Base
+    include AwsEc2::TemplateHelper
     BUILD_ROOT = "tmp"
 
     def compile

data/lib/aws_ec2/{s3.rb → script/upload.rb}

@@ -1,13 +1,16 @@
-module AwsEc2
-  class S3
+require 'fileutils'
+
+# Class for aws-ec2 upload_scripts command
+class AwsEc2::Script
+  class Upload < AwsEc2::Base
     def initialize(options={})
       @options = options
     end
 
-    def upload(skip_compile=false)
-      compiler.compile unless skip_compile
+    def upload
+      compiler.compile if @options[:compile]
       sync_scripts_to_s3
-      compiler.clean unless ENV['AWS_EC2_KEEP'] || skip_compile
+      compiler.clean if @options[:compile] and !ENV['AWS_EC2_KEEP']
     end
 
     def sync_scripts_to_s3

data/lib/aws_ec2/version.rb

@@ -1,3 +1,3 @@
 module AwsEc2
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-ec2
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Tung Nguyen
@@ -204,7 +204,6 @@ files:
 - lib/aws_ec2/base.rb
 - lib/aws_ec2/cli.rb
 - lib/aws_ec2/command.rb
-- lib/aws_ec2/compile.rb
 - lib/aws_ec2/config.rb
 - lib/aws_ec2/core.rb
 - lib/aws_ec2/create.rb
@@ -212,12 +211,14 @@ files:
 - lib/aws_ec2/dotenv.rb
 - lib/aws_ec2/help.rb
 - lib/aws_ec2/help/ami.md
-- lib/aws_ec2/help/compile.md
+- lib/aws_ec2/help/compile_scripts.md
 - lib/aws_ec2/help/create.md
+- lib/aws_ec2/help/upload_scripts.md
 - lib/aws_ec2/hook.rb
 - lib/aws_ec2/profile.rb
-- lib/aws_ec2/s3.rb
 - lib/aws_ec2/script.rb
+- lib/aws_ec2/script/compile.rb
+- lib/aws_ec2/script/upload.rb
 - lib/aws_ec2/scripts/ami_creation.sh
 - lib/aws_ec2/scripts/auto_terminate.sh
 - lib/aws_ec2/template_helper.rb

data/lib/aws_ec2/help/compile.md

@@ -1,5 +0,0 @@
-Examples:
-
-  $ aws-ec2 compile
-
-Compiles the scripts in app/scripts and app/user-data to the tmp folder. Useful for inspection.