ufo 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88ffa32343a3f2d384a43df599aab3521141bd03
-  data.tar.gz: d305e9b86ea4dbb552014b1c1ea4ee67d79dd4f6
+  metadata.gz: 44c73f56dd916b0f96995229189e5894c0ca568d
+  data.tar.gz: fca744890af7669cb85f24f0d6716cf9e2a7ef73
 SHA512:
-  metadata.gz: 200363f4ff73473eb9ca774ded09805f459af00d01130a9a4e7f9dee41238b5d0522be360908ba63f56b480f33f7e171f6fd7f3267e49af00c529fc43916911f
-  data.tar.gz: 0c1c498e29e3669907137abc93dbb9aa5b914a764ef506ec310e395124950171d8c78b39dbe7dfdaae74e93df743d99dcc0e5e063b4925b5fb5d5a4675134fcc
+  metadata.gz: b1b47ec0a9cfe953872d7377af9920dde72bdf1da2f884848b0d86107dced93ce54f259ce0ce69b520f85966bb91fcb11d143b8c03f9898f70bbf84de92a8382
+  data.tar.gz: '0865f013afd5cece517fb5935650116aa4f2f1f174b8c203917fba46937710216ce6c948d3db342452411c6337dee59f96ea75f99949ece8ee4a8864e3d7759e'

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.
 
+## [1.6.0]
+* rename ufo docker cleanup -> ufo docker clean
+* rename ufo docker image_name -> ufo docker name
+* add docs
+
 ## [1.5.0]
 * add ufo ships command
 * refactor code into modules: ecr, docker, tasks

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ufo (1.2.0)
+    ufo (1.5.0)
       aws-sdk
       colorize
       deep_merge
@@ -20,13 +20,13 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    aws-sdk (2.9.28)
-      aws-sdk-resources (= 2.9.28)
-    aws-sdk-core (2.9.28)
+    aws-sdk (2.9.37)
+      aws-sdk-resources (= 2.9.37)
+    aws-sdk-core (2.9.37)
       aws-sigv4 (~> 1.0)
       jmespath (~> 1.0)
-    aws-sdk-resources (2.9.28)
-      aws-sdk-core (= 2.9.28)
+    aws-sdk-resources (2.9.37)
+      aws-sdk-core (= 2.9.37)
     aws-sigv4 (1.0.0)
     builder (3.2.3)
     byebug (9.0.6)
@@ -83,4 +83,4 @@ DEPENDENCIES
   ufo!
 
 BUNDLED WITH
-   1.15.0
+   1.15.1

data/docs/.gitignore

@@ -0,0 +1,4 @@
+_site
+.sass-cache
+.jekyll-metadata
+Gemfile.lock

data/docs/CNAME

@@ -0,0 +1 @@
+ufoships.com

data/docs/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gem "jekyll"

data/docs/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 BoltOps
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/docs/README.md

