ufo 4.5.11 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a7401ccc5d5e288b485c4eaaf21a4ae14864a23bdc52c4e36ce9bf060f35d55
-  data.tar.gz: 2528b31c9fea0c43785a2d1c17c2529c85f3ac85dd431e9cc5de7fbca28cdc53
+  metadata.gz: e191dff1d9d879e6c78eb6062dbdf8440efcc3a1178125af01aaf807e6632e2c
+  data.tar.gz: 9656eee37d6155be650e7292692db31fe54797c1cf6ea5d9b8f75917ffb0dc7f
 SHA512:
-  metadata.gz: 890ed4c9715cea6d1c6865e13a3895467d72e266363ea0647111e513299c1e4d3182d68ad8039212bbae2d6c59d16ab53d44629042cde185a173c4fa62f3fbe4
-  data.tar.gz: bb31a72b778cb39de850a07cb6ce94dc31c50b2f257d067c77b5fa40dcf5d1dfcc3ce50d05c9980e8a1fa298c4f229bb1d47c6df0d44ae18e24d0b218f1647fc
+  metadata.gz: 3769a6dedd2cb9100c4531a820dd9c1b848acb84a58186d546a7825c4d96765b2a1a8239d6883bfa7e346e2577ed4a0b4d95da29375a266bb13637dbcafd6428
+  data.tar.gz: b5a48692922794b70328f73153c80f09475c91468e1432f4103d56b80bc5e40f10ef92301e711ee1806e41a1be0987b21b5f1c979371a31ae9b72cc1dbf437e6

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 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.
 
+## [4.6.0]
+- #95 Introduce: ufo logs command. Tail logs.
+- #96 docs and options
+
 ## [4.5.11]
 - add mfa support for normal IAM user
 

data/README.md

