Skip to content

referencing public images with creds #3008

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 28, 2025
Merged

referencing public images with creds #3008

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions docs/vendor/packaging-public-images.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,15 @@ For more information about the Replicated proxy registry, see [About the Replica

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 (either `proxy.replicated.com` or your custom domain) instead of multiple registry domains.

For public images, you can use anonymous access without configuring registry credentials.
For public images, you need to first configure registry credentials.

To pull public images through the Replicated proxy registry, use the following `docker` command:

```bash
docker pull REPLICATED_PROXY_DOMAIN/anonymous/UPSTREAM_REGISTRY_HOSTNAME/IMAGE:TAG
docker pull REPLICATED_PROXY_DOMAIN/proxy/APPSLUG/UPSTREAM_REGISTRY_HOSTNAME/IMAGE:TAG
```
Where:
* `APPSLUG` is your Replicated app slug found on the [app settings page](https://vendor.replicated.com/settings).
* `REPLICATED_PROXY_DOMAIN` is `proxy.replicated.com` or your custom domain. For information about how to set a custom domain for the proxy registry, see [Using Custom Domains](/vendor/custom-domains-using).
* `UPSTREAM_REGISTRY_HOSTNAME` is the hostname for the public registry where the image is located. If the image is located in a namespace within the registry, include the namespace after the hostname. For example, `quay.io/namespace`.
* `IMAGE` is the image name.
Expand All @@ -31,28 +32,28 @@ The following examples show how to pull public images from DockerHub:

```bash
# DockerHub is the default when no hostname is specified
docker pull proxy.replicated.com/anonymous/busybox
docker pull proxy.replicated.com/anonymous/nginx:1.16.0
docker pull proxy.replicated.com/proxy/APPSLUG/busybox
docker pull proxy.replicated.com/proxy/APPSLUG/nginx:1.16.0
```
```bash
# You can also optionally specify docker.io
docker pull proxy.replicated.com/anonymous/docker.io/replicated/replicated-sdk:1.0.0
docker pull proxy.replicated.com/proxy/APPSLUG/docker.io/replicated/replicated-sdk:1.0.0
```

### Pull Images from Other Registries

The following example shows how to pull images from the Amazon ECR Public Gallery:

```bash
docker pull proxy.replicated.com/anonymous/public.ecr.aws/nginx/nginx:latest
docker pull proxy.replicated.com/proxy/APPSLUG/public.ecr.aws/nginx/nginx:latest
```

### Pull Images Using a Custom Domain for the Proxy Registry

The following example shows how to pull a public image when a custom domain is configured for the proxy registry:

```bash
docker pull my.customdomain.io/anonymous/public.ecr.aws/nginx/nginx:latest
docker pull my.customdomain.io/proxy/APPSLUG/public.ecr.aws/nginx/nginx:latest
```
For information about how to set a custom domain for the proxy registry, see [Using Custom Domains](/vendor/custom-domains-using).

Expand Down
Loading