ufo 3.4.0 → 3.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6538c65fc62bc274a20fba3434414de8c69ad9ed21191d0045ea6eb3ded848b
-  data.tar.gz: 995b140a23c61dd0afc8d30e81c5c83dd0c2fafd75c5d0d11e5a12f8adc6fb75
+  metadata.gz: 52f0ef8e22102e9fc1ae63ae8074d39678bc575a457a94d04ffd0ec07e6c6938
+  data.tar.gz: aa281a52edbafa042a7005e8b7dd8ae687126c201197f7dbee220c30b239af88
 SHA512:
-  metadata.gz: 53c156400bd5f0ede61f83f1305ca8203b85dac5607c8b3397f4fe42741323941ba3f89364d2a47792a7e2ae99fc63c0991aa2961dca03c78bdb6b57f1a5796f
-  data.tar.gz: 738494c751a0bedd7209053682ea0141bf4d717035cc057e96b53d42df4b3c4cde762d5effba4f00ce028f4274347e4abc1abc4a6637a8cfe1e67aaf85d414ab
+  metadata.gz: '09506b8a70f79e4cb98292d5783ea875220eb02efb15098148b81a080a67820acf65926d1fe96ae50c9c1f41637a10fa4d4c20bb563af5948624f3a9f52378d2'
+  data.tar.gz: 370f8cf93cfa5010d90ef92bb5fd2a2b43828ee31e4bd211ccf14221ba34b90cc51f46eaf2f58b31b28a7f7df37793b8d9e1fdf94429331bc31dd61e3e3138f2

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.
 
+## [3.4.1]
+- Merge pull request #32 from tongueroo/fix-log-configuration
+- fix log configuration dasherization
+- Fixes issue #30 how can use syslog as driver for logging?
+
 ## [3.4.0]
 - Merge pull request #31 fargate support
 - ufo upgrade3_3_to_3_4 command

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ufo (3.3.2)
+    ufo (3.4.1)
       aws-sdk-cloudwatchlogs
       aws-sdk-ec2
       aws-sdk-ecr
@@ -52,7 +52,7 @@ GEM
     deep_merge (1.2.1)
     diff-lcs (1.3)
     docile (1.1.5)
-    i18n (1.0.0)
+    i18n (1.0.1)
       concurrent-ruby (~> 1.0)
     jmespath (1.4.0)
     json (2.1.0)

data/docs/_docs/faq.md

