Skip to content
This repository was archived by the owner on Aug 18, 2025. It is now read-only.

Commit 22f94f6

Browse files
johnstcnjohnstcn
authored
chore: add ECR documentation for 1.24 (#665)
1 parent bc255a9 commit 22f94f6

File tree

4 files changed

+72
-10
lines changed

4 files changed

+72
-10
lines changed

‎admin/registries/ecr.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: "Amazon Elastic Container Registry"
3+
description: Add a private Amazon ECR to Coder.
4+
---
5+
6+
This article will show you how to add your private ECR to Coder. If you're using
7+
public ECR registry, you do not need to follow the steps below.
8+
9+
Amazon requires users to [request temporary login credentials to access a
10+
private Elastic Container Registry (ECR)
11+
registry](https://docs.aws.amazon.com/AmazonECR/latest/userguide/registry_auth.html).
12+
When interacting with ECR, Coder will request temporary credentials from the
13+
registry using the AWS credentials linked to the registry.
14+
15+
## Step 1: Setting up your AWS credentials
16+
17+
To access a private ECR registry, Coder needs AWS credentials (specifically your
18+
**access key ID** and **secret access key**) with authorization to access the
19+
provided registry. You can either use AWS credentials tied to your own AWS
20+
account *or* credentials tied to an IAM user specifically for Coder (we
21+
recommend the latter option).
22+
23+
Note that you are not limited to providing one single set of AWS credentials.
24+
For example, you can use a set of credentials with access to all of your ECR
25+
repositories, or you can use individual sets of credentials, each with access to
26+
a single repository.
27+
28+
To provision AWS credentials for Coder:
29+
30+
1. **Optional:** [Create an IAM user for
31+
Coder](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html)
32+
to access ECR. You can either attach the AWS-managed policy
33+
`AmazonEC2ContainerRegistryReadOnly` to the user, or you can [create your
34+
own](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html).
35+
36+
1. [Create an access
37+
key](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)
38+
for the IAM user to be used with Coder (if one does not already exist).
39+
40+
## Step 2: Add your private ECR registry to Coder
41+
42+
You can add your private ECR registry at the same time that you [add your
43+
images](../../images/index.md). To import an image:
44+
45+
1. In Coder, go to **Images** and click on **Import Image** in the upper-right.
46+
47+
1. In the dialog that opens, you'll be prompted to pick a registry. However, to
48+
_add_ a registry, click **Add a new registry** located immediately below the
49+
registry selector.
50+
51+
1. Provide a **registry name** and the **registry**.
52+
53+
1. Set the **registry kind** to **ECR** and provide your **Access Key ID** and
54+
**Secret Access Key**.
55+
56+
1. Continue with the process of [adding your image](../../images/index.md).
57+
58+
1. When done, click **Import**.

‎admin/registries/gcr.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ title: "Google Container Registry"
33
description: Add the Google Container Registry to Coder.
44
---
55

6-
Google Container Registry (GCR) uses different authorization methods, unlike
7-
the generic `registry:2` image that requires a username and password. This
8-
article will show you how to add GCR to Coder using a `_json_key` file.
6+
Google Container Registry (GCR) uses different authorization methods, unlike the
7+
generic `registry:2` image that requires a username and password. This article
8+
will show you how to add GCR to Coder using a `_json_key` file.
99

1010
## Adding a private GCR registry
1111

@@ -14,17 +14,18 @@ Create a `_json_key` file with your authorization information:
1414
1. In the [Google Cloud Console](https://console.cloud.google.com/), configure a
1515
service account for access to the GCR registry holding your images for use
1616
with Coder.
17-
1. Create a [JSON key
18-
file](https://cloud.google.com/container-registry/docs/advanced-authentication#json-key).
17+
1. Create a
18+
[JSON key file](https://cloud.google.com/container-registry/docs/advanced-authentication#json-key).
1919

20-
Add your private GCR registry during the process of [adding
21-
images](../../images/index.md). To import an image:
20+
Add your private GCR registry during the process of
21+
[adding images](../../images/index.md). To import an image:
2222

2323
1. Go to **Images** > **Import Image** in the upper-right.
2424
1. In the dialog that opens, you'll be prompted to pick a registry by default.
2525
However, to _add_ a registry, click **Add a new registry**, which is the
2626
option located immediately below the registry selector.
27-
1. You'll be asked to provide a **registry name** and the **registry**.
27+
1. You'll be asked to provide a **registry name** and the **registry**. You can
28+
leave the **registry kind** as the default **Generic** value.
2829
1. Since your registry is a **private registry**, provide the `_json_key` string
2930
for the **username** and the file's contents for **password**.
3031
1. Continue with the process of [adding your image](../../images/index.md).

‎admin/registries/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ To import an image:
2424
1. **Optional.** If your registry is a **private registry** or you want to avoid
2525
hitting [rate limits](https://www.docker.com/increase-rate-limits), provide
2626
the **username** and **password** combination required to access the
27-
registry.
27+
registry. If your registry is a private **Amazon ECR Registry**, follow the
28+
steps specific to [AWS ECR](./ecr.md).
2829
1. Continue with the process of [adding your image](../../images/index.md).
2930
1. When done, click **Import**.
3031

@@ -43,5 +44,4 @@ To delete a registry:
4344

4445
Coder does not support the following registries at this time:
4546

46-
- Amazon ECR
4747
- GitHub Packages

‎manifest.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,9 @@
207207
{
208208
"path": "./admin/registries/default-registry.md"
209209
},
210+
{
211+
"path": "./admin/registries/ecr.md"
212+
},
210213
{
211214
"path": "./admin/registries/gcr.md"
212215
}

0 commit comments

Comments
 (0)