Add service connector support for Google Artifact Registry #2771

stefannica · 2024-06-11T21:22:05Z

Describe changes

Adds support for Google Artifact Registry as a drop-in replacement for the deprecated Google Container Registry in the GCP Service Connector.

The docker-registry resource type has been converted from a single-instance resource type into a multi-instance resource type. A GCP Service Connector can be configured to give access to not one but many GAR (Google Artifact Registry) docker repositories in addition to the legacy GCR registries available for the same project, e.g.:

$ zenml service-connector verify gcp --resource-type docker-registry 
Service connector 'gcp' is correctly configured with valid credentials and has access to the following resources:
┏━━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃   RESOURCE TYPE    │ RESOURCE NAMES                                           ┃
┠────────────────────┼──────────────────────────────────────────────────────────┨
┃ 🐳 docker-registry │ gcr.io/zenml-core                                        ┃
┃                    │ us.gcr.io/zenml-core                                     ┃
┃                    │ eu.gcr.io/zenml-core                                     ┃
┃                    │ asia.gcr.io/zenml-core                                   ┃
┃                    │ asia-docker.pkg.dev/zenml-core/asia.gcr.io               ┃
┃                    │ europe-docker.pkg.dev/zenml-core/eu.gcr.io               ┃
┃                    │ europe-central2-docker.pkg.dev/zenml-core/gcf-artifacts  ┃
┃                    │ europe-central2-docker.pkg.dev/zenml-core/zenml-projects ┃
┃                    │ europe-central2-docker.pkg.dev/zenml-core/zennews        ┃
┃                    │ europe-west1-docker.pkg.dev/zenml-core/cv-webinar        ┃
┃                    │ europe-west1-docker.pkg.dev/zenml-core/gcf-artifacts     ┃
┃                    │ europe-west1-docker.pkg.dev/zenml-core/slackbot          ┃
┃                    │ europe-west1-docker.pkg.dev/zenml-core/test              ┃
┃                    │ europe-west1-docker.pkg.dev/zenml-core/zenbot-website    ┃
┃                    │ europe-west4-docker.pkg.dev/zenml-core/gcf-artifacts     ┃
┃                    │ us-docker.pkg.dev/zenml-core/gcr.io                      ┃
┃                    │ us-docker.pkg.dev/zenml-core/us.gcr.io                   ┃
┗━━━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛

Backwards Compatibility

Support for the legacy deprecated GCR registries is included in the GCP service connector. Users that already have GCP service connectors configured to access GCR registries will not be negatively impacted by this change.

Multi-type GCP Service Connector before the update:

$ zenml service-connector verify gcp --resource-type docker-registry 
Service connector 'gcp' is correctly configured with valid credentials and has access to the following resources:
┏━━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━┓
┃   RESOURCE TYPE    │ RESOURCE NAMES    ┃
┠────────────────────┼───────────────────┨
┃ 🐳 docker-registry │ gcr.io/zenml-core ┃
┗━━━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━┛

Multi-type GCP Service Connector after the update:

$ zenml service-connector verify gcp --resource-type docker-registry 
Service connector 'gcp' is correctly configured with valid credentials and has access to the following resources:
┏━━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━━━┓
┃   RESOURCE TYPE    │ RESOURCE NAMES         ┃
┠────────────────────┼────────────────────────┨
┃ 🐳 docker-registry │ gcr.io/zenml-core      ┃
┃                    │ us.gcr.io/zenml-core   ┃
┃                    │ eu.gcr.io/zenml-core   ┃
┃                    │ asia.gcr.io/zenml-core ┃
┗━━━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━━━┛

Single-type GCP Service Connector before the update:

$ zenml service-connector verify gcr 
Service connector 'gcr' is correctly configured with valid credentials and has access to the following resources:
┏━━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━┓
┃   RESOURCE TYPE    │ RESOURCE NAMES    ┃
┠────────────────────┼───────────────────┨
┃ 🐳 docker-registry │ gcr.io/zenml-core ┃
┗━━━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━┛

Single-type GCP Service Connector after the update:

$ zenml service-connector verify gcr 
Service connector 'gcr' is correctly configured with valid credentials and has access to the following resources:
┏━━━━━━━━━━━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━┓
┃   RESOURCE TYPE    │ RESOURCE NAMES    ┃
┠────────────────────┼───────────────────┨
┃ 🐳 docker-registry │ gcr.io/zenml-core ┃
┗━━━━━━━━━━━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━┛

For multi-type GCP Service Connectors, the ZenML server logs will report an error if the Google Artifact Registry permissions necessary to discover GAR registries are not yet configured for the GCP Service Connector credentials, but this does not prevent the GCP Service Connector from functioning with GCR registries, e.g.:

Failed to list Google Artifact Registries: 403 Permission 'artifactregistry.repositories.list' denied on resource '//artifactregistry.googleapis.com/projects/zenml-core/locations/asia-southeast2' (or it may not 
exist). [reason: "IAM_PERMISSION_DENIED"
domain: "artifactregistry.googleapis.com"
metadata {
  key: "permission"
  value: "artifactregistry.repositories.list"
}
metadata {
  key: "resource"
  value: "projects/zenml-core/locations/asia-southeast2"
}
]

Users can follow the GCP guide on converting their existing GCR registries into Google Artifact Registries and follow them with the appropriate changes in their ZenML GCP Service Connectors:

add the documented IAM permissions to the GCP Service Connector credentials to access the Artifact Registries. The configured credentials must have at least the following GCP permissions:

artifactregistry.repositories.createOnPush
artifactregistry.repositories.downloadArtifacts
artifactregistry.repositories.get
artifactregistry.repositories.list
artifactregistry.repositories.readViaVirtualRepository
artifactregistry.repositories.uploadArtifacts
artifactregistry.locations.list

users may keep the gcr.io GCR URLs already configured in the GCP Service Connectors and in linked Container Registry stack components as long as these are redirected to GAR as covered in the transition GCR guide.

Even if the GCP Service Connector credentials do not grant access to GCR registries, the GCP Service Connector will continue to report these legacy GCR registries as accessible. These will be removed in a future release.

Pre-requisites

Please ensure you have done the following:

I have read the CONTRIBUTING.md document.
If my change requires a change to docs, I have updated the documentation accordingly.
I have added tests to cover my changes.
I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
If my changes require changes to the dashboard, these changes are communicated/requested.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Other (add details above)

coderabbitai · 2024-06-11T21:22:11Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

src/zenml/integrations/gcp/service_connectors/gcp_service_connector.py

+        # domain format with the project ID as the first part of the URL path
+        # and the registry name as the second part of the URL path
+        if match := re.match(
+            r"^(https://)?(([a-z0-9-]+)-docker.pkg.dev/([a-z0-9-]+)/([a-z0-9-.]+))(/.+)*$",


src/zenml/integrations/gcp/service_connectors/gcp_service_connector.py

+        # us.gcr.io, eu.gcr.io, asia.gcr.io) and the project ID is the
+        # first part of the URL path
+        elif match := re.match(
+            r"^(https://)?(((us|eu|asia)\.)?gcr.io/[a-z0-9-]+)(/.+)*$",


socket-security · 2024-06-11T21:38:49Z

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
pypi/[email protected]	environment, filesystem, network Transitive: eval, shell, unsafe	`+17`	5.69 MB	gcloudpypi, google_opensource

View full report↗︎

safoinme

This looks great!

…oogle-artifact-registry

stefannica requested a review from safoinme June 11, 2024 21:22

stefannica added the run-slow-ci label Jun 11, 2024

github-actions bot added internal To filter out internal PRs and issues enhancement New feature or request labels Jun 11, 2024

github-advanced-security bot found potential problems Jun 11, 2024

View reviewed changes

stefannica force-pushed the feature/ossk-405-google-artifact-registry branch from 51a0657 to 69aa33d Compare June 12, 2024 13:13

stefannica force-pushed the feature/ossk-405-google-artifact-registry branch from 69aa33d to d1ae399 Compare June 24, 2024 13:00

stefannica added 4 commits June 24, 2024 16:50

Add service connector support for Google Artifact Registry

2f4a9b2

Fix regular expressions

0d42e69

Fix spelling

3ce879f

Update docs

e270a90

stefannica force-pushed the feature/ossk-405-google-artifact-registry branch from d1ae399 to e270a90 Compare June 24, 2024 14:50

safoinme approved these changes Jun 24, 2024

View reviewed changes

stefannica added 2 commits June 26, 2024 07:54

Fix API docs

30214e8

Merge remote-tracking branch 'origin/develop' into feature/ossk-405-g…

5ebc9fb

…oogle-artifact-registry

stefannica merged commit f431cc6 into develop Jun 27, 2024
69 of 73 checks passed

stefannica deleted the feature/ossk-405-google-artifact-registry branch June 27, 2024 07:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add service connector support for Google Artifact Registry #2771

Add service connector support for Google Artifact Registry #2771

stefannica commented Jun 11, 2024 •

edited

Loading

coderabbitai bot commented Jun 11, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

socket-security bot commented Jun 11, 2024 •

edited

Loading

safoinme left a comment

Add service connector support for Google Artifact Registry #2771

Add service connector support for Google Artifact Registry #2771

Conversation

stefannica commented Jun 11, 2024 • edited Loading

Describe changes

Backwards Compatibility

Pre-requisites

Types of changes

coderabbitai bot commented Jun 11, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

socket-security bot commented Jun 11, 2024 • edited Loading

safoinme left a comment

Choose a reason for hiding this comment

stefannica commented Jun 11, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

socket-security bot commented Jun 11, 2024 •

edited

Loading