@@ -0,0 +1,65 @@
+---
+title: FAQ
+---
+
+**Q: Is AWS ECS Fargate supported?**
+
+Yes, Fargate is supported.  To use ufo with Fargate, the you should adjust the the template in `.ufo/templates` to use the Fargate structure.  If it's a brand new project. You can use `ufo init` with the `--launch_type fargate` option and it will generate a json file that has the right Fargate structure. Notable, it requires requiresCompatibilities, networkMode and executionRoleArn to be set.
+
+---
+
+**Q: What's the difference between ufo vs ecs-deploy?**
+
+Some differences:
+
+* ecs-deploy is implemented in bash
+* ufo is implemented in ruby
+* ecs-deploy is a simpler, which could work better for you. It’s nice that it’s one bash script.
+
+ufo does 3 things:
+
+1. Builds and pushes the Docker image
+2. Builds and registers the task definition with ECS
+3. Deploys by either creating or updating the ECS service
+
+Ecs-deploy does step 2 and 3 but not step 1. For step 3, doesn’t look like ecs-deploy creates a service if it doesn’t exist. It’s more designed to update existing an ECS service.
+
+The main difference is that ecs-deploy downloads current ECS task definition and replaces the image attribute. ufo regenerates the task definition from code each deploy. If you’re making adjustments to the task definition with the ECS console as your flow, the ecs-deploy makes more sense. If you want to keep your task definition codified than ufo makes more sense.
+
+Some more differences:
+
+* ufo creates the CloudWatch log group if doesn’t exist. Small thing but it’s easy to forget.
+* ufo has a concept of variables that get layered. This is how it handles multi environments with very similar task definitions with just a few differences.
+
+Generally, ufo does more in scope so we’re sort of comparing apples to oranges here.  Hope that helps.
+
+---
+
+**Q: Is it somehow possible to change the templates for the files, that the ufo init-command generates? Most of my services follow the same overall structure, which means I'll have to perform the same changes every time I initialize a new UFO setup.**
+
+Yes, this is achieved with the `--template` and `--template-mode` options when calling the `ufo init` command. The documentation for it is in the [ufo init reference docs](http://ufoships.com/reference/ufo-init/).
+
+---
+
+**Q: How can I used syslog instead of awslogs for logging?**
+
+Open up `.ufo/templates/main.json.erb` - this gets created as part of the [ufo init](http://ufoships.com/reference/ufo-init/) command.  Then you can adjust the ecs template definition to something like this:
+
+```json
+            "logConfiguration": {
+                "logDriver": "syslog"
+            },
+```
+
+Here's the specific aws docs section [Specifying a Log Configuration in your Task Definition](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html#specify-log-config)
+
+Also, you might have to enable the log driver by added it the ECS_AVAILABLE_LOGGING_DRIVERS variable to your `/etc/ecs/ecs.config`. Relevant docs:
+
+* [Using AWS Logs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html#enable_awslogs)
+* [ECS Agent Install](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-install.html)
+
+Hope that helps.
+
+<a id="prev" class="btn btn-basic" href="{% link _docs/next-steps.md %}">Back</a>
+<a id="next" class="btn btn-primary" href="{% link articles.md %}">Next Step</a>
+<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>

data/docs/_docs/next-steps.md

@@ -13,6 +13,6 @@ From here, there are a few resources that can help you continue along:
 Everyone can contribute to make ufo better, including the documentation. These docs are of the same ufo repo in the [docs folder](https://github.com/tongueroo/ufo/tree/master/docs). Please fork the project and open a pull request!  We love your pull requests. Contributions are encouraged and welcomed!
 
 <a id="prev" class="btn btn-basic" href="{% link _docs/automated-cleanup.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link articles.md %}">Next Step</a>
+<a id="next" class="btn btn-primary" href="{% link _docs/faq.md %}">Next Step</a>
 <p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
 

data/docs/_docs/params.md

@@ -19,6 +19,7 @@ A starter project `.ufo/params.yml` file is generated as part of the `ufo init`
 # Uncomment launch_type and network_configuration sections to enable fargate.
 #
 
+# ufo ship calls create_service when service doesnt exist
 create_service:
   deployment_configuration:
     maximum_percent: 200
@@ -31,6 +32,8 @@ create_service:
   #     security_groups: <%= @security_groups.inspect %>
   #     assign_public_ip: "ENABLED" # accepts ENABLED, DISABLED
 
+
+# ufo ship calls update_service when service already exists
 # 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.
@@ -47,6 +50,7 @@ update_service:
   #     security_groups: ["sg-0815f009d64fc4b2d"]
   #     assign_public_ip: "ENABLED" # accepts ENABLED, DISABLED
 
+# ufo task calls run_tasks
 run_task:
   # launch_type: "FARGATE"
   # network_configuration:
@@ -56,10 +60,10 @@ run_task:
   #     assign_public_ip: "ENABLED" # accepts ENABLED, DISABLED
 ```
 
-Ufo provides 1st class citizen adjust to the params that get sent to the aws-sdk calls:
+Ufo provides 1st class citizen access to adjust the params 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.
+* create_service - `ufo ship` calls this when the ECS service does not yet exist.
+* update_service - `ufo ship` 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.

data/docs/_includes/subnav.html

@@ -26,6 +26,7 @@
                 <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/next-steps.md %}">Next Steps</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 reference.md %}">Reference</a></li>
             </ul>

data/docs/articles.md

@@ -5,6 +5,6 @@ title: Articles
 * This blog post provides an introduction to the tool: [Ufo - Build Docker Containers and Ship Them to AWS ECS](https://medium.com/@tongueroo/ufo-easily-build-docker-containers-and-ship-them-to-aws-ecs-15556a2b39f#.qqu8o4wal)
 * This presentation covers ufo also: [Ufo Ship on AWS ECS](http://www.slideshare.net/tongueroo/ufo-ship-for-aws-ecs-70885296)
 
-<a id="prev" class="btn btn-basic" href="{% link _docs/next-steps.md %}">Back</a>
+<a id="prev" class="btn btn-basic" href="{% link _docs/faq.md %}">Back</a>
 <a id="next" class="btn btn-primary" href="{% link reference.md %}">Next Step</a>
 <p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>

data/lib/ufo/tasks/register.rb

@@ -24,8 +24,8 @@ module Ufo
     def register
       data = JSON.parse(IO.read(@template_definition_path), symbolize_names: true)
       data = data.to_snake_keys
-      data = fix_log_configuation_option(data)
-      message = "#{data[:family]} task definition registered."
+      data = dasherize_log_configuation_option(data)
+    message = "#{data[:family]} task definition registered."
       if @options[:noop]
         message = "NOOP: #{message}"
       else
@@ -55,11 +55,13 @@ module Ufo
 
     # LogConfiguration requires a string with dashes as the keys
     # https://docs.aws.amazon.com/sdkforruby/api/Aws/ECS/Client.html
-    def fix_log_configuation_option(data)
+    def dasherize_log_configuation_option(data)
       definitions = data[:container_definitions]
       definitions.each do |definition|
         next unless definition[:log_configuration]
         options = definition[:log_configuration][:options]
+        next unless options
+
         options["awslogs-group"] = options.delete(:awslogs_group)
         options["awslogs-region"] = options.delete(:awslogs_region)
         options["awslogs-stream-prefix"] = options.delete(:awslogs_stream_prefix)

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "3.4.0"
+  VERSION = "3.4.1"
 end

data/spec/lib/register_spec.rb

@@ -0,0 +1,49 @@
+describe Ufo::Tasks::Register do
+  before(:all) do
+    create_ufo_project
+  end
+
+  let(:register) { Ufo::Tasks::Register.new("fake_task_definition_path") }
+
+  context "syslog" do
+    let(:data) do
+      {
+        "container_definitions": [{
+          "logConfiguration": {
+            "logDriver": "syslog"
+          }
+        }]
+      }.to_snake_keys.deep_symbolize_keys
+    end
+
+    it "dasherizes log configuration option" do
+      result = register.dasherize_log_configuation_option(data)
+      driver = result[:container_definitions][0][:log_configuration][:log_driver]
+      expect(driver).to eq "syslog"
+    end
+  end
+
+  context "awslogs" do
+    let(:data) do
+      {
+        "container_definitions": [{
+          "logConfiguration": {
+            "logDriver": "awslogs",
+            "options": {
+              "awslogs-group": "mygroup",
+              "awslogs-region": "us-east-1",
+              "awslogs-stream-prefix": "mystream"
+            }
+          }
+        }]
+      }.to_snake_keys.deep_symbolize_keys
+    end
+
+    it "dasherizes log configuration option" do
+      result = register.dasherize_log_configuation_option(data)
+      log_configuration = result[:container_definitions][0][:log_configuration]
+      expect(log_configuration[:log_driver]).to eq "awslogs"
+      expect(log_configuration[:options].keys).to include("awslogs-group")
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ufo
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.4.1
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-16 00:00:00.000000000 Z
+date: 2018-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudwatchlogs
@@ -264,6 +264,7 @@ files:
 - docs/_docs/auto-completion.md
 - docs/_docs/automated-cleanup.md
 - docs/_docs/conventions.md
+- docs/_docs/faq.md
 - docs/_docs/helpers.md
 - docs/_docs/install.md
 - docs/_docs/migrations.md
@@ -455,6 +456,7 @@ files:
 - spec/lib/core_spec.rb
 - spec/lib/ecr_auth_spec.rb
 - spec/lib/ecr_cleaner_spec.rb
+- spec/lib/register_spec.rb
 - spec/lib/setting_spec.rb
 - spec/lib/ship_spec.rb
 - spec/lib/task_spec.rb
@@ -493,6 +495,7 @@ test_files:
 - spec/lib/core_spec.rb
 - spec/lib/ecr_auth_spec.rb
 - spec/lib/ecr_cleaner_spec.rb
+- spec/lib/register_spec.rb
 - spec/lib/setting_spec.rb
 - spec/lib/ship_spec.rb
 - spec/lib/task_spec.rb