Using Amazon ECR with the AWS CLI
The following steps walk you through the steps needed to push a container image to a private Amazon ECR repository for the first time using the Docker CLI and the AWS CLI.
For more information on the other tools available for managing your AWS resources,
including the different AWS SDKs, IDE toolkits, and the Windows PowerShell command line
tools, see http://aws.amazon.com/tools/
Prerequisites
Before you begin, be sure that you have completed the steps in Setting up with Amazon ECR.
If you do not already have the latest AWS CLI and Docker installed and ready to use, use the following steps to install both of these tools.
Install the AWS CLI
You can use the AWS command line tools to issue commands at your system's command line to perform Amazon ECR and other AWS tasks. This can be faster and more convenient than using the console. The command line tools are also useful for building scripts that perform AWS tasks.
To use the AWS CLI with Amazon ECR, install the latest AWS CLI version (Amazon ECR functionality is available in the AWS CLI starting with version 1.9.15). You can check your AWS CLI version with the aws --version command. For information about installing the AWS CLI or upgrading it to the latest version, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide.
Install Docker
Docker is available on many different operating systems, including most modern
Linux distributions, like Ubuntu, and even macOS and Windows. For more information
about how to install Docker on your particular operating system, go to the Docker
installation guide
You don't need a local development system to use Docker. If you are using Amazon EC2 already, you can launch an Amazon Linux 2 instance and install Docker to get started.
If you already have Docker installed, skip to Step 1: Create a Docker image.
To install Docker on an Amazon EC2 instance
-
Launch an instance with the Amazon Linux 2 AMI. For more information, see Launching an Instance in the Amazon EC2 User Guide for Linux Instances.
-
Connect to your instance. For more information, see Connect to Your Linux Instance in the Amazon EC2 User Guide for Linux Instances.
-
Update the installed packages and package cache on your instance.
sudo yum update -y -
Install the most recent Docker Community Edition package.
sudo amazon-linux-extras install docker -
Start the Docker service.
sudo service docker start -
Add the
ec2-userto thedockergroup so you can execute Docker commands without usingsudo.sudo usermod -a -G docker ec2-user -
Log out and log back in again to pick up the new
dockergroup permissions. You can accomplish this by closing your current SSH terminal window and reconnecting to your instance in a new one. Your new SSH session will have the appropriatedockergroup permissions. -
Verify that the
ec2-usercan run Docker commands withoutsudo.docker infoNote In some cases, you may need to reboot your instance to provide permissions for the
ec2-userto access the Docker daemon. Try rebooting your instance if you see the following error:Cannot connect to the Docker daemon. Is the docker daemon running on this host?
Step 1: Create a Docker image
In this section, you create a Docker image of a simple web application, and test it on your local system or Amazon EC2 instance, and then push the image to a container registry (such as Amazon ECR or Docker Hub) so you can use it in an Amazon ECS task definition.
To create a Docker image of a simple web application
-
Create a file called
Dockerfile. A Dockerfile is a manifest that describes the base image to use for your Docker image and what you want installed and running on it. For more information about Dockerfiles, go to the Dockerfile Reference. touch Dockerfile -
Edit the
Dockerfileyou just created and add the following content.FROM public.ecr.aws/docker/library/ubuntu:18.04 # Install dependencies RUN apt-get update && \ apt-get -y install apache2 # Install apache and write hello world message RUN echo 'Hello World!' > /var/www/html/index.html # Configure apache RUN echo '. /etc/apache2/envvars' > /root/run_apache.sh && \ echo 'mkdir -p /var/run/apache2' >> /root/run_apache.sh && \ echo 'mkdir -p /var/lock/apache2' >> /root/run_apache.sh && \ echo '/usr/sbin/apache2 -D FOREGROUND' >> /root/run_apache.sh && \ chmod 755 /root/run_apache.sh EXPOSE 80 CMD /root/run_apache.shThis Dockerfile uses the Ubuntu 18.04 image. The
RUNinstructions update the package caches, install some software packages for the web server, and then write the "Hello World!" content to the web server's document root. TheEXPOSEinstruction exposes port 80 on the container, and theCMDinstruction starts the web server. -
Build the Docker image from your Dockerfile.
Note Some versions of Docker may require the full path to your Dockerfile in the following command, instead of the relative path shown below.
docker build -t hello-world . -
Run docker images to verify that the image was created correctly.
docker images --filter reference=hello-worldOutput:
REPOSITORY TAG IMAGE ID CREATED SIZE hello-world latest e9ffedc8c286 4 minutes ago 241MB
-
Run the newly built image. The
-p 80:80option maps the exposed port 80 on the container to port 80 on the host system. For more information about docker run, go to the Docker run reference. docker run -t -i -p 80:80 hello-worldNote Output from the Apache web server is displayed in the terminal window. You can ignore the "
Could not reliably determine the server's fully qualified domain name" message. -
Open a browser and point to the server that is running Docker and hosting your container.
-
If you are using an Amazon EC2 instance, this is the Public DNS value for the server, which is the same address you use to connect to the instance with SSH. Make sure that the security group for your instance allows inbound traffic on port 80.
-
If you are running Docker locally, point your browser to http://localhost/
. -
If you are using docker-machine on a Windows or macOS computer, find the IP address of the VirtualBox VM that is hosting Docker with the docker-machine ip command, substituting
machine-namewith the name of the docker machine you are using.docker-machine ipmachine-name
You should see a web page with your "Hello World!" statement.
-
-
Stop the Docker container by typing Ctrl + c.
Step 2: Authenticate to your default registry
After you have installed and configured the AWS CLI, authenticate the Docker CLI to your default registry. That way, the docker command can push and pull images with Amazon ECR. The AWS CLI provides a get-login-password command to simplify the authentication process.
The get-login-password is the preferred method for
authenticating to an Amazon ECR private registry when using the AWS CLI. Ensure
that you have configured your AWS CLI to interact with AWS. For more
information, see AWS CLI
configuration basics in the
AWS Command Line Interface User Guide.
When passing the Amazon ECR authorization token to the docker
login command, use the value AWS for the username
and specify the Amazon ECR registry URI you want to authenticate to. If
authenticating to multiple registries, you must repeat the command for each
registry.
If you receive an error or the get-login-password command is unavailable, ensure you are using the latest version of the AWS CLI. For more information on installing or upgrading to the latest version of the AWS CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide.
-
get-login-password (AWS CLI)
aws ecr get-login-password --regionregion| docker login --username AWS --password-stdin.dkr.ecr.aws_account_idregion.amazonaws.com -
Get-ECRLoginCommand (AWS Tools for Windows PowerShell)
(Get-ECRLoginCommand).Password | docker login --username AWS --password-stdin.dkr.ecr.aws_account_idregion.amazonaws.com
Step 3: Create a repository
Now that you have an image to push to Amazon ECR, you must create a repository to hold it.
In this example, you create a repository called hello-world to which you
later push the hello-world:latest image. To create a repository, run the
following command:
aws ecr create-repository \ --repository-namehello-repository\ --image-scanning-configuration scanOnPush=true\ --regionregion
Step 4: Push an image to Amazon ECR
Now you can push your image to the Amazon ECR repository you created in the previous section. You use the docker CLI to push images, but there are a few prerequisites that must be satisfied for this to work properly:
-
The minimum version of docker is installed: 1.7
-
The Amazon ECR authorization token has been configured with docker login.
-
The Amazon ECR repository exists and the user has access to push to the repository.
After those prerequisites are met, you can push your image to your newly created repository in the default registry for your account.
To tag and push an image to Amazon ECR
-
List the images you have stored locally to identify the image to tag and push.
docker imagesOutput:
REPOSITORY TAG IMAGE ID CREATED VIRTUAL SIZE hello-world latest e9ffedc8c286 4 minutes ago 241MB
-
Tag the image to push to your repository.
docker tag hello-world:latestaws_account_id.dkr.ecr.region.amazonaws.com/hello-repository -
Push the image.
docker pushaws_account_id.dkr.ecr.region.amazonaws.com/hello-repositoryOutput:
The push refers to a repository [
aws_account_id.dkr.ecr.region.amazonaws.com/hello-repository] (len: 1) e9ae3c220b23: Pushed a6785352b25c: Pushed 0998bf8fb9e9: Pushed 0a85502c06c9: Pushed latest: digest: sha256:215d7e4121b30157d8839e81c4e0912606fca105775bb0636EXAMPLE size: 6774
Step 5: Pull an image from Amazon ECR
After your image has been pushed to your Amazon ECR repository, you can pull it from other locations. Use the docker CLI to pull images, but there are a few prerequisites that must be satisfied for this to work properly:
-
The minimum version of docker is installed: 1.7
-
The Amazon ECR authorization token has been configured with docker login.
-
The Amazon ECR repository exists and the user has access to pull from the repository.
After those prerequisites are met, you can pull your image. To pull your example image from Amazon ECR, run the following command:
docker pullaws_account_id.dkr.ecr.region.amazonaws.com/hello-repository:latest
Output:
latest: Pulling from hello-repository 0a85502c06c9: Pull complete 0998bf8fb9e9: Pull complete a6785352b25c: Pull complete e9ae3c220b23: Pull complete Digest: sha256:215d7e4121b30157d8839e81c4e0912606fca105775bb0636EXAMPLE Status: Downloaded newer image foraws_account_id.dkr.region.amazonaws.com/hello-repository:latest
Step 6: Delete an image
If you decide that you no longer need or want an image in one of your repositories,
you can delete it with the batch-delete-image command. To delete an
image, you must specify the repository that it is in and either a imageTag
or imageDigest value for the image. The example below deletes an image in
the hello-repository repository with the image tag
latest.
aws ecr batch-delete-image \ --repository-name hello-repository \ --image-ids imageTag=latest \ --regionregion
Step 7: Delete a repository
If you decide that you no longer need or want an entire repository of images, you can
delete the repository. By default, you cannot delete a repository that contains images;
however, the --force flag allows this. To delete a repository that contains
images (and all the images within it), run the following command.
aws ecr delete-repository \ --repository-name hello-repository \ --force \ --regionregion

