ufo 4.4.0 → 4.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e71aeb95d96170c7faa58087450a774e3358e63
-  data.tar.gz: 3fb85bfcfef7f0861652dcec20088b204ed8a5c8
+  metadata.gz: 9831eec0e5a8f8a604c5ea4b029dd649b058e97f
+  data.tar.gz: c0419936a5041b7b195ad4af5e81d1fb034ceca0
 SHA512:
-  metadata.gz: 95a679a60fbae5e1cd2a54e244e46622b59ef28835c9bfd105730caa5fc31c5deab8f9eb030fd6eb8f3f5028698ee425a2539c38c9434533abaf4668ee7fc870
-  data.tar.gz: f6613d13f0d3c633e21a89faf6ad6bd2c302dfe24a95d925dcc588814e8c099cfb6200e8220a4667e388caa16bc2453b80858a52426584c9a5cdb29d225179e2
+  metadata.gz: '08edd4ec8da658d61ee42f42101bdf1bff64328c014a8be77b9e8ded8cbb726bb38935210f37c59b2258426e793ab377986bd457c1c6c637d00279ceffe70e6d'
+  data.tar.gz: a23f2ace2f336622f4442092f6e83475bb47585e276943526ea1293419330713658b85995d54c44414b09dcabfd4c14411da191097ccc16a26c0b6c7a21f0db2

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 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.1]
+- return correct exit code 1 when cloudformation deploy fails
+- update docs: organize better into subfolders
+
 ## [4.4.0]
 - #71 from gurpreetatwal/patch-1 remove extra slash from URL
 - #73 organize docs better into subfolders

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ufo (4.4.0)
+    ufo (4.4.1)
       aws-sdk-cloudformation
       aws-sdk-cloudwatchlogs
       aws-sdk-ec2

data/docs/_docs/{load-balancer.md → extras/load-balancer.md}

@@ -44,7 +44,7 @@ For non-web container the `--elb` option must be explicitly set to `--elb=true`
 
 Ufo retains the ELB setting.  So future `ufo ship` commands will not suddenly remove the load balancer.  If you need to change the elb setting, then you need to explicitly set a new `--elb` value.
 
-Important: Adding and removing load balancers will change the ELB DNS.  Please take pre-caution using the elb options.  This risk is mitigated if you have configured [Route53 support]({% link _docs/route53-support.md %}).
+Important: Adding and removing load balancers will change the ELB DNS.  Please take pre-caution using the elb options.  This risk is mitigated if you have configured [Route53 support]({% link _docs/extras/route53-support.md %}).
 
 ## ELB Types: Application and Network
 

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

@@ -0,0 +1,82 @@
+---
+title: Minimal Deploy IAM Policy
+nav_order: 28
+---
+
+The IAM user you use to run the `ufo ship` command needs a minimal set of IAM policies in order to deploy to ECS. Here is a table of the baseline services needed:
+
+Service | Description
+--- | ---
+CloudFormation | To create the CloudFormation stack that then creates the most of the AWS resources that Ufo creates like ECS service and the ELB.
+EC2 | To describe subnets associated with VPC. Used to configured subnets to use for ECS tasks and ELBs.
+ECR | To pull and push to the ECR registry.  If you're using DockerHub this permission is not required.
+ECS | To create ECS service, task definitions, etc.
+ElasticloadBalancing | To create the ELB and related load balancing resoures like Listeners and Target Groups.
+ElasticloadBalancingV2 | To create the ELB and related load balancing resoures like Listeners and Target Groups.
+Logs | To write to CloudWatch Logs.
+Route53 | To create vanity DNS endpoint when using [Route53 setting]({% link _docs/extras/route53-support.md %}).
+
+## Instructions
+
+It is recommended that you create an IAM group and associate it with the IAM users that need access to use `jets deploy`.  Here are starter instructions and a policy that you can tailor for your needs:
+
+### Commands Summary
+
+Here's a summary of the commands:
+
+aws iam create-group --group-name Ufo
+cat << 'EOF' > /tmp/ecs-deploy-policy.json
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Action": [
+                "cloudformation:*",
+                "ec2:*",
+                "ecr:*",
+                "ecs:*",
+                "elasticloadbalancing:*",
+                "elasticloadbalancingv2:*",
+                "logs:*",
+                "route53:*"
+            ],
+            "Resource": "*",
+            "Effect": "Allow"
+        },
+        {
+            "Action": [
+                "iam:PassRole"
+            ],
+            "Effect": "Allow",
+            "Resource": "*",
+            "Condition": {
+                "StringLike": {
+                    "iam:PassedToService": [
+                        "ecs-tasks.amazonaws.com"
+                    ]
+                }
+            }
+        }
+    ]
+}
+EOF
+aws iam put-group-policy --group-name Ufo --policy-name UfoPolicy --policy-document file:///tmp/ecs-deploy-policy.json
+
+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
+
+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
+
+## 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 %}

