ufo 4.1.5 → 4.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfa53f85e3ac49817fc7173c918c0df4fcf438d16136a6fd51feb0ddc82b0e0e
-  data.tar.gz: e02f034850589710adf85058649086082cced6df401e76c854f8eed737ebf5ba
+  metadata.gz: a483c161490cb3856ee429ffa12e4d75d8443a00bb8712d0274b322dc7eb7a00
+  data.tar.gz: 4fbe98c516f119218a9eaedde01f81221163412855b62ca726bd6dc935e6f7b7
 SHA512:
-  metadata.gz: 3d7b2d923c46bad0e2d307f6ebb453ea3382c11dae15d81979ee273ecffbe386470c8ac3f13b1e7beb8def4a58afd37ce0e87f125fd1a3d4899ac82d5981035e
-  data.tar.gz: b3fcdecaf2d7b3507df84bd78c7d790a15b9f5299977bb4396f833470f0c05b15448a505c687e475220763266ea52577d8dfbba8f3baa927cff8f8d76752d74d
+  metadata.gz: f11255a49c787365803f8514de49a0a6be79d658b2b5fcca701cfa0fb41c903a1238b6b70dd75fb92f3da3f15d28e22c9295655787f280577f8a363581e18918
+  data.tar.gz: c5b98c8fe3985efd2dc849e84e39c751e469678585bc71fcc6cca09483bb52c4983cc22dba5173b0a12c05ae4c3288995ba1c84f718fdcce3e4fb520867f6aee

data/CHANGELOG.md

@@ -3,6 +3,11 @@
 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.
 
+## [4.1.6]
+- update bin/deploy starter wrapper
+- update quick start with note about ecr image
+- update ufo init help
+
 ## [4.1.5]
 - provide error message and instructions for case of missing default vpc, pull request #49
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ufo (4.1.5)
+    ufo (4.1.6)
       aws-sdk-cloudformation
       aws-sdk-cloudwatchlogs
       aws-sdk-ec2
@@ -25,41 +25,41 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     aws-eventstream (1.0.1)
-    aws-partitions (1.102.0)
-    aws-sdk-cloudformation (1.6.0)
-      aws-sdk-core (~> 3)
+    aws-partitions (1.107.0)
+    aws-sdk-cloudformation (1.10.0)
+      aws-sdk-core (~> 3, >= 3.26.0)
       aws-sigv4 (~> 1.0)
-    aws-sdk-cloudwatchlogs (1.5.0)
-      aws-sdk-core (~> 3)
+    aws-sdk-cloudwatchlogs (1.10.0)
+      aws-sdk-core (~> 3, >= 3.26.0)
       aws-sigv4 (~> 1.0)
-    aws-sdk-core (3.25.0)
+    aws-sdk-core (3.36.0)
       aws-eventstream (~> 1.0)
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.0)
       jmespath (~> 1.0)
-    aws-sdk-ec2 (1.43.0)
-      aws-sdk-core (~> 3)
+    aws-sdk-ec2 (1.54.0)
+      aws-sdk-core (~> 3, >= 3.26.0)
       aws-sigv4 (~> 1.0)
-    aws-sdk-ecr (1.4.0)
-      aws-sdk-core (~> 3)
+    aws-sdk-ecr (1.8.0)
+      aws-sdk-core (~> 3, >= 3.26.0)
       aws-sigv4 (~> 1.0)
-    aws-sdk-ecs (1.17.0)
-      aws-sdk-core (~> 3)
+    aws-sdk-ecs (1.22.0)
+      aws-sdk-core (~> 3, >= 3.26.0)
       aws-sigv4 (~> 1.0)
-    aws-sdk-elasticloadbalancingv2 (1.12.0)
-      aws-sdk-core (~> 3)
+    aws-sdk-elasticloadbalancingv2 (1.16.0)
+      aws-sdk-core (~> 3, >= 3.26.0)
       aws-sigv4 (~> 1.0)
     aws-sigv4 (1.0.3)
     byebug (10.0.2)
     cli_markdown (0.1.0)
