ufo 5.0.5 → 6.0.0

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

@@ -1,52 +0,0 @@
----
-title: Upgrading to Version 4.5
-short_title: Version 4.5
-order: 2
-categories: upgrading
-nav_order: 40
----
-
-In ufo version 4.4 and 4.5, the default cloudformation stack names used by ufo were changed.
-
-* In versions 4.3 and below, the cluster name is prepended to the service name.
-* In version 4.4, the cluster name is appended to the service name.
-* In version 4.5, the Ufo.env name is appended to the service name.
-
-By convention, the cluster name defaults to UFO_ENV. So, by default there is not difference between cluster name and UFO_ENV.  However, if you were using the cluster option then there will be a difference.  Here's a table to help explain:
-
-Version | UFO_ENV | Cluster Name | Stack Name
---- | --- | --- | ---
-4.3 and below | development | mycluster | mycluster-demo-web
-4.4 | development | mycluster | demo-web-mycluster
-4.5 | development | mycluster | 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.5 you can run:
-
-    ufo upgrade v43to45
-
-This updates your `.ufo/settings.yml` file to include `stack_naming: append_ufo_env` which removes a warning message and 20 second delay when you deploy. Example:
-
-.ufo/settings.yml:
-
-```yaml
-base:
-  stack_naming: append_ufo_env
-```
-
-If you would still like to keep the old behavior, you can use:
-
-Version | Setting
---- | ---
-4.3 and below | stack_naming: prepend_cluster
-4.4 | stack_naming: append_cluster
-4.5 | stack_naming: append_ufo_env
-
-## 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/upgrading/upgrade4.md

@@ -1,48 +0,0 @@
----
-title: Upgrading to Version 4.0
-short_title: Version 4.0
-order: 3
-categories: upgrading
-nav_order: 41
----
-
-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.
-
-## Upgrade Steps Summary
-
-The upgrade path recommended here should result in zero downtime. It is effectively a blue/green deployment with a DNS switchover.
-
-1. Run `ufo upgrade v3to4` in your project folder.
-2. Check the changed files.
-3. Run `ufo ship SERVICE`.
-4. Confirm your new service is working. `ufo ps` and `ufo apps` is useful.
-5. Switch the DNS to the new service's endpoint.
-6. Confirm everything on the new service works.
-7. Destroy the old ECS service with the ECS console. Do not destroy it with `ufo destroy` as the `ufo destroy` command will destroy the newly created service.
-
-Note, with ufo version 4, load balancers are supported and automatically created for web services. If you want to use the existing load balancer, you can do so by specifying `--elb existing-target-group-arn`.
-
-### ufo upgrade v3to4
-
-It is recommended that you run the `ufo upgrade v3to4` command with the network options specified. Please substitute the command with the vpc id and subnets for your setup.  Example:
-
-    $ ufo upgrade v3to4 --vpc-id vpc-111 --ecs-subnets subnet-111 subnet-222 --elb-subnets subnet-333 subnet-444 --force
-    Upgrading structure of your current project to the new ufo version 4 project structure
-          append  .dockerignore
-          append  .gitignore
-           force  .ufo/params.yml
-          create  .ufo/settings/cfn/default.yml
-          create  .ufo/settings/network/default.yml
-    Upgrade complete.
-
-If you run the upgrade command without specified options, then ufo will detect and use the default vpc and subnets, which might not be what you want.  Inspect the files and verify that they are what you desired.
-
-### Verify changed files
-
-File | Changes
---- | ---
-.ufo/params.yml | The create_service and update_service sections have been removed. The options handed by CloudFormation and can be customized with `.ufo/settings/cfn/default.yml`. If you have used these options for Fargate support, you no longer need to worry about them.  The generated CloudFormation template detects if the task definition uses Fargate and handles it for you.
-.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.
-
-{% include prev_next.md %}

data/docs/_docs/upgrading/upgrade5.md

@@ -1,19 +0,0 @@
----
-title: Upgrading to Version 5
-short_title: Version 5
-order: 1
-categories: upgrading
-nav_order: 39
----
-
-In ufo v5, the ufo went from underscore key names in the [cfn settings files]({% link _docs/settings/cfn.md %}) to camelized key names. So the auto_camelize behavior is disabled for newly `ufo init` projects. This mean ufo is backwards compatiable. You can enable the v5 behavior with `auto_camelize: false`. If you have not adjusted this setting, then ufo should still work with your current `.ufo` files.
-
-## Upgrading Instructions
-
-If you want to upgrade to the latest ufo v5 default behavior.
-
-1. Adjust your .ufo/settings/cfn files so that the keys are camelized
-2. Add to your .ufo/settings.yml `auto_camelize: false`
-3. Deploy and verify that your ECS app stil works
-
-{% include prev_next.md %}

data/docs/_docs/upgrading.md

@@ -1,13 +0,0 @@
----
-title: Upgrading
-nav_order: 38
----
-
-<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/variables.md

