ufo 2.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df0785744573abcd889a7d125e002395ed402a11628844cbb02792579c651427
-  data.tar.gz: c707e64b786e5f4bf7aed4a8e64ae0b8ad1f37231b0ac2259523c707ef139932
+  metadata.gz: c909def5e8c50d44c06b4fb96dbe5c56d1fa534fe919e01a9ec206ae95246dfd
+  data.tar.gz: cfc0ec639cc48c7cbb2ab9ba3fdaa29fe3337ae0ef95d7eca92c7f77c65e65ef
 SHA512:
-  metadata.gz: 126232930ff21ac0a23daf5a9ff430c268792c6eeb986998794ff641f3ba6c1cd02e186d4924c2cad0ef268a1956b1d3aff013b348188364475103203aec1fbd
-  data.tar.gz: dfdabc75f052471f0539e31196ec9474610ab51f82841db05685a24135f40727f6377787a94536e4e38315c005f7f98398a008c25c713e1c8ac5296dbf7ada0e
+  metadata.gz: a6a1ce7a570829d4201c978dfe6e0d4cf6c5b3c0e172e0cce9df9cac0573d16a42fa90328843381f42e144da58b9ae816c15393ae12bc590c53557041e2a6227
+  data.tar.gz: 138a530c4e23df2b55c83477a9dc183b6cd7191fb3c231dabfbdc4053088b5006394cbc54e517fdbf831f915d9e9ce67146468fc5729a5737c175b319406b8c8

data/.circleci/config.yml

@@ -0,0 +1,57 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/ruby:2.5.0-node-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - run:
+          name: submodule sync
+          command: |
+            git submodule sync
+            git submodule update --init
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            bundle exec rspec
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/render_me_pretty"]
+	path = vendor/render_me_pretty
+	url = git@github.com:tongueroo/render_me_pretty.git

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --format documentation
+--require spec_helper

data/CHANGELOG.md

@@ -3,9 +3,24 @@
 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.0.0]
+- dotufo: rename ufo folder to .ufo. Use ufo upgrade3 command to upgrade.
+- new settings.yml format to account for multiple AWS accounts and environments.
+- allows for environment specific setting file
+- add auto-completion, to setup: eval $(ufo completion_script)
+- ufo upgrade3 command
+- ufo init: Use Thor::Group as generator
+- default UFO_ENV is now development, not production
+- Merge pull request #9 from jlchenwenbo/master
+- Merge branch 'patch-1' of https://github.com/breezeight/ufo into breezeight-patch-1
+- Bug: Update ship.rb: list all ecs services instead of just the first page
+- replace project_root with Ufo.root internally
+- update docs
+- use vendorized render_me_pretty for erb rendering
+
 ## [2.2.3]
 - eval $(ufo completion_script) for tab auto-completion
-- default task_defintion template fixes: add ecs/ to awslogs_group, add helper.current_region
+- default task_definition template fixes: add ecs/ to awslogs_group, add helper.current_region
 - move bin/ufo to exe/ufo
 - rename: AwsServices to AwsService, Defaults to Default, Settings to Setting
 

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    ufo (2.2.2)
+    ufo (2.3.0)
+      activesupport
       aws-sdk-cloudwatchlogs
       aws-sdk-ec2
       aws-sdk-ecr
@@ -15,7 +16,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    aws-partitions (1.59.0)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    aws-partitions (1.60.0)
     aws-sdk-cloudwatchlogs (1.2.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
@@ -23,7 +29,7 @@ GEM
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.0)
       jmespath (~> 1.0)
-    aws-sdk-ec2 (1.26.0)
+    aws-sdk-ec2 (1.27.0)
       aws-sdk-core (~> 3)
       aws-sigv4 (~> 1.0)
     aws-sdk-ecr (1.2.0)
@@ -40,11 +46,15 @@ GEM
     codeclimate-test-reporter (1.0.8)
       simplecov (<= 0.13)
     colorize (0.8.1)
+    concurrent-ruby (1.0.5)
     deep_merge (1.2.1)
     diff-lcs (1.3)
     docile (1.1.5)
