Migrate container images from a third-party registry

If you pull some container images directly from third-party registries to deploy to Google Cloud environments such as Google Kubernetes Engine or Cloud Run, rate limits on image pulls or third-party outages can disrupt your builds and deployments. This page describes how to identify and copy those images to Artifact Registry for consolidated, consistent container image management.

Artifact Registry does not monitor third-party registries for updates to images you copy to Artifact Registry. If you want to incorporate a newer version of an image into your pipeline, you must push it to Artifact Registry.

Migration overview

Migration of your container images includes the following steps:

Set up prerequisites.
Identify images to migrate.
- Search your Dockerfile files and deployment manifests for references to third-party registries
- Determine pull frequency of images from third-party registries using Cloud Logging and BigQuery.
Copy identified images to Artifact Registry.
Verify that permissions to the registry are correctly configured, particularly if Artifact Registry and your Google Cloud deployment environment are in different projects.
Update manifests for your deployments.
Re-deploy your workloads.

Before you begin

Verify your permissions. You must have the Owner or Editor IAM role in the projects where you are migrating images to Artifact Registry.
Go to the project selector page
1. Select the Google Cloud project where you want to use Artifact Registry
2. In the Google Cloud console, go to Cloud Shell
3. Find your project ID and set it in Cloud Shell. Replace YOUR_PROJECT_ID with your project ID.
```
gcloud config set project YOUR_PROJECT_ID
```

Export the following environment variables:

  export PROJECT=$(gcloud config get-value project)

Enable the BigQuery, Artifact Registry, and Cloud Monitoring APIs with the following command:

gcloud services enable \
artifactregistry.googleapis.com \
stackdriver.googleapis.com \
logging.googleapis.com \
monitoring.googleapis.com

If you are not currently using Artifact Registry, configure a repository for your images:
- Create a repository
- Configure authentication for third-party clients that require access to the repository.
Verify that Go version 1.13 or newer is installed.
- Check the version of an existing Go installation with the command:
```
go version
```
- If you need to install or update Go, see the Go installation documentation.

Costs

This guide uses the following billable components of Google Cloud:

Identify images to migrate

Search the files you use to build and deploy your container images for references to third-party registries, then check how often you pull the images.

Identify references in Dockerfiles

Perform this step in a location where your Dockerfiles are stored. This might be where your code is locally checked out or in Cloud Shell if the files are available in a VM.

In the directory with your Dockerfiles, run the command:

grep -inr -H --include Dockerfile\* "FROM" . | grep -i -v -E 'docker.pkg.dev|gcr.io'

The output looks like the following example:

./code/build/baseimage/Dockerfile:1:FROM debian:stretch
./code/build/ubuntubase/Dockerfile:1:FROM ubuntu:latest
./code/build/pythonbase/Dockerfile:1:FROM python:3.5-buster

This command searches all the Dockerfiles in your directory and identifies the "FROM" line. Adjust the command as needed to match the way you store your Dockerfiles.

Identify references in manifests

Perform this step in a location where your GKE or Cloud Run manifests are stored. This might be where your code is locally checked out or in Cloud Shell if the files are available in a VM.

In the directory with your GKE or Cloud Run manifests run the command:

grep -inr -H --include \*.yaml "image:" . | grep -i -v -E 'docker.pkg.dev|gcr.io'

Sample output:

./code/deploy/k8s/ubuntu16-04.yaml:63: image: busybox:1.31.1-uclibc
./code/deploy/k8s/master.yaml:26:      image: kubernetes/redis:v1

This command looks at all YAML files in your directory and identifies the image: line, adjust as needed to work with how manifests are stored

To list images currently running on a cluster run the command:

  kubectl get all --all-namespaces -o yaml | grep image: | grep -i -v -E 'docker.pkg.dev|gcr.io'

This command returns all objects running in the currently selected Kubernetes cluster and gets their image names.

Sample output:

- image: nginx
  image: nginx:latest
    - image: nginx
    - image: nginx

Run this command for all GKE clusters across all Google Cloud projects for total coverage.

Identify pull frequency from a third-party registry

In projects that pull from third-party registries, use information about image pull frequency to determine if you usage is near or over any rate limits that the third-party registry enforces.

Collect log data

Create a log sink to export data to BigQuery. A log sink includes a destination and a query that selects the log entries to export. You can create a sink by querying individual projects, or you can use a script to collect data across projects.

To create a sink for a single project:

Go to the Logs Explorer
Choose a Google Cloud project.

On the Query builder tab, enter the following query:

  resource.type="k8s_pod"
  jsonPayload.reason="Pulling"

Change history filter from Last 1 hour to Last 7 Days.
Click Run Query.
After verifying that results show up correctly, click Actions > Create Sink.
In the list of sinks, select BigQuery dataset, then click Next.
In the Edit Sink panel perform the following steps:
- In the Sink Name field, enter image_pull_logs.
- In the Sink Destination field, create a new dataset or choose a destination dataset in another project.
Click Create Sink.

