ufo 3.1.2 → 3.2.0

data/docs/_docs/commands.md

@@ -1,10 +0,0 @@
----
-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/ufo-deploy.md

@@ -1,30 +0,0 @@
----
-title: ufo deploy
----
-
-It is useful to sometimes deploy only the task definition without re-building it.  Say for example, you are debugging the task definition and just want to directly edit the `.ufo/output/hi-web.json` definition. You can accomplish this with the `ufo deploy` command.  The `ufo deploy` command will deploy the task definition in `.ufo/output` unmodified.  Example:
-
-```
-ufo deploy hi-web
-```
-
-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]({% link _docs/ufo-ship.md %}) over the `ufo deploy` command do everything in one step:
-
-1. build the Docker image
-2. register the ECS task definition
-3. update the ECS service
-
-The `ufo ships`, `ufo ship`, `ufo deploy` command support the same options. The options are presented here again for convenience:
-
-{% include ufo-ship-options.md %}
-
-
-<a id="prev" class="btn btn-basic" href="{% link _docs/ufo-ships.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/ufo-scale.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
-

data/docs/_docs/ufo-destroy.md

@@ -1,19 +0,0 @@
----
-title: ufo destroy
----
-
-Ufo provides a quick way to destroy an ECS service. In order to destroy an ECS service you must makes sure that the desired number of tasks is first set to 0. It is easy to forgot to do this and waste time. So as part of destroying the service ufo will scale the ECS service down to 0 automatically first and then destroy the service.  Ufo also prompts you before destroying the service.
-
-```
-ufo destroy hi-web
-```
-
-If you would like to bypass the prompt you can use the `--sure` option.
-
-```
-ufo destroy hi-web --sure
-```
-
-<a id="prev" class="btn btn-basic" href="{% link _docs/ufo-scale.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/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/ufo-docker-build.md

@@ -1,79 +0,0 @@
----
-title: ufo docker build
----
-
-The `ufo docker build` builds a Docker image using the Dockerfile in the current project folder.  This simply is a wrapper command that shells out and calls the `docker` command.  We're use the [tongueroo/hi]((https://github.com/tongueroo/hi) project and it's Dockerfile for demonstration.  Example:
-
-```sh
-ufo docker build
-```
-
-You'll see that it calls:
-
-```
-docker build -t tongueroo/hi:ufo-2017-06-11T22-18-03-a18aa30 -f Dockerfile .
-```
-
-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.
-$
-```
-
-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
-Docker image tongueroo/hi:ufo-2017-06-11T22-22-32-a18aa30 built.  Took 34s.
-The push refers to a repository [docker.io/tongueroo/hi]
-ef375857f165: Pushed
-4d791d7cde66: Pushed
-277ff31e79b4: Layer already exists
-a361a4de05df: Layer already exists
-ufo-2017-06-11T22-22-32-a18aa30: digest: sha256:c5385a5084e87643bd943eb120e110321c59e8acd30736ba7b5223eb1143baa8 size: 3464
-Pushed tongueroo/hi:ufo-2017-06-11T22-22-32-a18aa30 docker image. Took 9s.
-```
-
-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.
-
-<a id="prev" class="btn btn-basic" href="{% link _docs/ufo-destroy.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/ufo-docker-push.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
-

data/docs/_docs/ufo-docker-clean.md

@@ -1,27 +0,0 @@
----
-title: ufo docker clean
----
-
-Ufo comes with a handy command to clean up old images that ufo generates. Ufo only deletes images from the docker daemon and does not remove any images from any registry.  To use it you pass the base portion of the image name to the command. Example:
-
-```sh
-ufo docker clean tongueroo/hi
-```
-
-Here is some example output of the commmand:
-
-```sh
-Cleaning up docker images...
-Running: docker rmi tongueroo/hi:ufo-2017-06-12T12-14-22-a18aa30 tongueroo/hi:ufo-2017-06-12T12-12-05-a18aa30
-```
-
-By default the clean command keeps the most 3 recent docker images. If you would like to override this setting you can use the `--keep` option. Example:
-
-```sh
-ufo docker clean tongueroo/hi --keep 5
-```
-
-<a id="prev" class="btn btn-basic" href="{% link _docs/ufo-docker-name.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/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/ufo-docker-name.md

@@ -1,15 +0,0 @@
----
-title: ufo docker name
----
-
-It is sometimes handy to grab the name of the Docker image that was just generated.  Let's say ou needed the image name so you can feed it into another script that you have. The command `ufo docker name` returns the image of the most recently built Docker image. Example:
-
-```sh
-$ ufo docker image
-tongueroo/hi:ufo-2017-06-12T12-34-48-a18aa30
-```
-
-<a id="prev" class="btn btn-basic" href="{% link _docs/ufo-docker-base.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/ufo-docker-clean.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
-