@@ -1,55 +0,0 @@
----
-title: Shared Variables
-nav_order: 18
----
-
-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.
-
-For example, given `variables/base.rb`:
-
-```
-@image = helper.full_image_name # includes the git sha tongueroo/demo-ufo:ufo-[sha].
-@cpu = 128
-@memory_reservation = 256
-@environment = helper.env_file(".env")
-```
-
-You can now use `@image` in your `.ufo/templates/main.json.erb` without having to declare them in the `.ufo/task_definitions.rb` file explicitly.  Variables are automatically made available to all templates and the `task_definition.rb` file.
-
-## Layering
-
-Shared variables also support a concept called layering.  The `variables/base.rb` file is treated specially and will always be evaluated.  Additionally, ufo will also evaluate the `variables/[UFO_ENV].rb` according to what UFO_ENV's value is. Thanks to layering, you can easily override variables to suit different environments like `production` or `development`. For example:
-
-`.ufo/variables/base.rb`:
-
-```ruby
-@image = helper.full_image_name # includes the git sha tongueroo/demo-ufo:ufo-[sha].
-@cpu = 128
-@memory_reservation = 256
-@environment = helper.env_file(".env")
-```
-
-When `ufo ship` is ran with `UFO_ENV=production` the `variables/production.rb` will be evaluated and layered on top of the variables defined in `base.rb`:
-
-`.ufo/variables/production.rb`:
-
-```ruby
-@environment = helper.env_vars(%Q[
-  RAILS_ENV=production
-  SECRET_KEY_BASE=secret
-])
-```
-
-When `ufo ship` is ran with `UFO_ENV=development` the `variables/development.rb` will be evaluated and layered on top of the variables defined in `base.rb`:
-
-
-`.ufo/variables/development.rb`:
-
-```ruby
-@environment = helper.env_vars(%Q[
-  RAILS_ENV=development
-  SECRET_KEY_BASE=secret
-])
-```
-
-{% include prev_next.md %}

data/docs/_includes/about.html

@@ -1,19 +0,0 @@
- <!-- About Section -->
-    <section class="success" id="about">
-        <div class="container">
-            <div class="row">
-                <div class="col-lg-12 text-center">
-                    <h2>About</h2>
-                    <hr class="star-light">
-                </div>
-            </div>
-            <div class="row">
-                <div class="col-lg-4 col-lg-offset-2">
-                    <p>Ufo is a tool that makes building and shipping Docker containers to AWS ECS easy. At a basic level, ufo builds the docker container image, registers that image to ECS as a task definition, and then deploys that task definition to ECS by updating the service. Ufo provides a <code>ufo ship</code> command that deploys your code to ECS.</p>
-                </div>
-                <div class="col-lg-4">
-                    <p>Ufo was built directly from real life production use cases after seeing the same patterns repeated over and over. Ufo allows you to write the AWS task definition json format file in ERB, an easy templating language.  This allows you to reuse the ufo tool with multiple applications and only put the truly application specific business logic in each app code base.</p>
-                </div>
-            </div>
-        </div>
-    </section>

data/docs/_includes/cfn-customize.md

