ufo 3.5.7 → 4.0.0

data/docs/_reference/ufo-ps.md

@@ -0,0 +1,53 @@
+---
+title: ufo ps
+reference: true
+---
+
+## Usage
+
+    ufo ps SERVICE
+
+## Description
+
+Show process info on ECS service.
+
+## Examples
+
+    $ ufo ps
+    => Service: demo-web
+       Service name: development-demo-web-Ecs-7GAUAXH5F56M
+       Status: ACTIVE
+       Running count: 2
+       Desired count: 2
+       Launch type: FARGATE
+       Task definition: demo-web:85
+       Elb: develop-Elb-1M74CLRS2G0Z4-686742146.us-east-1.elb.amazonaws.com
+    +----------+------+-------------+----------------+---------+-------+
+    |    Id    | Name |   Release   |    Started     | Status  | Notes |
+    +----------+------+-------------+----------------+---------+-------+
+    | f590ee5e | web  | demo-web:85 | 47 minutes ago | RUNNING |       |
+    | fb60ba9f | web  | demo-web:85 | 45 minutes ago | RUNNING |       |
+    +----------+------+-------------+----------------+---------+-------+
+
+Skip the summary info:
+
+    $ ufo ps --no-summary
+    +----------+------+-------------+----------------+---------+-------+
+    |    Id    | Name |   Release   |    Started     | Status  | Notes |
+    +----------+------+-------------+----------------+---------+-------+
+    | f590ee5e | web  | demo-web:85 | 48 minutes ago | RUNNING |       |
+    | fb60ba9f | web  | demo-web:85 | 45 minutes ago | RUNNING |       |
+    +----------+------+-------------+----------------+---------+-------+
+
+
+## Options
+
+```
+[--summary], [--no-summary]  # Display summary header info.
+                             # Default: true
+[--verbose], [--no-verbose]  
+[--mute], [--no-mute]        
+[--noop], [--no-noop]        
+[--cluster=CLUSTER]          # Cluster.  Overrides .ufo/settings.yml.
+```
+

data/docs/_reference/ufo-releases.md

@@ -0,0 +1,40 @@
+---
+title: ufo releases
+reference: true
+---
+
+## Usage
+
+    ufo releases SERVICE
+
+## Description
+
+Show possible 'releases' or task definitions for the service.
+
+## Example
+
+    $ ufo releases
+    Recent task definitions for this service:
+      demo-web:86
+      demo-web:85
+      demo-web:84
+      demo-web:83
+      demo-web:82
+      demo-web:81
+      demo-web:80
+      demo-web:79
+      demo-web:78
+      demo-web:77
+      demo-web:76
+    $
+
+
+## Options
+
+```
+[--verbose], [--no-verbose]  
+[--mute], [--no-mute]        
+[--noop], [--no-noop]        
+[--cluster=CLUSTER]          # Cluster.  Overrides .ufo/settings.yml.
+```
+

data/docs/_reference/ufo-resources.md

@@ -0,0 +1,44 @@
+---
+title: ufo resources
+reference: true
+---
+
+## Usage
+
+    ufo resources SERVICE
+
+## Description
+
+The ECS service resources.
+
+Displays information about the service.
+
+## Examples
+
+    $ ufo resources demo-web
+    Resources:
+    Ecs - AWS::ECS::Service:
+      arn:aws:ecs:us-east-1:111111111111:service/dev-demo-web-Ecs-KN8OVQ7L2N40
+    EcsSecurityGroupRule - AWS::EC2::SecurityGroupIngress:
+      EcsSecurityGroupRule
+    EcsSecurityGroup - AWS::EC2::SecurityGroup:
+      sg-63c17228
+    Elb - AWS::ElasticLoadBalancingV2::LoadBalancer:
+      arn:aws:elasticloadbalancing:us-east-1:111111111111:loadbalancer/app/dev-hi-Elb-1KEVRDILLSUC9/0b9434b7a9a66fb7
+    ElbSecurityGroup - AWS::EC2::SecurityGroup:
+      sg-11b1025a
+    Listener - AWS::ElasticLoadBalancingV2::Listener:
+      arn:aws:elasticloadbalancing:us-east-1:111111111111:listener/app/dev-hi-Elb-1KEVRDILLSUC9/0b9434b7a9a66fb7/1996f1f252d7ba2e
+    TargetGroup - AWS::ElasticLoadBalancingV2::TargetGroup:
+      arn:aws:elasticloadbalancing:us-east-1:111111111111:targetgroup/dev-h-Targe-1VUFA8577XWT7/7e67276c182fdc87
+
+
+## Options
+
+```
+[--verbose], [--no-verbose]  
+[--mute], [--no-mute]        
+[--noop], [--no-noop]        
+[--cluster=CLUSTER]          # Cluster.  Overrides .ufo/settings.yml.
+```
+