+    i18n (0.9.4)
+      concurrent-ruby (~> 1.0)
     jmespath (1.3.1)
     json (2.1.0)
+    minitest (5.11.3)
     plissken (1.2.0)
     rake (12.3.0)
     rspec (3.7.0)
@@ -66,6 +76,9 @@ GEM
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
     thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -20,6 +20,10 @@ Ufo deploys a task definition that is written in a templating language that is e
 
 See [ufoships.com](http://ufoships.com) for full documentation.
 
+## Important
+
+If you are on version 2, you can run `ufo upgrade3` within your project to upgrade it to version 3.  Refer to the [CHANGELOG](CHANGELOG.md).
+
 ## Installation
 
 ```sh
@@ -33,7 +37,7 @@ Full installation instructions are at [Install Ufo](http://ufoships.com/docs/ins
 To quickly demonstrate how simple it is to use ufo we will use an example app from [tongueroo/hi](https://github.com/tongueroo/ufo).  The app is a barebones sinatra app.  Here are the steps:
 
 ```sh
-brew cask install boltopslabs/software/bolts
+gem install ufo
 git clone https:///github.com/tongueroo/hi.git
 cd hi
 ufo init --app=hi --image=tongueroo/hi

data/docs/_docs/auto-completion.md

@@ -0,0 +1,27 @@
+---
+title: Auto Completion
+---
+
+Ufo supports bash auto-completion.  To set it up add this to your `~/.profile` or `.bashrc`:
+
+```
+eval $(ufo completion_script)
+```
+
+Auto Completion examples:
+
+```
+ufo [TAB]
+ufo ship [TAB]
+ufo ship hi-web [TAB]
+ufo ship hi-web --[TAB]
+ufo ship --[TAB]
+ufo docker [TAB]
+ufo docker build [TAB]
+ufo tasks [TAB]
+ufo tasks build [TAB]
+```
+
+<a id="prev" class="btn btn-basic" href="{% link _docs/conventions.md %}">Back</a>
+<a id="next" class="btn btn-primary" href="{% link _docs/run-in-pieces.md %}">Next Step</a>
+<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>

data/docs/_docs/automated-cleanup.md

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

data/docs/_docs/conventions.md

@@ -6,7 +6,7 @@ Ufo uses a set of naming conventions.  This helps enforce some best practices an
 
 ### UFO_ENV to ECS Cluster Convention
 
-By default, the ECS cluster value is the same as UFO_ENV's value.  So if `UFO_ENV=production` then the ECS Cluster is production and if `UFO_ENV=staging` then the ECS Cluster is staging.  You can easily override this convention by specifying the `--cluster` CLI option.  You can also override this behavior with [settings.yml]({% link _docs/settings.md %}) to spare you from having to type `--cluster` over and over.
+By default, the ECS cluster value is the same as UFO_ENV's value.  So if `UFO_ENV=production` then the ECS Cluster is `production` and if `UFO_ENV=development` then the ECS Cluster is `development`.  You can easily override this convention by specifying the `--cluster` CLI option.  You can also override this behavior with [settings.yml]({% link _docs/settings.md %}) to spare you from having to type `--cluster` over and over.
 
 ### Service and Task Names Convention
 
@@ -44,5 +44,5 @@ ufo ship hi-web --target-group=arn:aws:elasticloadbalancing:us-east-1:12345689:t
 ```
 
 <a id="prev" class="btn btn-basic" href="{% link _docs/helpers.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/run-in-pieces.md %}">Next Step</a>
+<a id="next" class="btn btn-primary" href="{% link _docs/auto-completion.md %}">Next Step</a>
 <p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>

data/docs/_docs/helpers.md

@@ -2,21 +2,21 @@
 title: Helpers
 ---
 
-The task\_definitions.rb file has access to special variables and helper methods available. These helper methods provide useful contextual information about the project.
+The `task_definitions.rb` file has access to helper methods. These helper methods provide useful contextual information about the project.
 
-For example, one of the variable provides the exposed port in the Dockerfile of the project. This is useful if someone changes the exported port in the Dockerfile, he likely to forget to also update the ufo variable so it is referenced via the helper. Here is a list of the important helpers:
+For example, one of the helper methods provides the exposed port in the Dockerfile of the project. This is useful if someone changes the exported port in the Dockerfile, he likely to forget to also update the ufo variable so it is referenced via the helper. Here is a list of the helpers:
 
 Helper  | Description
 ------------- | -------------
-full\_image\_name | The full docker image name that ufo builds. The "base" portion of the docker image name is defined in ufo/settings.yml. For example, the base portion is `tongueroo/hi` and the full image name is `tongueroo/hi:ufo-[timestamp]-[sha]`. The base name does not include the generated Docker tag, which contains a timestamp and git sha of the Dockerfile that is used.
+full\_image\_name | The full docker image name that ufo builds. The "base" portion of the docker image name is defined in `settings.yml`. For example, the base portion is `tongueroo/hi` and the full image name is `tongueroo/hi:ufo-[timestamp]-[sha]`. The base name does not include the generated Docker tag, which contains a timestamp and git sha of the Dockerfile that is used.
 dockerfile\_port | Exposed port extracted from the Dockerfile of the project. 
-env_vars(text) | This method takes a block of text that contains the env values in key=value format and converts that block of text to the proper task definition json format.
+env_vars(text) | This method takes a block of text that contains the env values in `key=value` format and converts that block of text to the proper task definition json format.
 env_file(path) | This method takes an `.env` file which contains a simple key value list of environment variables and converts the list to the proper task definition json format.
 task_definition_name | The name of the task_definition.  So if the code looks like this `task_definition "demo-web" do`, the task_definition_name is "demo-web".
 
-To call the helper in task_definitions.rb you must add `helper.` in front.  So full\_image\_name  is called via `helper.full_image_name`.
+To call the helper in task_definitions.rb you must add `helper.` in front.  So `full_image_name` is called via `helper.full_image_name`.
 
-The 2 classes which provide these special helper methods are in [ufo/dsl.rb](https://github.com/tongueroo/ufo/blob/master/lib/ufo/dsl.rb) and [ufo/dsl/helper.rb](https://github.com/tongueroo/ufo/blob/master/lib/ufo/dsl/helper.rb). Refer to these classes for the full list of the special variables and methods.
+The 2 classes which provide these special helper methods are in [ufo/dsl.rb](https://github.com/tongueroo/ufo/blob/master/lib/ufo/dsl.rb) and [ufo/dsl/helper.rb](https://github.com/tongueroo/ufo/blob/master/lib/ufo/dsl/helper.rb). Refer to these classes for the full list of the helper methods.
 
 <a id="prev" class="btn btn-basic" href="{% link _docs/variables.md %}">Back</a>
 <a id="next" class="btn btn-primary" href="{% link _docs/conventions.md %}">Next Step</a>

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

@@ -2,29 +2,36 @@
 title: Run in Pieces
 ---
 
-The `ufo ship` command goes through a few stages: building the docker image, registering the task defiintions and updating the ECS service.  The CLI exposes each of the steps as separate commands.  Here is now you would be able to run each of the steps in pieces.
+The `ufo ship` command goes through a few stages:
+
+1. building the docker image
+2. registering the task defiintions
+2. updating the ECS service.
+
+The CLI exposes many of these steps as separate commands.  Here is now you would be able to run each of the steps in pieces.
 
 Build the docker image first.
 
 ```bash
 ufo docker build
-ufo docker build --push # will also push to the docker registry
+ufo docker push # pushes last built image to a registry
 ```
 
 Build the task definitions.
 
 ```bash
-ufo tasks build
-ufo tasks register # will register all genreated task definitinos in the ufo/output folder
+ufo tasks build    # generates task definition json files to .ufo/output
+ufo tasks register # registers all genreated task definitions .ufo/output to ECS
 ```
 
-Skips all the build docker phases of a deploy sequence and only update the service with the task definitions.
+Update the service with the task definitions in `.ufo/output` untouched.
 
 ```bash
-ufo ship hi-web --no-docker
+ufo deploy hi-web
 ```
-Note if you use the `--no-docker` option you should ensure that you have already push a docker image to your docker registry.  Or else the task will not be able to spin up because the docker image does not exist.  It is normally recommended that you normally use `ufo ship`.
 
-<a id="prev" class="btn btn-basic" href="{% link _docs/conventions.md %}">Back</a>
+Note if you use the `ufo deploy` you should ensure that you have already push the docker image to your docker registry.  Or else the task will not be able to spin up because the docker image does not exist.  This is one of the reasons it is recommended that you use `ufo ship`.
+
+<a id="prev" class="btn btn-basic" href="{% link _docs/auto-completion.md %}">Back</a>
 <a id="next" class="btn btn-primary" href="{% link _docs/single-task.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

@@ -12,86 +12,98 @@ Let's take a look at an example `ufo/settings.yml`:
 
 ```yaml
 image: tongueroo/hi
-clean_keep: 30
-ecr_keep: 30
-aws_profile_ufo_env_map:
-  default: staging
-#   # More examples:
-#   aws_profile1: production
-#   aws_profile2: staging
-#   aws_profile3: development
-
-ufo_env_cluster_map:
-  default: production
-#   # More examples:
-#   production: production
-#   staging: staging
-#   development: development
+base:
+  image: <%= @image %>
+  # 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
+                 # cluster will be name development
+  # When you have AWS_PROFILE set to one of these values, ufo will switch to the desired
+  # environment. This prevents you from switching AWS_PROFILE, forgetting to
+  # also switch UFO_ENV, and accidentally deploying to production vs development.
+  # aws_profiles:
+  #   - dev_profile1
+  #   - dev_profile2
+
+production:
+  # cluster: prod
+  # aws_profiles:
+  #   - prod_profile
 ```
 
-The table below covers what each setting does:
+The table below covers each setting:
 
 Setting  | Description
 ------------- | -------------
 `image`  | The `image` value is the name that ufo will use for the Docker image name to be built.  Only provide the basename part of the image name without the tag because ufo automatically generates the tag for you. For example, `tongueroo/hi` is correct and `tongueroo/hi:my-tag` is incorrect.
-`aws_profile_ufo_env_map`  | Maps the `AWS_PROFILE` to the `UFO_ENV` value.
-`ufo_env_cluster_map`  | Maps the `UFO_ENV` to an ECS cluster value.  This allows you to override the convention where the default cluster equals to `UFO_ENV`. value.  This is covered in detailed at [Conventions]({% link _docs/conventions.md %}).
+`clean_keep`  | Docker images generated from ufo are cleaned up automatically for you at the end of `ufo ship`. This controls how many docker images to keep around. The default is 3.
+`ecr_keep`  | If you are using AWS ECR, then the ECR images can also be automatically cleaned up at the end of `ufo ship`. By default this is set to `nil` and all AWS ECR are kept.
+`cluster`  | By convention, the ECS cluster that ufo deploys to matches the `UFO_ENV`. If `UFO=development`, then `ufo ship` deploys to the `development` ECS cluster. This is option overrides this convetion.
+`aws_profiles`  | If you have the `AWS_PROFILE` environment variable set, this will ensure that you are deploying the right `UFO_ENV` to the right AWS
 
+Maps the `UFO_ENV` to an ECS cluster value.  This allows you to override the convention where the default cluster equals to `UFO_ENV`. value.  This is covered in detailed at [Conventions]({% link _docs/conventions.md %}).
 
-### UFO_ENV to ECS Cluster Mapping
 
-The `ufo_env_cluster_map` option allows you to override the [UFO_ENV to ECS Cluster Convention]({% link _docs/conventions.md %}).  Normally, the ECS cluster defaults to whatever UFO_ENV is set to.  For example, when `UFO_ENV=production` the ECS Cluster is production and when `UFO_ENV=staging` the ECS Cluster is staging.  This setting allows you to override this behavior so that you do not have to specify the `--cluster` CLI option repeatedly.  Let's go through an example:
+### ECS Cluster Convention
 
-By default:
+Normally, the ECS cluster defaults to whatever UFO_ENV is set to by [convention]({% link _docs/conventions.md %}).  For example, when `UFO_ENV=production` the ECS Cluster is `production` and when `UFO_ENV=development` the ECS Cluster is `development`.  This setting allows you to override this behavior so that you do not have to specify the `--cluster` CLI option repeatedly.  Let's go through an example:
 
-```sh
-UFO_ENV=production ufo ship hi-web # cluster defaults to UFO_ENV which is prod
-UFO_ENV=production ufo ship hi-web --cluster prod # same as above
-```
-
-Override the convention and explicitly specify the `--cluster` option in the CLI.
+By default, these are all the same:
 
 ```sh
-UFO_ENV=production ufo ship hi-web --cluster custom-cluster # override the default UFO_ENV TO cluster mapping
+ufo ship hi-web
+UFO_ENV=development ufo ship hi-web # same
+UFO_ENV=development ufo ship hi-web --cluster development # same
 ```
 
-We can also override the convention with `settings.yml`:
+If you use a specific `UFO_ENV=production`, these are the same
 
-```yaml
-ufo_env_cluster_map:
-  prod: custom-cluster
+```
+UFO_ENV=production ufo ship hi-web
+UFO_ENV=production ufo ship hi-web --cluster production # same
 ```
 
-Because of the `ufo_env_cluster_map` setting, the `--cluster` CLI option is not longer required:
+Override the convention and explicitly specify the `--cluster` option in the CLI.
 
 ```sh
-UFO_ENV=production ufo ship hi-web # same as --cluster custom-cluster because of settings.yml
+ufo ship hi-web --cluster custom-cluster # override the cluster
+UFO_ENV=production ufo ship hi-web --cluster production-cluster # override the cluster
 ```
 
-### AWS_PROFILE TO UFO_ENV Mapping
+By setting the cluster option in the `settings.yml` file, you won't have to specify the cluster repeatedly.
+
+### AWS_PROFILE awareness
 
-An interesting way to set `UFO_ENV` is with the `aws_profile_ufo_env_map` in `ufo/settings.yml`.  Given:
+An interesting option is `aws_profiles`.  Here's an example:
 
 ```yaml
-aws_profile_ufo_env_map:
-  default: development
-  my-prod-profile: production
-  my-stag-profile: staging
+development:
+  aws_profiles:
+    - dev-profile1
+    - dev-profile2
+
+production:
+  aws_profiles:
+    - prod-profile
 ```
 
-In this case, when you set `AWS_PROFILE` to switch AWS profiles, ufo picks this up and maps the `AWS_PROFILE` value to the specified `UFO_ENV` using the `aws_profile_ufo_env_map` lookup.  Example:
+In this case, when you set the environment variable `AWS_PROFILE` to switch AWS profiles in your shell, ufo picks this up and maps the `AWS_PROFILE` value to the specified `UFO_ENV` using the `aws_profiles` option.  Example:
 
 ```sh
-AWS_PROFILE=my-prod-profile => UFO_ENV=production
-AWS_PROFILE=my-stag-profile => UFO_ENV=staging
-AWS_PROFILE=default => UFO_ENV=development
-AWS_PROFILE=whatever => UFO_ENV=development
+AWS_PROFILE=dev-profile1 => UFO_ENV=development
+AWS_PROFILE=dev-profile2 => UFO_ENV=development
+AWS_PROFILE=prod-profile => UFO_ENV=production
 ```
 
-Notice how `AWS_PROFILE=whatever` results in `UFO_ENV=development`.  This is because the `default: development` map is specially treated. If you set the `default` map, this becomes the default value when the profile map is not specified in the rest of `ufo/settings.yml`.
-
-This behavior prevents you from switching `AWS_PROFILE`s and then accidentally deploying a production based docker image to staging and vice versas because you forgot to also switch `UFO_ENV` to its respective environment.
-
+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/ufo-help.md %}">Back</a>
 <a id="next" class="btn btn-primary" href="{% link _docs/ufo-env.md %}">Next Step</a>