@@ -1,53 +0,0 @@
-The properties in the file `.ufo/settings/cfn/default.yml` map directly to ufo's CloudFormation resources. It allows you to customize the resources.  The keys get transform to CamelCase keys to work with the CloudFormation template.
-
-### Example of Customization
-
-Let's customize the `AWS::ElasticLoadBalancingV2::TargetGroup` resource created by CloudFormation.  We'll adjust the `deregistration_delay.timeout_seconds` to `8`.  Here's the relevant section of the `.ufo/settings/cfn/default.yml`
-
-```
-TargetGroup:
-...
-  TargetGroupAttributes:
-  - Key: deregistration_delay.timeout_seconds
-    Value: 8
-```
-
-The value will be injected to the generated CloudFormation template under the corresponding "TargetGroup Properties".  The generated template looks something like this:
-
-```
-TargetGroup:
-  Properties:
-...
-    TargetGroupAttributes:
-    - Key: deregistration_delay.timeout_seconds
-      Value: 8
-...
-```
-
-In this way, you can customize and override any properties associated with resources created by the ufo CloudFormation stack.
-
-Here's a list of the resources in the [cfn/stack.yml](https://github.com/tongueroo/ufo/blob/master/lib/cfn/stack.yml) that you can customize:
-
-* Ecs
-* EcsSecurityGroup
-* EcsSecurityGroupRule
-* Elb
-* ElbSecurityGroup
-* Listener
-* TargetGroup
-
-## Layering Support
-
-The `base.yml` profile files always get evaluated and env-specific ENV.yml file are layered or merged together. This miminizes duplication.  For example, these files are merged:
-
-* .ufo/settings/cfn/base.yml
-* .ufo/settings/cfn/development.yml
-
-The settings in `development.yml` override the settings in `base.yml`. Here's another example:
-
-* .ufo/settings/network/base.yml
-* .ufo/settings/network/development.yml
-
-Note, this feature is available in v5.0.5+.
-
-For the most up to date list check out the [cfn/stack.yml](https://github.com/tongueroo/ufo/blob/master/lib/cfn/stack.yml) source code directly.

data/docs/_includes/commands.html

@@ -1,80 +0,0 @@
- <!-- About Section -->
-    <section id="about">
-        <div class="container">
-            <div class="row">
-                <div class="col-lg-6">
-                    <h3>Commands</h3>
-                    <div class="commands">
-{% highlight sh %}
-ufo ship
-ufo ps
-ufo current
-ufo apps
-ufo scale
-ufo docker build
-ufo tasks build
-ufo rollback
-ufo destroy
-{% endhighlight %}
-                    </div>
-                </div>
-                <div class="col-lg-6">
-                    <h3>variables/base.rb</h3>
-                    <div class="commands">
-{% highlight ruby %}
-@image = helper.full_image_name # includes the git sha tongueroo/demo-ufo:ufo-[sha].
-@cpu = 128
-@memory_reservation = 256
-@environment = helper.env_vars(%Q{
-  RAILS_ENV=production
-  SITE=awesome
-})
-{% endhighlight %}
-                    </div>
-                </div>
-            </div>
-            <div class="row">
-                <div class="col-lg-6">
-                    <h3>templates/main.json.erb</h3>
-                    <div class="commands">
-{% highlight json %}
-{
-    "family": "<%= @family %>",
-    "containerDefinitions": [
-        {
-            "name": "<%= @name %>",
-            "image": "<%= @image %>",
-            <% if @cpu %>
-            "cpu": <%= @cpu %>,
-            <% end %>
-            "command": <%= @command.to_json %>,
-            <% if @environment %>
-            "environment": <%= @environment.to_json %>,
-            <% end %>
-            "essential": true
-        }
-    ]
-}
-{% endhighlight %}
-                    </div>
-                </div>
-                <div class="col-lg-6">
-                    <h3>template_definitions.rb</h3>
-                    <div class="commands">
-{% highlight ruby %}
-task_definition "example-web" do
-  source "main"
-  variables(
-    family: task_definition_name,
-    name: "web",
-    awslogs_group: "ecs/example-web",
-    awslogs_stream_prefix: "example",
-    command: ["bin/web"]
-  )
-end
-{% endhighlight %}
-                    </div>
-                </div>
-            </div>
-        </div>
-    </section>

data/docs/_includes/contact.html

@@ -1,17 +0,0 @@
-<!-- Contact Section -->
-<section class="success" id="contact">
-    <div class="container">
-        <div class="row">
-            <div class="col-lg-12 text-center">
-                <h2>Learn More</h2>
-                <hr class="star-primary">
-            </div>
-        </div>
-        <div class="row">
-            <div class="col-lg-12 text-center">
-                <div id="success"></div>
-                <a id="next" href="{% link quick-start.md %}" class="btn btn-primary btn-xl">Quick Start</a>
-            </div>
-        </div>
-    </div>
-</section>

data/docs/_includes/contact_disqus.html

@@ -1,16 +0,0 @@
-<!-- Contact Section -->
-   <section id="contact">
-       <div class="container">
-           <div class="row">
-               <div class="col-lg-12 text-center">
-                   <h2>Contact me</h2>
-                   <hr class="star-primary">
-               </div>
-           </div>
-           <div class="row">
-               <div class="col-lg-8 col-lg-offset-2">
-                 <div id="disqus_thread"></div><!-- /#disqus_thread -->
-               </div>
-           </div>
-       </div>
-   </section>

data/docs/_includes/contact_static.html

@@ -1,17 +0,0 @@
-<!-- Contact Section -->
-<section class="success" id="contact">
-	<div class="container">
-		<div class="row">
-			<div class="col-lg-12 text-center">
-				<h2>Learn More</h2>
-				<hr class="star-primary">
-			</div>
-		</div>
-		<div class="row">
-      <div class="col-lg-12 text-center">
-          <div id="success"></div>
-          <button type="submit" class="btn btn-xl">Send Message</button>
-      </div>
-		</div>
-	</div>
-</section>

data/docs/_includes/content.html

@@ -1,26 +0,0 @@
-{% if page.url == "/" %}
-
-    {{ content }}
-
-{% else %}
-
-    <!-- Main section -->
-    <section id="main">
-        <div class="container">
-            <div class="row">
-                {% if page.reference %}
-                <div class="col-md-9 reference-nav">
-                    <a href="/reference">Back to Reference Index</a>
-                </div>
-                {% endif %}
-                <div class="col-md-9 content-body">
-                    <h1>{{ page.title }}</h1>
-                    {{ content }}
-                    {% include edit-on-github.html %}
-                </div>
-                {% include subnav.html %}
-            </div>
-        </div>
-    </section>
-
-{% endif %}