aws-ec2 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dea551aeb6e2d51a45460e30e408f4a82a32f61356f2e1391bcc837081272d28
-  data.tar.gz: f2dbabe12ceb094fba4fa6accb920e5a4bd38436ba5095dc1e26a1b53acb573c
+  metadata.gz: b4c5bf33bed4b038a859606fca1faf595e8fca5455f3ae4e3c07f3c2329d7c3b
+  data.tar.gz: f57b5c4305db3141a8f8dd1c540669ed2d666403df7d05af6a3ddb36f1d79280
 SHA512:
-  metadata.gz: 158ca61a47b19c5ed7ebc3a81331170df07cd7c55dac58df4610948a14c2e7ead29f7f132c1654479b7b0559da220952681f950cfe0977ef1a9c7401584205f2
-  data.tar.gz: 0e1d65584446dc61b176a75f0d16bb6f113b8574e103980e592875c500d4d002f59e2faf82e99def3eae12d62af28b8d34e1e0662729655c02c0933bfcef2174
+  metadata.gz: 0ab78f966ab1614ebe690b16f04d9e053803df832103542686d7697cc60af3e81ea341af447bb42c9fc181b599ac2cfdf268f665138441662a72d683e2da74bb
+  data.tar.gz: 787504de7fb53ae1c7656a420cbede3ae3c44844d21315b488ebd9fe6e005b06256800a6fd03d219ecd28f7e4c50192b9faad59e5ae9be1c6bf99a06d347058f

data/CHANGELOG.md

@@ -3,8 +3,13 @@
 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.3.0]
+- Do not merge profile to default profile.  This was pretty confusing usage.
+- Add --ami option which result in automatically creating an ami at the end of
+  the user-data script.
+
 ## [0.2.0]
-- add config files support. example: config/development.yml
+- Add config files support. example: config/development.yml.
 
 ## [0.1.0]
-- initial release
+- Initial release.

data/README.md

@@ -3,8 +3,8 @@
 Simple tool to create AWS ec2 instances consistently with pre-configured settings.  The pre-configured settings are stored in the profiles folder of the current directory.
 Example:
 
-* profiles/default.yml: default settings.  Takes the lowest precedence.
-* profiles/myserver.yml: myserver settings get combined with the default settings
+* profiles/default.yml: default settings.  If there is no other matching profile.
+* profiles/myserver.yml: myserver settings.
 
 ## Usage
 
