aws-ec2 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 195f128cedbd5bf833767064b92f8f0a81fa3cc24ae131d9a932a7b714e7e3b3
-  data.tar.gz: 408ad9efbdbcbc7008db3267cf7ed68617bb01c437ffd8d4b410dfe43dfd0516
+  metadata.gz: 41c5379df446fa7ebaeb8a4e7243b70c6b8ef3c91afc6a61af1ab42181695c8a
+  data.tar.gz: 8d4558040a99f9496bfdf74b1d43aeb470229f370ae9b14cda174a4096e83f34
 SHA512:
-  metadata.gz: 06af930c02065bcd7a88a3c14ba72c0716738faa663c8cd59cba9900719614d7bb328b84620d41dd4823aed56333dcccf19261c9ca11c988fdcf162991bfaebf
-  data.tar.gz: e13dd0da82d53d71ab2fe955e08ac7f1fe622981024361f1c926475159e7c4749d28a92e9ade7aa258ba92398f605a327da26b41674f29191b6857a2cf44e83b
+  metadata.gz: 0ce576737f3e0dc3c225c581d1507e9a9d338e048db588f7776cd2faa45e73d580b1789e43103d5e9d61298016457c4ec011e3eddf387eb14573fea292550d78
+  data.tar.gz: 94969a46aeb9d0e203b141dc7114df127b1bf353405c2d0574996493baaeea4d79c2863773e895d2d47b4228968c0876e94cba8e0606d628a69d893fac045524

data/.gitignore

@@ -3,9 +3,10 @@
 .bundle
 .config
 .yardoc
-InstalledFiles
 _yardoc
 coverage
+doc/
+InstalledFiles
 lib/bundler/man
 pkg
 rdoc

data/CHANGELOG.md

@@ -3,6 +3,17 @@
 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.
 
+## [1.0.0]
+- Merge pull request #1 from tongueroo/cli-template-upgrade
+- Merge pull request #2 from tongueroo/render_me_pretty
+- Merge pull request #3 from tongueroo/s3-upload
+- Merge pull request #4 from tongueroo/layout-support
+- add --randomize option
+- add extract_scripts and add_ssh_key helpers
+- conventionally use name of server as profile if profile exists
+- introduce settings.yml
+- latest_ami: exit if image cannot be found
+
 ## [0.9.0]
 - much improved error messaging
 - rename docs folder

data/Gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-# Specify your gem dependencies in aws_ec2.gemspec
+# Specify your gem dependencies in aws-ec2.gemspec
 gemspec
 
 gem "codeclimate-test-reporter", group: :test, require: nil

data/Gemfile.lock

@@ -1,32 +1,34 @@
 PATH
   remote: .
   specs:
-    aws-ec2 (0.8.4)
+    aws-ec2 (0.9.0)
       activesupport
       aws-sdk-ec2
       colorize
       dotenv
+      filesize
       hashie
+      render_me_pretty
       thor
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.4)
+    activesupport (5.1.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    aws-partitions (1.57.0)
-    aws-sdk-core (3.14.0)
+    aws-partitions (1.67.0)
+    aws-sdk-core (3.17.0)
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.0)
       jmespath (~> 1.0)
