The GCP Artifact Registry is a hosted docker repository that requires extra configuration for day-to-day use. This configuration is not typical of other repositories, and there are some considerations to account for when using it with Earthly. This guide will walk you through creating an Earthfile, building an image, and pushing it to Artifact Registry.
. It can accommodate more than just Docker images, but those are beyond the scope of this guide. Most of what we detail here applies to GCR as well, it will just require some .
This guide assumes you have already installed the , , and .
Create an Earthfile
No special considerations are needed in the Earthfile itself. You can use SAVE IMAGE just like any other repository.
FROM alpine:3.18
build:
RUN echo "Hello from Earthly!" > motd
ENTRYPOINT cat motd
SAVE IMAGE --push <region>-docker.pkg.dev/<project>/hello-earthly/hello-earthly:with-love
Configure the Artifact Repository Credential Helper
Artifact Repository does not issue permanent credentials. Instead, it relies on your Google credentials to issue Docker credentials. To this end, Google has built-in a credential helper to the gcloud CLI tool. gcloud can update your .docker/config.json on its own by running gcloud auth configure-docker <region>-docker.pkg.dev. Here is a sample entry it might create:
If you are using GCR; keep in mind that the needed permissions are based on the GCP storage permissions. We used the Storage Admin permissions to complete the guide with GCR.
Service Accounts also work with Earthly. Rather than gcloud init, simply log in using the Google-provided key like this:
RUN gcloud auth activate-service-account --key-file /test/key.json
Run the Target
With the helper installed, no special To build and push an image, simply execute the build target. Don't forget the --push flag!
Using this credential helper; you can also pull images without any special handling in an Earthfile:
FROM earthly/dind:alpine-main
run:
WITH DOCKER --pull <region>-docker.pkg.dev/<project>/hello-earthly/hello-earthly:with-love
RUN docker run <region>-docker.pkg.dev/<project>/hello-earthly/hello-earthly:with-love
END
Ensure that you have correct permissions to push and pull the images. Please reference the to ensure you have the correct permissions set. You will need to add the Artifact Registry Reader and Artifact Registry Writer roles to complete the tasks in this guide.
