Skip to content

Commit 7370ae6

Browse files
committed
Describe proxy registry pull through format
1 parent 7df6eeb commit 7370ae6

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

docs/vendor/packaging-private-images.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,54 @@ For example:
249249
replicated registry test index.docker.io --image my-company/my-image:v1.2.3
250250
```
251251

252+
## Pull public images through the Replicated proxy registry
253+
254+
You can use the Replicated proxy registry to pull both public and private images. Using the Replicated proxy registry for public images can simplify network access requirements for your customers, as they only need to whitelist a single domain (`proxy.replicated.com` or your custom domain) instead of multiple registry domains.
255+
256+
For public images, you can use anonymous access without configuring registry credentials. The URL structure for pulling public images is:
257+
258+
```
259+
proxy.replicated.com/anonymous/<upstream registry hostname>/<image>:<tag>
260+
```
261+
262+
### Examples
263+
264+
Login with license credentials:
265+
266+
```
267+
# If you have not configured a custom domain, use proxy.replicated.com
268+
docker login proxy.replicated.com -u <CUSTOMER_LICENSE_EMAIL> -p <LICENSE_ID>
269+
270+
# If you have configured a custom proxy domain, use it instead of proxy.replicated.com
271+
docker login {your proxy custom domain} -u <CUSTOMER_LICENSE_EMAIL> -p <LICENSE_ID>
272+
```
273+
274+
Pull public images from DockerHub (default registry when no registry hostname is specified):
275+
```bash
276+
# DockerHub/index.docker.io is the default when no registry hostname is specified
277+
docker pull proxy.replicated.com/anonymous/busybox
278+
docker pull proxy.replicated.com/anonymous/nginx:1.16.0
279+
280+
# You can also explicitly specify docker.io
281+
docker pull proxy.replicated.com/anonymous/docker.io/replicated/replicated-sdk:1.0.0
282+
```
283+
284+
Pull public images from other registries:
285+
```bash
286+
# Pull from Amazon ECR Public Gallery
287+
docker pull proxy.replicated.com/anonymous/public.ecr.aws/nginx/nginx:latest
288+
```
289+
290+
If you have configured a custom domain for your proxy registry, replace `proxy.replicated.com` with your custom domain in the examples above:
291+
292+
```bash
293+
docker pull {your proxy custom domain}/anonymous/public.ecr.aws/nginx/nginx:latest
294+
```
295+
296+
:::note
297+
For private registries or when you need to use specific credentials for quasi-public registries, configure the registry as an external registry first and use `/proxy/` instead of `/anonymous/` in the URL path.
298+
:::
299+
252300
## Related Topic
253301

254302
[Tutorial: Using ECR for Private Images](tutorial-ecr-private-images)

0 commit comments

Comments
 (0)