data/docs/_docs/ufo-docker-push.md

@@ -1,43 +0,0 @@
----
-title: ufo docker push
----
-
-The `ufo docker push` command pushes the most recent Docker image built by `ufo docker build` to a registry.  Example:
-
-```sh
-ufo docker build # to build the image
-ufo docker name  # to see the image name
-ufo docker push  # push up the registry
-```
-
-You'll see that `ufo docker push` simply shells out and calls `docker push`:
-
-```
-$ ufo docker push
-=> docker push 123456789.dkr.ecr.us-east-1.amazonaws.com/hi:ufo-2018-02-13T10-51-44-e0cc7be
-The push refers to a repository [123456789.dkr.ecr.us-east-1.amazonaws.com/hi]
-399c739c257d: Layer already exists
-...
-Pushed 123456789.dkr.ecr.us-east-1.amazonaws.com/hi:ufo-2018-02-13T10-51-44-e0cc7be docker image. Took 1s.
-$
-```
-
-You can also specify your own custom image to push as a parameter.
-
-```
-ufo docker push my/image:tag
-```
-
-You could also use the `--push` flag as part of the `ufo docker build` command to achieve the same thing as `ufo docker push`. Some find that `ufo docker push` is more intutitive.
-
-```sh
-ufo docker build --push # same as above
-```
-
-## Docker Authorization
-
-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, ufo will automatically try to authorize you and configure your `~/.docker/config.json`.  If can also use `aws ecr get-login` command.
-
-<a id="prev" class="btn btn-basic" href="{% link _docs/ufo-docker-build.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/ufo-docker-base.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>

data/docs/_docs/ufo-help.md

@@ -1,22 +0,0 @@
----
-title: ufo help
----
-
-You can run help for quick help information right at the cli.  Example:
-
-```sh
-ufo help
-```
-
-You can append `help`, `-h` or `--help` to the end of any command to get more help information about that specific command.  These all work.
-
-```sh
-ufo docker build help
-ufo ship --help
-ufo ships -h
-```
-
-<a id="prev" class="btn btn-basic" href="{% link _docs/ufo-tasks-register.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/settings.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
-

data/docs/_docs/ufo-init.md