To create a sink for multiple projects:

Open Cloud Shell.

Run the following commands in Cloud Shell:

PROJECTS="PROJECT-LIST"
DESTINATION_PROJECT="DATASET-PROJECT"
DATASET="DATASET-NAME"

for source_project in $PROJECTS
do
  gcloud logging --project="${source_project}" sinks create image_pull_logs bigquery.googleapis.com/projects/${DESTINATION_PROJECT}/datasets/${DATASET} --log-filter='resource.type="k8s_pod" jsonPayload.reason="Pulling"'
done

where

PROJECT-LIST is a list of Google Cloud project IDs, separated with spaces. For example project1 project2 project3.
DATASET-PROJECT is the project where you want to store your dataset.
DATASET-NAME is the name for the dataset, for example image_pull_logs.

After you create a sink, it takes time for data to flow to BigQuery tables, depending on how frequently images are pulled.

Query for pull frequency

Once you have a representative sample of image pulls that your builds make, run a query for pull frequency.

Go to the BigQuery console.

Run the following query:

SELECT
  REGEXP_EXTRACT(jsonPayload.message, r'"(.*?)"') AS imageName,
  COUNT(*) AS numberOfPulls
FROM
      `DATASET-PROJECT.DATASET-NAME.events_*`
GROUP BY
      imageName
ORDER BY
      numberOfPulls DESC

where

DATASET-PROJECT is the project that contains your dataset.
DATASET-NAME is the name of the dataset.

The following example shows output from the query. In the imageName column, you can review the pull frequency for images that are not stored in Artifact Registry or Container Registry.

Copy images to Artifact Registry

After you have identified images from third-party registries, you are ready to copy them to Artifact Registry. The gcrane tool helps you with the copying process.

Create a text file images.txt in Cloud Shell with the names of the images you identified. For example:
```
ubuntu:18.04
debian:buster
hello-world:latest
redis:buster
jupyter/tensorflow-notebook
```

Download gcrane.

  GO111MODULE=on go get github.com/google/go-containerregistry/cmd/gcrane

Create a script named copy_images.sh to copy your list of files.

#!/bin/bash

images=$(cat images.txt)

if [ -z "${AR_PROJECT}" ]
then
    echo ERROR: AR_PROJECT must be set before running this
    exit 1
fi

for img in ${images}
do
    gcrane cp ${img} LOCATION-docker.pkg.dev/${AR_PROJECT}/${img}
done

Replace LOCATION with the region or multi-region of your repository.

Make the script executable:

  chmod +x copy_images.sh

Run the script to copy the files:
```
AR_PROJECT=${PROJECT}
./copy_images.sh
```

Verify permissions

By default Google Cloud CI/CD services have access to Artifact Registry in the same Google Cloud project.

Cloud Build can push and pull images
Runtime environments such as GKE, Cloud Run, the App Engine flexible environment, and Compute Engine can pull images.

If you need to push or pull images across projects, or if you are using third-party tools in your pipeline that need to access Artifact Registry, make sure that permissions are configured correctly before you update and re-deploy your workloads.

For more information, see the access control documentation.

Update manifests to reference Artifact Registry

Update your Dockerfiles and your manifests to refer to Artifact Registry instead of the third-party registry.

The following example shows manifest referencing a third-party registry:

apiVersion: apps/v1
kind: Deployment
metadata:
  name: nginx-deployment
spec:
  selector:
    matchLabels:
      app: nginx
  replicas: 2
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      - name: nginx
        image: nginx:1.14.2
        ports:
        - containerPort: 80

This updated version of the manifest points to an image on us-docker.pkg.dev.

apiVersion: apps/v1
kind: Deployment
metadata:
  name: nginx-deployment
spec:
  selector:
    matchLabels:
      app: nginx
  replicas: 2
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      - name: nginx
        image: us-docker.pkg.dev/<AR_PROJECT>/nginx:1.14.2
        ports:
        - containerPort: 80

For a large number of manifests, use sed or another tool that can handle updates across many text files.

Re-deploy workloads

Re-deploy workloads with your updated manifests.

Keep track of new image pulls by running the following query in the BigQuery console:

SELECT`

FORMAT_TIMESTAMP("%D %R", timestamp) as timeOfImagePull,
REGEXP_EXTRACT(jsonPayload.message, r'"(.*?)"') AS imageName,
COUNT(*) AS numberOfPulls
FROM
  `image_pull_logs.events_*`
GROUP BY
  timeOfImagePull,
  imageName
ORDER BY
  timeOfImagePull DESC,
  numberOfPulls DESC

All new image pulls should be from Artifact Registry and contain the string docker.pkg.dev.