ufo 3.3.2 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9526c75651199d68e6ab75d2c9ead77f0fe98494dea3bd9bca13a3c2693e2151
-  data.tar.gz: bb7af2fbd70a4a59e63a8b39907c4923310aeb5d4dc4aeac4e906509af4b1e5b
+  metadata.gz: f6538c65fc62bc274a20fba3434414de8c69ad9ed21191d0045ea6eb3ded848b
+  data.tar.gz: 995b140a23c61dd0afc8d30e81c5c83dd0c2fafd75c5d0d11e5a12f8adc6fb75
 SHA512:
-  metadata.gz: 2a0c2bd7632a8f0643072130d074fd8730f683803eba102d830ec6c875ecc23173139e72883ff40c99fdb884ef07b97e3c2df54f3348d4772e784c26fa7bacb7
-  data.tar.gz: e09b54aa2f9bc98a729f74592036def9b4caa5ee531c1addab982e4a6576d52c52645027c5da9a243b911f6cb02b2ce14e057a6832a4c836c3986f77e3585d1d
+  metadata.gz: 53c156400bd5f0ede61f83f1305ca8203b85dac5607c8b3397f4fe42741323941ba3f89364d2a47792a7e2ae99fc63c0991aa2961dca03c78bdb6b57f1a5796f
+  data.tar.gz: 738494c751a0bedd7209053682ea0141bf4d717035cc057e96b53d42df4b3c4cde762d5effba4f00ce028f4274347e4abc1abc4a6637a8cfe1e67aaf85d414ab

data/CHANGELOG.md

@@ -3,6 +3,15 @@
 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.
 
+## [3.4.0]
+- Merge pull request #31 fargate support
+- ufo upgrade3_3_to_3_4 command
+- add params.yml concept to support fargate and any other aws-sdk option
+- add TemplateScope class
+- combine Default into Util module
+- clean up settings method
+- display params as helpful info
+
 ## [3.3.2]
 - Merge pull request #28 from netguru/master
 - Fix one off task: ufo task

data/Gemfile.lock

@@ -9,6 +9,7 @@ PATH
       aws-sdk-elasticloadbalancingv2
       colorize
       deep_merge
+      memoist
       plissken
       render_me_pretty
       thor
