Back to Reference Index

ufo ships

Usage

ufo ships [LIST_OF_SERVICES]

Description

Builds and ships same container image to multiple ECS services.

The ufo ships command allows you to deploy the same Docker image and task definition to multiple ECS services. It is a common pattern to have the same code base running on different roles. For example, say you have an application with 3 roles:

  1. web - serves web requests.
  2. worker - processes background jobs.
  3. clock - schedules background jobs.

Instead of using the ufo ship 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 demo-web demo-worker demo-clock

Shell expansion

Since the ECS service names are provided as a list you can shorten the command by using bash shell expansion 😁

ufo ships hi-{web,worker,clock}

If you’re new to shell expansion, run this to understand why above works just as well:

$ echo hi-{web,worker,clock}
demo-web demo-worker demo-clock

Overriding convention

As explained in detail in Conventions 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 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

The ufo ships, ufo ship, ufo deploy command support the same options. The options are presented here again for convenience:

Option Description
--cluster This decides what cluster to use. This can also be set in ufo/settings.yml covered in Settings. The cli option takes highest precedence.
--ecr-keep This integer option determines how many old docker images to keep around. Ufo will automatically delete and clean up docker images at the end of this process. The default is to keep all. If you set this, set it at a reasonable high number like 30.
--elb-eip-ids EIP Allocation ids to use for network load balancer. If specified then --elb-type is automatically assumed to be network.
--elb-type ELB type: application or network. Keep current deployed elb type when not specified.
--elb Decides to create elb, not create elb or use existing target group.
--pretty This boolean option determines ufo generates the task definitions in output in a pretty human readable format.
--stop-old-tasks This boolean option determines if ufo will call ecs stop-task on the old tasks after deployment. Sometimes old tasks hang around for a little bit with ECS this forces them along a little quicker. This option forceably kills running tasks, so configuring deregistration_delay.timeout_seconds is recommended in the cfn settings instead. Note, it seems like deregistration_delay is currently is respected for Application ELBs but not Network ELBs.
--task By convention ufo uses the same name for both the ECS service and task definition. You can override this convention with this option. The conventions are covered on the Conventions page.
--wait This boolean option determines if ufo blocks and waits until the service has been deployed before continuing.

Note: The --task option is not used with the ufo ships command.

Options

[--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.
[--scheduling-strategy=SCHEDULING_STRATEGY]  # Scheduling strategy to use for the service. IE: replica, daemon
[--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
[--image-override=IMAGE_OVERRIDE]            # Override image in task definition for quick testing
[--verbose], [--no-verbose]                  
[--mute], [--no-mute]                        
[--noop], [--no-noop]                        
[--cluster=CLUSTER]                          # Cluster.  Overrides .ufo/settings.yml.

Edit this page

See a typo or an error? You can improve this page. This website is available on GitHub and contributions are encouraged and welcomed. We love pull requests from you!