@@ -8,6 +8,8 @@
 [![Join the chat at https://gitter.im/tongueroo/ufo](https://badges.gitter.im/tongueroo/ufo.svg)](https://gitter.im/tongueroo/ufo?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Support](https://img.shields.io/badge/get-support-blue.svg)](https://boltops.com?utm_source=badge&utm_medium=badge&utm_campaign=ufo)
 
+[![BoltOps Badge](https://img.boltops.com/boltops/badges/boltops-badge.png)](https://www.boltops.com)
+
 Ufo is a tool that builds Docker images and deploys them to [AWS ECS](https://aws.amazon.com/ecs/).  The main command is `ufo ship`.  Here's summary of what it does:
 
 1. Builds a docker image.

data/docs/_docs/conventions.md

@@ -44,4 +44,4 @@ You can also use an existing ELB by specifying the target group arn as the value
 ufo ship demo-web --elb arn:aws:elasticloadbalancing:us-east-1:12345689:targetgroup/demo-web/12345
 ```
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/extras/codebuild-iam-role.md

@@ -1,6 +1,6 @@
 ---
 title: CodeBuild IAM Role
-nav_order: 31
+nav_order: 32
 ---
 
 Note, the `/tmp/ecs-deploy-policy.json` policy is available at [Minimal Deploy IAM]({% link _docs/extras/minimal-deploy-iam.md %}).
@@ -43,4 +43,4 @@ Create the IAM resources:
 
 The `attach-role-policy` command attaches a Customer Managed IAM policy to the IAM role. This is a little more reusable than using an inline policy.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/extras/dockerfile-erb.md

@@ -1,6 +1,6 @@
 ---
 title: Dynamic Dockerfile.erb
-nav_order: 32
+nav_order: 33
 ---
 
 Sometimes you may need a little more dynamic control of your Dockerfile. For these cases, ufo supports dynamically creating a Dockerfile from a Dockerfile.erb.  If Dockerfile.erb exists, ufo uses it to generate a Dockerfile as a part of the build process.  These means that you should update the source Dockerfile.erb instead, as the Dockerfile will be overwritten.  If Dockerfile.erb does not exist, then ufo will use the Dockerfile instead.
@@ -57,4 +57,4 @@ Why not use [build args](https://www.jeffgeerling.com/blog/2017/use-arg-dockerfi
 
 Ufo uses a YAML file so users will not have to remember to provide the build arg. It is also easy to update the `dockerfile_variables.yml` with the `ufo docker base` command.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/extras/ecs-network-mode.md

@@ -1,6 +1,6 @@
 ---
 title: ECS Network Mode
-nav_order: 26
+nav_order: 27
 ---
 
 ## Pros and Cons: bridge network mode
@@ -34,4 +34,4 @@ awsvpc | Fine grain security group permissions for each ECS service. | The numbe
 
 It is generally recommended to use awsvpc mode with ENI trunking supported instances. You get the best of both worlds in this situation: a strong security posture as well as container density.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/extras/load-balancer.md

@@ -1,6 +1,6 @@
 ---
 title: Load Balancer Support
-nav_order: 24
+nav_order: 25
 ---
 
 Ufo can automatically create a load balancer and associate it with an ECS service.  The options:
@@ -80,4 +80,4 @@ Under the hood, ufo implements load balancer support with CloudFormation. You ca
 
 <img src="/img/docs/cloudformation-resources.png" class="doc-photo" />
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/extras/minimal-deploy-iam.md

@@ -1,6 +1,6 @@
 ---
 title: Minimal Deploy IAM Policy
-nav_order: 30
+nav_order: 31
 ---
 
 The IAM user you use to run the `ufo ship` command needs a minimal set of IAM policies in order to deploy to ECS. Here is a table of the baseline services needed:
@@ -76,4 +76,4 @@ If you are using CodeBuild to deploy, you'll probably be interested the IAM poli
 This page refers to your **user** IAM policy used when running `ufo ship`. These are different from the IAM Policies associated with ECS Task.  For those iam policies refer to [IAM Roles for Tasks
 ](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html).
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/extras/redirection-support.md

@@ -1,6 +1,6 @@
 ---
 title: Redirection Support
-nav_order: 29
+nav_order: 30
 ---
 
 ## Application Load Balancers
@@ -24,4 +24,4 @@ listener:
 
 Network Load Balancers work at layer 4, so they do not support redirection.  Instead you need to handle redirection within your app.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/extras/route53-support.md

@@ -1,6 +1,6 @@
 ---
 title: Route53 Support
-nav_order: 28
+nav_order: 29
 ---
 
 Ufo can create a "pretty" route53 record and set it's value to the created ELB DNS name. This is done by configuring the `.ufo/settings/cfn/default.yml` file. Example:
@@ -24,4 +24,4 @@ Results in:
     aws route53 create-hosted-zone --name mydomain.com --caller-reference $(date +%s)
     aws route53 list-hosted-zones
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/extras/security-groups.md

@@ -1,6 +1,6 @@
 ---
 title: Security Groups
-nav_order: 25
+nav_order: 26
 ---
 
 Ufo creates and manages two security groups. One for the ELB and one for the ECS tasks.
@@ -33,4 +33,4 @@ In general, ports below 32768 are outside of the ephemeral port range. So an eas
 
 If you are using a network load balancer and are running bridge network mode, then you need to whitelist ports 32768 to 65535 to `0.0.0.0/0`.  This is because network load balancers operate at layer 4 of the OSI model and cannot be assigned security groups, so they use the security group of the instance.  If you feel this is too loose of permissions, you can use awsvpc mode. There are some considerations for awsvpc mode though which is discussed next.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/extras/ssl-support.md

@@ -1,6 +1,6 @@
 ---
 title: SSL Support
-nav_order: 27
+nav_order: 28
 ---
 
 You can configure SSL support by uncomment the `listener_ssl` option in `.ufo/settings/cfn/default.yml`.  Here's an example:
@@ -17,4 +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.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/faq.md

@@ -1,6 +1,6 @@
 ---
 title: FAQ
-nav_order: 44
+nav_order: 45
 ---
 
 **Q: Is AWS ECS Fargate supported?**
@@ -97,4 +97,4 @@ Also, you might have to enable the log driver by adding the ECS_AVAILABLE_LOGGIN
 
 Hope that helps.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/helpers.md

@@ -19,4 +19,4 @@ To call the helper in task_definitions.rb you must add `helper.` in front.  So `
 
 The 2 classes which provide these special helper methods are in [ufo/dsl.rb](https://github.com/tongueroo/ufo/blob/master/lib/ufo/dsl.rb) and [ufo/dsl/helper.rb](https://github.com/tongueroo/ufo/blob/master/lib/ufo/dsl/helper.rb). Refer to these classes for the full list of the helper methods.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/install.md

@@ -32,4 +32,4 @@ For more information about the Bolts Toolbelt or to get an installer for another
 * Docker: You will need a working version of [Docker](https://docs.docker.com/engine/installation/) installed as ufo shells out and calls the `docker` command.
 * AWS: Set up your AWS credentials at `~/.aws/credentials` and `~/.aws/config`.  This is the [AWS standard way of setting up credentials](https://aws.amazon.com/blogs/security/a-new-and-standardized-way-to-manage-credentials-in-the-aws-sdks/).
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/more/auto-completion.md

@@ -1,6 +1,6 @@
 ---
 title: Auto Completion
-nav_order: 43
+nav_order: 44
 ---
 
 Ufo supports bash auto-completion.  To set it up add the following to your `~/.profile` or `.bashrc`:
@@ -21,4 +21,4 @@ Auto Completion examples:
     ufo tasks [TAB]
     ufo tasks build [TAB]
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/more/automated-cleanup.md

@@ -1,6 +1,6 @@
 ---
 title: Automated Clean Up
-nav_order: 42
+nav_order: 43
 ---
 
 Ufo can be configured to automatically clean old images from the ECR registry after the deploy completes by configuring your [settings.yml]({% link _docs/settings.md %}) file like so:
@@ -11,4 +11,4 @@ ecr_keep: 30
 
 Automated Docker images clean up only works if you are using ECR registry.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/more/customize-cloudformation.md

@@ -1,6 +1,6 @@
 ---
 title: Customize CloudFormation
-nav_order: 37
+nav_order: 38
 ---
 
 Under the hood, ufo creates most of the required resources with a CloudFormation stack.  This includes the ELB, Target Group, Listener, Security Groups, ECS Service, and Route 53 records.  You might need to customize these resources.  Here are the ways to customize the resources that ufo creates.
@@ -32,4 +32,4 @@ UFO_ENV_EXTRA=2 ufo ship demo-web -\-cluster dev | demo-web-development-2
 
 The CloudFormation stack is currently generated from a template. The source code for this template is located at [cfn/stack.yml](https://github.com/tongueroo/ufo/blob/master/lib/cfn/stack.yml).  This implementation might change in the future.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/more/migrations.md

@@ -1,6 +1,6 @@
 ---
 title: Database Migrations
-nav_order: 41
+nav_order: 42
 ---
 
 A common task is to run database migrations with newer code before deploying the code. This is easily achieved with the `ufo task` command. Here's an example:
@@ -22,4 +22,4 @@ The `ufo task` command is generalized so you can run any one-off task. It is not
 2. Registers the ECS Task definition
 3. Runs a one-off ECS Task
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/more/run-in-pieces.md

@@ -1,6 +1,6 @@
 ---
 title: Run in Pieces
-nav_order: 39
+nav_order: 40
 ---
 
 The `ufo ship` command goes through a few stages:
@@ -27,4 +27,4 @@ Update the service with the task definitions in `.ufo/output` untouched.
 
 Note if you use the `ufo deploy` you should ensure that you have already pushed the docker image to your docker registry.  Or else the task will not be able to spin up because the docker image does not exist.  This is one of the reasons it is recommended that you use `ufo ship`.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/more/single-task.md

@@ -1,6 +1,6 @@
 ---
 title: Run Single Task
-nav_order: 40
+nav_order: 41
 ---
 
 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.
@@ -22,4 +22,4 @@ You can describe that task for more details:
 
 You can check out the [ufo task](http://ufoships.com/reference/ufo-task/) reference for more details.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/more/stuck-cloudformation.md

@@ -1,6 +1,6 @@
 ---
 title: Stuck CloudFormation
-nav_order: 38
+nav_order: 39
 ---
 
 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.
@@ -26,4 +26,4 @@ To cancel a current deploy, run:
 
 This is the same thing as canceling the stack update in the CloudFormation console.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/more/why-cloudformation.md

@@ -1,6 +1,6 @@
 ---
 title: Why CloudFormation
-nav_order: 36
+nav_order: 37
 ---
 
 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.
@@ -18,4 +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" />
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/next-steps.md

@@ -1,6 +1,6 @@
 ---
 title: Next Steps
-nav_order: 46
+nav_order: 47
 ---
 
 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.
@@ -13,4 +13,4 @@ From here, there are a few resources that can help you continue along:
 
 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!
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/quick-start-ec2.md

@@ -82,4 +82,4 @@ If you would like not to manage the EC2 server fleet, you are looking for ECS Fa
 
 Learn more in the next sections.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/settings.md

@@ -51,4 +51,4 @@ An interesting option is `aws_profile`.  This allows you to tightly connect an A
 
 Normally, the ECS cluster defaults to whatever UFO_ENV is set to by [convention]({% link _docs/conventions.md %}).  For example, when `UFO_ENV=production` the ECS Cluster is `production` and when `UFO_ENV=development` the ECS Cluster is `development`.  There are several ways to override this behavior. This is detailed in the [Settings Cluster docs]({% link _docs/settings/cluster.md %}).
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/settings/aws_profile.md

@@ -33,4 +33,4 @@ The binding is two-way. So:
 
 This behavior prevents you from switching `AWS_PROFILE`s, forgetting to switch `UFO_ENV` and then accidentally deploying a production based docker image to development and vice versa because you forgot to also switch `UFO_ENV` to its respective environment.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/settings/cfn.md

@@ -9,4 +9,4 @@ nav_order: 14
 
 {% include cfn-customize.md %}
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/settings/cluster.md

@@ -69,4 +69,4 @@ The precedence of the settings from highest to lowest is:
 * cluster environment setting
 * UFO_ENV default convention
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/settings/network.md

@@ -32,4 +32,4 @@ elb_subnets | Used to create elb load balancer.  Defaults to same subnets as ecs
 ecs_security_groups | Additional security groups to associate with the ECS tasks.
 elb_security_groups | Additional security groups to associate with the ELB.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/ssl_errors.md

@@ -1,6 +1,5 @@
 ---
 Title: SSL Errors
-# nav_order:
 ---
 
 UFO uses the AWS Ruby SDK and the underlying default SSL certificate chain configured in your active Ruby and
@@ -38,4 +37,4 @@ Once you have updated OpenSSL and your `brew` packages, use the helper scripts a
 
 The `update-cert-chain.sh` file was created using the suggestions from <https://gemfury.com/help/could-not-verify-ssl-certificate/>. Please review the information at <https://gemfury.com/help/could-not-verify-ssl-certificate/> if the `Helper Scripts` above do not fully resolve your issue.
 
-The `test-aws-api-access.rb` uses examples from the <https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/quick-start-guide.html> for using and configuring the Ruby AWS SDK on your system.
+The `test-aws-api-access.rb` uses examples from the <https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/quick-start-guide.html> for using and configuring the Ruby AWS SDK on your system.

data/docs/_docs/structure.md

@@ -37,4 +37,4 @@ File / Directory  | Description
 
 Now that you know where the ufo configurations are located and what they look like, let’s use ufo!
 
-{% include prev_next.md %}
+{% include prev_next.md %}

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

@@ -58,4 +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.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

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

@@ -89,4 +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 %}).
 
-{% include prev_next.md %}
+{% include prev_next.md %}

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

@@ -92,4 +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.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

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

@@ -35,4 +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.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

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

@@ -174,4 +174,4 @@ demo-worker task definition registered.
 $
 ```
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/tutorial.md

@@ -11,4 +11,4 @@ In the next sections, we'll walk through using ufo in detail. We will ufo-ify a
 
 Let's start!
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/ufo-current.md

@@ -1,6 +1,6 @@
 ---
 title: Ufo Current
-nav_order: 22
+nav_order: 23
 ---
 
 ## service
@@ -46,4 +46,4 @@ This can be shorten with with current also.
     ufo current --services demo-web demo-worker demo-clock
     ufo ships
 
-{% include prev_next.md %}
+{% include prev_next.md %}

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

@@ -1,6 +1,6 @@
 ---
 title: UFO_ENV_EXTRA
-nav_order: 21
+nav_order: 22
 ---
 
 <div class="video-box"><div class="video-container"><iframe src="https://www.youtube.com/embed/UVQuwQGToYE" frameborder="0" allowfullscreen=""></iframe></div></div>
@@ -19,4 +19,4 @@ The precedence:
 1. UFO_ENV_EXTRA - takes highest precedence
 2. `.ufo/current` env-extra setting - takes lower precedence
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/ufo-env.md

@@ -1,6 +1,6 @@
 ---
 title: UFO_ENV
-nav_order: 20
+nav_order: 21
 ---
 
 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.
@@ -45,4 +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 %}).
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/ufo-logs.md

@@ -0,0 +1,50 @@
+---
+title: ufo logs command
+nav_order: 20
+---
+
+The ufo logs command will tail the logs of the ecs service if you are using the awslogs driver.
+
+## Examples
+
+    $ ufo logs demo-web
+    2020-01-16 23:58:16 UTC 10.20.120.135 - - [16/Jan/2020:23:58:16 +0000] "GET / HTTP/1.1" 200 3 0.0003
+    2020-01-16 23:58:16 UTC 10.20.120.135 - - [16/Jan/2020:23:58:16 UTC] "GET / HTTP/1.1" 200 3
+    2020-01-16 23:58:16 UTC - -> /
+
+## Current Set
+
+If you have a current service name set.
+
+    $ ufo current --service demo-web
+    $ ufo logs # follow by default
+    2020-01-16 23:58:16 UTC 10.20.120.135 - - [16/Jan/2020:23:58:16 +0000] "GET / HTTP/1.1" 200 3 0.0003
+    2020-01-16 23:58:16 UTC 10.20.120.135 - - [16/Jan/2020:23:58:16 UTC] "GET / HTTP/1.1" 200 3
+    2020-01-16 23:58:16 UTC - -> /
+
+## Options
+
+By default the logs follow and use the simple format without the log stream. Here's how adjust those options:
+
+    ufo logs --no-follow
+    ufo logs --format detailed # to show stream too
+
+More info: [ufo logs reference]({% link _reference/ufo-logs.md %})
+
+## awslog driver
+
+The generated .ufo task definition defaults to the awslogs driver. If you need it, it looks like this:
+
+```json
+"logConfiguration": {
+  "logDriver": "awslogs",
+  "options": {
+    "awslogs-group": "<%= @awslogs_group %>",
+    "awslogs-region": "<%= @awslogs_region || 'us-east-1' %>",
+    "awslogs-stream-prefix": "<%= @awslogs_stream_prefix %>"
+  }
+}
+```
+
+
+{% include prev_next.md %}

data/docs/_docs/ufo-task-params.md

@@ -1,6 +1,6 @@
 ---
 title: Ufo Task Params
-nav_order: 23
+nav_order: 24
 ---
 
 You can run one off task with the [ufo task](https://ufoships.com/reference/ufo-task/) command.
@@ -40,4 +40,4 @@ ERB and [shared variables]({% link _docs/variables.md %}) are available in the p
 
 Note, the params.yml file does not have access to the `task_definition_name` helper method. That is only available in the `task_definitions.rb` template_definition code blocks.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/upgrading.md

@@ -1,6 +1,6 @@
 ---
 title: Upgrading
-nav_order: 33
+nav_order: 34
 ---
 
 <ul>
@@ -10,4 +10,4 @@ nav_order: 33
 {% endfor %}
 </ul>
 
-{% include prev_next.md %}
+{% include prev_next.md %}

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

@@ -3,7 +3,7 @@ title: Upgrading to Version 4.5
 short_title: Version 4.5
 order: 1
 categories: upgrading
-nav_order: 34
+nav_order: 35
 ---
 
 In ufo version 4.4 and 4.5, the default cloudformation stack names used by ufo were changed.
@@ -49,4 +49,4 @@ Version | Setting
 
 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 %}
+{% include prev_next.md %}

data/docs/_docs/upgrading/upgrade4.md

@@ -3,7 +3,7 @@ title: Upgrading to Version 4.0
 short_title: Version 4.0
 order: 2
 categories: upgrading
-nav_order: 35
+nav_order: 36
 ---
 
 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.
@@ -45,4 +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.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/variables.md

@@ -52,4 +52,4 @@ When `ufo ship` is ran with `UFO_ENV=development` the `variables/development.rb`
 ])
 ```
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_includes/subnav.html

@@ -26,6 +26,7 @@
                 <li><a href="{% link _docs/variables.md %}">Shared Variables</a></li>
                 <li><a href="{% link _docs/helpers.md %}">Helpers</a></li>
                 <li><a href="{% link _docs/conventions.md %}">Conventions</a></li>
+                <li><a href="{% link _docs/ufo-logs.md %}">Ufo Logs</a></li>
                 <li><a href="{% link _docs/ufo-env.md %}">Ufo Env</a></li>
                 <li><a href="{% link _docs/ufo-env-extra.md %}">Ufo Env Extra</a></li>
                 <li><a href="{% link _docs/ufo-current.md %}">Ufo Current</a></li>

data/docs/_reference/ufo-logs.md

@@ -0,0 +1,39 @@
+---
+title: ufo logs
+reference: true
+---
+
+## Usage
+
+    ufo logs
+
+## Description
+
+Prints out logs
+
+## Examples
+
+    ufo logs demo-web
+
+If you have a current service name set.
+
+    ufo current --service demo-web
+    ufo logs # follow by default
+    ufo logs --no-follow
+    ufo logs --format detailed # to show stream too
+
+
+## Options
+
+```
+[--follow], [--no-follow]    #  Whether to continuously poll for new logs. To exit from this mode, use Control-C.
+                             # Default: true
+[--since=SINCE]              # From what time to begin displaying logs.  By default, logs will be displayed starting from 1 minutes in the past. The value provided can be an ISO 8601 timestamp or a relative time.
+[--format=FORMAT]            # The format to display the logs. IE: detailed or short.  With detailed, the log stream name is also shown.
+                             # Default: simple
+[--verbose], [--no-verbose]  
+[--mute], [--no-mute]        
+[--noop], [--no-noop]        
+[--cluster=CLUSTER]          # Cluster.  Overrides .ufo/settings.yml.
+```
+

data/docs/articles.md

@@ -1,6 +1,6 @@
 ---
 title: Articles
-nav_order: 45
+nav_order: 46
 ---
 
 * [How to Create Unlimited Extra Environments
@@ -11,4 +11,4 @@ nav_order: 45
 * [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)
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/docs.md

@@ -26,4 +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.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/quick-start.md

@@ -129,4 +129,4 @@ Here's an article that compares the cost of ECS Fargate: [Heroku vs ECS Fargate
 
 {% include repo_push_access.md %}
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/reference.md

@@ -12,6 +12,7 @@ title: CLI Reference
 * [ufo destroy]({% link _reference/ufo-destroy.md %})
 * [ufo docker]({% link _reference/ufo-docker.md %})
 * [ufo init]({% link _reference/ufo-init.md %})
+* [ufo logs]({% link _reference/ufo-logs.md %})
 * [ufo network]({% link _reference/ufo-network.md %})
 * [ufo ps]({% link _reference/ufo-ps.md %})
 * [ufo releases]({% link _reference/ufo-releases.md %})

data/lib/ufo/cli.rb

@@ -187,6 +187,15 @@ module Ufo
       Status.new(service, options).run
     end
 
+    desc "logs", "Prints out logs"
+    long_desc Help.text(:logs)
+    option :follow, default: true, type: :boolean, desc: " Whether to continuously poll for new logs. To exit from this mode, use Control-C."
+    option :since, desc: "From what time to begin displaying logs.  By default, logs will be displayed starting from 1 minutes in the past. The value provided can be an ISO 8601 timestamp or a relative time."
+    option :format, default: "simple", desc: "The format to display the logs. IE: detailed or short.  With detailed, the log stream name is also shown."
+    def logs(service=:current)
+      Logs.new(service, options).run
+    end
+
     desc "completion *PARAMS", "Prints words for auto-completion."
     long_desc Help.text("completion")
     def completion(*params)

data/lib/ufo/help/logs.md

@@ -0,0 +1,10 @@
+## Examples
+
+    ufo logs demo-web
+
+If you have a current service name set.
+
+    ufo current --service demo-web
+    ufo logs # follow by default
+    ufo logs --no-follow
+    ufo logs --format detailed # to show stream too

data/lib/ufo/logs.rb

@@ -0,0 +1,55 @@
+require "aws-logs"
+
+module Ufo
+  class Logs < Base
+    include AwsService
+
+    delegate :service, to: :info
+
+    def run
+      log = find_log_group_name
+      puts "Showing logs for log group: #{log["awslogs-group"]} and stream prefix #{log["awslogs-stream-prefix"]}"
+      if log
+        cloudwatch_tail(log)
+      else
+        puts "Unable to find log group for service: #{service.service_name}"
+      end
+    end
+
+    def find_log_group_name
+      resp = ecs.describe_task_definition(task_definition: info.service.task_definition)
+
+      container_definitions = resp.task_definition.container_definitions
+
+      unless container_definitions.size == 1
+        puts "ERROR: ufo logs command only supports 1 container definition in the ECS task definition".color(:red)
+        return
+      end
+
+      definition = container_definitions.first
+      log_conf = definition.log_configuration
+
+      if log_conf && log_conf.log_driver == "awslogs"
+        # options["awslogs-group"]
+        # options["awslogs-region"]
+        # options["awslogs-stream-prefix"]
+        log_conf.options
+      else
+        puts "Only supports awslogs driver. Detected log_driver: #{log_conf.log_driver}"
+        return
+      end
+    end
+
+    def cloudwatch_tail(log={})
+      since = @options[:since] || "10m" # by default, search only 10 mins in the past
+      cw_tail = AwsLogs::Tail.new(
+        log_group_name: log["awslogs-group"],
+        log_stream_name_prefix: log["awslogs-stream-prefix"],
+        since: since,
+        follow: @options[:follow],
+        format: @options[:format],
+      )
+      cw_tail.run
+    end
+  end
+end

data/lib/ufo/version.rb

@@ -1,3 +1,3 @@
 module Ufo
-  VERSION = "4.5.11"
+  VERSION = "4.6.0"
 end

data/spec/fixtures/mocks/logs/awslogs.json

@@ -0,0 +1,70 @@
+{
+  "task_definition": {
+    "task_definition_arn": "arn:aws:ecs:us-west-2:112233445566:task-definition/demo-web:1",
+    "container_definitions": [
+      {
+        "name": "web",
+        "image": "112233445566.dkr.ecr.us-west-2.amazonaws.com/demo/sinatra:ufo-2020-01-16T22-56-26-a28378e80",
+        "cpu": 256,
+        "memory": 1024,
+        "memory_reservation": 1024,
+        "port_mappings": [
+          {
+            "container_port": 4567,
+            "host_port": 4567,
+            "protocol": "tcp"
+          }
+        ],
+        "essential": true,
+        "command": [
+          "bin/web"
+        ],
+        "environment": [],
+        "log_configuration": {
+          "log_driver": "awslogs",
+          "options": {
+            "awslogs-group": "ecs/demo-web",
+            "awslogs-region": "us-west-2",
+            "awslogs-stream-prefix": "demo"
+          }
+        }
+      }
+    ],
+    "family": "demo-web",
+    "task_role_arn": "arn:aws:iam::112233445566:role/demo",
+    "network_mode": "awsvpc",
+    "revision": 1,
+    "volumes": [
+    ],
+    "status": "ACTIVE",
+    "requires_attributes": [
+      {
+        "name": "com.amazonaws.ecs.capability.logging-driver.awslogs"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.ecr-auth"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.docker-remote-api.1.19"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.docker-remote-api.1.21"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.task-iam-role"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.docker-remote-api.1.18"
+      },
+      {
+        "name": "ecs.capability.task-eni"
+      }
+    ],
+    "placement_constraints": [
+
+    ],
+    "compatibilities": [
+      "EC2"
+    ]
+  }
+}

data/spec/fixtures/mocks/logs/no-awslogs.json

@@ -0,0 +1,70 @@
+{
+  "task_definition": {
+    "task_definition_arn": "arn:aws:ecs:us-west-2:112233445566:task-definition/demo-web:1",
+    "container_definitions": [
+      {
+        "name": "web",
+        "image": "112233445566.dkr.ecr.us-west-2.amazonaws.com/demo/sinatra:ufo-2020-01-16T22-56-26-a28378e80",
+        "cpu": 256,
+        "memory": 1024,
+        "memory_reservation": 1024,
+        "port_mappings": [
+          {
+            "container_port": 4567,
+            "host_port": 4567,
+            "protocol": "tcp"
+          }
+        ],
+        "essential": true,
+        "command": [
+          "bin/web"
+        ],
+        "environment": [],
+        "log_configuration": {
+          "log_driver": "whatever",
+          "options": {
+            "awslogs-group": "ecs/demo-web",
+            "awslogs-region": "us-west-2",
+            "awslogs-stream-prefix": "demo"
+          }
+        }
+      }
+    ],
+    "family": "demo-web",
+    "task_role_arn": "arn:aws:iam::112233445566:role/demo",
+    "network_mode": "awsvpc",
+    "revision": 1,
+    "volumes": [
+    ],
+    "status": "ACTIVE",
+    "requires_attributes": [
+      {
+        "name": "com.amazonaws.ecs.capability.logging-driver.awslogs"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.ecr-auth"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.docker-remote-api.1.19"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.docker-remote-api.1.21"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.task-iam-role"
+      },
+      {
+        "name": "com.amazonaws.ecs.capability.docker-remote-api.1.18"
+      },
+      {
+        "name": "ecs.capability.task-eni"
+      }
+    ],
+    "placement_constraints": [
+
+    ],
+    "compatibilities": [
+      "EC2"
+    ]
+  }
+}

data/spec/lib/logs_spec.rb

@@ -0,0 +1,55 @@
+describe Ufo::Logs do
+  let(:logs) do
+    logs = Ufo::Logs.new("test-web", {})
+    allow(logs).to receive(:exit).and_return(null)
+    allow(logs).to receive(:info).and_return(null)
+    allow(logs).to receive(:ecs).and_return(ecs)
+    logs
+  end
+  let(:ecs) do
+    ecs = double(:ecs).as_null_object
+    allow(ecs).to receive(:describe_task_definition).and_return(mock_response(fixture))
+    ecs
+  end
+  let(:null) { double(:null).as_null_object }
+
+  context "awslogs conf" do
+    let(:fixture) { "spec/fixtures/mocks/logs/awslogs.json" }
+    it "find_log_group_name" do
+      log_group_name = logs.find_log_group_name
+      expect(log_group_name).to eq({"awslogs-group" => "ecs/demo-web", "awslogs-region" => "us-west-2", "awslogs-stream-prefix" => "demo" })
+    end
+  end
+
+  context "not a awslogs conf" do
+    let(:fixture) { "spec/fixtures/mocks/logs/no-awslogs.json" }
+    it "find_log_group_name" do
+      log_group_name = logs.find_log_group_name
+      expect(log_group_name).to be nil
+    end
+  end
+
+  def mock_response(file)
+    data = JSON.load(IO.read(file))
+
+    td = data["task_definition"]
+    container_definitions = td["container_definitions"].map do |c|
+      l = c["log_configuration"]
+      log_configuration = Aws::ECS::Types::LogConfiguration.new(
+        log_driver: l["log_driver"],
+        options: l["options"],
+      )
+      Aws::ECS::Types::ContainerDefinition.new(
+        name: c["name"],
+        log_configuration: log_configuration,
+      )
+    end
+    task_definition = Aws::ECS::Types::TaskDefinition.new(
+      task_definition_arn: td["task_definition_arn"],
+      container_definitions: container_definitions,
+    )
+    Aws::ECS::Types::DescribeTaskDefinitionResponse.new(
+      task_definition: task_definition,
+    )
+  end
+end

data/ufo.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "aws-logs"
   spec.add_dependency "aws-mfa-secure"
   spec.add_dependency "aws-sdk-cloudformation"
   spec.add_dependency "aws-sdk-cloudwatchlogs"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ufo
 version: !ruby/object:Gem::Version
-  version: 4.5.11
+  version: 4.6.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-10 00:00:00.000000000 Z
+date: 2020-01-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-logs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: aws-mfa-secure
   requirement: !ruby/object:Gem::Requirement
@@ -311,7 +325,6 @@ files:
 - README.md
 - Rakefile
 - docs/.gitignore
-- docs/.ruby-version
 - docs/CNAME
 - docs/Gemfile
 - docs/LICENSE
@@ -358,6 +371,7 @@ files:
 - docs/_docs/ufo-current.md
 - docs/_docs/ufo-env-extra.md
 - docs/_docs/ufo-env.md
+- docs/_docs/ufo-logs.md
 - docs/_docs/ufo-task-params.md
 - docs/_docs/ufo-tasks-register.md
 - docs/_docs/upgrading.md
@@ -414,6 +428,7 @@ files:
 - docs/_reference/ufo-docker-push.md
 - docs/_reference/ufo-docker.md
 - docs/_reference/ufo-init.md
+- docs/_reference/ufo-logs.md
 - docs/_reference/ufo-network-help.md
 - docs/_reference/ufo-network-init.md
 - docs/_reference/ufo-network.md
@@ -544,6 +559,7 @@ files:
 - lib/ufo/help/docker/push.md
 - lib/ufo/help/help.md
 - lib/ufo/help/init.md
+- lib/ufo/help/logs.md
 - lib/ufo/help/network/init.md
 - lib/ufo/help/ps.md
 - lib/ufo/help/releases.md
@@ -561,6 +577,7 @@ files:
 - lib/ufo/info.rb
 - lib/ufo/init.rb
 - lib/ufo/log_group.rb
+- lib/ufo/logs.rb
 - lib/ufo/network.rb
 - lib/ufo/network/fetch.rb
 - lib/ufo/network/helper.rb
@@ -604,6 +621,8 @@ files:
 - spec/fixtures/dockerfiles/ecr/Dockerfile
 - spec/fixtures/home_existing/.aws/config
 - spec/fixtures/home_existing/.docker/config.json
+- spec/fixtures/mocks/logs/awslogs.json
+- spec/fixtures/mocks/logs/no-awslogs.json
 - spec/fixtures/ps/describe_tasks.json
 - spec/fixtures/settings.yml
 - spec/lib/apps_spec.rb
@@ -612,6 +631,7 @@ files:
 - spec/lib/completion_spec.rb
 - spec/lib/ecr_auth_spec.rb
 - spec/lib/ecr_cleaner_spec.rb
+- spec/lib/logs_spec.rb
 - spec/lib/ps_spec.rb
 - spec/lib/register_spec.rb
 - spec/lib/setting_spec.rb
@@ -640,7 +660,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: AWS ECS Deploy Tool
@@ -655,6 +675,8 @@ test_files:
 - spec/fixtures/dockerfiles/ecr/Dockerfile
 - spec/fixtures/home_existing/.aws/config
 - spec/fixtures/home_existing/.docker/config.json
+- spec/fixtures/mocks/logs/awslogs.json
+- spec/fixtures/mocks/logs/no-awslogs.json
 - spec/fixtures/ps/describe_tasks.json
 - spec/fixtures/settings.yml
 - spec/lib/apps_spec.rb
@@ -663,6 +685,7 @@ test_files:
 - spec/lib/completion_spec.rb
 - spec/lib/ecr_auth_spec.rb
 - spec/lib/ecr_cleaner_spec.rb
+- spec/lib/logs_spec.rb
 - spec/lib/ps_spec.rb
 - spec/lib/register_spec.rb
 - spec/lib/setting_spec.rb