@@ -16,16 +17,16 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.5)
+    activesupport (5.2.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    aws-partitions (1.73.0)
+    aws-partitions (1.80.0)
     aws-sdk-cloudwatchlogs (1.2.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
-    aws-sdk-core (3.17.1)
+    aws-sdk-core (3.19.0)
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.0)
       jmespath (~> 1.0)
@@ -42,7 +43,7 @@ GEM
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
     aws-sigv4 (1.0.2)
-    byebug (10.0.1)
+    byebug (10.0.2)
     cli_markdown (0.1.0)
     codeclimate-test-reporter (1.0.8)
       simplecov (<= 0.13)
@@ -51,10 +52,11 @@ GEM
     deep_merge (1.2.1)
     diff-lcs (1.3)
     docile (1.1.5)
-    i18n (0.9.5)
+    i18n (1.0.0)
       concurrent-ruby (~> 1.0)
-    jmespath (1.3.1)
+    jmespath (1.4.0)
     json (2.1.0)
+    memoist (0.16.0)
     minitest (5.11.3)
     plissken (1.2.0)
     rake (12.3.1)

data/docs/README.md

@@ -14,8 +14,7 @@ For larger fixes, you can run the site locally with the following:
 git clone https://github.com/tongueroo/ufo.git
 cd ufo/docs
 bundle
-jekyll clean
-jekyll serve
+bin/web # runs jekyll clean and jekyll serve
 ```
 
 You'll be able to view the site on [http://localhost:4000](http://localhost:4000).

data/docs/_docs/params.md

@@ -0,0 +1,72 @@
+---
+title: Params
+---
+
+Additionally, the params that ufo sends to the [ruby aws-sdk](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ECS/Client.html#run_task-instance_method) methods to create resources can be customized with a `params.yml` file.  This allows you to customize the tool using the full power of the aws-sdk.
+
+A starter project `.ufo/params.yml` file is generated as part of the `ufo init` command. Let's take a look at an example `params.yml`:
+
+```yaml
+<%
+  # replace with actual values:
+  @subnets = ["subnet-111","subnet-222"]
+  @security_groups = ["sg-111"]
+%>
+# These params are passsed to the corresponding aws-sdk ecs client methods.
+# AWS Docs example: https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ECS/Client.html#run_task-instance_method
+#
+# Comments left in as examples.
+# Uncomment launch_type and network_configuration sections to enable fargate.
+#
+
+create_service:
+  deployment_configuration:
+    maximum_percent: 200
+    minimum_healthy_percent: 100
+  desired_count: 1
+  # launch_type: "FARGATE"
+  # network_configuration:
+  #   awsvpc_configuration:
+  #     subnets: <%= @subnets.inspect %> # required
+  #     security_groups: <%= @security_groups.inspect %>
+  #     assign_public_ip: "ENABLED" # accepts ENABLED, DISABLED
+
+# update service is provide as an example below.  Though it is probably better
+# to not add any options to update_service if you are using the ECS console
+# to update these settings often.
+update_service:
+  # force_new_deployment: true
+  # deployment_configuration:
+  #   maximum_percent: 200
+  #   minimum_healthy_percent: 100
+  # desired_count: 1
+  # launch_type: "FARGATE"
+  # network_configuration:
+  #   awsvpc_configuration:
+  #     subnets: ["subnet-0ea22ddeb59d13ecc","subnet-0215e12250b7404e7"] # required
+  #     security_groups: ["sg-0815f009d64fc4b2d"]
+  #     assign_public_ip: "ENABLED" # accepts ENABLED, DISABLED
+
+run_task:
+  # launch_type: "FARGATE"
+  # network_configuration:
+  #   awsvpc_configuration:
+  #     subnets: <%= @subnets.inspect %> # required
+  #     security_groups: <%= @security_groups.inspect %>
+  #     assign_public_ip: "ENABLED" # accepts ENABLED, DISABLED
+```
+
+Ufo provides 1st class citizen adjust to the params that get sent to the aws-sdk calls:
+
+* create_service - `ufo ship` is calls this when the ECS service does not yet exist.
+* update_service - `ufo ship` is calls this when the ECS service already exists.
+* run_task - `ufo task` calls this.
+
+The parameters from this `params.yml` file gets merged with params ufo generates internally.  Here's an example of where the merging happens in the source code for the run task command [task.rb](https://github.com/tongueroo/ufo/blob/90f12df035843528770122deb328d150249a25e2/lib/ufo/task.rb#L20)  Also, here's the starter [params.yml source code](https://github.com/tongueroo/ufo/blob/master/lib/template/.ufo/params.yml) for reference.
+
+ERB and variables are available in the params file.  Noticed how ERB is used at the top of the example file to set some subnets to prevent duplication.
+
+<a id="prev" class="btn btn-basic" href="{% link _docs/settings.md %}">Back</a>
+<a id="next" class="btn btn-primary" href="{% link _docs/ufo-env.md %}">Next Step</a>
+<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
+

data/docs/_docs/settings.md

@@ -15,11 +15,6 @@ base:
   image: tongueroo/hi
   # clean_keep: 30 # cleans up docker images on your docker server.
   # ecr_keep: 30 # cleans up images on ECR and keeps this remaining amount. Defaults to keep all.
-  # defaults when an new ECS service is created by ufo ship
-  new_service:
-    maximum_percent: 200
-    minimum_healthy_percent: 100
-    desired_count: 1
 
 development:
   # cluster: dev # uncomment if you want the cluster name be other than the default
@@ -111,6 +106,6 @@ AWS_PROFILE=prod-profile => UFO_ENV=production
 This behavior prevents you from switching `AWS_PROFILE`s and then accidentally deploying a production based docker image to development and vice versas because you forgot to also switch `UFO_ENV` to its respective environment.
 
 <a id="prev" class="btn btn-basic" href="{% link _docs/structure.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/ufo-env.md %}">Next Step</a>
+<a id="next" class="btn btn-primary" href="{% link _docs/params.md %}">Next Step</a>
 <p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
 

data/docs/_docs/tutorial-ufo-init.md

@@ -63,11 +63,6 @@ base:
   # clean_keep: 30 # cleans up docker images on your docker server.
   # ecr_keep: 30 # cleans up images on ECR and keeps this remaining amount. Defaults to keep all.
   # defaults when an new ECS service is created by ufo ship
-  new_service:
-    maximum_percent: 200
-    minimum_healthy_percent: 100
-    desired_count: 1
-
 development:
   # cluster: dev # uncomment if you want the cluster name be other than the default
                  # the default is to match UFO_ENV.  So UFO_ENV=development means the ECS

data/docs/_docs/ufo-env.md

@@ -51,6 +51,6 @@ AWS_PROFILE=whatever => UFO_ENV=development # since there are no profiles that m
 
 Notice how `AWS_PROFILE=whatever` results in `UFO_ENV=development`.  This is because there are no matching aws_profiles in the `settings.yml`.  More info on settings is available at [settings]({% link _docs/settings.md %}).
 
-<a id="prev" class="btn btn-basic" href="{% link _docs/settings.md %}">Back</a>
+<a id="prev" class="btn btn-basic" href="{% link _docs/params.md %}">Back</a>
 <a id="next" class="btn btn-primary" href="{% link _docs/variables.md %}">Next Step</a>
 <p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>

data/docs/_includes/subnav.html

@@ -15,6 +15,7 @@
             <ul>
                 <li><a href="{% link _docs/structure.md %}">Structure</a></li>
                 <li><a href="{% link _docs/settings.md %}">Settings</a></li>
+                <li><a href="{% link _docs/params.md %}">Params</a></li>
                 <li><a href="{% link _docs/ufo-env.md %}">UFO_ENV</a></li>
                 <li><a href="{% link _docs/variables.md %}">Shared Variables</a></li>
                 <li><a href="{% link _docs/helpers.md %}">Helpers</a></li>

data/docs/_reference/ufo-deploy.md

@@ -20,7 +20,15 @@ The above command does the following:
 1. register the `.ufo/output/hi-web.json` task definition to ECS untouched.
 2. deploys it to ECS by updating the service
 
-The `ufo deploy` command does less than the `ufo ship` command.  Typically, people use `ufo ship` over the `ufo deploy` command do everything in one step:
+### ufo tasks build
+
+To regenerate a `.ufo/output/hi-web.json` definition:
+
+    ufo tasks build
+
+### ufo ship
+
+The `ufo deploy` command does less than the `ufo ship` command.  Normally, it is recommended to use `ufo ship` over the `ufo deploy` command to do everything in one step:
 
 1. build the Docker image
 2. register the ECS task definition

data/docs/_reference/ufo-init.md

@@ -32,6 +32,12 @@ For this example we will use [tongueroo/hi](https://github.com/tongueroo/hi) whi
           append  .gitignore
     Starter ufo files created.
 
+## 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/hi --app hi --launch-type fargate --execution-role-arn arn:aws:iam::536766270177:role/ecsTaskExecutionRole
+
 ## Options: app and image
 
 The `app` is that application name that you want to show up on the ECS dashboard.  It is encouraged to have the app name be a single word.
@@ -59,6 +65,18 @@ The standard directory structure of the `.ufo` folder that was created looks lik
 
 For a explanation of the folders and files refer to [Structure]({% link _docs/structure.md %}).
 
+## Fargate Support
+
+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/hi --app hi --force --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/hi --app hi --force --launch-type fargate --execution-role-arn arn:aws:iam::536766270177: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.
+
 ## Custom Templates
 
 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:
@@ -83,14 +101,17 @@ If you would like to use a local template that is not on GitHub, then created a
 ## Options
 
 ```
-[--force]                        # Bypass overwrite are you sure prompt for existing files.
---image=IMAGE                    # Docker image name without the tag. Example: tongueroo/hi. Configures ufo/settings.yml
---app=APP                        # App name. Preferably one word. Used in the generated ufo/task_definitions.rb.
-[--template=TEMPLATE]            # Custom template to use.
-[--template-mode=TEMPLATE_MODE]  # Template mode: replace or additive.
-[--verbose], [--no-verbose]      
-[--mute], [--no-mute]            
-[--noop], [--no-noop]            
-[--cluster=CLUSTER]              # Cluster.  Overrides ufo/settings.yml.
+[--force]                                  # Bypass overwrite are you sure prompt for existing files.
+--image=IMAGE                              # Docker image name without the tag. Example: tongueroo/hi. Configures ufo/settings.yml
+--app=APP                                  # App name. Preferably one word. Used in the generated ufo/task_definitions.rb.
+[--launch-type=LAUNCH_TYPE]                # ec2 or fargate.
+                                           # Default: ec2
+[--execution-role-arn=EXECUTION_ROLE_ARN]  # execution role arn used by tasks, required for fargate.
+[--template=TEMPLATE]                      # Custom template to use.
+[--template-mode=TEMPLATE_MODE]            # Template mode: replace or additive.
+[--verbose], [--no-verbose]                
+[--mute], [--no-mute]                      
+[--noop], [--no-noop]                      
+[--cluster=CLUSTER]                        # Cluster.  Overrides ufo/settings.yml.
 ```
 

data/docs/_reference/ufo-task.md

@@ -13,25 +13,24 @@ Run a one-time task.
 
 ## Examples
 
-To run a one time task with ECS:
-
-    ufo task hi-migrate
-
-You can also override the command used by the Docker container in the task definitions via command.
+You can use the `--command` or `-c` option to override the Docker container command.
 
+    ufo task hi-migrate # default command
     ufo task hi-web --command bin/migrate
     ufo task hi-web --command bin/with_env bundle exec rake db:migrate:redo VERSION=xxx
+    ufo task hi-web -c uptime
+    ufo task hi-web -c pwd
 
 
 ## Options
 
 ```
-[--docker], [--no-docker]    # Enable docker build and push
-                             # Default: true
-[--command=one two three]    # Override the command used for the container
-[--verbose], [--no-verbose]  
-[--mute], [--no-mute]        
-[--noop], [--no-noop]        
-[--cluster=CLUSTER]          # Cluster.  Overrides ufo/settings.yml.
+    [--docker], [--no-docker]    # Enable docker build and push
+                                 # Default: true
+c, [--command=one two three]     # Override the command used for the container
+    [--verbose], [--no-verbose]  
+    [--mute], [--no-mute]        
+    [--noop], [--no-noop]        
+    [--cluster=CLUSTER]          # Cluster.  Overrides ufo/settings.yml.
 ```
 

data/docs/_reference/ufo-upgrade3_3_to_3_4.md

@@ -0,0 +1,23 @@
+---
+title: ufo upgrade3_3_to_3_4
+reference: true
+---
+
+## Usage
+
+    ufo upgrade3_3_to_3_4
+
+## Description
+
+Upgrade from version 3.3 to 3.4
+
+
+## Options
+
+```
+[--verbose], [--no-verbose]  
+[--mute], [--no-mute]        
+[--noop], [--no-noop]        
+[--cluster=CLUSTER]          # Cluster.  Overrides ufo/settings.yml.
+```
+

data/docs/reference.md

@@ -15,4 +15,5 @@ title: CLI Reference
 * [ufo task]({% link _reference/ufo-task.md %})
 * [ufo tasks]({% link _reference/ufo-tasks.md %})
 * [ufo upgrade3]({% link _reference/ufo-upgrade3.md %})
+* [ufo upgrade3_3_to_3_4]({% link _reference/ufo-upgrade3_3_to_3_4.md %})
 * [ufo version]({% link _reference/ufo-version.md %})

data/lib/template/.ufo/params.yml.tt

@@ -0,0 +1,65 @@
+<%%
+  # replace with actual values:
+  @subnets = ["subnet-111","subnet-222"]
+  @security_groups = ["sg-111"]
+%>
+# These params are passsed to the corresponding aws-sdk ecs client methods.
+# AWS Docs example: https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/ECS/Client.html#run_task-instance_method
+#
+# Comments left in as examples.
+# Uncomment launch_type and network_configuration sections to enable fargate.
+#
+
+create_service:
+  deployment_configuration:
+    maximum_percent: 200
+    minimum_healthy_percent: 100
+  desired_count: 1
+<% if @options[:launch_type] == "fargate" -%>
+  launch_type: "FARGATE"
+  network_configuration:
+    awsvpc_configuration:
+      subnets: <%%= @subnets.inspect %> # required
+      security_groups: <%%= @security_groups.inspect %>
+      assign_public_ip: "ENABLED" # accepts ENABLED, DISABLED
+<% else -%>
+  # launch_type: "FARGATE"
+  # network_configuration:
+  #   awsvpc_configuration:
+  #     subnets: <%%= @subnets.inspect %> # required
+  #     security_groups: <%%= @security_groups.inspect %>
+  #     assign_public_ip: "ENABLED" # accepts ENABLED, DISABLED
+<% end -%>
+
+# update service is provide as an example below.  Though it is probably better
+# to not add any options to update_service if you are using the ECS console
+# to update these settings often.
+update_service:
+  # force_new_deployment: true
+  # deployment_configuration:
+  #   maximum_percent: 200
+  #   minimum_healthy_percent: 100
+  # desired_count: 1
+  # launch_type: "FARGATE"
+  # network_configuration:
+  #   awsvpc_configuration:
+  #     subnets: <%%= @subnets.inspect %> # required
+  #     security_groups: <%%= @security_groups.inspect %>
+  #     assign_public_ip: "ENABLED" # accepts ENABLED, DISABLED
+
+run_task:
+<% if @options[:launch_type] == "fargate" -%>
+  launch_type: "FARGATE"
+  network_configuration:
+    awsvpc_configuration:
+      subnets: <%%= @subnets.inspect %> # required
+      security_groups: <%%= @security_groups.inspect %>
+      assign_public_ip: "ENABLED" # accepts ENABLED, DISABLED
+<% else -%>
+  # launch_type: "FARGATE"
+  # network_configuration:
+  #   awsvpc_configuration:
+  #     subnets: <%%= @subnets.inspect %> # required
+  #     security_groups: <%%= @security_groups.inspect %>
+  #     assign_public_ip: "ENABLED" # accepts ENABLED, DISABLED
+<% end -%>

data/lib/template/.ufo/settings.yml.tt

@@ -7,10 +7,6 @@ base:
   # clean_keep: 30
   # ecr_keep: 30
   # defaults when an new ECS service is created by ufo ship
-  new_service:
-    maximum_percent: 200
-    minimum_healthy_percent: 100
-    desired_count: 1
 
 development:
   # cluster: dev

data/lib/template/.ufo/templates/fargate.json.erb

@@ -0,0 +1,37 @@
+{
+  "family": "<%= @family %>",
+  "requiresCompatibilities": ["FARGATE"],
+  "networkMode": "awsvpc",
+  "executionRoleArn": "<%= @execution_role_arn %>",
+  "cpu": "<%= @cpu %>",
+  "memory": "<%= @memory %>",
+  "containerDefinitions": [
+    {
+      "name": "<%= @name %>",
+      "image": "<%= @image %>",
+      <% if @container_port %>
+      "portMappings": [
+        {
+          "containerPort": "<%= @container_port %>",
+          "protocol": "tcp"
+        }
+      ],
+      <% end %>
+      "command": <%= @command.to_json %>,
+      <% if @environment %>
+      "environment": <%= @environment.to_json %>,
+      <% end %>
+      <% if @awslogs_group %>
+      "logConfiguration": {
+        "logDriver": "awslogs",
+        "options": {
+          "awslogs-group": "<%= @awslogs_group %>",
+          "awslogs-region": "<%= @awslogs_region || 'us-east-1' %>",
+          "awslogs-stream-prefix": "<%= @awslogs_stream_prefix %>"
+        }
+      },
+      <% end %>
+      "essential": true
+    }
+  ]
+}