Google Cloud Container Registry

How to store container images in GCP

This is an older version of the ZenML documentation. To read and view the latest version please visit this up-to-date URL.

The GCP container registry is a container registry flavor which comes built-in with ZenML and uses the Google Artifact Registry or the Google Container Registry to store container images.

When to use it

You should use the GCP container registry if:

• one or more components of your stack need to pull or push container images.

• you have access to GCP. If you're not using GCP, take a look at the other container registry flavors.

How to deploy it

Google Container Registry

When using the Google Container Registry, all you need to do is enabling it here.

Google Artifact Registry

When using the Google Artifact Registry, you need to:

• enable it here

• go here and create a Docker repository.

How to find the registry URI

Google Container Registry

When using the Google Container Registry, the GCP container registry URI should have one of the following formats:

gcr.io/<PROJECT_ID>
# or
us.gcr.io/<PROJECT_ID>
# or
eu.gcr.io/<PROJECT_ID>
# or
asia.gcr.io/<PROJECT_ID>

# Examples:
gcr.io/zenml
us.gcr.io/my-project
asia.gcr.io/another-project

To figure our the URI for your registry:

• Go to the GCP console.

• Click on the dropdown menu in the top left to get a list of available projects with their names and IDs.

• Use the ID of the project you want to use fill the template gcr.io/<PROJECT_ID> and get your URI (You can also use the other prefixes <us/eu/asia>.gcr.io as explained above if you want your images stored in a different region).

Google Artifact Registry

When using the Google Artifact Registry, the GCP container registry URI should have the following format:

<REGION>-docker.pkg.dev/<PROJECT_ID>/<REPOSITORY_NAME>

# Examples:
europe-west1-docker.pkg.dev/zenml/my-repo
southamerica-east1-docker.pkg.dev/zenml/zenml-test
asia-docker.pkg.dev/my-project/another-repo

To figure our the URI for your registry:

• Go here and select the repository that you want to uses to store Docker images. If you don't have a repository yet, take a look at the deployment section.

• On the top, click the copy button to copy the full repository URL.

How to use it

To use the Azure container registry, we need:

• Docker installed and running.

• The GCP CLI installed and authenticated.

• The registry URI. Check out the previous section on the URI format and how to get the URI for your registry.

We can then register the container registry and use it in our active stack:

zenml container-registry register <NAME> \
    --flavor=gcp \
    --uri=<REGISTRY_URI>

# Add the container registry to the active stack
zenml stack update -c <NAME>

Additionally, we'll need to configure Docker so it can pull and push images:

Google Container Registry

gcloud auth configure-docker

Google Artifact Registry

gcloud auth configure-docker <REGION>-docker.pkg.dev

For more information and a full list of configurable attributes of the GCP container registry, check out the API Docs.