イメージの事前ウォーミングを行うと、ランタイム クライアントがリクエストする前に、コンテナ イメージの イメージ ストリーミング キャッシュへのダウンロードを明示的にトリガーできます。これにより、イメージ ストリーミングを使用するワークロードの新しいイメージ バージョンの最初の pull に関連する「コールド スタート」レイテンシが実質的に解消されます。
概要
イメージを Artifact Registry に push すると、基盤となるストレージ システムに保存されます。低レイテンシ アクセスを実現するために、Artifact Registry はイメージ ストリーミング キャッシュも使用します。このキャッシュは通常、イメージ ストリーミングが有効になっているクライアントからの最初の pull で入力されます。Google Kubernetes Engine クラスタのスケールアップなど、レイテンシの影響を受けやすいワークロードの場合、このキャッシュがウォームアップするまで待機すると遅延が発生する可能性があります。事前ウォーミングは、イメージをイメージ ストリーミング キャッシュに事前に取得するのに役立ちます。
Prewarm Artifact API を使用すると、特定のイメージ バージョンまたはタグをプリキャッシュするように手動でリクエストできます。また、イメージが指定された期間キャッシュに残るように、保持期間を指定します。
制限事項
- API のみ: 事前準備は Artifact Registry REST API を使用してのみ利用できます。gcloud CLI または Google Cloud コンソールでは、事前ウォーミングは使用できません。
- GKE のみ: 事前ウォーミングは、イメージ ストリーミングが有効になっている GKE クラスタでのみ有効です。イメージ ストリーミングには、クライアント ノードで実行される特定のソフトウェアが必要です。
- 単一のアーティファクト: API リクエストごとに事前準備できるアーティファクト(バージョンまたはタグ)は 1 つだけです。
- マルチアーキテクチャ イメージ: 対象外です。アーキテクチャ イメージの特定のバージョンを使用します。
始める前に
- Artifact Registry API を有効にします。詳細については、Artifact Registry を有効にするをご覧ください。
- gcloud CLI をインストールして、REST API リクエストの認証トークンを取得します。
必要なロール
事前ウォーミングされたイメージの管理に必要な権限を取得するには、リポジトリに対する次の IAM ロールの付与を管理者に依頼してください。
-
キャッシュからアーティファクトをプリウォームまたは削除する(
artifactregistry.repositories.prewarmArtifact、artifactregistry.repositories.removePrewarmedArtifact): Artifact Registry 書き込み (roles/artifactregistry.writer) -
事前準備されたアーティファクトを確認または一覧表示する(
artifactregistry.repositories.checkPrewarmedArtifact、artifactregistry.repositories.listPrewarmedArtifacts): Artifact Registry 読み取り (roles/artifactregistry.reader)
ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。
必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。
この権限モデルにより、書き込みアクセス権を持つユーザーのみがキャッシュの状態を管理できるようになり、未承認のユーザーがキャッシュを過剰に埋めるのを防ぐことができます。一方、読み取りアクセス権を持つユーザーは、ストリーミングに使用できるアーティファクトを確認できます。
イメージを事前準備する
イメージを事前準備するには、リポジトリの :prewarmArtifact メソッドに POST リクエストを送信します。
REST API
参照: projects.locations.repositories.prewarmArtifact
リクエストの本文は次の構造になります。
{
"version": "projects/PROJECT_ID/locations/LOCATION/repositories/REPOSITORY/packages/PACKAGE/versions/VERSION",
"retention_days": 3
}
または、タグを使用します。
{
"tag": "projects/PROJECT_ID/locations/LOCATION/repositories/REPOSITORY/packages/PACKAGE/tags/TAG",
"retention_days": 3,
"force": true
}
| フィールド | 説明 |
|---|---|
tag |
(省略可)プリウォームする特定のアーティファクト タグ。version または tag を指定する必要があります。 |
version |
(省略可)プリウォームする特定のアーティファクト バージョン。version または tag を指定する必要があります。 |
retention_days |
(省略可)アーティファクトをキャッシュに保持する日数。このフィールドを指定しない場合、デフォルトは 3 日間です。 |
force |
(省略可)true の場合、システムは古いアーティファクトを削除して、このアーティファクトのスペースを確保することがあります。 |
例: 特定のバージョンを事前準備する
次の例では、my-repo リポジトリの nginx パッケージのバージョン sha256:52e... を事前ウォーミングします。
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{
"version": "projects/my-project/locations/us-central1/repositories/my-repo/packages/nginx/versions/sha256:52e85304675567b5e656f5e997576a9d20c57176",
"retention_days": 7
}' \
"https://artifactregistry.googleapis.com/v1/projects/my-project/locations/us-central1/repositories/my-repo:prewarmArtifact"
例: タグを事前準備する
次の例では、my-app パッケージの production タグ付きイメージをプリウォームします。
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{
"tag": "projects/my-project/locations/us-central1/repositories/my-repo/packages/my-app/tags/production",
"force": true
}' \
"https://artifactregistry.googleapis.com/v1/projects/my-project/locations/us-central1/repositories/my-repo:prewarmArtifact"
事前準備のステータスを確認する
アーティファクトが事前ウォーミングされているかどうかを確認するには、:checkPrewarmedArtifact メソッドを使用します。
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{
"version": "projects/my-project/locations/us-central1/repositories/my-repo/packages/nginx/versions/sha256:52e85304675567b5e656f5e997576a9d20c57176"
}' \
"https://artifactregistry.googleapis.com/v1/projects/my-project/locations/us-central1/repositories/my-repo:checkPrewarmedArtifact"
事前ウォーミングされたアーティファクトを一覧表示する
リポジトリ内のすべての事前ウォーミングされたアーティファクトを一覧表示するには、prewarmedArtifacts コレクションで GET メソッドを使用します。
curl -X GET \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
"https://artifactregistry.googleapis.com/v1/projects/my-project/locations/us-central1/repositories/my-repo/prewarmedArtifacts"
キャッシュから削除
プリウォーム キャッシュからアーティファクトを明示的に削除するには、:removePrewarmedArtifact メソッドを使用します。この方法は、スペースを解放する場合や、特定の画像モードがキャッシュで不要になった場合に使用します。
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-d '{
"version": "projects/my-project/locations/us-central1/repositories/my-repo/packages/nginx/versions/sha256:52e85304675567b5e656f5e997576a9d20c57176"
}' \
"https://artifactregistry.googleapis.com/v1/projects/my-project/locations/us-central1/repositories/my-repo:removePrewarmedArtifact"