@@ -14,6 +14,13 @@ aws-ec2 create myserver --profile myserver
 
 In a nutshell, the profile parameters are passed to the ruby aws-sdk [AWS::EC2::Client#run_instances](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/Client.html#run_instances-instance_method) method.  So you can specify any parameter you wish that is available there. To check out what a profile looks like look at the [example default](example/profiles/default.yml)
 
+You can use ERB in the profile files. Some useful helper methods in the profile files are:
+
+* user_data: a helper method that allows you to embed a generated user_data script.  More details on the user_data helper are provided below.
+* config:
+
+The template helpers defined in [template_helper.rb](lib/aws_ec2/template_helper.rb).
+
 ### Convention
 
 By convention, the profile name matches the first parameter after the create command.  So the command above could be shortened to:
@@ -34,6 +41,10 @@ The user-data script is generated on the machine that is running the aws-ec2 com
 
 To use the user-data script when creating an EC2 instance, you can use the helper method in the profile.
 
+### Config
+
+You can set a config file and define variables in there that are available to in your profiles and user_data scripts.
+
 ## Noop mode
 
 You can do a test run with the `--noop` flag.  This will print out what settings will be used to launch the instance.
@@ -49,20 +60,6 @@ Spot instance support natively supported by the AWS run_instances command.  Simp
 * [https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplateSpotMarketOptionsRequest.html](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplateSpotMarketOptionsRequest.html)
 * [https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/Types/SpotMarketOptions.html](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/Types/SpotMarketOptions.html)
 
-## Spot Fleet Support
-
-Additionally, spot fleet is supported.  Launching a fleet request is slighlyt more complicated but is useful if you are okay with multiple types of instances.  The spot instance profile files are stored in the profiles/spot folder.  Example:
-
-* profiles/spot/default.yml: default settings.  Takes the lowest precedence.
-* profiles/spot/myspot.yml: myspot settings get combined with the default settings
-
-Note the parameters structure of a spot fleet request is different from the parameter structure to run a single instance with the create command above. The profile parameters are passed to the ruby aws-sdk [AWS::EC2::Client#request_spot_fleet](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/EC2/Client.html#request_spot_fleet-instance_method) method.  So you can specify any parameter you wish that is available there.
-
-```sh
-ec2 spot myspot --profile myspot
-ec2 spot myspot # same as above by convention
-```
-
 ## More Help
 
 ```sh

data/lib/aws-ec2.rb

@@ -12,6 +12,7 @@ module AwsEc2
   autoload :Spot, "aws_ec2/spot"
   autoload :TemplateHelper, "aws_ec2/template_helper"
   autoload :UserData, "aws_ec2/user_data"
+  autoload :Ami, "aws_ec2/ami"
   autoload :Config, "aws_ec2/config"
   autoload :Core, "aws_ec2/core"
 

data/lib/aws_ec2/ami.rb

@@ -0,0 +1,15 @@
+module AwsEc2
+  class Ami
+    def initialize(ami_name)
+      @ami_name = ami_name
+    end
+
+    def user_data_snippet
+      region = `aws configure get region`.strip rescue 'us-east-1'
+      # the shebang line is here in case there's currently an
+      # empty user-data script.  If there is not, then it wont hurt.
+      template = IO.read(File.expand_path("../scripts/ami_creation.sh", __FILE__))
+      ERB.new(template, nil, "-").result(binding)
+    end
+  end
+end

data/lib/aws_ec2/cli.rb

@@ -5,6 +5,7 @@ module AwsEc2
     class_option :profile, desc: "profile name to use"
 
     desc "create NAME", "create ec2 instance"
+    option :ami, desc: "ami name, if specified an ami will be created at the end of user data"
     long_desc Help.text(:create)
     def create(name)
       Create.new(options.merge(name: name)).run
@@ -17,6 +18,7 @@ module AwsEc2
     end
 
     desc "userdata NAME", "displays generated userdata script"
+    option :ami, desc: "ami name, if specified an ami will be created at the end of user data"
     long_desc Help.text(:user_data)
     def userdata(name)
       UserData.new(options.merge(name: name)).run

data/lib/aws_ec2/help/create.md

@@ -1,3 +1,11 @@
 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:
+
+$ 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

data/lib/aws_ec2/help/user_data.md

@@ -3,3 +3,11 @@ Displays the generated user data script. Useful for debugging since ERB can be r
 Given a user data script in profiles/user-data/myscript.sh, run:
 
 $ aws-ec2 userdata myscript
+
+You can have an ami creation snippet of code added to the end of the user data script with the `--ami` option.
+
+$ aws-ec2 userdata myscript --ami myname
+
+If you want to include a timestamp in the name you can use this:
+
+$ aws-ec2 userdata myscript --ami '`date "+myname_%Y-%m-%d-%H-%M"`'

data/lib/aws_ec2/scripts/ami_creation.sh

@@ -0,0 +1,27 @@
+#!/bin/bash -exu
+
+# Configure aws cli in case it is not yet configured
+mkdir -p /home/ec2-user/.aws
+if [ ! -f /home/ec2-user/.aws/config ]; then
+  cat >/home/ec2-user/.aws/config <<EOL
+[default]
+region = <%= region %>
+output = json
+EOL
+fi
+
+# The aws ec2 create-image command below reboots the instance.
+# So before rebooting the instance, schedule a job to terminate the instance
+# in 20 mins after the machine has rebooted
+cat >~/terminate-myself.sh <<EOL
+#!/bin/bash -exu
+INSTANCE_ID=$(wget -q -O - http://169.254.169.254/latest/meta-data/instance-id)
+aws ec2 terminate-instances --instance-ids \$INSTANCE_ID
+EOL
+at now + 1 minutes -f ~/terminate-myself.sh
+
+# Create AMI Bundle
+AMI_NAME="<%= @ami_name %>"
+INSTANCE_ID=$(wget -q -O - http://169.254.169.254/latest/meta-data/instance-id)
+REGION=$(aws configure get region)
+aws ec2 create-image --name $AMI_NAME --instance-id $INSTANCE_ID --region $REGION

data/lib/aws_ec2/template_helper.rb

@@ -3,7 +3,7 @@ require "erb"
 
 module AwsEc2
   module TemplateHelper
-    def user_data(name)
+    def user_data(name, base64=true)
       # allow user to specify the path also
       if File.exist?(name)
         name = File.basename(name) # normalize name, change path to name
@@ -11,8 +11,36 @@ module AwsEc2
       name = File.basename(name, '.sh')
       path = "#{root}/profiles/user-data/#{name}.sh"
       result = erb_result(path)
+      result = append_ami_creation(result)
 
-      Base64.encode64(result).strip
+      base64 ? Base64.encode64(result).strip : result
+    end
+
+    # provides access to config/* settings as variables
+    #   AWS_EC2_ENV=development => config/development.yml
+    #   AWS_EC2_ENV=production => config/production.yml
+    def config
+      AwsEc2.config
+    end
+
+    # pretty timestamp that is useful for ami ids.
+    # the timestamp is generated once and cached.
+    def timestamp
+      @timestamp ||= Time.now.strftime("%Y-%m-%d-%H-%M-%S")
+    end
+
+  private
+    def append_ami_creation(user_data)
+      ami = @options[:ami]
+
+      if ami
+        # assuming that the user-data script is a bash script here for simplicity
+        # TODO: add support for other types of scripts
+        # might be able to do this by wrapping all scripts in cloud-init
+        ami_creation_snippet = AwsEc2::Ami.new(ami).user_data_snippet
+        user_data += ami_creation_snippet
+      end
+      user_data
     end
 
     def erb_result(path)

data/lib/aws_ec2/user_data.rb

@@ -11,13 +11,7 @@ module AwsEc2
     end
 
     def run
-      if File.exist?(@options[:name])
-        filename = File.basename(@options[:name], '.sh')
-      end
-
-      filename ||= @options[:name]
-      path = "profiles/user-data/#{filename}.sh"
-      puts erb_result(path)
+      puts user_data(@options[:name], false)
     end
   end
 end

data/lib/aws_ec2/util.rb

@@ -24,9 +24,9 @@ module AwsEc2
 
       params_exit_check!(profile_file, default_file)
 
-      defaults = load_profile(default_file)
-      params = load_profile(profile_file)
-      params = defaults.deep_merge(params)
+      params = File.exist?(profile_file) ?
+                  load_profile(profile_file) :
+                  load_profile(default_file)
       @profile_params = params
     end
 
@@ -44,6 +44,7 @@ module AwsEc2
       puts "Using profile: #{file}"
       data = YAML.load(erb_result(file))
       data ? data : {} # in case the file is empty
+      data.has_key?("run_instances") ? data["run_instances"] : data
     end
 
     def profile_name

data/lib/aws_ec2/version.rb

@@ -1,3 +1,3 @@
 module AwsEc2
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-ec2
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-22 00:00:00.000000000 Z
+date: 2018-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -162,6 +162,7 @@ files:
 - example/profiles/user-data/dev.sh
 - exe/aws-ec2
 - lib/aws-ec2.rb
+- lib/aws_ec2/ami.rb
 - lib/aws_ec2/aws_services.rb
 - lib/aws_ec2/cli.rb
 - lib/aws_ec2/command.rb
@@ -172,6 +173,7 @@ files:
 - lib/aws_ec2/help/create.md
 - lib/aws_ec2/help/spot.md
 - lib/aws_ec2/help/user_data.md
+- lib/aws_ec2/scripts/ami_creation.sh
 - lib/aws_ec2/spot.rb
 - lib/aws_ec2/template_helper.rb
 - lib/aws_ec2/user_data.rb