ufo 3.5.3 → 3.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7338b5ba4ca3bb5d26dfa18ee50dba6f8ecd3d45834bcd89d8d3053811c28c78
-  data.tar.gz: a5d9590cc34d8a7929f1bb68ffebfb6e8625e2a6c55fa079d94a0393b864a882
+  metadata.gz: 5a7fa29c3df7ba9a608f0e2c82fd27231fa6f083136ba3a08b987067518de477
+  data.tar.gz: 94c3f8f4e5fc4b2cc9cf8fcac9ef49e42d876a137cfd414a10d62c915da7c96d
 SHA512:
-  metadata.gz: 7c4e12cd02e469e89cb2a514a3e377d3c60f16f99cd29ab32dc8ce5c5e03a9d8a215b9fdcaa98e10e4151234d6a9169e97a4a0ec62e63b51a1f181b5711c4904
-  data.tar.gz: 9e6858395d6689e321687f6dd948a43739ff70b08114b190919eef171bce0d1994959c7ed12eb372b131938f759c2b459cef9172fd8f45890aed7cfec32a22d5
+  metadata.gz: eac7a33bea59ff2420a63ece5779c874a7b9bb03d6a5856417cb87d330a657a3fdb35888ee971545703b00bfa5e9887490efc0657cf0c4ccaeb6f717e9f29387
+  data.tar.gz: b0b8e6d712982eea6a6f58c4eefbb172da9bfef85ae4e5a2d23e69c30fa47059238175bbb1c0902cade9f9af3a16d2bdfd8c66b072906076c6fd3017d1303209

data/CHANGELOG.md

@@ -3,7 +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.
 
-## [3.5.2]
+## [3.5.4]
+- Merge pull request #38 from tongueroo/docker-build-options
+- add ability to specify custom docker build options with env UFO_DOCKER_BUILD_OPTIONS variable
+- update faq
+
+## [3.5.3]
 - Merge pull request #36 from tongueroo/fix-shared-variables-in-task-definitions
 - allow usage of shared variables in task_definition blocks again
 - dont warn of instance variable collision for template scope variables

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ufo (3.5.2)
+    ufo (3.5.4)
       aws-sdk-cloudwatchlogs
       aws-sdk-ec2
       aws-sdk-ecr
@@ -22,15 +22,17 @@ GEM
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    aws-partitions (1.84.0)
+    aws-eventstream (1.0.0)
+    aws-partitions (1.87.0)
     aws-sdk-cloudwatchlogs (1.3.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
-    aws-sdk-core (3.20.2)
+    aws-sdk-core (3.21.1)
+      aws-eventstream (~> 1.0)
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.0)
       jmespath (~> 1.0)
