This project offers a very simple reverse proxy that lets you expose your
(public or private) Google Container Registries on gcr.io
as a public registry
on your own domain name.
For example, if you have a public registry, and offering images like:
docker pull gcr.io/ahmetb-public/busybox
You can use this proxy, and instead offer your images ✨way fancier🎩, like:
docker pull r.ahmet.dev/busybox
Download the source code, and build as a container image:
docker build --tag gcr.io/[YOUR_PROJECT]/gcr-proxy .
Then, push to a registry like:
docker push gcr.io/[YOUR_PROJECT]/gcr-proxy
You can easily deploy this as a serverless container to Google Cloud Run. This handles many of the heavy-lifting for you.
- Build and push docker images (previous step)
- Deploy to Cloud Run.
- Configure custom domain.
- Create domain mapping
- Verify domain ownership
- Update your DNS records
- Have fun!
To deploy this to Cloud Run, replace [PROJECT_ID]
with the project ID
of the GCR registry you want to expose publicly:
gcloud beta run deploy \
--allow-unauthenticated \
--image "[IMAGE]" \
--set-env-vars "REGISTRY_HOST=gcr.io,REPO_PREFIX=[GCP_PROJECT_ID]"
This will deploy a proxy for your
gcr.io/[GCP_PROJECT_ID]
public registry. If your GCR registry is private, see the section below on "Exposing private registries".
Then create a domain mapping by running (replace the --domain
value):
gcloud beta run domain-mappings create \
--service gcr-proxy \
--domain reg.ahmet.dev
This command will require verifying ownership of your domain name, and have you set DNS records for your domain to point to Cloud Run. Then, it will take some 15-20 minutes to actually provision TLS certificates for your domain name.
...is much harder. You need to deploy the application to an environment like Kubernetes, obtain a valid TLS certificate for your domain name, and make it publicly accessible.
If you set REGISTRY_HOST
and REGISTRY_PREFIX
environment variables, you can
also use this proxy for other docker registries.
For example, to proxy docker pull ahmet/example
to Docker Hub, specify
environment variables:
REGISTRY_HOST=index.docker.io
REPO_PREFIX=ahmet
Note: This is not tested with registries other than Docker Hub and GCR.io. If you can make it work with Azure Container Registry or AWS Elastic Container Registry, contribute examples here.
⚠️ This will make images in your private GCR registries publicly accessible on the internet.
-
Create an IAM Service Account.
-
Give it permissions to access the GCR registry GCS Bucket. (Or simply, you can give it the project-wide
Storage Object Viewer
role.) -
Copy your service account JSON key into the root of the repository as
key.json
. -
(Not ideal, but whatever) Rebuild the docker image with your service account key JSON in it. This will require editing
Dockerfile
to addCOPY
andENV
directives like:COPY key.json /app/key.json ENV GOOGLE_APPLICATION_CREDENTIALS /app/key.json ENTRYPOINT [...]
You need to rebuild and deploy the updated image.
While deploying, you can set additional environment variables for customization:
Key | Value |
---|---|
REGISTRY_HOST |
specify hostname for target registry, e.g. gcr.io . |
DISABLE_BROWSER_REDIRECTS |
if you set this variable to any value, visiting example.com/image on this browser will not redirect to [REGISTRY_HOST]/[REPO_PREFIX]/image to allow your users to browse the image on GCR. If you're exposing private registries, you might want to set this variable. |
AUTH_HEADER |
The Authentication: [...] header’s value to authenticate to the target registry |
GOOGLE_APPLICATION_CREDENTIALS |
(For gcr.io ) Path to the IAM service account JSON key file to expose the private GCR registries publicly. |
This is not an official Google project. See LICENSE.