Back to Reference Index

ufo deploy

Usage

ufo deploy SERVICE

Description

Deploy task definition to ECS service without re-building the definition.

It is useful to sometimes deploy only the task definition without re-building it. Say for example, you are debugging the task definition and just want to directly edit the .ufo/output/demo-web.json definition. You can accomplish this with the ufo deploy command. The ufo deploy command will deploy the task definition in .ufo/output unmodified. Example:

ufo deploy demo-web

The above command does the following:

  1. register the .ufo/output/demo-web.json task definition to ECS untouched.
  2. deploys it to ECS by updating the service

ufo tasks build

To regenerate a .ufo/output/demo-web.json definition:

ufo tasks build

ufo ship

The ufo deploy command does less than the ufo ship command. Normally, it is recommended to use ufo ship over the ufo deploy command to do everything in one step:

  1. build the Docker image
  2. register the ECS task definition
  3. update the ECS service

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.

Creating mutiple environments in parallel

If you would like to create multiple enviroments quickly in parallel, the --no-wait and --build option can help speed up the process. Example:

ufo ship # at least once
for i in {1..3}; do
  UFO_ENV_EXTRA=$i ufo deploy --no-wait --build
done

A more detailed post is available here: How to Create Unlimited Extra Environments .

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
                                             # Default: true
[--image-override=IMAGE_OVERRIDE]            # Override image in task definition for quick testing
[--register], [--no-register]                # Register task definition
                                             # Default: true
[--build], [--no-build]                      # Build task definition
                                             # Default: true
[--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!