ufo 4.3.1 → 4.4.0

data/docs/_docs/single-task.md

@@ -1,5 +1,6 @@
 ---
 title: Run Single Task
+nav_order: 36
 ---
 
 Sometimes you do not want to run a long running `service` but a one time task. Running Rails migrations are an example of a one off task.  Here is an example of how you would run a one time task.
@@ -26,6 +27,4 @@ aws ecs describe-tasks --tasks arn:aws:ecs:us-west-2:994926937775:task/a0e4229d-
 
 You can check out the [ufo task](http://ufoships.com/reference/ufo-task/) reference for more details.
 
-<a id="prev" class="btn btn-basic" href="{% link _docs/run-in-pieces.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/migrations.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
+{% include prev_next.md %}

data/docs/_docs/ssl-support.md

@@ -1,5 +1,6 @@
 ---
 title: SSL Support
+nav_order: 25
 ---
 
 You can configure SSL support by uncomment the `listener_ssl` option in `.ufo/settings/cfn/default.yml`.  Here's an example:
@@ -16,6 +17,4 @@ For the certificate arn, you will need to create a certificate with AWS ACM. To
 
 The protocol will be either HTTP or HTTPS for Application Load Balancers and TCP or TLS for Network Load Balancers. Ufo will infer the right value, so you usually don't have to configure the protocol manually.  You can configure it if required though.
 
-<a id="prev" class="btn btn-basic" href="{% link _docs/ecs-network-mode.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/route53-support.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
+{% include prev_next.md %}

data/docs/_docs/structure.md

@@ -1,5 +1,6 @@
 ---
 title: Structure
+nav_order: 11
 ---
 
 Ufo creates a `.ufo` folder within your project which contains the required files used by ufo to build and deploy docker images to ECS.  The standard directory structure of the `.ufo` folder looks like this:
@@ -36,7 +37,4 @@ File / Directory  | Description
 
 Now that you know where the ufo configurations are located and what they look like, let’s use ufo!
 
-<a id="prev" class="btn btn-basic" href="{% link docs.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>
-
+{% include prev_next.md %}

data/docs/_docs/stuck-cloudformation.md

@@ -1,5 +1,6 @@
 ---
 title: Stuck CloudFormation
+nav_order: 34
 ---
 
 The CloudFormation stack update or creation can get stuck in a `*_IN_PROGRESS` state for a very long time, like more than an hour.  This happens when you deploy an ECS service that fails to stabilize. Usually, this is an error with the Docker container failing to start up successfully.
@@ -25,6 +26,4 @@ To cancel a current deploy, run:
 
 This is the same thing as canceling the stack update in the CloudFormation console.
 
-<a id="prev" class="btn btn-basic" href="{% link _docs/customize-cloudformation.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/upgrade4.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
+{% include prev_next.md %}

data/docs/_docs/tutorial-ufo-docker-build.md

@@ -1,5 +1,6 @@
 ---
 title: Build Docker
+nav_order: 6
 ---
 
 ## Build the Docker Image
@@ -57,7 +58,4 @@ Docker push took 12s.
 
 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 automatically calls the `aws ecr get-login` command and authenticates for you.
 
-<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>
-
+{% include prev_next.md %}

data/docs/_docs/tutorial-ufo-init.md

@@ -1,5 +1,6 @@
 ---
 title: Setup Ufo
+nav_order: 5
 ---
 
 The easiest way to create this ufo folder is by using the `ufo init` command.  For this tutorial we'll [tongueroo/demo-ufo](https://github.com/tongueroo/demo-ufo) which is a small test sinatra app.
@@ -88,7 +89,4 @@ The `image` value is the name that ufo will use as a base portion of the name to
 
 The other settings are optional.  You can learn more about them at [Settings]({% link _docs/settings.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>
-
+{% include prev_next.md %}

data/docs/_docs/tutorial-ufo-ship.md

@@ -1,5 +1,6 @@
 ---
 title: Deploy One App
+nav_order: 8
 ---
 
 ## Step 3 - Ship the Code to ECS
@@ -91,6 +92,4 @@ We've been typing the `demo-web` service name explicitly.  We can set the curren
 
 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>
+{% include prev_next.md %}

data/docs/_docs/tutorial-ufo-ships.md

@@ -1,5 +1,6 @@
 ---
 title: Deploy Multiple Apps
+nav_order: 9
 ---
 
 You might have noticed in the tutorial that the generated starter .ufo folder contains 3 task definitions a `web`, `worker` and `clock` role.  This is a common pattern.  The web process handles web traffic, the worker process handles background job processing that would be too slow and potentially block web requests, and a clock process is typically used to schedule recurring jobs.
@@ -34,6 +35,4 @@ ufo ships demo-{web,worker,clock}
 
 In the case of the `ufo ships` command the `--wait` option defaults to false so that all the specified ECS services update in parallel.  You can check on the status of the update on the CloudFormation console.
 
-<a id="prev" class="btn btn-basic" href="{% link _docs/tutorial-ufo-ship.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link docs.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
+{% include prev_next.md %}

data/docs/_docs/tutorial-ufo-tasks-build.md

@@ -1,5 +1,6 @@
 ---
 title: Task Definitions
+nav_order: 7
 ---
 
 ## Build the ECS Task Definitions
@@ -173,6 +174,4 @@ demo-worker task definition registered.
 $
 ```
 
-<a id="prev" class="btn btn-basic" href="{% link _docs/tutorial-ufo-docker-build.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/tutorial-ufo-ship.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
+{% include prev_next.md %}

data/docs/_docs/tutorial.md

@@ -1,5 +1,6 @@
 ---
 title: Tutorial
+nav_order: 4
 ---
 
 In the next sections, we'll walk through using ufo in detail. We will ufo-ify a project. Then we'll go through the step by step process that ufo automated.  Normally ufo is not really used in step like fashion like in this tutorial, but going through it step by step really helps to understand how ufo works.  Here are the steps we'll go through:
@@ -10,6 +11,4 @@ In the next sections, we'll walk through using ufo in detail. We will ufo-ify a
 
 Let's start!
 
-<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-ufo-init.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
+{% include prev_next.md %}

data/docs/_docs/ufo-current.md

@@ -1,5 +1,6 @@
 ---
 title: Ufo Current
+nav_order: 21
 ---
 
 ## service
@@ -45,6 +46,4 @@ This can be shorten with with current also.
     ufo current --services demo-web demo-worker demo-clock
     ufo ships
 
-<a id="prev" class="btn btn-basic" href="{% link _docs/ufo-env-extra.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/load-balancer.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
+{% include prev_next.md %}

data/docs/_docs/ufo-env-extra.md

@@ -1,5 +1,6 @@
 ---
 title: UFO_ENV_EXTRA
+nav_order: 20
 ---
 
 Ufo has an concept of extra environments. This is controlled by the `UFO_ENV_EXTRA` variable.  By setting `UFO_ENV_EXTRA` you can create additional identical ECS services or environments.
@@ -16,6 +17,4 @@ The precedence:
 1. UFO_ENV_EXTRA - takes highest precedence
 2. `.ufo/current` env-extra setting - takes lower precedence
 
-<a id="prev" class="btn btn-basic" href="{% link _docs/ufo-env.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/ufo-current.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
+{% include prev_next.md %}

data/docs/_docs/ufo-env.md

@@ -1,5 +1,6 @@
 ---
 title: UFO_ENV
+nav_order: 19
 ---
 
 Ufo's behavior is controlled by the `UFO_ENV` environment variable.  For example, the `UFO_ENV` variable is used to layer different ufo variable files together to make it easy to specify settings for different environments like production and development.  This is covered thoroughly in the [Variables]({% link _docs/variables.md %}) section.  `UFO_ENV` defaults to `development` when not set.
@@ -44,6 +45,4 @@ AWS_PROFILE=whatever => UFO_ENV=development # since there are no profiles that m
 
 Notice how `AWS_PROFILE=whatever` results in `UFO_ENV=development`.  This is because there are no matching aws_profiles in the `settings.yml`.  More info on settings is available at [settings]({% link _docs/settings.md %}).
 
-<a id="prev" class="btn btn-basic" href="{% link _docs/conventions.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/ufo-env-extra.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
+{% include prev_next.md %}

data/docs/_docs/ufo-tasks-register.md

@@ -18,5 +18,4 @@ demo-worker task definition registered.
 
 You can verify that the task definitions have been registered properly by viewing the AWS ECS Console Task Definitions page.  You should see something similar to this:
 
-<img src="/img/tutorials/ecs-console-task-definitions.png" class="doc-photo" />
-
+<img src="/img/tutorials/ecs-console-task-definitions.png" class="doc-photo" />

data/docs/_docs/upgrading.md

@@ -0,0 +1,13 @@
+---
+title: Upgrading
+nav_order: 29
+---
+
+<ul>
+{% assign docs = site.docs | where: "categories","upgrading" | sort: "order" %}
+{% for doc in docs -%}
+  <li><a href='{{doc.url}}'>{{doc.title}}</a></li>
+{% endfor %}
+</ul>
+
+{% include prev_next.md %}

data/docs/_docs/upgrading/upgrade4.4.md

@@ -0,0 +1,39 @@
+---
+title: Upgrading to Version 4.4
+short_title: Version 4.4
+nav_order: 30
+order: 1
+categories: upgrading
+---
+
+In ufo version 4.4, the environment name gets appends to the end of the CloudFormation stack name.  Previous versions prepended the environment name to the stack name. This means a new stack gets created if you're going from version 4.3 to 4.4. For example:
+
+Version | Stack Name
+--- | ---
+4.3 and below | development-demo-web
+4.4 and above | demo-web-development
+
+You must upgrade to using the new stack and delete the old stack manually.  You can delete the old stack with the CloudFormation console by selecting the old stack, clicking Actions, and *Delete Stack*.
+
+## Upgrading Instructions
+
+To upgrade from version 4.3 to 4.4 you can run:
+
+    ufo upgrade v43to44
+
+This updates your `.ufo/settings.yml` file to include `stack_naming: append_env` which removes a warning message and 20 second delay when you deploy. Example:
+
+.ufo/settings.yml:
+
+```yaml
+base:
+  stack_naming: append_env
+```
+
+If you would still like to keep the old behavior, you can use `stack_naming: prepend_env` for now. However, support for prepend_env will be removed in future versions.
+
+## Reasoning
+
+CloudFormation names the resources it creates with the beginning portion of the stack name. When the stack name prepends the environment then resources like ELBs a little bit harder to identify since they might be named something like this `product-Elb-K0LFFQ9LK50W`. It makes it harder to distinguish ELBs from different apps created by ufo.
+
+{% include prev_next.md %}

data/docs/_docs/{upgrade4.md → upgrading/upgrade4.md}

@@ -1,5 +1,9 @@
 ---
-title: Upgrading to Version 4
+title: Upgrading to Version 4.0
+short_title: Version 4.0
+nav_order: 31
+order: 2
+categories: upgrading
 ---
 
 A major change in ufo from version 3 to 4 is that the ECS service is now created by CloudFormation. If you have an existing ECS service deployed by ufo version 3, when you deploy your app again with ufo version 4, there will be a new additional ECS service created. Here is the recommended upgrade path.
@@ -41,6 +45,4 @@ File | Changes
 .ufo/settings/cfn/default.yml | Starter cfn settings file.
 .ufo/settings/network/default.yml | This generated file will have the vpc and subnets that you specified above.  You can change them directly in this file to control what network settings ufo uses.
 
-<a id="prev" class="btn btn-basic" href="{% link _docs/stuck-cloudformation.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>
+{% include prev_next.md %}

data/docs/_docs/variables.md

@@ -1,5 +1,6 @@
 ---
 title: Shared Variables
+nav_order: 16
 ---
 
 Often, you end up using the set of common variables across your task definitions for a project.  Ufo supports a shared variables concept to support this.  You specify variables files in the `.ufo/variables` folder and they are made available to your `.ufo/task_definitions.rb` as well as your `.ufo/templates` files.
@@ -51,6 +52,4 @@ When `ufo ship` is ran with `UFO_ENV=development` the `variables/development.rb`
 ])
 ```
 
-<a id="prev" class="btn btn-basic" href="{% link _docs/params.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/helpers.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
+{% include prev_next.md %}

data/docs/_docs/why-cloudformation.md

@@ -1,5 +1,6 @@
 ---
 title: Why CloudFormation
+nav_order: 32
 ---
 
 Version 3 of ufo was a simpler implementation and did not make use of CloudFormation to create the ECS service. In version 4, ufo uses CloudFormation to create the ECS Service.  This is because ufo became more powerful. Notably, support for Load Balancers was added. With this power, also came added complexity. So the complexity was push onto CloudFormation.  Hence, ECS service is implemented as CloudFormation resource in version 4.
@@ -17,6 +18,4 @@ You can check the resources created with CloudFormation by clicking on the stack
 
 <img src="/img/docs/cloudformation-resources.png" class="doc-photo" />
 
-<a id="prev" class="btn btn-basic" href="{% link _docs/faq.md %}">Back</a>
-<a id="next" class="btn btn-primary" href="{% link _docs/customize-cloudformation.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
+{% include prev_next.md %}

data/docs/_includes/prev_next.md

@@ -0,0 +1,19 @@
+{% assign all_pages = site.pages | concat: site.docs | where_exp: "item", "item.nav_order" %}
+{% assign links = all_pages | sort: "nav_order" %}
+{% for link in links %}
+	{% if link.url == page.url %}
+		{% unless forloop.first %}
+			{% assign prev = tmpprev %}
+		{% endunless %}
+		{% if forloop.last %}
+		  {% assign last = "/reference" %}
+		{% else %}
+			{% assign next = links[forloop.index] %}
+		{% endif %}
+	{% endif %}
+	{% assign tmpprev = link %}
+{% endfor %}
+
+{% if prev %}<a id="prev" class="btn btn-basic" href="{{ prev.url }}">Back</a>{% endif %}{% if last %}<a id="next" class="btn btn-primary" href="/reference">Next Step</a>{% endif %}
+{% if next %}<a id="next" class="btn btn-primary" href="{{ next.url }}">Next Step</a>{% endif %}
+<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>

data/docs/_includes/subnav.html

@@ -33,12 +33,19 @@
                 <li><a href="{% link _docs/redirection-support.md %}">Redirection Support</a></li>
                 <li><a href="{% link _docs/faq.md %}">FAQ</a></li>
             </ul>
+        <li><a href="{% link _docs/upgrading.md %}">Upgrading</a>
+            <ul>
+                {% assign docs = site.docs | where: "categories","upgrading" | sort: "order" %}
+                {% for doc in docs -%}
+                  <li><a href='{{doc.url}}'>{{doc.short_title}}</a></li>
+                {% endfor %}
+            </ul>
+        </li>
         <li>More
             <ul>
                 <li><a href="{% link _docs/why-cloudformation.md %}">Why CloudFormation</a></li>
                 <li><a href="{% link _docs/customize-cloudformation.md %}">Customize CloudFormation</a></li>
                 <li><a href="{% link _docs/stuck-cloudformation.md %}">Stuck CloudFormation</a></li>
-                <li><a href="{% link _docs/upgrade4.md %}">Upgrade 4</a></li>
                 <li><a href="{% link _docs/run-in-pieces.md %}">Run In Pieces</a></li>
                 <li><a href="{% link _docs/single-task.md %}">Run Single Task</a></li>
                 <li><a href="{% link _docs/migrations.md %}">Database Migrations</a></li>

data/docs/_reference/{ufo-upgrade-v3_3to3_4.md → ufo-upgrade-v33to34.md}

@@ -1,11 +1,11 @@
 ---
-title: ufo upgrade v3_3to3_4
+title: ufo upgrade v33to34
 reference: true
 ---
 
 ## Usage
 
-    ufo upgrade v3_3to3_4
+    ufo upgrade v33to34
 
 ## Description
 

data/docs/_reference/ufo-upgrade-v43to44.md

@@ -0,0 +1,15 @@
+---
+title: ufo upgrade v43to44
+reference: true
+---
+
+## Usage
+
+    ufo upgrade v43to44
+
+## Description
+
+Upgrade from version 4.3 to 4.4
+
+
+

data/docs/_reference/ufo-upgrade.md

@@ -14,8 +14,9 @@ upgrade subcommands
 ## Subcommands
 
 * [ufo upgrade v2to3]({% link _reference/ufo-upgrade-v2to3.md %}) - Upgrade from version 2 to 3.
-* [ufo upgrade v3_3to3_4]({% link _reference/ufo-upgrade-v3_3to3_4.md %}) - Upgrade from version 3.3 to 3.4
+* [ufo upgrade v33to34]({% link _reference/ufo-upgrade-v33to34.md %}) - Upgrade from version 3.3 to 3.4
 * [ufo upgrade v3to4]({% link _reference/ufo-upgrade-v3to4.md %}) - Upgrade from version 3 to 4.
+* [ufo upgrade v43to44]({% link _reference/ufo-upgrade-v43to44.md %}) - Upgrade from version 4.3 to 4.4
 
 ## Options
 

data/docs/articles.md

@@ -1,5 +1,6 @@
 ---
 title: Articles
+nav_order: 40
 ---
 
 * [How to Create Unlimited Extra Environments
@@ -10,6 +11,4 @@ title: Articles
 * [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)
 * [Ufo Ship on AWS ECS Presentation](http://www.slideshare.net/tongueroo/ufo-ship-for-aws-ecs-70885296)
 
-<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/next-steps.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
+{% include prev_next.md %}

data/docs/docs.md

@@ -1,5 +1,6 @@
 ---
 title: Docs
+nav_order: 10
 ---
 
 ## Overview
@@ -25,7 +26,4 @@ You might like these articles:
 
 Also, the [UFO Tutorial Docs]({% link _docs/tutorial.md %}) provide a detail walkthrough on how each UFO step works.
 
-<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/structure.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
-
+{% include prev_next.md %}

data/docs/quick-start.md

@@ -1,5 +1,6 @@
 ---
-title: "Quick Start: Fargate"
+title: 'Quick Start: Fargate'
+nav_order: 1
 ---
 
 ## What is ECS Fargate?
@@ -126,5 +127,4 @@ Here's an article that compares the cost of ECS Fargate: [Heroku vs ECS Fargate
 
 {% include repo_push_access.md %}
 
-<a id="next" class="btn btn-primary" href="{% link _docs/quick-start-ec2.md %}">Next Step</a>
-<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>
+{% include prev_next.md %}