forger 1.6.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7f8632fbacedf3fef18dd35609c6be4d1562529addb42070483aabcf3440327
-  data.tar.gz: 97d4a488cd4a376e09888d9724a9ba4ec20c88ddb6c290aa3b5f5257e496572e
+  metadata.gz: 40903820dcf27929a6a4772f175612f8ef7090cfba6335134c181609397e2d46
+  data.tar.gz: 7f25db5d64cb8fd19acfe6f420fb4cfb9122395f8628d3bd39de14552e8daa46
 SHA512:
-  metadata.gz: 1f20c8838736d1e26fa8ddc7da67aa453ab7975043e87ee1612cf4cb69f1e28ada67d2eebb507859341e387ee7a3a0864320c1fff699dcf7bd6e008750983da3
-  data.tar.gz: e931dad7f1c96d2915fc6cc3a3cc3c6574a9a6130a510cfe6c4809627a21f1976fbf6575fb072b197bef555938d8795187b5b49ba481ab8cb533956da5968e40
+  metadata.gz: 4ca21504ea5bd44e8f290cb857f81bac99c0d2dfb84486f5bff456916c8f9f12b4292052ba2b99afafe134ce57222263f2332733ecfb7970b6e75df4ce590753
+  data.tar.gz: f3d5fb6bb654c89d50f2ec2510c119f3ae5a1b6b46a4923cf066ed248806236d30200795d8f8013be8b4c56abc2035e097990c2da83794cb14d4e93495e13f3b

data/CHANGELOG.md

@@ -3,6 +3,23 @@
 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.
 
+## [2.0.0]
+- Merge pull request #11 and #12 from tongueroo/new:
+- forger new: creates a starter project that works right off the bat
+- Merge pull request #10 from tongueroo/waiter:
+- New abilities: forger destroy, forger create --ssh, forger create --wait
+- Bug fixes and improvements:
+- add key-name option, fix auto terminate for on-demand instances
+- add spot option in default profile
+- allow cloudwatch option to be saved in settings
+- all user-data scripts to be under subfolders
+- change cloudwatch log group name to forger
+- detect os by ID in os-release
+- fix case when s3_folder only has bucket name
+- improve ssh waiting and add spot max monthly price estimate
+- install wget and tar when needed for extract_forger_scripts helper
+- forger create: wait for instance to be ready and provide dns and ssh command by default
+
 ## [1.6.0]
 - Merge pull request #10 from tongueroo/waiter
 - forger destroy command

data/Gemfile

@@ -2,5 +2,3 @@ source "https://rubygems.org"
 
 # Specify your gem dependencies in forger.gemspec
 gemspec
-
-gem "codeclimate-test-reporter", group: :test, require: nil

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    forger (1.5.4)
+    forger (2.0.0)
       activesupport
       aws-sdk-ec2
       aws-sdk-s3
@@ -16,38 +16,37 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.0)
+    activesupport (5.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    aws-partitions (1.82.0)
-    aws-sdk-core (3.20.2)
+    aws-eventstream (1.0.1)
+    aws-partitions (1.105.0)
+    aws-sdk-core (3.30.0)
+      aws-eventstream (~> 1.0)
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.0)
       jmespath (~> 1.0)
-    aws-sdk-ec2 (1.30.0)
-      aws-sdk-core (~> 3)
+    aws-sdk-ec2 (1.50.0)
+      aws-sdk-core (~> 3, >= 3.26.0)
       aws-sigv4 (~> 1.0)
-    aws-sdk-kms (1.5.0)
-      aws-sdk-core (~> 3)
+    aws-sdk-kms (1.9.0)
+      aws-sdk-core (~> 3, >= 3.26.0)
       aws-sigv4 (~> 1.0)
-    aws-sdk-s3 (1.9.1)
-      aws-sdk-core (~> 3)
+    aws-sdk-s3 (1.21.0)
+      aws-sdk-core (~> 3, >= 3.26.0)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.0)
-    aws-sigv4 (1.0.2)
+    aws-sigv4 (1.0.3)
     byebug (10.0.2)
-    codeclimate-test-reporter (1.0.8)
-      simplecov (<= 0.13)
     coderay (1.1.2)
     colorize (0.8.1)
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
-    docile (1.1.5)
-    dotenv (2.4.0)
-    ffi (1.9.23)
-    filesize (0.1.1)
+    dotenv (2.5.0)
+    ffi (1.9.25)
+    filesize (0.2.0)
     formatador (0.2.5)
     guard (2.14.2)
       formatador (>= 0.2.4)
@@ -67,11 +66,10 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    hashie (3.5.7)
-    i18n (1.0.1)
+    hashie (3.6.0)
+    i18n (1.1.0)
       concurrent-ruby (~> 1.0)
     jmespath (1.4.0)