-    aws-sdk-ec2 (1.31.0)
+    aws-sdk-ec2 (1.34.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
     aws-sdk-ecr (1.3.0)

data/docs/_docs/faq.md

@@ -4,7 +4,40 @@ 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.
+Yes, Fargate is supported.  To use ufo with Fargate, you will need to adjust the template in `.ufo/templates` to use a structure support by Fargate.  If it's a brand new project. You can use `ufo init` with the `--launch-type fargate` option and it will generate a starter JSON file that has the right Fargate structure. Notably, it has the requiresCompatibilities, networkMode, and executionRoleArn attributes.
+
+The neat thing about Fargate is that can be an extremely cost-effective way to run one-off tasks. This blog post [Heroku vs ECS Fargate vs EC2 On-Demand vs EC2 Spot Pricing Comparison](https://blog.boltops.com/2018/04/22/heroku-vs-ecs-fargate-vs-ec2-on-demand-vs-ec2-spot-pricing-comparison) provides a relative comparison of costs.
+
+---
+
+**Q: Can I tell ufo to use specific docker build options?**
+
+Yes, you can do this with the environment variable `UFO_DOCKER_BUILD_OPTIONS`.  Example:
+
+```
+$ UFO_DOCKER_BUILD_OPTIONS="--build-arg RAILS_ENV=production" ufo docker build
+Building docker image with:
+  docker build --build-arg RAILS_ENV=production -t tongueroo/hi:ufo-2018-05-19T11-52-16-6714713 -f Dockerfile .
+...
+Docker image tongueroo/hi:ufo-2018-05-19T11-52-16-6714713 built.  Took 2s.
+```
+
+---
+
+**Q: Can you tell ufo to use a custom user-defined Docker tag name?**
+
+In short, no. There's some image cleanup logic that relies on the specific naming convention.  However, you can re-tag the build docker image with another tag after ufo is done building the image.  The key is using the `ufo docker name` command to get the last docker image name that was built by ufo. Example:
+
+```
+$ ufo docker build
+$ ufo docker name
+tongueroo/hi:ufo-2018-05-19T11-41-06-6714713
+$ docker tag $(ufo docker name) hi:mytag
+$ docker images | grep hi
+hi                                                     mytag                              5b01e38bd060        3 minutes ago       955MB
+tongueroo/hi                                           ufo-2018-05-19T11-41-06-6714713    5b01e38bd060        3 minutes ago       955MB
+$ docker push hi:mytag
+```
 
 ---
 

data/docs/_docs/params.md

@@ -38,17 +38,6 @@ create_service:
 # 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
 
 # ufo task calls run_tasks
 run_task:

data/docs/_reference/ufo-docker-build.md

@@ -72,6 +72,16 @@ You should see it being pushed at the end:
 
 Note in order to push the image to a registry you will need to login into the registry.  If you are using DockerHub use the `docker login` command.  If you are using AWS ECR then you can use the `aws ecr get-login` command.
 
+## Docker Build Options
+
+You can specify docker build options with the `UFO_DOCKER_BUILD_OPTIONS` environment variable.  Example:
+
+    $ UFO_DOCKER_BUILD_OPTIONS="--build-arg RAILS_ENV=production" ufo docker build
+    Building docker image with:
+      docker build --build-arg RAILS_ENV=production -t tongueroo/hi:ufo-2018-05-19T11-52-16-6714713 -f Dockerfile .
+    ...
+    Docker image tongueroo/hi:ufo-2018-05-19T11-52-16-6714713 built.  Took 2s.
+
 
 ## Options
 

data/docs/_reference/ufo-init.md

@@ -71,7 +71,7 @@ For ECS Fargate, the ECS task definition structure is a bit different.  To initi
 
     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.
+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
 

data/docs/_reference/ufo-task.md

@@ -21,6 +21,14 @@ You can use the `--command` or `-c` option to override the Docker container comm
     ufo task hi-web -c uptime
     ufo task hi-web -c pwd
 
+## Skipping Docker
+
+The `--no-docker` option is useful. By default, the `ufo task` command will build the docker image.  The docker build process usually is the part that takes the most time. You can skip the docker build process after building it at least once.  This is a faster way to run a bunch of commands with thesame Docker image. Example:
+
+    ufo task hi-web -c uptime # build at least once
+    ufo task hi-web --no-docker -c ls # skip docker for speed
+    ufo task hi-web --no-docker -c pwd # skip docker for speed
+
 
 ## Options
 

data/lib/ufo/docker/builder.rb

@@ -25,7 +25,7 @@ class Ufo::Docker
 
       update_auth_token
 
-      command = "docker build -t #{full_image_name} -f #{@dockerfile} ."
+      command = "docker build #{build_options}-t #{full_image_name} -f #{@dockerfile} ."
       say "Building docker image with:".green
       say "  #{command}".green
       check_dockerfile_exists
@@ -44,6 +44,12 @@ class Ufo::Docker
       say "Docker image #{full_image_name} built.  " + "Took #{pretty_time(took)}.".green
     end
 
+    def build_options
+      options = ENV['UFO_DOCKER_BUILD_OPTIONS']
+      options += " " if options
+      options
+    end
+
     # Parse Dockerfile for FROM instruction. If the starting image is from an ECR
     # repository, it's likely an private image so we authorize ECR for pulling.
     def update_auth_token

data/lib/ufo/help/docker/build.md

@@ -59,3 +59,12 @@ You should see it being pushed at the end:
 
 Note in order to push the image to a registry you will need to login into the registry.  If you are using DockerHub use the `docker login` command.  If you are using AWS ECR then you can use the `aws ecr get-login` command.
 
+## Docker Build Options
+
+You can specify docker build options with the `UFO_DOCKER_BUILD_OPTIONS` environment variable.  Example:
+
+    $ UFO_DOCKER_BUILD_OPTIONS="--build-arg RAILS_ENV=production" ufo docker build
+    Building docker image with:
+      docker build --build-arg RAILS_ENV=production -t tongueroo/hi:ufo-2018-05-19T11-52-16-6714713 -f Dockerfile .
+    ...
+    Docker image tongueroo/hi:ufo-2018-05-19T11-52-16-6714713 built.  Took 2s.

data/lib/ufo/help/init.md

@@ -58,7 +58,7 @@ For ECS Fargate, the ECS task definition structure is a bit different.  To initi
 
     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.
+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
 

data/lib/ufo/help/task.md

@@ -8,3 +8,10 @@ You can use the `--command` or `-c` option to override the Docker container comm
     ufo task hi-web -c uptime
     ufo task hi-web -c pwd
 
+## Skipping Docker
+
+The `--no-docker` option is useful. By default, the `ufo task` command will build the docker image.  The docker build process usually is the part that takes the most time. You can skip the docker build process after building it at least once.  This is a faster way to run a bunch of commands with thesame Docker image. Example:
+
+  ufo task hi-web -c uptime # build at least once
+  ufo task hi-web --no-docker -c ls # skip docker for speed
+  ufo task hi-web --no-docker -c pwd # skip docker for speed

data/lib/ufo/task.rb

@@ -30,7 +30,12 @@ module Ufo
         display_params(task_options)
       end
       resp = ecs.run_task(task_options)
-      puts "Task ARN: #{resp.tasks[0].task_arn}" unless @options[:mute]
+      unless @options[:mute]
+        task_arn = resp.tasks[0].task_arn
+        puts "Task ARN: #{task_arn}"
+        puts "  aws ecs describe-tasks --tasks #{task_arn} --cluster #{@cluster}"
+        # todo: maybe add cw comand here also
+      end
     end
 
   private

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "3.5.3"
+  VERSION = "3.5.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ufo
 version: !ruby/object:Gem::Version
-  version: 3.5.3
+  version: 3.5.4
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-08 00:00:00.000000000 Z
+date: 2018-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudwatchlogs