Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update GCP registry docs #2676

Merged
merged 4 commits into from
May 13, 2024
Merged

Update GCP registry docs #2676

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9b59cd7
update gcp registry docs
safoinme May 6, 2024
4cb66b8
Merge branch 'develop' into feature/OSSK-532-gcp-artifact-registry
safoinme May 8, 2024
1be1459
Apply suggestions from code review
safoinme May 8, 2024
9e79328
Merge branch 'develop' into feature/OSSK-532-gcp-artifact-registry
safoinme May 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 7 additions & 41 deletions docs/book/stacks-and-components/component-guide/container-registries/gcp.md
View file
Open in desktop
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
Loading