@@ -0,0 +1,21 @@
+# Ufo Documentation
+
+This project powers the ufo documementation website: [ufoships.com](http://ufoships.com).  It is a static website generated by [Jekyll](https://jekyllrb.com/).
+
+## Contributing
+
+For minor changes like typos, you can click **Suggest an edit to this page**, located at the bottom of each article. This will take you to the source file on GitHub, where you can submit a pull request for your change through the UI.
+
+## Local Setup
+
+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
+```
+
+You'll be able to view the site on [http://localhost:4000](http://localhost:4000).

data/docs/_config.yml

@@ -0,0 +1,69 @@
+# Site settings
+title: Ufo
+email: tongueroo@gmail.com
+url: http://ufoships.com
+description: "An Easy Way to Build and Ship Docker Images to AWS ECS"
+keywords: "AWS EC2 Container Service, AWS ECS, UFO, Deploy to ECS, ufo ship"
+skills: ""
+meta_author: Tung Nguyen
+
+# Google webmaster tools
+google_verify:
+
+# https://ssl.bing.com/webmaster/configure/verify/ownership Option 2 content= goes here
+bing_verify:
+
+# Contact form:
+# - static : pass through formspree.io to validate email sending
+# - disqus : replace contact form by disqus thread
+# - comment the line below if you want to stick with the default PHP contact form
+contact: static
+
+# If you use disqus you need disqus shortname
+# https://help.disqus.com/customer/portal/articles/466208
+disqus_shortname:
+
+# Color settings (hex-codes without the leading hash-tag)
+color:
+  primary: 3972c7
+  primary-rgb: "24,288,156" #"128,179,255"
+  secondary: 2c3e50 #FD6E8A
+  secondary-dark: 233140 #A2122F
+  links: a3c8ff
+
+# Footer settings
+footer:
+  copyright: BoltOps, LLC
+  location: San Francisco, CA
+  social: BoltOps
+  credits:
+  contact: contact@boltops.com
+  phone:
+
+# Social networks usernames (many more available: google-plus, flickr, dribbble, pinterest, instagram, tumblr, linkedin, etc.)
+social:
+  - title: twitter
+    url: http://twitter.com/boltopslabs
+  - title: github
+    url: http://github.com/boltopslabs
+
+# Credits content
+credits: 'BoltOps, LLC'
+
+# Build settings
+markdown: kramdown
+permalink: pretty
+
+gh_url: "https://github.com/tongueroo/ufo"
+
+collections:
+  docs:
+    name: "Documentation"
+    output: true
+
+defaults:
+  - values:
+      layout: default
+
+plugins_dir:
+ - jekyll-coffeescript

data/docs/_docs/commands.md

@@ -0,0 +1,10 @@
+---
+title: Commands
+---
+
+The [tutorial]({% link _docs/tutorial.md %}) does a great job of covering the main ufo commands and overall usage.  In the next sections we'll cover the ufo commands in more detail.
+
+<a id="prev" class="btn btn-basic" href="{% link _docs/tutorial-ufo-ships.md %}">Back</a>
+<a id="next" class="btn btn-primary" href="{% link _docs/ufo-init.md %}">Next Step</a>
+<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
+

data/docs/_docs/conventions.md

@@ -0,0 +1,45 @@
+---
+title: Conventions
+---
+
+Ufo uses a set of naming conventions.  This helps enforce some best practices and also allows the ufo commands to be concise.  Ufo allows you to easily override or bypass the conventions if you need it.
+
+### Service and Task Names Convention
+
+The main convention is that the ECS service and task definition name are the same by default.   If you would like to override this convention then you can specify the task name.
+
+```
+ufo ship hi-web-prod --task my-task
+```
+
+This means that in the task_definition.rb you will also defined it with `my-task`.  For example:
+
+```ruby
+task_definition "my-task" do
+  source "web" # this corresponds to the file in "ufo/templates/web.json.erb"
+  variables(
+    family: "my-task",
+    ....
+  )
+end
+
+```
+
+### Web Role Convention
+
+By convention, if the service has a container name web, you'll get prompted to create an ELB and specify a target group arn.  If you would like to name a service with the word "web" in it without having to use an ELB target group then you can use the `--no-target-group-prompt`.  Example:
+
+```sh
+ufo ship hi-web-prod --no-target-group-prompt
+```
+
+You can also bypass the prompt by specifying the target group arn as part of the command upfront. The ELB and target group must already exist.  The elb target group only gets associated when the service gets created for the first time.  If the service already exists then the `--target-group` parameter just gets ignored and the ECS task simply gets updated.  Example:
+
+```bash
+ufo ship hi-web-prod --target-group=arn:aws:elasticloadbalancing:us-east-1:12345689:targetgroup/hi-web-prod/12345
+```
+
+<a id="prev" class="btn btn-basic" href="{% link _docs/ufo-settings.md %}">Back</a>
+<a id="next" class="btn btn-primary" href="{% link _docs/next-steps.md %}">Next Step</a>
+<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
+

data/docs/_docs/install.md

@@ -0,0 +1,32 @@
+---
+title: Installation
+---
+
+### Install with Bolts Toolbelt
+
+If you want to quickly install ufo without having to worry about ufo's dependency you can simply install the Bolts Toolbelt which has ufo included.
+
+```sh
+brew cask install boltopslabs/software/bolts
+```
+
+For more information about the Bolts Toolbelt or to get an installer for another operating system visit: [https://boltops.com/toolbelt](https://boltops.com/toolbelt)
+
+### Install with RubyGems
+
+If you prefer to install ufo via RubyGems follow the instructions:
+
+```sh
+gem install ufo
+```
+
+Or you can add ufo to your Gemfile in your project if you are working with a ruby project.  It is not required for your project to be a ruby project to use ufo.
+
+{% highlight ruby %}
+gem "ufo"
+{% endhighlight %}
+
+<a id="prev" class="btn btn-basic" href="/docs/">Back</a>
+<a id="next" class="btn btn-primary" href="{% link _docs/structure.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

@@ -0,0 +1,18 @@
+---
+title: Next Steps
+---
+
+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.
+
+From here, there are a few resources that can help you continue along:
+
+* Check out the [ufo](https://github.com/tongueroo/ufo) repo on GitHub
+* Submit an issue
+* Write a blog post describing how you are using ufo, or an interesting problem ufo has allowed you to solve
+
+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/conventions.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/structure.md

@@ -0,0 +1,31 @@
+---
+title: Structure
+---
+
+Ufo creates a ufo folder within your project which contains the required files used by for ufo to build and deploy docker images to ECS.  The standard directory structure of the ufo folder looks like this:
+
+```sh
+ufo
+├── output
+├── settings.yml
+├── task_definitions.rb
+└── templates
+    └── main.json.erb
+```
+
+The table below covers the purpose of each folder and file.
+
+File / Directory  | Description
+------------- | -------------
+<code>output/</code>  | The folder where the generated task definitions are written to.  The way the task definitions are generated are covered in [ufo tasks build]({% link _docs/tutorial-ufo-tasks-build.md %}).
+<code>settings.yml</code>  | Ufo's settings file, where you and adjust the default settings.
+<code>task_definitions.rb</code>  | This where you define the task definitions and specify the variables to be used for the ERB templates.
+<code>templates/</code>  | The ERB templates with the task definition json code.  The template are covered in more detail in [ufo tasks build]({% link _docs/tutorial-ufo-tasks-build.md %}).
+<code>templates/main.json.erb</code>  | This is the main and starter template task definition json file that ufo initially generates.
+
+Now that you know where the ufo configurations are located and what they look like.  Let use ufo!
+
+<a id="prev" class="btn btn-basic" href="{% link _docs/install.md %}">Back</a>
+<a id="next" class="btn btn-primary" href="{% link _docs/tutorial.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-docker-build.md

@@ -0,0 +1,68 @@
+---
+title: ufo docker build
+---
+
+### Step 1 - Build the Docker Image
+
+Let's use the `ufo docker build` command to build the docker image. The command uses the `Dockerfile` in the current project to build the docker image.  You use your own Dockerfile so you have fully control over how you would like the image to be built.  For this tutorial we will continue to use the [tongueroo/hi](https://github.com/tongueroo/hi) app and it's Dockerfile. Let's run the command:
+
+```sh
+ufo docker build
+```
+
+You should see similar output (some of the output has been truncated for conciseness):
+
+```sh
+$ ufo docker build
+Building docker image with:
+  docker build -t tongueroo/hi:ufo-2017-06-11T22-18-03-a18aa30 -f Dockerfile .
+Sending build context to Docker daemon 734.2 kB
+Step 1 : FROM ruby:2.3.3
+ ---> 0e1db669d557
+Step 2 : RUN apt-get update &&   apt-get install -y     build-essential     nodejs &&   rm -rf /var/lib/apt/lists/* && apt-get clean && apt-get purge
+ ---> Using cache
+ ---> 931ace833716
+...
+Step 7 : ADD . /app
+ ---> fae2452e6c35
+Removing intermediate container 4c93f92a7fd8
+Step 8 : RUN bundle install --system
+ ---> Running in f851b9cb7d27
+Using rake 12.0.0
+Using i18n 0.8.1
+...
+Using web-console 2.3.0
+Bundle complete! 12 Gemfile dependencies, 56 gems now installed.
+Bundled gems are installed into /usr/local/bundle.
+ ---> 194830c5c1a8
+...
+Removing intermediate container 67545cd4cd09
+Step 11 : CMD bin/web
+ ---> Running in b1b26e68d957
+ ---> 8547bb48b21f
+Removing intermediate container b1b26e68d957
+Successfully built 8547bb48b21f
+Docker image tongueroo/hi:ufo-2017-06-11T22-18-03-a18aa30 built.  Took 33s.
+$
+```
+
+As you can see `ufo docker build` effectively shells out and calls `docker build -t tongueroo/hi:ufo-2017-06-11T22-18-03-a18aa30 -f Dockerfile .`.  The docker image tag that is generated contains a useful timestamp and the current HEAD git sha of the project that you are on.
+
+By default when you are running `ufo docker build` directly it does not push the docker image to the registry.  If you would like it to automaticaly push the built image to a registry at the end of the build use the `--push` flag.
+
+```sh
+ufo docker build --push
+```
+
+You should see it being pushed at the end:
+
+```sh
+Pushed tongueroo/hi:ufo-2017-06-11T22-22-32-a18aa30 docker image. Took 9s.
+```
+
+Note in order to push the image to a register 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.
+
+<a id="prev" class="btn btn-basic" href="{% link _docs/tutorial-ufo-init.md %}">Back</a>
+<a id="next" class="btn btn-primary" href="{% link _docs/tutorial-ufo-tasks-build.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

@@ -0,0 +1,34 @@
+---
+title: ufo init
+---
+
+The easiest way to create this ufo folder is by using the `ufo init` command.  For this tutorial we'll [tongueroo/hi](https://github.com/tongueroo/hi) which is a small test sinatra app.
+Let's run the command in our newly clone project.
+
+```sh
+git clone https://github.com/tongueroo/hi.git
+cd hi
+ufo init --app=hi --env stag --cluster=stag --image=tongueroo/hi
+```
+
+You should see output similiar to this:
+
+<img src="/img/tutorials/ufo-init.png" class="doc-photo" />
+
+The standard directory structure of the ufo folder looks like this:
+
+```sh
+ufo
+├── output
+├── settings.yml
+├── task_definitions.rb
+└── templates
+    └── main.json.erb
+```
+
+The explanation of the folders and files were covered in detailed earlier at [Structure]({% link _docs/structure.md %}).
+
+<a id="prev" class="btn btn-basic" href="{% link _docs/tutorial.md %}">Back</a>
+<a id="next" class="btn btn-primary" href="{% link _docs/tutorial-ufo-docker-build.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-ship.md

@@ -0,0 +1,64 @@
+---
+title: ufo ship
+---
+
+### Step 3 - Ship the Code to ECS
+
+In this guide we have walked through what ufo does step by step.  First ufo builds the Docker image with `ufo docker build`.  Then it will build and register the ECS task definitions with the `ufo tasks` commands. Now we'll deploy the code to ECS.
+
+```sh
+ufo ship hi-web-stag
+```
+
+The output should look something like this (some of the output has been removed for conciseness):
+
+```sh
+$ ufo ship hi-web-stag
+Building docker image with:
+  docker build -t tongueroo/hi:ufo-2017-06-12T06-46-12-a18aa30 -f Dockerfile .
+...
+Pushed tongueroo/hi:ufo-2017-06-12T06-46-12-a18aa30 docker image. Took 9s.
+Building Task Definitions...
+Generating Task Definitions:
+  ufo/output/hi-web-stag.json
+  ufo/output/hi-worker-stag.json
+  ufo/output/hi-clock-stag.json
+Task Definitions built in ufo/output.
+hi-web-stag task definition registered.
+Shipping hi-web-stag...
+hi-web-stag service updated on stag cluster with task hi-web-stag
+Software shipped!
+Cleaning up docker images...
+Running: docker rmi tongueroo/hi:ufo-2017-06-11T20-32-16-a18aa30 tongueroo/hi:ufo-2017-06-11T20-27-44-bc80e84 tongueroo/hi:ufo-2017-06-11T20-02-18-bc80e84
+```
+
+Checking the ECS console you should see something like this:
+
+<img src="/img/tutorials/ecs-console-ufo-ship.png" class="doc-photo" />
+
+### Skipping Previous Steps
+
+The `ufo ship` command will automatically calls the steps we called manually in the previous pages: `ufo build` and `ufo tasks`.
+
+If you would like to skip the first 2 steps you can use the `--no-docker` and `--no-tasks` flags:
+
+```sh
+ufo ship hi-web-stag --no-docker --no-tasks
+```
+
+The output should look something like this:
+
+```sh
+Shipping hi-web-stag...
+hi-web-stag service updated on stag cluster with task hi-web-stag
+Software shipped!
+```
+
+Normally you run everything together in one `ufo ship` command though.  Ufo takes a multiple step process and simplifies it down to a single command!
+
+Congratulations 🎊 You have successfully built a Docker image, register it and deployed it to AWS ECS.
+
+<a id="prev" class="btn btn-basic" href="{% link _docs/tutorial-ufo-tasks-build.md %}">Back</a>
+<a id="next" class="btn btn-primary" href="{% link _docs/tutorial-ufo-ships.md %}">Next Step</a>
+<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
+