Skip to content

Commit

Permalink
enhance docs for ecr (#720)
Browse files Browse the repository at this point in the history
Co-authored-by: Daniel Fangl <[email protected]>
  • Loading branch information
HarshCasper and dfangl authored Sep 5, 2023
1 parent 4f395a1 commit 7f3b516
Show file tree
Hide file tree
Showing 2 changed files with 140 additions and 25 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
165 changes: 140 additions & 25 deletions content/en/user-guide/aws/elastic-container-registry/index.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,162 @@
---
title: "Elastic Container Registry (ECR)"
linkTitle: "Elastic Container Registry (ECR)"
categories: ["LocalStack Pro"]
description: >
Get started with Elastic Container Registry (ECR) on LocalStack
aliases:
- /aws/elastic-container-registry/
---

A basic version of Elastic Container Registry (ECR) is available to store application images. ECR is often used in combination with other APIs that deploy containerized apps, like ECS or EKS.
## Introduction

Elastic Container Registry (ECR) is a fully managed container registry service provided by Amazon Web Services.
ECR enables you to store, manage, and deploy Docker container images to build, store, and deploy containerized applications.
ECR integrates with other AWS services, such as Lambda, ECS, and EKS.

LocalStack supports Elastic Container Registry via the Pro/Team offering, allowing you to use the ECR APIs in your local environment to build & push Docker images to a local ECR registry.
The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_ecr/), which provides information on the extent of ECR's integration with LocalStack.

## Getting started

This guide is designed for users new to Elastic Container Registry and assumes basic knowledge of the AWS CLI and our [`awslocal`](https://github.com/localstack/awscli-local) wrapper script.

Start your LocalStack container using your preferred method. We will demonstrate how to build and push a Docker image to a local ECR repository.

### Create a Docker image

To get started, create a Docker image for a simple web application that can be used in an ECS task definition.
Create a new file named `Dockerfile` (with no file extension) in your project directory.
This file will contain the instructions for building the Docker image.
Add the following content to the file:

```Dockerfile
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.sh
```

You can now build the Docker image from the `Dockerfile` using the `docker CLI:

{{< command >}}
$ docker build -t localstack-ecr-image .
{{< / command >}}

You can run the following command to verify that the image was built successfully:

{{< command >}}
$ docker images
{{< / command >}}

You will see output similar to the following:

```bash
REPOSITORY TAG IMAGE ID CREATED SIZE
..
localstack-ecr-image latest 38883941b8fa 1 minute ago 185MB
```

### Create an ECR repository

To push the Docker image to ECR, you first need to create a repository.
You can create an ECR repository using the [`CreateRepository`](https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_CreateRepository.html) API.
Run the following command to create a repository named `localstack-ecr-repository`:

{{< command >}}
$ awslocal ecr create-repository --repository-name repo1
$ awslocal ecr create-repository \
--repository-name localstack-ecr-repository \
--image-scanning-configuration scanOnPush=true
{{< / command >}}

You will see an output similar to the following:

```sh
{
"repository": {
"repositoryArn": "arn:aws:ecr:us-east-1:000000000000:repository/repo1",
"registryId": "abc898c8",
"repositoryName": "repo1",
"repositoryUri": "localhost:4510/repo1"
"repositoryArn": "arn:aws:ecr:us-east-1:000000000000:repository/localstack-ecr-repository",
"registryId": "000000000000",
"repositoryName": "localstack-ecr-repository",
"repositoryUri": "localhost.localstack.cloud:4510/localstack-ecr-repository",
"createdAt": "2023-07-24T16:58:36+05:30",
"imageTagMutability": "MUTABLE",
"imageScanningConfiguration": {
"scanOnPush": true
},
"encryptionConfiguration": {
"encryptionType": "AES256"
}
}
}
{{< / command >}}
```

You will need the `repositoryUri` value to push the Docker image to the repository.

### Push the Docker image to the repository

To push the Docker image to the repository, you first need to tag the image with the `repositoryUri`.
Run the following command to tag the image:

You can then build and tag a new Docker image, and push it to the repository URL (`localhost:4510/repo1` in the example above):
{{< command >}}
$ cat Dockerfile
FROM nginx
ENV foo=bar
$ docker tag localstack-ecr-image localhost:4510/localstack-ecr-repository
{{< / command >}}

You can now push the image to the repository using the `docker` CLI:

{{< command >}}
$ docker build -t localhost:4510/repo1 .
...
Successfully built e2cfb3cf012d
Successfully tagged localhost:4510/repo1:latest
$ docker push localhost.localstack.cloud:4510/localstack-ecr-repository
{{< / command >}}

The image will take a few seconds to push to the repository.
You can run the following command to verify that the image was pushed successfully:

{{< command >}}
$ docker push localhost:4510/repo1
The push refers to repository [localhost:4510/repo1]
318be7aea8fc: Pushed
fe08d5d042ab: Pushed
f2cb0ecef392: Pushed
latest: digest: sha256:4dd893a43df24c8f779a5ab343b7ef172fb147c69ed5e1278d95b97fe0f584a5 size: 948
...
$ awslocal ecr list-images --repository-name localstack-ecr-repository
{{< / command >}}

You will see an output similar to the following:

```bash
{
"imageIds": [
{
"imageDigest": "sha256:1cbc853c42983362817b5eecac80b1389c0a5cf9cfd1e711d9d0a1f5a7a36d43",
"imageTag": "latest"
}
]
}
```

## Resource Browser

The LocalStack Web Application provides a Resource Browser for managing ECR repositories and images.
You can access the Resource Browser by opening the LocalStack Web Application in your browser, navigating to the **Resources** section, and then clicking on **ECR** under the **Compute** section.

<img src="ecr-resource-browser.png" alt="ECR Resource Browser" title="ECR Resource Browser" width="900" />

The Resource Browser allows you to perform the following actions:

- **Create repository**: Create a new ECR repository by clicking the **Create** button, and specify the **Registry Id**, **Repository Name**, **Tags**, and other options.
- **View repository**: View the details of an ECR repository by clicking on the repository name.
You can also view the push commands to push an image to the repository by clicking the **View Push Commands** button.
- **Delete repository**: Delete an ECR repository by selecting the ECR repository, clicking the **Actions** button, and then clicking **Remove Selected**.

## Examples

The following code snippets and sample applications provide practical examples of how to use ECR in LocalStack for various use cases:

- [Amazon RDS initialization using CDK, Lambda, ECR, and Secrets Manager](https://github.com/localstack/amazon-rds-init-cdk)
- [Lambda Container Images with ECR](https://github.com/localstack/localstack-pro-samples/tree/master/lambda-container-image)
- [Pushing Docker images to ECR and running them locally on ECS](https://github.com/localstack/localstack-pro-samples/tree/master/ecs-ecr-container-app)

0 comments on commit 7f3b516

Please sign in to comment.