ufo 4.4.2 → 4.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d98dc4756c6e74a03e33965e204e3d1e7df743e
-  data.tar.gz: fea753dd83bdeb2928e1947cf2e0f9290c7db3f5
+  metadata.gz: 2f3d71a890dc7dac92751517b4aecc81cbaf37d8
+  data.tar.gz: 00b13ce41a1175c882fef6fbc0d3df52ac0b5636
 SHA512:
-  metadata.gz: 2f08996b96a47e48349552d4ce47eeb823e9340c92c1a4f9f1c8fc77738864a5c00e2481a63184ec8af4256b68b7a6f11d6acd7abcdf15d153e79ad2369d48a1
-  data.tar.gz: e9cc6d0790208fcb42590269eb632aa7e654b571f316704d1cd2809e6c85a7cd1ad3e66cfe4e8c3485a4b2e55fdb9c18587fe8a81381f38710451c893bd1d151
+  metadata.gz: 70244a2dcc77c9bee7b1586745490fcff58cc7056be81597dfb3434c09caad7831909927419bd4920b490adb57ede2e1335f7ba6c5c8a2444fe14aab07ce5da4
+  data.tar.gz: ec407342a7d7c7520d6c33d99d1df53731a06692f238f5dacde6c774b4bac0a50737f7b16a0e25ed4d3445f6f0148738f584f8c230db66f6a2ca8f3ad95fe5f3

data/CHANGELOG.md

@@ -3,6 +3,12 @@
 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.4.3]
+- fix edge case when target group name is too long: only occurs with UFO\_FORCE\_TARGET_GROUP mode
+- stdout sync true for improved codebuild status
+- ufo network init ecs-subnets and elb-subnets options
+- update docs: use ecr repo in quick start examples
+
 ## [4.4.2]
 - fix current_region for codebuild
 

data/Gemfile.lock

