Menu
Amazon EC2 Container Service
Developer Guide (API Version 2014-11-13)

Getting Started with Amazon ECS

Let's get started with Amazon EC2 Container Service (Amazon ECS) by creating a task definition, scheduling tasks, and configuring a cluster in the Amazon ECS console.

You can optionally create an Amazon EC2 Container Registry (Amazon ECR) image repository and push an image to it. For more information on Amazon ECR, see the Amazon EC2 Container Registry User Guide.

The Amazon ECS first run wizard will guide you through the process to get started with Amazon ECS. The wizard gives you the option of creating a cluster and launching our sample web application, or if you already have a Docker image you would like to launch in Amazon ECS, you can create a task definition with that image and use that for your cluster instead.

Important

Before you begin, be sure that you've completed the steps in Setting Up with Amazon ECS and that your AWS user has the required permissions specified in the Amazon ECS First Run Wizard IAM policy example.

Choose your Amazon ECS first run wizard configuration options

  1. Open the Amazon ECS console first run wizard at https://console.aws.amazon.com/ecs/home#/firstRun.

  2. Select your Amazon ECS first run options.

    Choose your configuration options

    To create an Amazon ECS cluster and deploy a container application to it, check the top option. To create an Amazon ECR repository and push an image to it, which you can use in your Amazon ECS task definitions, check the bottom option. Choose Continue to proceed.

  3. If you've chosen to create an Amazon ECR repository, then complete the next two sections of the first run wizard, Configure repository and Build, tag, and push Docker image . If you are not creating an Amazon ECR repository, skip ahead to Create a task definition.

Configure repository

A repository is a place that you store Docker images in Amazon ECR. Every time you push or pull an image from Amazon ECR, you specify the registry and repository location to tell Docker where to push the image to or where to pull it from.

  • For Repository name, enter a unique name for your repository and choose Next step.

Build, tag, and push Docker image

In this section of the wizard, you use the Docker CLI to tag an existing local image (that you have built from a Dockerfile or pulled from another registry, such as Docker Hub) and then push the tagged image to your Amazon ECR registry.

  1. Retrieve the docker login command that you can use to authenticate your Docker client to your registry by pasting the aws ecr get-login command from the console into a terminal window.

    Note

    The get-login command is available in the AWS CLI starting with version 1.9.15. You can check your AWS CLI version with the aws --version command.

  2. Run the docker login command that was returned in the previous step. This command provides an authorization token that is valid for 12 hours.

    Important

    When you execute this docker login command, the command string can be visible by other users on your system in a process list (ps -e) display. Because the docker login command contains authentication credentials, there is a risk that other users on your system could view them this way and use them to gain push and pull access to your repositories. If you are not on a secure system, you should consider this risk and log in interactively by omitting the -p password option, and then entering the password when prompted.

  3. (Optional) If you have a Dockerfile for the image you want to push, build the image and tag it for your new repository by pasting the docker build command from the console into a terminal window (make sure you are in the same directory as your Dockerfile).

  4. Tag the image for your Amazon ECR registry and your new repository by pasting the docker tag command from the console into a terminal window. The console command assumes that your image was built from a Dockerfile in the previous step; if you did not build your image from a Dockerfile, replace the first instance of repository:latest with the image ID or image name of your local image that you want to push.

  5. Push the newly tagged image to your Amazon ECR repository by pasting the docker push command into a terminal window.

  6. Choose Done to finish.

Create a task definition

A task definition is like a blue print for your application. Every time you launch a task in Amazon ECS, you specify a task definition so the service knows which Docker image to use for containers, how many containers to use in the task, and the resource allocation for each container.

  1. Configure your task definition parameters.

    The first run wizard comes preloaded with a task definition, and you can see the simple-app container defined in the console. You can optionally rename the task definition or review and edit the resources used by the container (such as CPU units and memory limits) by choosing the container name and editing the values shown (CPU units are under the Advanced container configuration menu). Task definitions created in the first run wizard are limited to a single container for simplicity's sake. You can create multi-container task definitions later in the Amazon ECS console.

    Note

    If you are using an Amazon ECR image in your task definition, be sure to use the full registry/repository:tag naming for your Amazon ECR images. For example, aws_account_id.dkr.ecr.region.amazonaws.com/my-web-app:latest.

    For more information on what each of these task definition parameters does, see Task Definition Parameters.

  2. Choose Next step to continue.