@@ -1,54 +0,0 @@
----
-title: ufo init
----
-
-The `ufo init` command provides a way to quickly setup a project to be ufo ready. It creates a ufo folder with all the starter supporting files in order to use ufo.  This page demonstrates how to use `ufo init`.  The command requires these options: `--app` and `--image`.
-
-For this example we will use [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 --image=tongueroo/hi
-```
-
-You should see output similiar to this:
-
-```sh
-$ ufo init --app=hi --image=tongueroo/hi
-Setting up ufo project...
-      create  .ufo/settings.yml
-      create  .ufo/task_definitions.rb
-      create  .ufo/templates/main.json.erb
-      create  .ufo/variables/base.rb
-      create  .ufo/variables/development.rb
-      create  .ufo/variables/production.rb
-      create  Dockerfile
-      create  bin/deploy
-      append  .gitignore
-Starter ufo files created.
-```
-
-The standard directory structure of the ufo folder looks like this:
-
-```sh
-ufo
-├── output
-├── settings.yml
-├── task_definitions.rb
-├── templates
-├   └── main.json.erb
-└── variables
-    ├── base.rb
-    ├── production.rb
-    └── development.rb
-```
-
-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/commands.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/ufo-ship.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
-

data/docs/_docs/ufo-scale.md

@@ -1,21 +0,0 @@
----
-title: ufo scale
----
-
-Ufo provides a command to quickly scale up and down an ECS service. Here's an example of how you use it:
-
-```sh
-ufo scale hi-web 3
-```
-
-You should get output similiar to below:
-
-```sh
-Scale hi-web service in stag cluster to 3
-```
-
-While scaling via this method is quick and convenient the [ECS Service AutoScaling](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html) that is built into ECS is a much more powerful way to manage scaling your ECS service.
-
-<a id="prev" class="btn btn-basic" href="{% link _docs/ufo-deploy.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/ufo-destroy.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>

data/docs/_docs/ufo-ship.md

@@ -1,75 +0,0 @@
----
-title: ufo ship
----
-
-The main command you use when using ufo is: `ufo ship`.  This command builds the docker image, registers the generated ECS task definition and deploys the definition to AWS ECS all in one go.
-
-The command has a decent amount of options, you can see the options available with `ufo ship -h`.  The table below covers some of the options in detail:
-
-{% include ufo-ship-options.md %}
-
-As you can see there are plenty of options for `ufo ship`.  Let's demonstrate usage of them in a few examples:
-
-#### Load Balancer Target Group
-
-When you are deploying to a service with the word 'web' in it, ufo by convention assumes that this is a web service that uses a load balancer in front of it.  This is also covered a in the [Conventions]({% link _docs/conventions.md %}) page.  If you would you like to create a service with the word web without an load balancer associated with it you can use the `--no-target-group-prompt` option:
-
-```sh
-ufo ship hi-web --no-target-group-prompt
-```
-
-Or if you would like specify the target-group up front and not be bother with the prompted later you can use the `--target-group` option.
-
-```sh
-ufo ship hi-web --target-group=arn:aws:elasticloadbalancing:us-east-1:12345689:targetgroup/hi-web/12345
-```
-
-#### Deploying Existing Task Definition
-
-Let's say you already have built an registered a task definition by some other means and only want to use ufo to deploy that already registered task definition. You can do this by skipping the task build and register phase. It probably also makes sense to skip the docker phase in this case.
-
-```sh
-ufo ship hi-web --no-docker --no-tasks
-```
-
-#### Waiting for Deployments to Complete
-
-By default when ufo updates the ECS service with the new task definition it does so asynchronuously. You then normally visit the ECS service console and then refresh until you see that the deployment is completed.  You can also have ufo poll and wait for the deployment to be done with the `--wait` option
-
-```sh
-ufo ship hi-web --wait
-```
-
-You should see output similar to this:
-
-```sh
-Shipping hi-web...
-hi-web service updated on cluster with task hi-web
-Waiting for deployment of task definition hi-web:8 to complete
-......
-Time waiting for ECS deployment: 31s.
-Software shipped!
-```
-
-#### Cleaning up Docker Images Automatically
-
-Since ufo builds the Docker image every time there's a deployment you will end up with a long list of docker images.  Ufo automatically cleans up older docker images at the end of the deploy process if you are using AWS ECR.  By default ufo keeps the most recent 30 Docker images. This can be adjust with the `--ecr-keep` option.
-
-```sh
-docker ship hi-web --ecr-keep 2
-```
-
-You should see something like this:
-
-```sh
-Cleaning up docker images...
-Running: docker rmi tongueroo/hi:ufo-2017-06-12T06-46-12-a18aa30
-```
-
-If you are using DockerHub or another registry, ufo does not automatically clean up images.
-
-
-<a id="prev" class="btn btn-basic" href="{% link _docs/ufo-init.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/ufo-ships.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
-

data/docs/_docs/ufo-ships.md

@@ -1,52 +0,0 @@
----
-title: ufo ships
----
-
-The `ufo ships` command allows you to deploy the *same* Docker image and task definition to multiple ECS services.  This is a very common pattern to have the same code base running on different roles.  For example, say you have an app with 3 roles:
-
-1. web - serves web requests.
-2. worker - processes background jobs.
-3. clock - schedules background jobs.
-
-Instead of using the [ufo ship]({% link _docs/ufo-ship.md %}) and build and deploying the code 3 times you can instead use `ufo ships`.  This will result in the *same* Docker image and *same* task definition being deployed to all 3 services.  Example usage:
-
-```sh
-ufo ships hi-web hi-worker hi-clock
-```
-
-### Shell expansion
-
-Since the ECS service names are provided as a list you can shorten the command by using bash shell expansion 😁
-
-```sh
-ufo ships hi-{web,worker,clock}
-```
-
-If you're new to shell expansion, run this to understand why above works just as well:
-
-```sh
-$ echo hi-{web,worker,clock}
-hi-web hi-worker hi-clock
-```
-
-### Overriding convention
-
-As explained in detail in [Conventions]({% link _docs/conventions.md %}) the task definition and service name are the same by convention.  This convention also applies for each of the services being shipped in the list. The task definition and service names match for each of the services in the list.  If you would like to override the convention as part of the ships command then you use a special syntax. In the special syntax the service and task definition is separated by a colon.  Examples:
-
-```sh
-ufo ships hi-web-1:hi-web hi-clock-1 hi-worker-1
-ufo ships hi-web-1:my-task hi-clock-1:another-task hi-worker-1:third-task
-```
-
-### ufo ships Options
-
-The `ufo ships`, `ufo ship`, `ufo deploy` command support the same options. The options are presented here again for convenience:
-
-{% include ufo-ship-options.md %}
-
-Note: The `--task` option is not used with the `ufo ships` command.
-
-<a id="prev" class="btn btn-basic" href="{% link _docs/ufo-ship.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/ufo-deploy.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
-