-    codeclimate-test-reporter (1.0.8)
+    codeclimate-test-reporter (1.0.9)
       simplecov (<= 0.13)
     colorize (0.8.1)
     concurrent-ruby (1.0.5)
     deep_merge (1.2.1)
     diff-lcs (1.3)
     docile (1.1.5)
-    i18n (1.1.0)
+    i18n (1.1.1)
       concurrent-ruby (~> 1.0)
     jmespath (1.4.0)
     json (2.1.0)
@@ -77,7 +77,7 @@ GEM
       rspec-mocks (~> 3.8.0)
     rspec-core (3.8.0)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    rspec-expectations (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-mocks (3.8.0)

data/docs/_reference/ufo-init.md

@@ -20,9 +20,9 @@ The `ufo init` command provides a way to quickly setup a project to be ufo ready
 
 For this example we will use [tongueroo/demo-ufo](https://github.com/tongueroo/demo-ufo) which is a small test sinatra app.  Let's run the command in our newly clone project.
 
-    $ git clone https://github.com/tongueroo/demo-ufo.git
-    $ cd demo-ufo
-    $ ufo init --app=demo --image=tongueroo/demo-ufo
+    $ git clone https://github.com/tongueroo/demo-ufo.git demo
+    $ cd demo
+    $ ufo init --image=tongueroo/demo-ufo
     Setting up ufo project...
           create  .ufo/settings.yml
           create  .ufo/task_definitions.rb
@@ -37,10 +37,10 @@ For this example we will use [tongueroo/demo-ufo](https://github.com/tongueroo/d
 
 ## More Short Examples
 
-    ufo init --image httpd --app demo
-    ufo init --image 123456789012.dkr.ecr.us-west-2.amazonaws.com/myimage --app demo
-    ufo init --image tongueroo/demo-ufo --app demo --launch-type fargate --execution-role-arn arn:aws:iam::123456789012:role/ecsTaskExecutionRole
-    ufo init --image httpd --app demo --vpc-id vpc-123
+    ufo init --image httpd
+    ufo init --image 123456789012.dkr.ecr.us-west-2.amazonaws.com/myimage
+    ufo init --image tongueroo/demo-ufo --launch-type fargate --execution-role-arn arn:aws:iam::123456789012:role/ecsTaskExecutionRole
+    ufo init --image httpd --vpc-id vpc-123
 
 ## Important options
 
@@ -75,13 +75,11 @@ For a explanation of the folders and files refer to [Structure]({% link _docs/st
 
 For ECS Fargate, the ECS task definition structure is a bit different.  To initialize a project to support Fargate use the `--launch-type fargate` option.  You'll be prompted for a execution role arn.  This value gets added to the generated `.ufo/variables/base.rb` and used in the `.ufo/templates/main.json.erb`.
 
-    ufo init --image tongueroo/demo-ufo --app demo --force --launch-type fargate
+    ufo init --image tongueroo/demo-ufo --app demo --launch-type fargate
 
 You can also generate the init ufo files and bypass the prompt by providing the `--execution-role-arn` option upfront.
 
-    ufo init --image tongueroo/demo-ufo --app demo --force --launch-type fargate --execution-role-arn arn:aws:iam::123456789012:role/ecsTaskExecutionRole
-
-Important: You will need to adjust adjust the generated `.ufo/params.yml` and set the subnet and security_group values which are required for Fargate.
+    ufo init --image tongueroo/demo-ufo --app demo --launch-type fargate --execution-role-arn arn:aws:iam::123456789012:role/ecsTaskExecutionRole
 
 For more information and a demo of Fargate support, check out the [Fargate Docs]({% link _docs/fargate.md %}).
 
@@ -89,21 +87,21 @@ For more information and a demo of Fargate support, check out the [Fargate Docs]
 
 If you would like the `ufo init` command to use your own custom templates, you can achieve this with the `--template` and `--template-mode` options.  Example:
 
-    ufo init --app=demo --image=tongueroo/demo-ufo --template=tongueroo/ufo-custom-template
+    ufo init --image=tongueroo/demo-ufo --template=tongueroo/ufo-custom-template
 
 This will clone the repo on GitHub into the `~/.ufo/templates/tongueroo/ufo-custom-template` and use that as an additional template source.  The default `--template-mode=additive` mode means that if there's a file in `tongueroo/ufo-custom-template` that exists it will use that in place of the default template files.
 
 If you do not want to use any of the original default template files within the ufo gem at all, you can use the `--template-mode=replace` mode. Replace mode will only use templates from the provided `--template` option.  Example:
 
-    ufo init --app=demo --image=tongueroo/demo-ufo --template=tongueroo/ufo-custom-template --template-mode=replace
+    ufo init --image=tongueroo/demo-ufo --template=tongueroo/ufo-custom-template --template-mode=replace
 
 You can also specific the full GitHub url. Example:
 
-    ufo init --app=demo --image=tongueroo/demo-ufo --template=https://github.com/tongueroo/ufo-custom-template
+    ufo init --image=tongueroo/demo-ufo --template=https://github.com/tongueroo/ufo-custom-template
 
 If you would like to use a local template that is not on GitHub, then created a top-level folder in `~/.ufo/templates` without a subfolder. Example:
 
-    ufo init --app=demo --image=tongueroo/demo-ufo --template=my-custom # uses ~/.ufo/templates/my-custom
+    ufo init --image=tongueroo/demo-ufo --template=my-custom # uses ~/.ufo/templates/my-custom
 
 
 ## Options

data/docs/bin/web

@@ -1,4 +1,4 @@
 #!/bin/bash -ex
 
 bundle exec jekyll clean
-exec bundle exec jekyll serve
+exec bundle exec jekyll serve "$@"

data/docs/quick-start.md

@@ -4,16 +4,20 @@ title: Quick Start
 
 In a hurry? No sweat! Here's a quick start to using ufo that takes only a few minutes. For this example, we will use a sinatra app from [tongueroo/demo-ufo](https://github.com/tongueroo/demo-ufo).  The `ufo init` command sets up the ufo directory structure in your project. The `ufo ship` command deploys your code to an AWS ECS service.  The `ufo ps` and `ufo scale` command shows you how to verify and scale additional containers.
 
-```sh
-gem install ufo
-git clone https://github.com/tongueroo/demo-ufo.git demo
-cd demo
-ufo init --image=tongueroo/demo-ufo
-ufo current --service demo-web
-ufo ship
-ufo ps
-ufo scale 2
-```
+    gem install ufo
+    git clone https://github.com/tongueroo/demo-ufo.git demo
+    cd demo
+    ufo init --image=tongueroo/demo-ufo
+    ufo current --service demo-web
+    ufo ship
+    ufo ps
+    ufo scale 2
+
+Note: The example pushes the Docker image to Dockerhub. If you are using ECR instead, you can specific an ECR repo with the `--image` option.  Example:
+
+    ufo init --image 123456789012.dkr.ecr.us-west-2.amazonaws.com/myimage
+
+For more info, refer to the [ufo init](http://ufoships.com/reference/ufo-init/) reference docs.
 
 ## What Happened
 

data/lib/template/bin/deploy.tt

@@ -1,4 +1,4 @@
-#!/bin/bash -xe
+#!/bin/bash
 
 # Generated starter bin/deploy script example.
 # Meant to be overridden.

data/lib/ufo/help/init.md

@@ -7,9 +7,9 @@ The `ufo init` command provides a way to quickly setup a project to be ufo ready
 
 For this example we will use [tongueroo/demo-ufo](https://github.com/tongueroo/demo-ufo) which is a small test sinatra app.  Let's run the command in our newly clone project.
 
-    $ git clone https://github.com/tongueroo/demo-ufo.git
-    $ cd demo-ufo
-    $ ufo init --app=demo --image=tongueroo/demo-ufo
+    $ git clone https://github.com/tongueroo/demo-ufo.git demo
+    $ cd demo
+    $ ufo init --image=tongueroo/demo-ufo
     Setting up ufo project...
           create  .ufo/settings.yml
           create  .ufo/task_definitions.rb
@@ -24,10 +24,10 @@ For this example we will use [tongueroo/demo-ufo](https://github.com/tongueroo/d
 
 ## More Short Examples
 
-    ufo init --image httpd --app demo
-    ufo init --image 123456789012.dkr.ecr.us-west-2.amazonaws.com/myimage --app demo
-    ufo init --image tongueroo/demo-ufo --app demo --launch-type fargate --execution-role-arn arn:aws:iam::123456789012:role/ecsTaskExecutionRole
-    ufo init --image httpd --app demo --vpc-id vpc-123
+    ufo init --image httpd
+    ufo init --image 123456789012.dkr.ecr.us-west-2.amazonaws.com/myimage
+    ufo init --image tongueroo/demo-ufo --launch-type fargate --execution-role-arn arn:aws:iam::123456789012:role/ecsTaskExecutionRole
+    ufo init --image httpd --vpc-id vpc-123
 
 ## Important options
 
@@ -62,13 +62,11 @@ For a explanation of the folders and files refer to [Structure]({% link _docs/st
 
 For ECS Fargate, the ECS task definition structure is a bit different.  To initialize a project to support Fargate use the `--launch-type fargate` option.  You'll be prompted for a execution role arn.  This value gets added to the generated `.ufo/variables/base.rb` and used in the `.ufo/templates/main.json.erb`.
 
-    ufo init --image tongueroo/demo-ufo --app demo --force --launch-type fargate
+    ufo init --image tongueroo/demo-ufo --app demo --launch-type fargate
 
 You can also generate the init ufo files and bypass the prompt by providing the `--execution-role-arn` option upfront.
 
-    ufo init --image tongueroo/demo-ufo --app demo --force --launch-type fargate --execution-role-arn arn:aws:iam::123456789012:role/ecsTaskExecutionRole
-
-Important: You will need to adjust adjust the generated `.ufo/params.yml` and set the subnet and security_group values which are required for Fargate.
+    ufo init --image tongueroo/demo-ufo --app demo --launch-type fargate --execution-role-arn arn:aws:iam::123456789012:role/ecsTaskExecutionRole
 
 For more information and a demo of Fargate support, check out the [Fargate Docs]({% link _docs/fargate.md %}).
 
@@ -76,18 +74,18 @@ For more information and a demo of Fargate support, check out the [Fargate Docs]
 
 If you would like the `ufo init` command to use your own custom templates, you can achieve this with the `--template` and `--template-mode` options.  Example:
 
-    ufo init --app=demo --image=tongueroo/demo-ufo --template=tongueroo/ufo-custom-template
+    ufo init --image=tongueroo/demo-ufo --template=tongueroo/ufo-custom-template
 
 This will clone the repo on GitHub into the `~/.ufo/templates/tongueroo/ufo-custom-template` and use that as an additional template source.  The default `--template-mode=additive` mode means that if there's a file in `tongueroo/ufo-custom-template` that exists it will use that in place of the default template files.
 
 If you do not want to use any of the original default template files within the ufo gem at all, you can use the `--template-mode=replace` mode. Replace mode will only use templates from the provided `--template` option.  Example:
 
-    ufo init --app=demo --image=tongueroo/demo-ufo --template=tongueroo/ufo-custom-template --template-mode=replace
+    ufo init --image=tongueroo/demo-ufo --template=tongueroo/ufo-custom-template --template-mode=replace
 
 You can also specific the full GitHub url. Example:
 
-    ufo init --app=demo --image=tongueroo/demo-ufo --template=https://github.com/tongueroo/ufo-custom-template
+    ufo init --image=tongueroo/demo-ufo --template=https://github.com/tongueroo/ufo-custom-template
 
 If you would like to use a local template that is not on GitHub, then created a top-level folder in `~/.ufo/templates` without a subfolder. Example:
 
-    ufo init --app=demo --image=tongueroo/demo-ufo --template=my-custom # uses ~/.ufo/templates/my-custom
+    ufo init --image=tongueroo/demo-ufo --template=my-custom # uses ~/.ufo/templates/my-custom

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "4.1.5"
+  VERSION = "4.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ufo
 version: !ruby/object:Gem::Version
-  version: 4.1.5
+  version: 4.1.6
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-30 00:00:00.000000000 Z
+date: 2018-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudformation