Skip to content

Commit

Permalink
Update GCP registry docs (#2676)
Browse files Browse the repository at this point in the history
* update gcp registry docs

* Apply suggestions from code review

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>

---------

Co-authored-by: Alex Strick van Linschoten <strickvl@users.noreply.github.com>
  • Loading branch information
safoinme and strickvl committed May 13, 2024
1 parent 6828d45 commit 47c3242
Showing 1 changed file with 7 additions and 41 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,12 @@ description: Storing container images in GCP.
# Google Cloud Container Registry

The GCP container registry is a [container registry](container-registries.md) flavor that comes built-in with ZenML and
uses the [Google Artifact Registry](https://cloud.google.com/artifact-registry) or
the [Google Container Registry](https://cloud.google.com/container-registry) to store container images.
uses the [Google Artifact Registry](https://cloud.google.com/artifact-registry).

{% hint style="warning" %}
**Important Notice: Google Container Registry [is being replaced by Artifact Registry](https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr). Please start using Artifact Registry for your containers. As per Google's documentation, "after May 15, 2024, Artifact Registry will host images for the gcr.io domain in Google Cloud projects without previous Container Registry usage. After March 18, 2025, Container Registry will be shut down."**
The terms `container registry` and `artifact registry` will be used interchangeably throughout this document.
{% endhint %}

### When to use it

Expand All @@ -25,19 +29,10 @@ clash/issue and is working on a fix. For now, please use Python <3.11 together
with the GCP integration.
{% endhint %}

{% tabs %}
{% tab title="Google Container Registry" %}
When using the Google Container Registry, all you need to do is enable
it [here](https://console.cloud.google.com/marketplace/product/google/containerregistry.googleapis.com).
{% endtab %}

{% tab title="Google Artifact Registry" %}
When using the Google Artifact Registry, you need to:

* enable it [here](https://console.cloud.google.com/marketplace/product/google/artifactregistry.googleapis.com)
* go [here](https://console.cloud.google.com/artifacts) and create a `Docker` repository.
{% endtab %}
{% endtabs %}

### Infrastructure Deployment

Expand All @@ -53,34 +48,6 @@ a random one is generated for you. For more information about how to work use th

## How to find the registry URI

{% tabs %}
{% tab title="Google Container Registry" %}
When using the Google Container Registry, the GCP container registry URI should have one of the following formats:

```shell
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 out the URI for your registry:

* Go to the [GCP console](https://console.cloud.google.com/).
* 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 in 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).
{% endtab %}

{% tab title="Google Artifact Registry" %}
When using the Google Artifact Registry, the GCP container registry URI should have the following format:

```shell
Expand All @@ -97,8 +64,7 @@ To figure out the URI for your registry:
* Go [here](https://console.cloud.google.com/artifacts) and select the repository that you want to use to store Docker
images. If you don't have a repository yet, take a look at the [deployment section](gcp.md#how-to-deploy-it).
* On the top, click the copy button to copy the full repository URL.
{% endtab %}
{% endtabs %}


#### Infrastructure Deployment

Expand Down

0 comments on commit 47c3242

Please sign in to comment.