Configure service

In this section of the wizard, you select how you would like to configure the Amazon ECS service that is created from your task definition. A service launches and maintains a specified number of copies of the task definition in your cluster. The Amazon ECS sample application is a web-based "Hello World" style application that is meant to run indefinitely, so by running it as a service, it will restart if the task becomes unhealthy or unexpectedly stops.

  1. In the Service Name field, select a name for your service.

  2. In the Desired number of tasks field, enter the number of tasks you would like to launch with your specified task definition.

    Note

    If your task definition contains static port mappings, the number of container instances you launch in the next section of the wizard must be greater than or equal to the number of tasks specified here.

  3. (Optional) You can choose to use an Elastic Load Balancing load balancer with your service. When a task is launched from a service that is configured to use a load balancer, the container instance that the task is launched on is registered with the load balancer and traffic from the load balancer is distributed across the instances in the load balancer.

    Important

    Elastic Load Balancing load balancers do incur cost while they exist in your AWS resources. For more information on Elastic Load Balancing pricing, see Elastic Load Balancing Pricing.

    Complete the following steps to use a load balancer with your service.

    1. In the Elastic load balancing section, choose the Container name: host port menu, and then choose simple-app:80. The default values here are set up for the sample application, but you can configure different listener options for the load balancer. For more information, see Service Load Balancing.

    2. In the Service IAM Role section, choose the Select IAM role for service menu, and then choose an existing Amazon ECS service (ecsServiceRole) role that you have already created, or click Create new role to create the required IAM role for your service.

  4. Review your load balancer settings and click Next Step.

Configure cluster

In this section of the wizard, you name your cluster, and then configure the container instances that your tasks can be placed on, the address range that you can reach your instances and load balancer from, and the IAM roles to use with your container instances that let Amazon ECS take care of this configuration for you.

  1. In the Cluster name field, choose a name for your cluster.

  2. In the EC2 instance type field, choose the instance type to use for your container instances. Instance types with more CPU and memory resources can handle more tasks. For more information on the different instance types, see Amazon EC2 Instances.

  3. In the Number of instances field, type the number of Amazon EC2 instances you want to launch into your cluster for tasks to be placed on. The more instances you have in your cluster, the more tasks you can place on them. Amazon EC2 instances incur costs while they exist in your AWS resources. For more information, see Amazon EC2 Pricing.

    Note

    If you created a service with more than one desired task in it that exposes container ports on to container instance ports, such as the Amazon ECS sample application, you need to specify at least that many instances here.

  4. Select a key pair name to use with your container instances. This is required for you to log into your instances with SSH; if you do not specify a key pair here, you cannot connect to your container instances with SSH. If you do not have a key pair, you can create one in the Amazon EC2 console at https://console.aws.amazon.com/ec2/.

  5. (Optional) In the Security Group section, you can choose a CIDR block that restricts access to your instances. The default value (Anywhere)allows access from the entire Internet.

  6. In the Container instance IAM role section, choose an existing Amazon ECS container instance (ecsInstanceRole) role that you have already created, or choose Create new role to create the required IAM role for your container instances.

  7. Click Review and Launch to proceed.

Review

  1. Review your task definition, task configuration, and cluster configurations and click Launch Instance & Run Service to finish. You are directed to a Launch Status page that shows the status of your launch and describes each step of the process (this can take a few minutes to complete while your Auto Scaling group is created and populated).

  2. After the launch is complete, choose View service to view your service in the Amazon ECS console.