-    aws-sdk-ec2 (1.25.0)
+    aws-sdk-ec2 (1.28.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
     aws-sigv4 (1.0.2)
-    byebug (9.1.0)
+    byebug (10.0.0)
     codeclimate-test-reporter (1.0.8)
       simplecov (<= 0.13)
     coderay (1.1.2)
@@ -35,7 +37,8 @@ GEM
     diff-lcs (1.3)
     docile (1.1.5)
     dotenv (2.2.1)
-    ffi (1.9.18)
+    ffi (1.9.23)
+    filesize (0.1.1)
     formatador (0.2.5)
     guard (2.14.2)
       formatador (>= 0.2.4)
@@ -56,7 +59,7 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     hashie (3.5.7)
-    i18n (0.9.3)
+    i18n (0.9.5)
       concurrent-ruby (~> 1.0)
     jmespath (1.3.1)
     json (2.1.0)
@@ -78,6 +81,10 @@ GEM
     rb-fsevent (0.10.2)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
+    render_me_pretty (0.8.0)
+      activesupport
+      colorize
+      tilt
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -90,7 +97,7 @@ GEM
     rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
+    rspec-support (3.7.1)
     ruby_dep (1.5.0)
     shellany (0.0.1)
     simplecov (0.13.0)
@@ -100,7 +107,8 @@ GEM
     simplecov-html (0.10.2)
     thor (0.20.0)
     thread_safe (0.3.6)
-    tzinfo (1.2.4)
+    tilt (2.0.8)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
 
 PLATFORMS

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Tung Nguyen
+Copyright (c) 2018 Tung Nguyen
 
 MIT License
 

data/README.md

@@ -1,6 +1,8 @@
 # AWS EC2 Tool
 
-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 project directory.
+[![CircleCI](https://circleci.com/gh/tongueroo/aws-ec2.svg?style=svg)](https://circleci.com/gh/tongueroo/aws-ec2)
+
+Tool to create AWS ec2 instances consistently with pre-configured settings.  The pre-configured settings are stored in the profiles folder of the current project directory.
 Example:
 
 * profiles/default.yml: Default settings. Used when no profile is specified.
@@ -9,6 +11,7 @@ Example:
 ## Usage
 
 ```sh
+aws-ec2 create NAME --profile PROFILE
 aws-ec2 create myserver --profile myserver
 ```
 
@@ -23,17 +26,40 @@ aws-ec2 create myserver --profile myserver --noop
 cat tmp/user-data.txt # to view generated user-data script
 ```
 
+## Conventional Profile Name
+
+If there is a profile name that matches the ec2 specified instance name, you can omit the `--profile` flag. Example
+
+```sh
+aws-ec2 create webserver --profile webserver
+aws-ec2 create webserver # same thing as --profile whatever
+```
+
+It is useful to add a random string to the end of your server name, but not use it for the `--profile` flag.  Example:
+
+```
+aws-ec2 create myserver-abc --profile myserver
+aws-ec2 create myserver-123 --profile myserver
+```
+
+You can use the `--randomize` option to do this automatically:
+
+```
+aws-ec2 create myserver --randomize
+```
+
 ## Project Structure
 
 Directory  | Description
 ------------- | -------------
 app/helpers  | Custom helpers methods.  Define them as modules and their methods are made available whenever ERB is available: `profiles`, `app/scripts`, `app/user-data` files, etc. For example, you would define a `module FooHelper` in `app/helpers/foo_helper.rb`.
-app/partials  | Your partials that can to be included in other scripts.  This is used in conjunction with the `partial` helper method.
+app/partials  | Your partials that can to be included in other scripts.  This is used in conjunction with the `partial` helper method. With great power comes great responsibility.  It is recommended to use partials sparely to keep scripts more straightforward.
 app/scripts  | Where you define common scripts that can be used to configure the server. These scripts can be automatically uploaded to an s3 bucket for later downloading in your user-data script by setting the `scripts_s3_bucket` config option.
 app/user-data  | Your user-data scripts that are used to bootstrap EC2 instance.
 config/[AWS_EC2_ENV].yml  | The config file where you set configs that you want available in your templating logic.  Examples are: `config/development.yml` and `config/production.yml`. You access the config variables with the `<%= config["var"] %>` helper.
-profiles  | Your profile files.  These files mainly contain parameters that are passed to the aws-sd2 run_instances API method.
-tmp  | Where the generated scripts get compiled to. You can manually invoke the complilation via `aws-ec2 compile` to inspect what is generated.  This is automatically done as part of the `aws-ec2` create command.
+app/user-data/layouts  | user-data scripts support layouts. You user-data layouts go in here.
+profiles  | Your profile files.  These files mainly contain parameters that are passed to the aws-sdk run_instances API method.
+tmp  | Where the generated scripts get compiled to. You can manually invoke the compilation via `aws-ec2 compile` to inspect what is generated.  This is automatically done as part of the `aws-ec2` create command.
 
 ## Helpers
 
@@ -43,7 +69,7 @@ Helper  | Description
 ------------- | -------------
 user_data | Allows you to embed a generated user_data script.  More details on the user-data are provided in the user data section below.
 config | Access to the variables set in config/[AWS_EC2_ENV].yml.  Examples are `config/development.yml` and `config/production.yml`.
-latest_ami | Returns an AMI id by searching the AMI name pattern and sorting in reverse older.  Example: `latest_ami("ruby-2.5.0_*")` would return the latest ruby AMIs are named with timestamps at the end like so: `ruby-2.5.0_2018-01-30-05-36-02` and `ruby-2.5.0_2018-01-29-05-36-02`.
+latest_ami | Returns an AMI id by searching the AMI name pattern and sorting in reverse order.  Example: `latest_ami("ruby-2.5.0_*")` would return the latest ruby AMIs are named with timestamps at the end like so: `ruby-2.5.0_2018-01-30-05-36-02` and `ruby-2.5.0_2018-01-29-05-36-02`.
 search_ami | Returns a collection of AMI image objects based on a search pattern. The query searches on the AMI name.
 
 For a full list of all the template helpers check out: [aws_ec2/template_helper](lib/aws_ec2/template_helper).
@@ -56,14 +82,14 @@ You can provide a user-data script to customize the server upon launch.  The use
 
 * app/user-data/myserver.yml
 
-The user-data script is generated on the machine that is running the aws-ec2 command. If this is your local macosx machine, then the context of your local macosx machine is available. To see the generated user-data script, you can run the create command in noop mode and then inspect the generated script.  Example:
+The user-data script is generated on the machine that is running the aws-ec2 command. If this is your local macosx machine, then the context of your local macosx machine is available. To see the generated user-data script, you can run the create command in `--noop` mode and then inspect the generated script.  Example:
 
 ```sh
 aws-ec2 create myserver --noop
 cat tmp/user-data.txt
 ```
 
-Another way to view the generated user-data scripts is the `aws-ec2 compile` command.  It generates the files in the tmp folder.  Example:
+Another way to view the generated user-data scripts is the `aws-ec2 compile` command.  It generates the files in the `tmp` folder.  Example:
 
 ```
 aws-ec2 compile # generates files in tmp folder
@@ -76,6 +102,43 @@ $ grep user_data profiles/default.yml
 user_data: "<%= user_data("bootstrap") %>"
 ```
 
+### User-Data Layouts
+
+User-data scripts support layouts.  This is useful if you have common setup and finish code with your user-data scripts. Here's an example: `app/user-data/layouts/default.sh`:
+
+```bash
+#!/bin/bash
+# do some setup
+<%= yield %>
+# finish work
+```
+
+And `app/user-data/box.sh`:
+
+```
+yum install -y vim
+```
+
+The resulting generated user-data script will be:
+
+```bash
+#!/bin/bash
+# do some setup
+yum install -y vim
+# finish work
+```
+
+You can specify the layout to use when you call the `user_data` helper method in your profile. Example: `profiles/box.yml`:
+
+```yaml
+---
+...
+user_data: <%= user_data("box.sh", layout: "mylayout" ) %>
+...
+```
+
+If there's a `layouts/default.sh`, then it will automatically be used without having to specify the layout option.  You can disable this behavior by passing in `layout: false` or by deleting the `layouts/default.sh` file.
+
 ### Config
 
 You can set variables in a config file and they are available when ERB is available: profiles, user-data, scripts, etc.  Example `config/development.yml`:
@@ -112,6 +175,10 @@ Option | Description
 --- | ---
 scripts_s3_bucket | Set this to the bucket name where you want the generated scripts in app/scripts and app/user-data to be uploaded to.  The upload sync happens right before the internal to run_instances call that launches the instance.  If you need more custom logic, you can use the `before_run_instances` hook, covered in the Hooks section.
 
+### Settings
+
+A `config/settings.yml` file controls the internal behavior of aws-ec2. It is different from config files which are meant for user defined varibles.  Settings variables are for internal use.
+
 ### Hooks
 
 There is only one hook: `before_run_instances`.  You can configure this with `config/hooks.yml`:  Example:

data/Rakefile

@@ -1,6 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-task :default => :spec
+task default: :spec
 
 RSpec::Core::RakeTask.new

data/aws-ec2.gemspec

@@ -19,17 +19,19 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "thor"
-  spec.add_dependency "hashie"
-  spec.add_dependency "colorize"
-  spec.add_dependency "dotenv"
   spec.add_dependency "activesupport"
   spec.add_dependency "aws-sdk-ec2"
+  spec.add_dependency "colorize"
+  spec.add_dependency "dotenv"
+  spec.add_dependency "filesize"
+  spec.add_dependency "hashie"
+  spec.add_dependency "render_me_pretty"
+  spec.add_dependency "thor"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "byebug"
-  spec.add_development_dependency "rake"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-bundler"
   spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "rake"
 end

data/lib/aws-ec2.rb

@@ -1,6 +1,7 @@
 $:.unshift(File.expand_path("../", __FILE__))
 require "aws_ec2/version"
 require "colorize"
+require "render_me_pretty"
 
 module AwsEc2
   autoload :Help, "aws_ec2/help"
@@ -11,13 +12,15 @@ module AwsEc2
   autoload :Base, "aws_ec2/base"
   autoload :Create, "aws_ec2/create"
   autoload :Ami, "aws_ec2/ami"
-  autoload :TemplateHelper, "aws_ec2/template_helper"
+  autoload :Template, "aws_ec2/template"
   autoload :Script, "aws_ec2/script"
   autoload :Config, "aws_ec2/config"
   autoload :Core, "aws_ec2/core"
   autoload :Dotenv, "aws_ec2/dotenv"
   autoload :Hook, "aws_ec2/hook"
-
+  autoload :Completion, "aws_ec2/completion"
+  autoload :Completer, "aws_ec2/completer"
+  autoload :Setting, "aws_ec2/setting"
   extend Core
 end
 

data/lib/aws_ec2/ami.rb

@@ -3,7 +3,7 @@ module AwsEc2
     def run
       # Delegates to the Create command.
       # So we just have to set up the option for it.
-      @options[:ami_name] = @options[:name]
+      @options[:ami_name] = @name
       Create.new(@options).run
     end
   end

data/lib/aws_ec2/base.rb

@@ -1,9 +1,42 @@
 module AwsEc2
   class Base
+    # constants really only used by script classes
+    SCRIPTS_INFO_PATH = "tmp/data/scripts_info.txt"
+    BUILD_ROOT = "tmp"
+
     def initialize(options={})
       @options = options.clone
+      @name = randomize(@options[:name])
       AwsEc2.validate_in_project!
-      Profile.new(@options).check!
     end
+
+    # Appends a short random string at the end of the ec2 instance name.
+    # Later we will strip this same random string from the name.
+    # Very makes it convenient.  We can just type:
+    #
+    #   aws-ec2 create server --randomize
+    #
+    # instead of:
+    #
+    #   aws-ec2 create server-123 --profile server
+    #
+    def randomize(name)
+      if @options[:randomize]
+        random = (0...3).map { (65 + rand(26)).chr }.join.downcase # Ex: jhx
+        [name, random].join('-')
+      else
+        name
+      end
+    end
+
+    # Strip the random string at end of the ec2 instance name
+    def derandomize(name)
+      if @options[:randomize]
+        name.sub(/-(\w{3})$/,'') # strip the random part at the end
+      else
+        name
+      end
+    end
+
   end
 end

data/lib/aws_ec2/cli.rb

@@ -8,6 +8,7 @@ module AwsEc2
     option :ami_name, desc: "when specified, an ami creation script is appended to the user-data script"
     option :auto_terminate, type: :boolean, default: false, desc: "automatically terminate the instance at the end of user-data"
     option :source_ami, desc: "override the source image_id in profile"
+    option :randomize, type: :boolean, desc: "append random characters to end of name"
     def create(name)
       Create.new(options.merge(name: name)).run
     end
@@ -21,8 +22,9 @@ module AwsEc2
 
     desc "compile", "compiles app/scripts and app/user-data to tmp folder"
     long_desc Help.text(:compile)
+    option :layout, default: "default", desc: "layout for user_data helper"
     def compile
-      Script::Compile.new(options).compile
+      Script::Compile.new(options).compile_all
     end
 
     desc "upload", "compiles and uploads scripts to s3"
@@ -31,5 +33,22 @@ module AwsEc2
     def upload
       Script::Upload.new(options).upload
     end
+
+    desc "completion *PARAMS", "Prints words for auto-completion."
+    long_desc Help.text("completion")
+    def completion(*params)
+      Completer.new(CLI, *params).run
+    end
+
+    desc "completion_script", "Generates a script that can be eval to setup auto-completion."
+    long_desc Help.text("completion_script")
+    def completion_script
+      Completer::Script.generate
+    end
+
+    desc "version", "prints version"
+    def version
+      puts VERSION
+    end
   end
 end