data/docs/_docs/{redirection-support.md → extras/redirection-support.md}

@@ -5,7 +5,7 @@ nav_order: 27
 
 ## Application Load Balancers
 
-If you are using an Application Load Balancer you can configure redirection by editing the default actions of the regular listener that is set up by ufo. This assumes you have set up [SSL Support]({% link _docs/ssl-support.md %}).  Here's an example that redirects http to https with a 302 http status code:
+If you are using an Application Load Balancer you can configure redirection by editing the default actions of the regular listener that is set up by ufo. This assumes you have set up [SSL Support]({% link _docs/extras/ssl-support.md %}).  Here's an example that redirects http to https with a 302 http status code:
 
 ```
 listener:

data/docs/_docs/faq.md

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

data/docs/_docs/next-steps.md

@@ -1,6 +1,6 @@
 ---
 title: Next Steps
-nav_order: 41
+nav_order: 42
 ---
 
 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/upgrading/upgrade4.4.md

@@ -1,9 +1,9 @@
 ---
 title: Upgrading to Version 4.4
 short_title: Version 4.4
-nav_order: 30
 order: 1
 categories: upgrading
+nav_order: 30
 ---
 
 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

@@ -1,9 +1,9 @@
 ---
 title: Upgrading to Version 4.0
 short_title: Version 4.0
-nav_order: 31
 order: 2
 categories: upgrading
+nav_order: 31
 ---
 
 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/_includes/subnav.html

@@ -25,13 +25,15 @@
                 <li><a href="{% link _docs/ufo-env.md %}">Ufo Env</a></li>
                 <li><a href="{% link _docs/ufo-env-extra.md %}">Ufo Env Extra</a></li>
                 <li><a href="{% link _docs/ufo-current.md %}">Ufo Current</a></li>
-                <li><a href="{% link _docs/load-balancer.md %}">Load Balancer</a></li>
-                <li><a href="{% link _docs/security-groups.md %}">Security Groups</a></li>
-                <li><a href="{% link _docs/ecs-network-mode.md %}">ECS Network Mode</a></li>
-                <li><a href="{% link _docs/ssl-support.md %}">SSL Support</a></li>
-                <li><a href="{% link _docs/route53-support.md %}">Route53 Support</a></li>
-                <li><a href="{% link _docs/redirection-support.md %}">Redirection Support</a></li>
-                <li><a href="{% link _docs/faq.md %}">FAQ</a></li>
+        <li>Extras
+            <ul>
+                <li><a href="{% link _docs/extras/load-balancer.md %}">Load Balancer</a></li>
+                <li><a href="{% link _docs/extras/security-groups.md %}">Security Groups</a></li>
+                <li><a href="{% link _docs/extras/ecs-network-mode.md %}">ECS Network Mode</a></li>
+                <li><a href="{% link _docs/extras/ssl-support.md %}">SSL Support</a></li>
+                <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>
             </ul>
         <li><a href="{% link _docs/upgrading.md %}">Upgrading</a>
             <ul>
@@ -43,14 +45,15 @@
         </li>
         <li>More
             <ul>
-                <li><a href="{% link _docs/why-cloudformation.md %}">Why CloudFormation</a></li>
-                <li><a href="{% link _docs/customize-cloudformation.md %}">Customize CloudFormation</a></li>
-                <li><a href="{% link _docs/stuck-cloudformation.md %}">Stuck CloudFormation</a></li>
-                <li><a href="{% link _docs/run-in-pieces.md %}">Run In Pieces</a></li>
-                <li><a href="{% link _docs/single-task.md %}">Run Single Task</a></li>
-                <li><a href="{% link _docs/migrations.md %}">Database Migrations</a></li>
-                <li><a href="{% link _docs/automated-cleanup.md %}">Automated Cleanup</a></li>
-                <li><a href="{% link _docs/auto-completion.md %}">Auto-Completion</a></li>
+                <li><a href="{% link _docs/more/why-cloudformation.md %}">Why CloudFormation</a></li>
+                <li><a href="{% link _docs/more/customize-cloudformation.md %}">Customize CloudFormation</a></li>
+                <li><a href="{% link _docs/more/stuck-cloudformation.md %}">Stuck CloudFormation</a></li>
+                <li><a href="{% link _docs/more/run-in-pieces.md %}">Run In Pieces</a></li>
+                <li><a href="{% link _docs/more/single-task.md %}">Run Single Task</a></li>
+                <li><a href="{% link _docs/more/migrations.md %}">Database Migrations</a></li>
+                <li><a href="{% link _docs/more/automated-cleanup.md %}">Automated Cleanup</a></li>
+                <li><a href="{% link _docs/more/auto-completion.md %}">Auto-Completion</a></li>
+                <li><a href="{% link _docs/faq.md %}">FAQ</a></li>
                 <li><a href="{% link articles.md %}">Articles</a></li>
                 <li><a href="{% link _docs/next-steps.md %}">Next Steps</a></li>
                 <li><a href="{% link reference.md %}">CLI Reference</a></li>

data/docs/articles.md

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

data/lib/ufo/ship.rb

@@ -30,6 +30,7 @@ module Ufo
         puts "Software shipped!"
       else
         puts "Software fail to ship."
+        exit 1
       end
     end
 

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "4.4.0"
+  VERSION = "4.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ufo
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.4.1
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-13 00:00:00.000000000 Z
+date: 2019-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudformation
@@ -290,32 +290,34 @@ files:
 - docs/LICENSE
 - docs/README.md
 - docs/_config.yml
-- docs/_docs/auto-completion.md
-- docs/_docs/automated-cleanup.md
 - docs/_docs/aws-ecs-task-execution-role.md
 - docs/_docs/conventions.md
-- docs/_docs/customize-cloudformation.md
-- docs/_docs/ecs-network-mode.md
+- docs/_docs/extras/ecs-network-mode.md
+- docs/_docs/extras/load-balancer.md
+- docs/_docs/extras/minimal-deploy-iam.md
+- docs/_docs/extras/redirection-support.md
+- docs/_docs/extras/route53-support.md
+- docs/_docs/extras/security-groups.md
+- docs/_docs/extras/ssl-support.md
 - docs/_docs/faq.md
 - docs/_docs/fargate.md
 - docs/_docs/helpers.md
 - docs/_docs/install.md
-- docs/_docs/load-balancer.md
-- docs/_docs/migrations.md
+- docs/_docs/more/auto-completion.md
+- docs/_docs/more/automated-cleanup.md
+- docs/_docs/more/customize-cloudformation.md
+- docs/_docs/more/migrations.md
+- docs/_docs/more/run-in-pieces.md
+- docs/_docs/more/single-task.md
+- docs/_docs/more/stuck-cloudformation.md
+- docs/_docs/more/why-cloudformation.md
 - docs/_docs/next-steps.md
 - docs/_docs/params.md
 - docs/_docs/quick-start-ec2.md
-- docs/_docs/redirection-support.md
-- docs/_docs/route53-support.md
-- docs/_docs/run-in-pieces.md
-- docs/_docs/security-groups.md
 - docs/_docs/settings-cfn.md
 - docs/_docs/settings-network.md
 - docs/_docs/settings.md
-- docs/_docs/single-task.md
-- docs/_docs/ssl-support.md
 - docs/_docs/structure.md
-- docs/_docs/stuck-cloudformation.md
 - docs/_docs/tutorial-ufo-docker-build.md
 - docs/_docs/tutorial-ufo-init.md
 - docs/_docs/tutorial-ufo-ship.md
@@ -330,7 +332,6 @@ files:
 - docs/_docs/upgrading/upgrade4.4.md
 - docs/_docs/upgrading/upgrade4.md
 - docs/_docs/variables.md
-- docs/_docs/why-cloudformation.md
 - docs/_includes/about.html
 - docs/_includes/cfn-customize.md
 - docs/_includes/commands.html