@@ -24,30 +24,30 @@ GEM
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    aws-eventstream (1.0.2)
-    aws-partitions (1.151.0)
-    aws-sdk-cloudformation (1.18.0)
-      aws-sdk-core (~> 3, >= 3.48.2)
+    aws-eventstream (1.0.3)
+    aws-partitions (1.171.0)
+    aws-sdk-cloudformation (1.22.0)
+      aws-sdk-core (~> 3, >= 3.53.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-cloudwatchlogs (1.17.0)
-      aws-sdk-core (~> 3, >= 3.48.2)
+    aws-sdk-cloudwatchlogs (1.20.0)
+      aws-sdk-core (~> 3, >= 3.53.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-core (3.48.4)
+    aws-sdk-core (3.54.2)
       aws-eventstream (~> 1.0, >= 1.0.2)
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-ec2 (1.79.0)
-      aws-sdk-core (~> 3, >= 3.48.2)
+    aws-sdk-ec2 (1.89.0)
+      aws-sdk-core (~> 3, >= 3.53.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-ecr (1.14.0)
-      aws-sdk-core (~> 3, >= 3.48.2)
+    aws-sdk-ecr (1.17.0)
+      aws-sdk-core (~> 3, >= 3.53.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-ecs (1.36.0)
-      aws-sdk-core (~> 3, >= 3.48.2)
+    aws-sdk-ecs (1.40.0)
+      aws-sdk-core (~> 3, >= 3.53.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-elasticloadbalancingv2 (1.26.0)
-      aws-sdk-core (~> 3, >= 3.48.2)
+    aws-sdk-elasticloadbalancingv2 (1.29.0)
+      aws-sdk-core (~> 3, >= 3.53.0)
       aws-sigv4 (~> 1.1)
     aws-sigv4 (1.1.0)
       aws-eventstream (~> 1.0, >= 1.0.2)

data/docs/_docs/extras/codebuild-iam-role.md

@@ -0,0 +1,46 @@
+---
+title: CodeBuild IAM Role
+nav_order: 29
+---
+
+Note, the `/tmp/ecs-deploy-policy.json` policy is available at [Minimal Deploy IAM]({% link _docs/extras/minimal-deploy-iam.md %}).
+
+## Existing IAM Role
+
+If you're using CodeBuild with `ufo ship` to handle deployments, you can use the same policy for the role that you assign to the the CodeBuild project and attach it to the the CodeBuild service IAM role that is usually created with the CodeBuild Console wizard.  For example, of the IAM role was called `codebuild-myapp-service-role`:
+
+    aws iam put-role-policy --role-name codebuild-myapp-service-role --policy-name EcsDeployPolicy --policy-document file:///tmp/ecs-deploy-policy.json
+    aws iam get-role-policy --role-name codebuild-myapp-service-role --policy-name EcsDeployPolicy
+
+The `put-role-policy` command adds a *inline* policy to the existing IAM role.
+
+## New IAM Role
+
+If you are creating the IAM role for CodeBuild yourself from scratch these commands will be helpful:
+
+Create the policy document:
+
+    cat << 'EOF' > /tmp/role-trust-policy.json
+    {
+      "Version": "2012-10-17",
+      "Statement": [{
+        "Action": "sts:AssumeRole",
+        "Principal": {
+          "Service": "codebuild.amazonaws.com"
+        },
+        "Effect": "Allow",
+        "Sid": ""
+      }]
+    }
+    EOF
+
+Create the IAM resources:
+
+    aws iam create-role --role-name EcsDeployRole --assume-role-policy-document file:///tmp/role-trust-policy.json
+    aws iam create-policy --policy-name EcsDeployPolicy --policy-document file:///tmp/ecs-deploy-policy.json
+    ACCOUNT=$(aws sts get-caller-identity | jq -r '.Account')
+    aws iam attach-role-policy --policy-arn arn:aws:iam::$ACCOUNT:policy/EcsDeployPolicy --role-name EcsDeployRole
+
+The `attach-role-policy` command attaches a Customer Managed IAM policy to the IAM role. This is a little more reusable than using an inline policy.
+
+{% include prev_next.md %}

data/docs/_docs/extras/minimal-deploy-iam.md

@@ -67,16 +67,13 @@ Then create a user and add the user to IAM group. Here's an example:
     aws iam create-user --user-name tung
     aws iam add-user-to-group --user-name tung --group-name Ufo
 
-## CodeBuild
+## CodeBuild IAM Role
 
-If you're using CodeBuild with `ufo ship` to handle deployments, you can use the same policy for the role that you assign to the the CodeBuild project and attach it to the the CodeBuild service IAM role that is usually created with the CodeBuild Console wizard.  For example, of the IAM role was called `codebuild-myapp-service-role`:
-
-    aws iam put-role-policy --role-name codebuild-myapp-service-role --policy-name EcsDeployPolicy --policy-document file:///tmp/ecs-deploy-policy.json
-    aws iam get-role-policy --role-name codebuild-myapp-service-role --policy-name EcsDeployPolicy
+If you are using CodeBuild to deploy, you'll probably be interested the IAM policy for the CodeBuild project: [CodeBuild IAM Role]({% link _docs/extras/codebuild-iam-role.md %})
 
 ## ECS Task IAM Policy vs User Deploy IAM Policy
 
 This page refers to your **user** IAM policy used when running `ufo ship`. These are different from the IAM Policies associated with ECS Task.  For those iam policies refer to [IAM Roles for Tasks
 ](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html).
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/faq.md

@@ -1,6 +1,6 @@
 ---
 title: FAQ
-nav_order: 40
+nav_order: 41
 ---
 
 **Q: Is AWS ECS Fargate supported?**

data/docs/_docs/more/auto-completion.md

@@ -1,6 +1,6 @@
 ---
 title: Auto Completion
-nav_order: 39
+nav_order: 40
 ---
 
 Ufo supports bash auto-completion.  To set it up add the following to your `~/.profile` or `.bashrc`:

data/docs/_docs/more/automated-cleanup.md

@@ -1,6 +1,6 @@
 ---
 title: Automated Clean Up
-nav_order: 38
+nav_order: 39
 ---
 
 Ufo can be configured to automatically clean old images from the ECR registry after the deploy completes by configuring your [settings.yml]({% link _docs/settings.md %}) file like so:

data/docs/_docs/more/customize-cloudformation.md

@@ -1,6 +1,6 @@
 ---
 title: Customize CloudFormation
-nav_order: 33
+nav_order: 34
 ---
 
 Under the hood, ufo creates most of the required resources with a CloudFormation stack.  This includes the ELB, Target Group, Listener, Security Groups, ECS Service, and Route 53 records.  You might need to customize these resources.  Here are the ways to customize the resources that ufo creates.

data/docs/_docs/more/migrations.md

@@ -1,6 +1,6 @@
 ---
 title: Database Migrations
-nav_order: 37
+nav_order: 38
 ---
 
 A common task is to run database migrations with newer code before deploying the code. This is easily achieved with the `ufo task` command. Here's an example:

data/docs/_docs/more/run-in-pieces.md

@@ -1,6 +1,6 @@
 ---
 title: Run in Pieces
-nav_order: 35
+nav_order: 36
 ---
 
 The `ufo ship` command goes through a few stages:

data/docs/_docs/more/single-task.md

@@ -1,6 +1,6 @@
 ---
 title: Run Single Task
-nav_order: 36
+nav_order: 37
 ---
 
 Sometimes you do not want to run a long running `service` but a one time task. Running Rails migrations are an example of a one off task.  Here is an example of how you would run a one time task.

data/docs/_docs/more/stuck-cloudformation.md

@@ -1,6 +1,6 @@
 ---
 title: Stuck CloudFormation
-nav_order: 34
+nav_order: 35
 ---
 
 The CloudFormation stack update or creation can get stuck in a `*_IN_PROGRESS` state for a very long time, like more than an hour.  This happens when you deploy an ECS service that fails to stabilize. Usually, this is an error with the Docker container failing to start up successfully.

data/docs/_docs/more/why-cloudformation.md

@@ -1,6 +1,6 @@
 ---
 title: Why CloudFormation
-nav_order: 32
+nav_order: 33
 ---
 
 Version 3 of ufo was a simpler implementation and did not make use of CloudFormation to create the ECS service. In version 4, ufo uses CloudFormation to create the ECS Service.  This is because ufo became more powerful. Notably, support for Load Balancers was added. With this power, also came added complexity. So the complexity was push onto CloudFormation.  Hence, ECS service is implemented as CloudFormation resource in version 4.

data/docs/_docs/next-steps.md

@@ -1,6 +1,6 @@
 ---
 title: Next Steps
-nav_order: 42
+nav_order: 43
 ---
 
 This concludes the tutorial guide for ufo. Hopefully you are now more comfortable with ufo's basic usage, concepts, and have a feel for the workflow.

data/docs/_docs/quick-start-ec2.md

@@ -9,12 +9,14 @@ ECS EC2 is a way to run Docker containers on your own EC2 instances.  This diffe
 
 ## Let's Go
 
-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.  
+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.
 
     gem install ufo
     git clone https://github.com/tongueroo/demo-ufo.git demo
     cd demo
-    ufo init --image=tongueroo/demo-ufo # NOTE: use your own account
+    aws ecr create-repository --repository-name demo/sinatra
+    ECR_REPO=$(aws ecr describe-repositories --repository-name demo/sinatra | jq -r '.repositories[].repositoryUri')
+    ufo init --image $ECR_REPO
     ufo current --service demo-web
     ufo ship
     ufo ps
@@ -22,7 +24,7 @@ In a hurry? No sweat! Here's a quick start to using ufo that takes only a few mi
 
 This quickstart assumes:
 
-* You have push access to the repo. Refer to the Notes "Repo Push Access" section below for more info. 
+* You have push access to the repo. Refer to the Notes "Repo Push Access" section below for more info.
 * You are using ECS EC2 and have an ECS cluster with EC2 Container instances running. Refer to the Notes "ECS EC2 vs ECS Fargate" section below for more info.
 
 ## What Happened
@@ -52,7 +54,7 @@ Setting up ufo project...
 Starter ufo files created.
 $ ufo ship demo-web
 Building docker image with:
-  docker build -t tongueroo/demo-ufo:ufo-2017-09-10T15-00-19-c781aaf -f Dockerfile .
+  docker build -t 112233445566.dkr.ecr.us-west-2.amazonaws.com/demo/sinatra:ufo-2017-09-10T15-00-19-c781aaf -f Dockerfile .
 ....
 Software shipped!
 $ ufo ps

data/docs/_docs/upgrading/upgrade4.4.md

@@ -3,7 +3,7 @@ title: Upgrading to Version 4.4
 short_title: Version 4.4
 order: 1
 categories: upgrading
-nav_order: 30
+nav_order: 31
 ---
 
 In ufo version 4.4, the environment name gets appends to the end of the CloudFormation stack name.  Previous versions prepended the environment name to the stack name. This means a new stack gets created if you're going from version 4.3 to 4.4. For example:

data/docs/_docs/upgrading/upgrade4.md

@@ -3,7 +3,7 @@ title: Upgrading to Version 4.0
 short_title: Version 4.0
 order: 2
 categories: upgrading
-nav_order: 31
+nav_order: 32
 ---
 
 A major change in ufo from version 3 to 4 is that the ECS service is now created by CloudFormation. If you have an existing ECS service deployed by ufo version 3, when you deploy your app again with ufo version 4, there will be a new additional ECS service created. Here is the recommended upgrade path.

data/docs/_docs/upgrading.md

@@ -1,6 +1,6 @@
 ---
 title: Upgrading
-nav_order: 29
+nav_order: 30
 ---
 
 <ul>

data/docs/_includes/repo_push_access.md

@@ -1,8 +1,8 @@
 ## Repo Push Access
 
-The quick start example pushes the Docker image to a Dockerhub repo. You need your own repo with push access. This repo could be your own Dockerhub account or ECR repo.  You can control the setting with the `--image` option.  Example:
+The quick start example pushes the Docker image to a Docker repo that you have access to. This repo could be your own Dockerhub account or ECR repo.  You can control the setting with the `--image` option.  Example:
 
-    ufo init --image=yourusername/yourrepo # use your own account
+    ufo init --image=yourusername/yourrepo # use your own Dockerhub account
 
 Also, if you are using ECR instead, you can specify an ECR repo with the `--image` option.  Example:
 

data/docs/_includes/subnav.html

@@ -34,6 +34,7 @@
                 <li><a href="{% link _docs/extras/route53-support.md %}">Route53 Support</a></li>
                 <li><a href="{% link _docs/extras/redirection-support.md %}">Redirection Support</a></li>
                 <li><a href="{% link _docs/extras/minimal-deploy-iam.md %}">Minimal Deploy IAM</a></li>
+                <li><a href="{% link _docs/extras/codebuild-iam-role.md %}">CodeBuild IAM Role</a></li>
             </ul>
         <li><a href="{% link _docs/upgrading.md %}">Upgrading</a>
             <ul>

data/docs/articles.md

@@ -1,6 +1,6 @@
 ---
 title: Articles
-nav_order: 41
+nav_order: 42
 ---
 
 * [How to Create Unlimited Extra Environments

data/docs/quick-start.md

@@ -14,7 +14,9 @@ In a hurry? No sweat! Here's a quick start to using ufo that takes only a few mi
     git clone https://github.com/tongueroo/demo-ufo demo
     cd demo
     AWS_ACCOUNT=$(aws sts get-caller-identity | jq -r '.Account')
-    ufo init --image tongueroo/demo-ufo --launch-type fargate --execution-role-arn arn:aws:iam::$AWS_ACCOUNT:role/ecsTaskExecutionRole
+    aws ecr create-repository --repository-name demo/sinatra
+    ECR_REPO=$(aws ecr describe-repositories --repository-name demo/sinatra | jq -r '.repositories[].repositoryUri')
+    ufo init --image $ECR_REPO --launch-type fargate --execution-role-arn arn:aws:iam::$AWS_ACCOUNT:role/ecsTaskExecutionRole
     ufo current --service demo-web
     ufo ship
     ufo ps
@@ -22,7 +24,7 @@ In a hurry? No sweat! Here's a quick start to using ufo that takes only a few mi
 
 This quickstart assumes:
 
-* You have push access to the repo. Refer to the Notes "Repo Push Access" section below for more info. 
+* You have push access to the repo. Refer to the Notes "Repo Push Access" section below for more info.
 * The `ecsTaskExecutionRole` needs to exist on your AWS account.  If you do not have an ecsTaskExecutionRole yet, create one by following: [Create ecsTaskExecutionRole with AWS CLI]({% link _docs/aws-ecs-task-execution-role.md %}).
 
 ## What Happened
@@ -38,7 +40,7 @@ You should see output similar to this.
 
     $ ufo ship
     Building docker image with:
-      docker build -t tongueroo/demo-ufo:ufo-2018-06-29T22-54-07-20b3a10 -f Dockerfile .
+      docker build -t 112233445566.dkr.ecr.us-west-2.amazonaws.com/demo/sinatra:ufo-2018-06-29T22-54-07-20b3a10 -f Dockerfile .
     ...
     10:58:38PM CREATE_COMPLETE AWS::ECS::Service Ecs
     10:58:40PM CREATE_COMPLETE AWS::CloudFormation::Stack development-demo-web

data/lib/cfn/stack.yml

@@ -101,9 +101,10 @@ Resources:
 # When adding and removing EIPs
 # Error: TargetGroup cannot be associated with more than one load balancer
 # Solution: https://forums.aws.amazon.com/thread.jspa?threadID=254544
+# Note: we truncate the stack name because target group names can be only 32 chars long
       Name: !Join
       - '-'
-      - - <%= @stack_name %>
+      - - <%= @stack_name[0..-6] %>
         - !Select [ 2, !Split [ '-', !GetAtt Elb.LoadBalancerName]]
 <% end -%>
       Protocol: <%= @default_target_group_protocol %>

data/lib/ufo/network/helper.rb

@@ -9,7 +9,7 @@ class Ufo::Network
       fetch = Fetch.new(@options[:vpc_id])
       @options[:vpc_id] ||= fetch.vpc_id
       @options[:ecs_subnets] ||= fetch.subnet_ids
-      @options[:elb_subnets] ||= fetch.subnet_ids
+      @options[:elb_subnets] ||= @options[:ecs_subnets] || fetch.subnet_ids
     end
 
     # hack for specs

data/lib/ufo/network.rb

@@ -7,7 +7,8 @@ module Ufo
     def self.cli_options
       [
         [:force, type: :boolean, desc: "Bypass overwrite are you sure prompt for existing files."],
-        [:subnets, type: :array, desc: "Subnets"],
+        [:ecs_subnets, type: :array, desc: "ECS Subnets"],
+        [:elb_subnets, type: :array, desc: "ELB Subnets"],
         [:vpc_id, desc: "Vpc id"],
         [:filename, default: "default", desc: "Name of the settings file to create w/o extension."],
       ]

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "4.4.2"
+  VERSION = "4.4.3"
 end

data/lib/ufo.rb

@@ -1,3 +1,5 @@
+$stdout.sync = true unless ENV["UFO_STDOUT_SYNC"] == "0"
+
 $:.unshift(File.expand_path('../', __FILE__))
 require 'deep_merge'
 require 'fileutils'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ufo
 version: !ruby/object:Gem::Version
-  version: 4.4.2
+  version: 4.4.3
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-24 00:00:00.000000000 Z
+date: 2019-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudformation
@@ -292,6 +292,7 @@ files:
 - docs/_config.yml
 - docs/_docs/aws-ecs-task-execution-role.md
 - docs/_docs/conventions.md
+- docs/_docs/extras/codebuild-iam-role.md
 - docs/_docs/extras/ecs-network-mode.md
 - docs/_docs/extras/load-balancer.md
 - docs/_docs/extras/minimal-deploy-iam.md