data/docs/_reference/ufo-rollback.md

@@ -0,0 +1,59 @@
+---
+title: ufo rollback
+reference: true
+---
+
+## Usage
+
+    ufo rollback SERVICE VERSION
+
+## Description
+
+Rolls back to older task definition.
+
+## Examples
+
+You only need to specific the task definition version number, though you can specify the name also
+
+    ufo rollback demo-web 1
+    ufo rollback demo-web demo-web:1
+
+To see recent task definitions:
+
+    ufo releases
+
+If you set a current service with `ufo current`, then the commands get shorten:
+
+    ufo rollback demo-web:1
+    ufo rollback 1
+
+Note, task definitions get created by many ways with more than just `ufo ship`. So it the previous version might not be the latest version number minus one.
+
+## Using image name
+
+Another way to specify the version for rollback is with the container definition's image value.  Here's the portion of the ecs task definition that you would look for:
+
+    ...
+    "container_definitions": [
+      {
+        "name": "web",
+        "image": "tongueroo/demo-ufo:ufo-2018-06-21T15-03-52-ac60240",
+        "cpu": 256,
+    ...
+
+You only need to specify enough for a match to be found.  Ufo searches the 30 most recent task definitions. So all of these would work:
+
+    ufo rollback tongueroo/demo-ufo:ufo-2018-06-21T15-03-52-ac60240
+    ufo rollback 2018-06-21T15-03-52
+    ufo rollback ac60240
+
+
+## Options
+
+```
+[--verbose], [--no-verbose]  
+[--mute], [--no-mute]        
+[--noop], [--no-noop]        
+[--cluster=CLUSTER]          # Cluster.  Overrides .ufo/settings.yml.
+```
+

data/docs/_reference/ufo-scale.md

@@ -13,8 +13,28 @@ Scale the ECS service.
 
 Ufo provides a command to scale up and down an ECS service quickly. It is a simple wrapper for `aws ecs update-service --service xxx ----desired-count xxx`.  Here's an example of how you use it:
 
-    $ ufo scale hi-web 3
-    Scale hi-web service in stag cluster to 3
+    $ ufo scale 3
+    Scale demo-web service in development cluster to 3
+
+It is useful to use `ufo ps` to check the status.
+
+    $ ufo ps
+    => Service: demo-web
+       Service name: development-demo-web-Ecs-7GAUAXH5F56M
+       Status: ACTIVE
+       Running count: 2
+       Desired count: 3
+       Launch type: FARGATE
+       Task definition: demo-web:85
+       Elb: develop-Elb-1M74CLRS2G0Z4-686742146.us-east-1.elb.amazonaws.com
+    +----------+------+-------------+----------------+--------------+-------+
+    |    Id    | Name |   Release   |    Started     |    Status    | Notes |
+    +----------+------+-------------+----------------+--------------+-------+
+    | 8f95ef9d | web  | demo-web:85 | PENDING        | PROVISIONING |       |
+    | f590ee5e | web  | demo-web:85 | 50 minutes ago | RUNNING      |       |
+    | fb60ba9f | web  | demo-web:85 | 48 minutes ago | RUNNING      |       |
+    +----------+------+-------------+----------------+--------------+-------+
+    $
 
 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.
 
@@ -25,6 +45,6 @@ While scaling via this method is quick and convenient the [ECS Service AutoScali
 [--verbose], [--no-verbose]  
 [--mute], [--no-mute]        
 [--noop], [--no-noop]        
-[--cluster=CLUSTER]          # Cluster.  Overrides ufo/settings.yml.
+[--cluster=CLUSTER]          # Cluster.  Overrides .ufo/settings.yml.
 ```
 

data/docs/_reference/ufo-ship.md

@@ -19,15 +19,15 @@ The main command you use when using ufo is: `ufo ship`.  This command:
 
 Basic usage is:
 
-    ufo ship hi-web
+    ufo ship demo-web
 
 The ECS service gets created if the service does not yet exist on the cluster.
 
 ### Conventions
 
-By convention the task and service names match. If you need override to this convention then you can specific the task.  For example if you want to ship to the `hi-web-1` service and use the `hi-web` task, run:
+By convention the task and service names match. If you need override to this convention then you can specific the task.  For example if you want to ship to the `demo-web-1` service and use the `demo-web` task, run:
 
-    ufo ship hi-web-1 --task hi-web
+    ufo ship demo-web-1 --task demo-web
 
 ## Options in Detail
 
@@ -37,15 +37,31 @@ The command has a decent amount of options, you can see the options available wi
 
 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
+### Load Balancer
 
-When you are deploying to a service with the word 'web' in it, ufo 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.  The deploy will prompt you for the ELB `--target-group`  if the ECS does not yet exist.  For non-web container the `--target-group` option gets ignored.  The prommpt can be bypassed by specifying a valid `--target-group` option or specifying the `---no-target-group-prompt` option.
+ECS services can be associated with a Load Balancer upon creation. Ufo can automatically create a load balancer.  The options:
 
-    ufo ship hi-web --no-target-group-prompt
+1. Automatically create the ELB.
+2. Provide a target group from an existing ELB.
+3. No ELB is created.
 
-Or if you would like to specify the target-group upfront and not be bother with the prompted later you can use the `--target-group` option.
+Here are examples for each of them:
 
-    ufo ship hi-web --target-group=arn:aws:elasticloadbalancing:us-east-1:12345689:targetgroup/hi-web/12345
+    ufo ship demo-web --elb=true
+
+    # Use existing target group from pre-created ELB:
+    ufo ship demo-web --elb=arn:aws:elasticloadbalancing:us-east-1:123456789:targetgroup/target-name/2378947392743
+
+    # Disable creating elb and prompt:
+    ufo ship demo-web --elb=false
+
+Note, if the docker container's name is web then the `--elb` flag defaults to true automatically.
+
+If you need to create a network load balancer with pre-allocated EIPs, you can use `--elb-eip-ids`, example:
+
+    ufo deploy demo-web --elb-eip-ids eipalloc-a8de9ca1 eipalloc-a8de9ca2
+
+More info available at the [load balancer docs](http://ufoships.com/docs/load-balancer/).
 
 ### Deploying Task Definition without Docker Build
 
@@ -55,27 +71,37 @@ Let's you want skip the docker build phase and only want use ufo to deploy a tas
 
 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
 
-    ufo ship hi-web --wait
+    ufo ship demo-web --wait
 
 You should see output similar to this:
 
-    Shipping hi-web...
-    hi-web service updated on cluster with task hi-web
-    Waiting for deployment of task definition hi-web:8 to complete
+    Shipping demo-web...
+    demo-web service updated on cluster with task demo-web
+    Waiting for deployment of task definition demo-web:8 to complete
     ......
     Time waiting for ECS deployment: 31s.
     Software shipped!
 
+### Route 53 DNS Support
+
+Ufo can automatically create a "pretty" route53 record an set it to the created ELB dns name. This is done in by configuring the `.ufo/settings/network/[profile].yml` file. Example:
+
+    dns:
+      name: "{stack_name}.mydomain.com."
+      hosted_zone_name: mydomain.com. # dont forget the trailing period
+
+Refer to [Route53 Support](http://ufoships.com/docs/route53-support/) for more info.
+
 ### 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.
 
-    docker ship hi-web --ecr-keep 2
+    docker ship demo-web --ecr-keep 2
 
 You should see something like this:
 
     Cleaning up docker images...
-    Running: docker rmi tongueroo/hi:ufo-2017-06-12T06-46-12-a18aa30
+    Running: docker rmi tongueroo/demo-ufo:ufo-2017-06-12T06-46-12-a18aa30
 
 If you are using DockerHub or another registry, ufo does not automatically clean up images.
 
@@ -83,18 +109,19 @@ If you are using DockerHub or another registry, ufo does not automatically clean
 ## Options
 
 ```
-[--task=TASK]                                        # ECS task name, to override the task name convention.
-[--target-group=TARGET_GROUP]                        # ELB Target Group ARN.
-[--target-group-prompt], [--no-target-group-prompt]  # Enable Target Group ARN prompt
-                                                     # Default: true
-[--wait], [--no-wait]                                # Wait for deployment to complete
-[--pretty], [--no-pretty]                            # Pretty format the json for the task definitions
-                                                     # Default: true
-[--stop-old-tasks], [--no-stop-old-tasks]            # Stop old tasks after waiting for deploying to complete
-[--ecr-keep=N]                                       # ECR specific cleanup of old images.  Specifies how many images to keep.  Only runs if the images are ECR images. Defaults keeps all images.
-[--verbose], [--no-verbose]                          
-[--mute], [--no-mute]                                
-[--noop], [--no-noop]                                
-[--cluster=CLUSTER]                                  # Cluster.  Overrides ufo/settings.yml.
+[--ecr-keep=N]                             # ECR specific cleanup of old images.  Specifies how many images to keep.  Only runs if the images are ECR images. Defaults keeps all images.
+[--elb=ELB]                                # Decides to create elb, not create elb or use existing target group.
+[--elb-eip-ids=one two three]              # EIP Allocation ids to use for network load balancer.
+[--elb-type=ELB_TYPE]                      # ELB type: application or network. Keep current deployed elb type when not specified.
+[--pretty], [--no-pretty]                  # Pretty format the json for the task definitions
+                                           # Default: true
+[--stop-old-tasks], [--no-stop-old-tasks]  # Stop old tasks as part of deployment to speed it up
+[--task=TASK]                              # ECS task name, to override the task name convention.
+[--wait], [--no-wait]                      # Wait for deployment to complete
+                                           # Default: true
+[--verbose], [--no-verbose]                
+[--mute], [--no-mute]                      
+[--noop], [--no-noop]                      
+[--cluster=CLUSTER]                        # Cluster.  Overrides .ufo/settings.yml.
 ```
 

data/docs/_reference/ufo-ships.md

@@ -19,7 +19,7 @@ The `ufo ships` command allows you to deploy the *same* Docker image and task de
 
 Instead of using the [ufo ship]({% link _reference/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:
 
-    ufo ships hi-web hi-worker hi-clock
+    ufo ships demo-web demo-worker demo-clock
 
 ## Shell expansion
 
@@ -30,14 +30,14 @@ Since the ECS service names are provided as a list you can shorten the command b
 If you're new to shell expansion, run this to understand why above works just as well:
 
     $ echo hi-{web,worker,clock}
-    hi-web hi-worker hi-clock
+    demo-web demo-worker demo-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:
 
-    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 demo-web-1:demo-web demo-clock-1 demo-worker-1
+    ufo ships demo-web-1:my-task demo-clock-1:another-task demo-worker-1:third-task
 
 ## ufo ships Options
 
@@ -47,31 +47,22 @@ The `ufo ships`, `ufo ship`, `ufo deploy` command support the same options. The
 
 Note: The `--task` option is not used with the `ufo ships` command.
 
-## ELB Target Group
-
-For each service being deployed to, ufo will create the ECS service if the service does not yet exist on the cluster.  The deploy process will prompt you for the ELB `--target-group` if you are deploying to a 'web' service that does not yet exist.  Ufo determines that it is a web service by the name of the service. If the service has 'web' in the name then it is considered a web service. If it is not a web service then the `--target-group` option gets ignored.
-
-The prommt can be bypassed by specifying a valid `--target-group` option or specifying the `---no-target-group-prompt` option.  ## Examples
-
-    ufo ships hi-web hi-clock hi-worker --target-group arn:aws:elasticloadbalancing:us-east-1:123456789:targetgroup/hi-web/jsdlfjsdkd
-    ufo ships hi-web hi-clock hi-worker --no-target-group-prompt
-
 
 ## Options
 
 ```
-[--task=TASK]                                        # ECS task name, to override the task name convention.
-[--target-group=TARGET_GROUP]                        # ELB Target Group ARN.
-[--target-group-prompt], [--no-target-group-prompt]  # Enable Target Group ARN prompt
-                                                     # Default: true
-[--wait], [--no-wait]                                # Wait for deployment to complete
-[--pretty], [--no-pretty]                            # Pretty format the json for the task definitions
-                                                     # Default: true
-[--stop-old-tasks], [--no-stop-old-tasks]            # Stop old tasks after waiting for deploying to complete
-[--ecr-keep=N]                                       # ECR specific cleanup of old images.  Specifies how many images to keep.  Only runs if the images are ECR images. Defaults keeps all images.
-[--verbose], [--no-verbose]                          
-[--mute], [--no-mute]                                
-[--noop], [--no-noop]                                
-[--cluster=CLUSTER]                                  # Cluster.  Overrides ufo/settings.yml.
+[--ecr-keep=N]                             # ECR specific cleanup of old images.  Specifies how many images to keep.  Only runs if the images are ECR images. Defaults keeps all images.
+[--elb=ELB]                                # Decides to create elb, not create elb or use existing target group.
+[--elb-eip-ids=one two three]              # EIP Allocation ids to use for network load balancer.
+[--elb-type=ELB_TYPE]                      # ELB type: application or network. Keep current deployed elb type when not specified.
+[--pretty], [--no-pretty]                  # Pretty format the json for the task definitions
+                                           # Default: true
+[--stop-old-tasks], [--no-stop-old-tasks]  # Stop old tasks as part of deployment to speed it up
+[--task=TASK]                              # ECS task name, to override the task name convention.
+[--wait], [--no-wait]                      # Wait for deployment to complete
+[--verbose], [--no-verbose]                
+[--mute], [--no-mute]                      
+[--noop], [--no-noop]                      
+[--cluster=CLUSTER]                        # Cluster.  Overrides .ufo/settings.yml.
 ```
 

data/docs/_reference/ufo-stop.md

@@ -0,0 +1,31 @@
+---
+title: ufo stop
+reference: true
+---
+
+## Usage
+
+    ufo stop SERVICE
+
+## Description
+
+Stop tasks from old deployments.  Can speed up deployments with network load balancer.
+
+ECS deployments can sometimes take a while. One reason could be because the old ECS tasks can take some time to drain and removed. The recommended way to speed this draining process up is configuring the `deregistration_delay.timeout_seconds` to a low value.  You can configured this in `.ufo/settings/cfn/default.yml`. For more info refer to http://localhost:4000/docs/settings-cfn/  This setting works well for Application Load Balancers.
+
+However, for Network Load Balancers, it seems like the deregistration_delay is not currently being respected. In this case, it take an annoying load time and this command can help speed up the process.
+
+The command looks for any extra old ongoing deployments and stops the tasks associated with them.  This can cause errors for any inflight requests.
+
+    ufo stop demo-web
+
+
+## Options
+
+```
+[--verbose], [--no-verbose]  
+[--mute], [--no-mute]        
+[--noop], [--no-noop]        
+[--cluster=CLUSTER]          # Cluster.  Overrides .ufo/settings.yml.
+```
+