-    json (2.1.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
@@ -95,26 +93,21 @@ GEM
       activesupport
       colorize
       tilt
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
     ruby_dep (1.5.0)
     shellany (0.0.1)
-    simplecov (0.13.0)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
     thor (0.20.0)
     thread_safe (0.3.6)
     tilt (2.0.8)
@@ -127,7 +120,6 @@ PLATFORMS
 DEPENDENCIES
   bundler
   byebug
-  codeclimate-test-reporter
   forger!
   guard
   guard-bundler
@@ -135,4 +127,4 @@ DEPENDENCIES
   rake
 
 BUNDLED WITH
-   1.16.1
+   1.16.3

data/README.md

@@ -8,55 +8,63 @@ Example:
 * profiles/default.yml: Default settings. Used when no profile is specified.
 * profiles/myserver.yml: myserver profile.  Used when `--profile myserver` is specified.
 
-## Usage
+## How It Works
 
-```sh
-forger create NAME --profile PROFILE
-forger 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.  This allows you to specify any parameter you wish that is available in the aws-sdk. To check out what a profile looks like check out [example default profile](docs/example/profiles/default.yml).
+
+## Usage: Quick Start
+
+    forger new ec2 # generates starter skeleton project
+    cd ec2
+    forger create myserver # creates instance
+
+## Useful new options
+
+By default, `forger new` generates a project with some starting values for the files in the `config` and `profiles` folders.  You likely want to edit these values using your own values. Things like security groups, subnets, iam role, and the s3_folder option are useful settings to modify.  You can also specify a lot of these values as a part of the `new` command. Example:
+
+    forger new ec2 --security-group sg-11223344 --iam MyIamRole --key-name my-keypair --s3-folder my-bucket/my-folder
+
+Notably, using the `--s3-folder` option generates a project that make use of the `app/scripts` files and inserts some bash code into your user-data script that downloads and extracts the files. For more help:
 
-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.  This allows you to specify any parameter you wish that is available in the aws-sdk. To check out what a profile looks like check out [example default](docs/example/profiles/default.yml)
+    forger new -h
+
+## Usage: More Details
+
+    forger create NAME --profile PROFILE
+    forger create myserver --profile myserver
 
 ## 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.  This is one good way to inspect the generated user-data script.
 
-```sh
-forger create myserver --profile myserver --noop
-cat tmp/user-data.txt # to view generated user-data script
-```
+    forger 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
-forger create webserver --profile webserver
-forger create webserver # same as above
-```
+    forger create webserver --profile webserver
+    forger create webserver # same as above
 
 It is useful to add a random string to the end of your server name, but not use it for the `--profile` flag.  Example:
 
-```
-forger create myserver-abc --profile myserver
-forger create myserver-123 --profile myserver
-```
+    forger create myserver-abc --profile myserver
+    forger create myserver-123 --profile myserver
 
 You can use the `--randomize` option to do this automatically:
 
-```
-forger create myserver --randomize
-```
+    forger 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/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. 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 `s3_folder` settings option.
-app/user-data  | Your user-data scripts that are used to bootstrap EC2 instance.
-app/user-data/layouts  | user-data scripts support layouts. You user-data layouts go in here.
+app/user_data  | Your user-data scripts that are used to bootstrap EC2 instance.
+app/user_data/layouts  | user-data scripts support layouts. You user-data layouts go in here.
 config/[FORGER_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-sdk run_instances API method.
 tmp  | Where the generated scripts get compiled to. You can manually invoke the compilation via `forger compile` to inspect what is generated.  This is automatically done as part of the `forger` create command.
@@ -79,33 +87,27 @@ You can also define custom helpers in the `app/helpers` folder as ruby modules w
 
 ## User-Data
 
-You can provide a user-data script to customize the server upon launch.  The user-data scripts are located under the `app/user-data` folder.  Example:
+You can provide a user-data script to customize the server upon launch.  The user-data scripts are located under the `app/user_data` folder.  Example:
 
-* app/user-data/myserver.yml
+* app/user_data/myserver.yml
 
 The user-data script is generated on the machine that is running the forger 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
-forger create myserver --noop
-cat tmp/user-data.txt
-```
+    forger create myserver --noop
+    cat tmp/user-data.txt
 
 Another way to view the generated user-data scripts is the `forger compile` command.  It generates the files in the `tmp` folder.  Example:
 
-```
-forger compile # generates files in tmp folder
-```
+    forger compile # generates files in tmp folder
 
 To use the user-data script when creating an EC2 instance, use the `user_data` helper method in the profile file.  Here's a grep of an example profile that uses the helper to show you want it looks like. Be sure to surround the ERB call with quotes because the user-data script context is base64 encoded.
 
-```
-$ grep user_data profiles/default.yml
-user_data: "<%= user_data("bootstrap") %>"
-```
+    $ 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`:
+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
@@ -114,11 +116,9 @@ User-data scripts support layouts.  This is useful if you have common setup and
 # finish work
 ```
 
-And `app/user-data/box.sh`:
+And `app/user_data/box.sh`:
 
-```
-yum install -y vim
-```
+    yum install -y vim
 
 The resulting generated user-data script will be:
 
@@ -173,7 +173,7 @@ development:
   # By setting s3_folder, forger will automatically tarball and upload your scripts
   # to set. You then can then use the extract_scripts helper method to download
   # the scripts onto the server.
-  s3_folder: boltops-infra-stag/ec2
+  s3_folder: my-bucket/forger
   # compile_clean: true # uncomment to clean at the end of a compile
   # extract_scripts:
   #   to: "/opt"
@@ -186,7 +186,7 @@ production:
 
 There is only one hook: `before_run_instances`.  You can configure this with `config/hooks.yml`:  Example:
 
-```
+```yaml
 ---
 before_run_instances: /path/to/my/script.sh
 ```
@@ -234,20 +234,16 @@ An example of a spot instance profile is provided in [example/profiles/spot.yml]
 
 ## More Help
 
-```sh
-forger create help
-forger ami help
-forger compile help
-forger help # general help
-```
+    forger create help
+    forger ami help
+    forger compile help
+    forger help # general help
 
 Examples are in the [example](docs/example) folder.  You will have to update settings like your subnet and security group ids.
 
 ## Installation
 
-```sh
-gem install forger
-```
+    gem install forger
 
 ### Dependencies
 

data/forger.gemspec

@@ -25,9 +25,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "dotenv"
   spec.add_dependency "filesize"
   spec.add_dependency "hashie"
+  spec.add_dependency "memoist"
   spec.add_dependency "render_me_pretty"
   spec.add_dependency "thor"
-  spec.add_dependency "memoist"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "byebug"

data/lib/forger.rb

@@ -2,28 +2,32 @@ $:.unshift(File.expand_path("../", __FILE__))
 require "forger/version"
 require "colorize"
 require "render_me_pretty"
+require "memoist"
 
 module Forger
-  autoload :Help, "forger/help"
-  autoload :Command, "forger/command"
-  autoload :CLI, "forger/cli"
+  autoload :Ami, "forger/ami"
   autoload :AwsService, "forger/aws_service"
-  autoload :Profile, "forger/profile"
   autoload :Base, "forger/base"
-  autoload :Create, "forger/create"
-  autoload :Destroy, "forger/destroy"
-  autoload :Ami, "forger/ami"
-  autoload :Wait, "forger/wait"
   autoload :Clean, "forger/clean"
-  autoload :Template, "forger/template"
-  autoload :Script, "forger/script"
+  autoload :CLI, "forger/cli"
+  autoload :Command, "forger/command"
+  autoload :Completer, "forger/completer"
+  autoload :Completion, "forger/completion"
   autoload :Config, "forger/config"
   autoload :Core, "forger/core"
+  autoload :Create, "forger/create"
+  autoload :Destroy, "forger/destroy"
   autoload :Dotenv, "forger/dotenv"
+  autoload :Help, "forger/help"
   autoload :Hook, "forger/hook"
-  autoload :Completion, "forger/completion"
-  autoload :Completer, "forger/completer"
+  autoload :Network, "forger/network"
+  autoload :New, "forger/new"
+  autoload :Profile, "forger/profile"
+  autoload :Script, "forger/script"
+  autoload :Sequence, "forger/sequence"
   autoload :Setting, "forger/setting"
+  autoload :Template, "forger/template"
+  autoload :Wait, "forger/wait"
   extend Core
 end
 

data/lib/forger/cli.rb

@@ -13,16 +13,22 @@ module Forger
 
     common_options = Proc.new do
       option :auto_terminate, type: :boolean, default: false, desc: "automatically terminate the instance at the end of user-data"
-      option :cloudwatch, type: :boolean, default: false, desc: "enable cloudwatch logging, supported for amazonlinux2 and ubuntu"
+      option :cloudwatch, type: :boolean, desc: "enable cloudwatch logging, supported for amazonlinux2 and ubuntu"
     end
 
+    long_desc Help.text(:new)
+    New.cli_options.each do |args|
+      option *args
+    end
+    register(New, "new", "new NAME", "Generates new forger project")
+
     desc "create NAME", "create ec2 instance"
     long_desc Help.text(:create)
     option :ami_name, desc: "when specified, an ami creation script is appended to the user-data script"
     option :randomize, type: :boolean, desc: "append random characters to end of name"
     option :source_ami, desc: "override the source image_id in profile"
-    option :wait, desc: "Wait until the instance is ready and report dns name"
-    option :ssh, desc: "Wait until the instance is ready and ssh into instance"
+    option :wait, type: :boolean, default: true, desc: "Wait until the instance is ready and report dns name"
+    option :ssh, type: :boolean, desc: "Ssh into instance immediately after it's ready"
     option :ssh_user, default: "ec2-user", desc: "User to use to with the ssh option to log into instance"
     common_options.call
     def create(name)
@@ -36,7 +42,7 @@ module Forger
       Ami.new(options.merge(name: name)).run
     end
 
-    desc "compile", "compiles app/scripts and app/user-data to tmp folder"
+    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