クリーンアップポリシーの設定

Artifact Registry のクリーンアップポリシーでは、不要になったアーティファクトバージョンを自動的に削除する、または無期限に保存するアーティファクトを保持するための条件を定義します。

クリーンアップポリシーは、アーティファクトの多くのバージョンを保存するが、本番環境にリリースする特定のバージョンのみを保持する必要がある場合に便利です。アーティファクトを削除する条件で削除ポリシーを定義し、アーティファクトを保持する条件で保持ポリシーを定義できます。

アーティファクトバージョンが削除ポリシーと保持ポリシーの両方の条件と一致する場合、Artifact Registry は保持ポリシーを適用します。

削除ポリシーによってトリガーされる削除は、Artifact Registry のプロジェクトごとの削除リクエストの割り当てに対してカウントされ、1 日あたりのリポジトリごとに 300,000 件の削除に制限されます。

ポリシーの適用スケジュール

Artifact Registry では、定期的に実行されるバックグラウンドジョブを使用して、クリーンアップポリシーに一致するアーティファクトを削除、保持します。変更は約 1 日以内に有効になります。

リポジトリごとのクリーンアップポリシーの最大数

1 つのリポジトリには最大 10 個のクリーンアップポリシーを適用できます。

サポートされているファイル形式

すべてのリポジトリ形式について、標準リポジトリとリモートリポジトリにクリーンアップポリシーを設定できます。

必要なロール

クリーンアップポリシーを適用または削除するために必要な権限を取得するには、リポジトリプロジェクトに対する Artifact Registry 管理者（roles/artifactregistry.admin）IAM ロールの付与を管理者に依頼してください。ロールの付与の詳細については、アクセスの管理をご覧ください。

この事前定義ロールには、クリーンアップポリシーを適用または削除するために必要な権限が含まれています。必要な権限を正確に確認するには、[必要な権限] セクションを開いてください。

必要な権限

クリーンアップポリシーを適用または削除するには、次の権限が必要です。

artifactregistry.repositories.update
クリーンアップポリシーの条件を満たすアーティファクトを削除するには: artifactregistry.versions.delete

カスタムロールや他の事前定義ロールを使用して、これらの権限を取得することもできます。

Artifact Registry サービスエージェントのデフォルトのロールには権限 artifactregistry.versions.delete が含まれています。これは、クリーンアップポリシーの条件を満たすイメージを削除するために必要な権限です。

ポリシーファイルを作成する

ポリシーファイルは、削除ポリシーと保持ポリシーを定義する JSON ファイルです。ポリシーファイルを作成するには、JSON ファイルを作成して編集し、Google Cloud CLI を使用してポリシーを適用するか、Google Cloud コンソールを使用します。削除ポリシーでは、アーティファクトを削除するための条件を指定します。保持ポリシーでは、アーティファクトを保持する条件または保持するバージョンの数を指定します。条件とバージョンの数を、同じ保持ポリシーに使用することはできません。

削除ポリシーを作成する

削除ポリシーによって、アーティファクトの削除の最小期間または最大期間と、追加のフィルタリング条件を指定して、ポリシーを特定のアーティファクトに限定できます。

なんらかの理由で削除したくないアーティファクトがある場合は、削除ポリシーとともに、条件付き保持ポリシーを作成するか、最新バージョンの保持ポリシーを作成します。アーティファクトが削除ポリシーと keep ポリシーの両方の条件に一致する場合、アーティファクトは保持されます。

Console

削除ポリシーは、新しいリポジトリか既存のリポジトリに対して作成できます。

既存のリポジトリに削除ポリシーを追加するには:

Google Cloud コンソールで [リポジトリ] ページを開きます。

[リポジトリ] ページを開く
リポジトリリストでリポジトリを選択し、[リポジトリの編集] をクリックします。
アーティファクトの削除を commit する前に、[クリーンアップポリシー] セクションで [ドライラン] を選択して新しいポリシーをテストします。テスト結果を確認する詳細については、ドライランをご覧ください。

ポリシーが意図したとおりに機能していることを確認したら、リポジトリの設定を再度編集し、[アーティファクトの削除] を選択してクリーンアップポリシーを適用し、選択したアーティファクトを削除します。
[クリーンアップポリシーを追加] をクリックして、次の内容を追加します。
- 名前: クリーンアップポリシーに名前を付けます。この名前は、リポジトリに適用するポリシーのグループ内で一意にする必要があります。
- ポリシータイプ: [条件付き削除] を選択します。
- タグの状態: タグ付けされたアーティファクトかタグ付けされていないアーティファクトかをポリシーで確認するかどうかを指定します。イメージをリポジトリに push またはリポジトリから pull するときに、アーティファクトにタグが付けられます。Docker タグの詳細については、コンテナのコンセプトをご覧ください。
  - 任意のタグ状態: タグの状態を無視し、タグ付けされたアーティファクトとタグ付けされていないアーティファクトの両方に適用されます。
  - タグ付き: タグ付けされたアーティファクトにのみ適用されます。
  - タグなし: タグ付けされていないアーティファクトにのみ適用されます。
  タグをサポートしていない形式は、untagged として扱われます。リポジトリで不変のタグが有効になっている場合、タグ付けされたアーティファクトは削除できません。
  
  クリーンアップポリシーに適用されるタグの状態の詳細については、TagState リファレンスをご覧ください。
削除ポリシーを定義する省略可能な方法は次のとおりです。
- タグ接頭辞: タグ接頭辞のカンマ区切りのリスト。たとえば、接頭辞 test と staging は、タグ testenv と staging-1.5 が付けられたイメージと一致します。タグ接頭辞を使用するには、tagState を TAGGED に設定する必要があります。
- バージョン接頭辞: アーティファクトバージョンの接頭辞のカンマ区切りリスト。たとえば、v1、v2 は、バージョン v1.5、v2.0alpha、v10.2 と一致します。
- パッケージ接頭辞: アーティファクト名の接頭辞のリスト。接頭辞間で Enter または , を入力することにより、複数の接頭辞を入力できます。たとえば、red, blue は red と blue の 2 つの接頭辞を作成し、アーティファクト名 red-team、redis、bluebird と一致します。
- 次より古い: アーティファクトのバージョンがリポジトリ内に作成されてからの最小時間で、期間として指定されます。たとえば、30d は 30 日間です。それぞれ、s、m、h、d を追加することにより、秒、分、時、日の期間を指定できます。
- 次より新しい: アーティファクトのバージョンがリポジトリ内に作成されてからの最大時間で、期間として指定されます。たとえば、30d は 30 日間です。
クリーンアップポリシーは、[クリーンアップポリシーを追加] をクリックすることでさらに追加できます。
[更新] をクリックします。

クリーンアップポリシーがリポジトリに適用されます。[リポジトリの詳細] セクションで [Show more] をクリックすると、クリーンアップポリシーを表示できます。

JSON

{
  "name": "DELETE_POLICY_NAME",
  "action": {"type": "Delete"},
  "condition": {
    "tagState": "TAG_STATUS",
    "tagPrefixes": ["TAG_PREFIXES"],
    "versionNamePrefixes": ["VERSION_PREFIXES"],
    "packageNamePrefixes": ["PACKAGE_PREFIXES"],
    "olderThan": "OLDER_THAN_DURATION",
    "newerThan": "NEWER_THAN_DURATION"
  }
}

削除ポリシーには、名前、アクション、1 つ以上の条件を含める必要があります。

name: 削除ポリシーのスニペットでは、DELETE_POLICY_NAME はポリシーの名前です。この名前は、リポジトリに適用するポリシーのグループ内で一意にする必要があります。
action: 削除ポリシーの場合、値は {"type": "Delete"} です。
condition: 次の条件を 1 つ以上指定します。

tagState: TAG_STATUS は、タグ付けされたアーティファクトまたはタグ付けされていないアーティファクトをポリシーで確認する必要があるかを示します。イメージをリポジトリに push またはリポジトリから pull するときに、アーティファクトにタグが付けられます。サポートされている値は次のとおりです。
- tagged: タグ付けされたアーティファクトにのみ適用されます。
- untagged: タグ付けされていないアーティファクトにのみ適用されます。
- any: タグの状態を無視し、タグ付けされたアーティファクトとタグ付けされていないアーティファクトの両方に適用されます。
タグをサポートしていない形式は、untagged として扱われます。リポジトリで不変のタグが有効になっている場合、タグ付けされたアーティファクトは削除できません。

Docker タグの詳細については、コンテナのコンセプトをご覧ください。
tagPrefixes: TAG_PREFIXES はタグ接頭辞のカンマ区切りのリストです。たとえば、"test", "staging" は、タグ "testenv" と "staging-1.5" を持つイメージと一致します。タグ接頭辞を使用するには、tagState を TAGGED に設定する必要があります。
versionNamePrefixes: VERSION_PREFIXES は、アーティファクトバージョンの接頭辞のカンマ区切りのリストです。たとえば、"v1", "v2" は、バージョン "v1.5"、"v2.0alpha"、"v10.2" と一致します。
packageNamePrefixes: PACKAGE_PREFIXES は、アーティファクト名の接頭辞のカンマ区切りのリストです。たとえば、"red", "blue" は、アーティファクト名 "red-team"、"redis"、"bluebird" と一致します。
olderThan: OLDER_THAN_DURATION は、アーティファクトのバージョンがリポジトリ内に作成されてからの最小時間であり、期間として指定されます。たとえば、30d は 30 日間です。それぞれ、s、m、h、d を追加することにより、秒、分、時、日の期間を指定できます。
newerThan: NEWER_THAN_DURATION は、アーティファクトのバージョンがリポジトリ内に作成されてからの最大時間で、期間として指定されます。たとえば、30d は 30 日間です。

条件付き保持ポリシーの作成

条件付き保持ポリシーでは、アーティファクトの保持の条件を指定します。ポリシーは、削除ポリシーと連携して、削除ポリシーの仕様に従って削除されるものの、保持する必要があるアーティファクトを保持します。アーティファクトが削除ポリシーと keep ポリシーの両方の条件に一致すると、アーティファクトは保持されます。

Console

保持ポリシーは、新規または既存のリポジトリに対して作成できます。

既存のリポジトリに保持ポリシーを追加するには:

Google Cloud コンソールで [リポジトリ] ページを開きます。

[リポジトリ] ページを開く
リポジトリリストでリポジトリを選択し、[リポジトリの編集] をクリックします。
アーティファクトの削除を commit する前に、[クリーンアップポリシー] セクションで [ドライラン] を選択して新しいポリシーをテストします。保持ポリシーの結果を表示するには、少なくとも 1 つの削除ポリシーを設定する必要があります。テスト結果を確認する詳細については、ドライランをご覧ください。

ポリシーが意図したとおりに機能していることを確認したら、リポジトリの設定を再度編集し、[アーティファクトの削除] を選択してクリーンアップポリシーを適用し、選択したアーティファクトを削除します。
[クリーンアップポリシーを追加] をクリックして、次の内容を追加します。
- 名前: クリーンアップポリシーに名前を付けます。この名前は、リポジトリに適用するポリシーのグループ内で一意にする必要があります。
- ポリシーの種類: [条件付き保持] を選択します。
- タグの状態: タグ付けされたアーティファクトかタグ付けされていないアーティファクトかをポリシーで確認するかどうかを指定します。イメージをリポジトリに push またはリポジトリから pull するときに、アーティファクトにタグが付けられます。Docker タグの詳細については、コンテナのコンセプトをご覧ください。
  - 任意のタグ状態: タグの状態を無視し、タグ付けされたアーティファクトとタグ付けされていないアーティファクトの両方に適用されます。
  - タグ付き: タグ付けされたアーティファクトにのみ適用されます。
  - タグなし: タグ付けされていないアーティファクトにのみ適用されます。
  タグをサポートしていない形式は、untagged として扱われます。リポジトリで不変のタグが有効になっている場合、タグ付けされたアーティファクトは削除できません。クリーンアップポリシーに適用されるタグの状態の詳細については、TagState リファレンスをご覧ください。
保持ポリシーを定義する省略可能な方法は次のとおりです。
- タグ接頭辞: タグ接頭辞のカンマ区切りのリスト。たとえば、接頭辞 test と staging は、タグ testenv と staging-1.5 が付けられたイメージと一致します。タグ接頭辞を使用するには、tagState を TAGGED に設定する必要があります。
- バージョン接頭辞: アーティファクトバージョンの接頭辞のカンマ区切りリスト。たとえば、v1、v2 は、バージョン v1.5、v2.0alpha、v10.2 と一致します。
- パッケージ接頭辞: アーティファクト名の接頭辞のカンマ区切りのリスト。たとえば、red, blue は、アーティファクト名 red-team、redis、bluebird と一致します。
注意: パッケージ接頭辞が指定されている場合、Artifact Registry は指定されたパッケージ接頭辞と一致するパッケージの最新バージョンのみを保持します。
- 次より古い: アーティファクトのバージョンがリポジトリ内に作成されてからの最小時間で、期間として指定されます。たとえば、30d は 30 日間です。それぞれ、s、m、h、d を追加することにより、秒、分、時、日の期間を指定できます。
- 次より新しい: アーティファクトのバージョンがリポジトリ内に作成されてからの最大時間で、期間として指定されます。たとえば、30d は 30 日間です。
クリーンアップポリシーは、[クリーンアップポリシーを追加] をクリックすることでさらに追加できます。
[更新] をクリックします。

クリーンアップポリシーがリポジトリに適用されます。

JSON

形式は削除ポリシーに似ています。保持ポリシーの場合、action の値は {"type": "Keep"} です。

{
  "name": "KEEP_POLICY_NAME",
  "action": {"type": "Keep"},
  "condition": {
    "tagState": "TAG_STATUS",
    "tagPrefixes": ["TAG_PREFIXES"],
    "versionNamePrefixes": ["VERSION_PREFIXES"],
    "packageNamePrefixes": ["PACKAGE_PREFIXES"],
    "olderThan": "OLDER_THAN_DURATION",
    "newerThan": "NEWER_THAN_DURATION"
  }
}

以下を置き換えます。

KEEP_POLICY_NAME は、クリーンアップポリシーの名前に置き換えます。この名前は、リポジトリに適用するポリシーのグループ内で一意にする必要があります。
TAG_STATUS は、タグの状態に置き換えます。これは、ポリシーが、タグ付けされたアーティファクトとタグ付けされていないアーティファクトのどちらをチェックするかを示します。イメージをリポジトリに push またはリポジトリから pull するときに、アーティファクトにタグが付けられます。Docker タグの詳細については、コンテナのコンセプトをご覧ください。

次のオプションがあります。
- tagged: タグ付けされたアーティファクトにのみ適用されます。
- untagged: タグ付けされていないアーティファクトにのみ適用されます。
- any: すべてのバージョンに適用されます。
タグをサポートしていない形式は、untagged として扱われます。リポジトリで不変のタグが有効になっている場合、タグ付けされたアーティファクトは削除できません。クリーンアップポリシーに適用されるタグの状態の詳細については、TagState リファレンスをご覧ください。
TAG_PREFIXES は、タグ接頭辞のカンマ区切りのリストに置き換えます。たとえば、接頭辞 test と staging は、タグ testenv と staging-1.5 が付けられたイメージと一致します。タグ接頭辞を使用するには、tagState を TAGGED に設定する必要があります。
VERSION_PREFIXES は、アーティファクトバージョンの接頭辞のカンマ区切りのリストに置き換えます。たとえば、v1, v2 は、バージョン v1.5、v2.0alpha、v10.2 と一致します。
PACKAGE_PREFIXES は、アーティファクト名の接頭辞のカンマ区切りのリストに置き換えます。たとえば、red, blue は、アーティファクト名 red-team、redis、bluebird と一致します。

OLDER_THAN_DURATION は、リポジトリのバージョンがリポジトリに作成されてからの最小期間（期間）に置き換えます。たとえば、30d は 30 日間です。それぞれ、s、m、h、d を追加することにより、秒、分、時、日の期間を指定できます。
NEWER_THAN_DURATION は、アーティファクトのバージョンがリポジトリで作成されてからの最大時間（期間）に置き換えます。たとえば、30d は 30 日間です。

Console

最新バージョンの保持ポリシーは、新規または既存のリポジトリに対して作成できます。

最新バージョンの保持ポリシーを既存のリポジトリに追加するには:

Google Cloud コンソールで [リポジトリ] ページを開きます。

[リポジトリ] ページを開く
リポジトリリストでリポジトリを選択し、[リポジトリの編集] をクリックします。
アーティファクトの削除を commit する前に、[クリーンアップポリシー] セクションで [ドライラン] を選択して新しいポリシーをテストします。保持ポリシーの結果を表示するには、少なくとも 1 つの削除ポリシーを設定する必要があります。テスト結果を確認する詳細については、ドライランをご覧ください。

ポリシーが意図したとおりに機能していることを確認したら、リポジトリの設定を再度編集し、[アーティファクトの削除] を選択してクリーンアップポリシーを適用し、選択したアーティファクトを削除します。
[クリーンアップポリシーを追加] をクリックして、次の内容を追加します。
- 名前: クリーンアップポリシーに名前を付けます。この名前は、リポジトリに適用するポリシーのグループ内で一意にする必要があります。
- ポリシータイプ: [最新のバージョンを保持] を選択します。
[保持数] フィールドに、リポジトリに保持するアーティファクトのバージョン数を入力します。
省略可: [パッケージの接頭辞] を選択して、保持ポリシーを適用するパッケージの接頭辞を指定します。たとえば、red, blue は、アーティファクト名 red-team、redis、bluebird と一致します。

注意: パッケージ接頭辞が指定されている場合、Artifact Registry は指定されたパッケージ接頭辞と一致するパッケージの最新バージョンのみを保持します。
クリーンアップポリシーは、[クリーンアップポリシーを追加] をクリックすることでさらに追加できます。
[更新] をクリックします。

クリーンアップポリシーがリポジトリに適用されます。[リポジトリの詳細] セクションで [Show more] をクリックすると、クリーンアップポリシーを表示できます。

JSON

形式は削除ポリシーに似ています。保持ポリシーの場合、action の値は {"type": "Keep"} です。

特定の数のバージョンを保持する保持ポリシーには、condition セクションではなく mostRecentVersions セクションがあります。

{
  "name": "KEEP_POLICY_NAME",
  "action": {"type": "Keep"},
  "mostRecentVersions": {
    "packageNamePrefixes": ["PACKAGE_PREFIXES"],
    "keepCount": MINIMUM_NUMBER
  }
}

以下を置き換えます。

KEEP_POLICY_NAME は、保持ポリシーの名前に置き換えます。この名前は、リポジトリに適用するポリシーのグループ内で一意にする必要があります。
PACKAGE_PREFIXES は、保持ポリシーを適用する省略可能なパッケージ接頭辞に置き換えます。たとえば、red, blue は、アーティファクト名 red-team、redis、bluebird と一致します。

MINIMUM_NUMBER は、リポジトリに保持するアーティファクトのバージョン数に置き換えます。

リポジトリ内のすべてのパッケージに保持ポリシーを適用するには、packageNamePrefixes 条件を省略します。リポジトリ内の各パッケージについて、指定された数の最新バージョンが保持されます。

ポリシーファイルの例

次のポリシーファイルの例では、1 つの削除ポリシーと 2 つの保持ポリシーがあります。

delete-prerelease ポリシーは、アーティファクトが alpha または v0 の文字列で始まっている場合、アーティファクトバージョンをアップロードから 30 日後に削除します。
keep-tagged-release ポリシーは、webapp または mobile で始まるファイル名を持つ、接頭辞 release でタグ付けされたアーティファクトを保持します。
keep-minimum-versions ポリシーは、webapp、mobile、または sandbox で始まるファイル名を持つ、アーティファクトの最新の 5 つのバージョンを保持します。

[
  {
    "name": "delete-prerelease",
    "action": {"type": "Delete"},
    "condition": {
      "tagState": "tagged",
      "tagPrefixes": ["alpha", "v0"],
      "olderThan": "30d"
    }
  },
  {
    "name": "keep-tagged-release",
    "action": {"type": "Keep"},
    "condition": {
      "tagState": "tagged",
      "tagPrefixes": ["release"],
      "packageNamePrefixes": ["webapp", "mobile"]
    }
  },
  {
    "name": "keep-minimum-versions",
    "action": {"type": "Keep"},
    "mostRecentVersions": {
      "packageNamePrefixes": ["webapp", "mobile", "sandbox"],
      "keepCount": 5
    }
  }
]

ドライランでポリシーをテストする

クリーンアップポリシーをテストするには、コンソールでクリーンアップポリシーを設定するか、--dry-run フラグを指定して gcloud artifacts set-cleanup-policies コマンドを実行します。

クリーンアップポリシーの効果を分析するには、Artifact Registry のデータアクセス監査ログを確認します。クリーンアップポリシーのデータアクセス監査ログを受信するには、Artifact Registry サービスのデータアクセス監査ログのデータ書き込みタイプを明示的に有効にする必要があります。データアクセス監査ログを有効にするには、監査ログを有効にするをご覧ください。

Console

Google Cloud コンソールで [リポジトリ] ページを開きます。

[リポジトリ] ページを開く
リポジトリリストでリポジトリを選択し、[リポジトリの編集] をクリックします。
[クリーンアップポリシー] セクションで、[ドライラン] を選択します。
[クリーンアップポリシーを追加する] をクリックし、条件付き削除、条件付き保持、または最新バージョンを保持ポリシーのオプションを構成します。
[更新] をクリックします。

削除ポリシーによって BatchDeleteVersions アクションが行われると、パラメータ validateOnly が "true" と評価されます。

クリーンアップポリシーのドライランの監査ログをクエリするには、次のコマンドを実行します。

gcloud logging read 'protoPayload.serviceName="artifactregistry.googleapis.com" AND protoPayload.request.parent:"projects/PROJECT_ID/locations/LOCATION/repositories/REPOSITORY" AND protoPayload.request.validateOnly=true' \
    --resource-names="projects/PROJECT_ID" \
    --project=PROJECT_ID

出力は次のようになります。

insertId: qwe123ty3
logName: projects/my-project/logs/cloudaudit.googleapis.com%2Fdata_access
operation:
  first: true
  id: projects/my-project/locations/us-west1/operations/12345abc-fb9b-4b6f-b02c-9a397ee807d4
  producer: artifactregistry.googleapis.com
protoPayload:
  '@type': type.googleapis.com/google.cloud.audit.AuditLog
  authenticationInfo:
    principalEmail: service-774919394028@gcp-sa-staging-artreg.iam.gserviceaccount.com
  authorizationInfo:
  - granted: true
    permission: artifactregistry.versions.delete
    resource: projects/my-project/locations/us-west1/repositories/docker-test-dryrun/packages/-
    resourceAttributes: {}
  methodName: google.devtools.artifactregistry.v1.ArtifactRegistry.BatchDeleteVersions
  request:
    '@type': type.googleapis.com/google.devtools.artifactregistry.v1.BatchDeleteVersionsRequest
    names:
    - projects/my-project/locations/us-west1/repositories/docker-test-dryrun/packages/docker-load-thursday/versions/sha256:4bb3756e4e75dfbc3ced87521ed62b26d16fb4e17993ae6877165f2b6551fb55
    - projects/my-project/locations/us-west1/repositories/docker-test-dryrun/packages/docker-load-thursday/versions/sha256:e8185538b50df953529b300be4963b2c21158808becac7aa0d610f61de8ba701
    - projects/my-project/locations/us-west1/repositories/docker-test-dryrun/packages/docker-load-thursday/versions/sha256:7f7fb0a9453da49f831fe92eb8b1751be13acefe1bbd44cc3f0d63d41c422246
    - projects/my-project/locations/us-west1/repositories/docker-test-dryrun/packages/docker-load-thursday/versions/sha256:84ac871a34560b39dd7bde57b4d333f18a7e8c1b61c8d350c1fefeb1fcd2b3ac
parent: projects/my-project/locations/us-west1/repositories/docker-test-dryrun/packages/-
    validateOnly: true
  requestMetadata:
    callerIp: private
    callerSuppliedUserAgent: stubby_client
    destinationAttributes: {}
    requestAttributes:
      auth: {}
      time: '2023-05-26T04:31:21.909465579Z'
  resourceName: projects/my-project/locations/us-west1/repositories/docker-test-dryrun/packages/-
  serviceName: artifactregistry.googleapis.com
receiveTimestamp: '2023-05-26T04:31:22.641338594Z'
resource:
  labels:
    method: google.devtools.artifactregistry.v1.ArtifactRegistry.BatchDeleteVersions
    project_id: my-project
    service: artifactregistry.googleapis.com
  type: audited_resource
severity: INFO
timestamp: '2023-05-26T04:31:21.909004200Z'

gcloud CLI

クリーンアップポリシーのドライランを行うには、次のコマンドを実行します。

gcloud artifacts repositories set-cleanup-policies REPOSITORY \
    --project=PROJECT_ID \
    --location=LOCATION \
    --policy=POLICY_FILE \
    --dry-run

以下を置き換えます。

REPOSITORY はリポジトリの名前に置き換えます。
PROJECT_ID は、Google Cloud プロジェクトの ID に置き換えます。
LOCATION は、リポジトリのリージョンまたはマルチリージョンのロケーションに置き換えます。

削除ポリシーによって BatchDeleteVersions アクションが行われると、パラメータ validateOnly が "true" と評価されます。

クリーンアップポリシーのドライランの監査ログをクエリするには、次のコマンドを実行します。

gcloud logging read 'protoPayload.serviceName="artifactregistry.googleapis.com" AND protoPayload.request.parent:"projects/PROJECT_ID/locations/LOCATION/repositories/REPOSITORY" AND protoPayload.request.validateOnly=true' \
    --resource-names="projects/PROJECT_ID" \
    --project=PROJECT_ID

出力は次のようになります。

insertId: qwe123ty3
logName: projects/my-project/logs/cloudaudit.googleapis.com%2Fdata_access
operation:
  first: true
  id: projects/my-project/locations/us-west1/operations/12345abc-fb9b-4b6f-b02c-9a397ee807d4
  producer: artifactregistry.googleapis.com
protoPayload:
  '@type': type.googleapis.com/google.cloud.audit.AuditLog
  authenticationInfo:
    principalEmail: service-774919394028@gcp-sa-staging-artreg.iam.gserviceaccount.com
  authorizationInfo:
  - granted: true
    permission: artifactregistry.versions.delete
    resource: projects/my-project/locations/us-west1/repositories/docker-test-dryrun/packages/-
    resourceAttributes: {}
  methodName: google.devtools.artifactregistry.v1.ArtifactRegistry.BatchDeleteVersions
  request:
    '@type': type.googleapis.com/google.devtools.artifactregistry.v1.BatchDeleteVersionsRequest
    names:
    - projects/my-project/locations/us-west1/repositories/docker-test-dryrun/packages/docker-load-thursday/versions/sha256:4bb3756e4e75dfbc3ced87521ed62b26d16fb4e17993ae6877165f2b6551fb55
    - projects/my-project/locations/us-west1/repositories/docker-test-dryrun/packages/docker-load-thursday/versions/sha256:e8185538b50df953529b300be4963b2c21158808becac7aa0d610f61de8ba701
    - projects/my-project/locations/us-west1/repositories/docker-test-dryrun/packages/docker-load-thursday/versions/sha256:7f7fb0a9453da49f831fe92eb8b1751be13acefe1bbd44cc3f0d63d41c422246
    - projects/my-project/locations/us-west1/repositories/docker-test-dryrun/packages/docker-load-thursday/versions/sha256:84ac871a34560b39dd7bde57b4d333f18a7e8c1b61c8d350c1fefeb1fcd2b3ac
parent: projects/my-project/locations/us-west1/repositories/docker-test-dryrun/packages/-
    validateOnly: true
  requestMetadata:
    callerIp: private
    callerSuppliedUserAgent: stubby_client
    destinationAttributes: {}
    requestAttributes:
      auth: {}
      time: '2023-05-26T04:31:21.909465579Z'
  resourceName: projects/my-project/locations/us-west1/repositories/docker-test-dryrun/packages/-
  serviceName: artifactregistry.googleapis.com
receiveTimestamp: '2023-05-26T04:31:22.641338594Z'
resource:
  labels:
    method: google.devtools.artifactregistry.v1.ArtifactRegistry.BatchDeleteVersions
    project_id: my-project
    service: artifactregistry.googleapis.com
  type: audited_resource
severity: INFO
timestamp: '2023-05-26T04:31:21.909004200Z'

リポジトリにポリシーを適用する

ローカル JSON ファイルで定義されたクリーンアップポリシーを使用するには、gcloud CLI を使用して、Artifact Registry がアーティファクトバージョンの自動削除を処理するリポジトリに適用します。

コンソールで [ドライラン] に設定したクリーンアップポリシーを適用するには、ポリシーを [アーティファクトを削除] に設定します。

クリーンアップポリシーは標準リポジトリのみに適用できます。クリーンアップポリシーを適用することはできません。

Google Cloud プロジェクト
仮想リポジトリ。

Console

クリーンアップポリシーを適用するには:

Google Cloud コンソールで [リポジトリ] ページを開きます。

[リポジトリ] ページを開く
リポジトリリストでリポジトリを選択し、[リポジトリの編集] をクリックします。
[クリーンアップポリシー] セクションで、[アーティファクトを削除] を選択します。

Artifact Registry では、定期的に実行されるバックグラウンドジョブを使用して、ポリシーに一致するアーティファクトを削除、保持します。変更は約 1 日以内に有効になります。

gcloud

クリーンアップポリシーを適用するには、クリーンアップポリシーファイルがあるディレクトリで次のコマンドを実行します。

gcloud artifacts repositories set-cleanup-policies REPOSITORY \
    --project=PROJECT_ID \
    --location=LOCATION \
    --policy=POLICY_FILE \
    --no-dry-run

以下を置き換えます。

REPOSITORY はリポジトリの名前に置き換えます。
PROJECT_ID は、Google Cloud プロジェクトの ID に置き換えます。
LOCATION は、リポジトリのリージョンまたはマルチリージョンのロケーションに置き換えます。
--no-dry-run は、リポジトリのドライラン機能を無効にします。
POLICY_FILE は、クリーンアップポリシーを含むファイルの名前です。

たとえば、次のコマンドでは、policy.json のポリシーがプロジェクト my-project のリージョン us-east1 のリポジトリ my-repo に適用されます。

gcloud artifacts repositories set-cleanup-policies my-repo \
    --project=my-project \
    --location=us-east1 \
    --policy=policy.json

Artifact Registry では、定期的に実行されるバックグラウンドジョブを使用して、ポリシーに一致するアーティファクトを削除、保持します。変更は約 1 日以内に有効になります。

ポリシーを更新する

Console

Google Cloud コンソールで [リポジトリ] ページを開きます。

[リポジトリ] ページを開く
リポジトリリストでリポジトリを選択し、[リポジトリの編集] をクリックします。
[クリーンアップポリシー] セクションで、変更するポリシーの名前をクリックします。
クリーンアップポリシーを編集して、[更新] をクリックします。

クリーンアップポリシーがリポジトリに適用されます。

gcloud CLI

既存のポリシーを更新するには、ポリシーファイルの設定を編集してから、再度次のコマンドを実行してポリシーを適用します。

gcloud artifacts repositories set-cleanup-policies REPOSITORY \
    --project=PROJECT_ID \
    --location=LOCATION \
    --policy=POLICY_FILE \
    --no-dry-run

以下を置き換えます。

REPOSITORY はリポジトリの名前に置き換えます。
PROJECT_ID は、Google Cloud プロジェクトの ID に置き換えます。
LOCATION は、リポジトリのリージョンまたはマルチリージョンのロケーションに置き換えます。
--no-dry-run は、リポジトリのドライラン機能を無効にします。
POLICY_FILE は、クリーンアップポリシーを含むファイルの名前です。

リポジトリのクリーンアップポリシーを一覧表示する

リポジトリに関連付けられたクリーンアップポリシーを表示できます。

Console

Google Cloud コンソールで [リポジトリ] ページを開きます。

[リポジトリ] ページを開く
[リポジトリ] リストで、表示するリポジトリを選択します。
[リポジトリの詳細] セクションで、[もっと見る] をクリックします。

クリーンアップポリシーの名前が表示されます。
リポジトリのクリーンアップポリシーの詳細を表示または編集するには、[リポジトリを編集] をクリックします。

既存のクリーンアップポリシーの詳細が、クリーンアップポリシーのセクションに表示されます。

gcloud CLI

次のコマンドを実行します。

gcloud artifacts repositories list-cleanup-policies REPOSITORY \
    --project=PROJECT_ID \
    --location=LOCATION

以下を置き換えます。

REPOSITORY はリポジトリの名前に置き換えます。
PROJECT_ID は、Google Cloud プロジェクトの ID に置き換えます。
LOCATION は、リポジトリのリージョンまたはマルチリージョンのロケーションに置き換えます。

リポジトリからポリシーを削除する

Artifact Registry でアーティファクトのバージョンを自動的に削除する必要がなくなった場合は、リポジトリからクリーンアップポリシーを削除します。

Console

Google Cloud コンソールで [リポジトリ] ページを開きます。

[リポジトリ] ページを開く
リポジトリリストでリポジトリを選択し、[リポジトリの編集] をクリックします。
[クリーンアップポリシー] セクションで、削除するポリシーの名前にカーソルを合わせます。
[削除] アイコンをクリックします。
[更新] をクリックします。

クリーンアップポリシーが削除されます。

gcloud CLI

次のコマンドを実行します。

gcloud artifacts repositories delete-cleanup-policies REPOSITORY \
    --policynames=POLICY_NAMES \
    --project=PROJECT_ID \
    --location=LOCATION

以下を置き換えます。

REPOSITORY はリポジトリの名前です。
PROJECT_ID は、Google Cloud プロジェクトの ID です。
LOCATION は、リポジトリのリージョンまたはマルチリージョンのロケーションです。
POLICY_NAMES は、削除するポリシーのポリシー名のカンマ区切りリストです。

たとえば、次のコマンドは、プロジェクト my-project のリージョン us-east1 のリポジトリ my-repo から delete-test という名前のポリシーを削除します。

gcloud artifacts repositories delete-cleanup-policies my-repo \
    --policynames=delete-test \
    --project=my-project \
    --location=us-east1

クリーンアップポリシーの監査ログエントリ

Cloud Logging でクリーンアップポリシーのログエントリを表示するには、DATA_WRITE ロギングを有効にする必要があります。

リポジトリにクリーンアップポリシーを設定すると、オペレーションはリポジトリの更新（UpdateRepository オペレーション）として記録されます。

Artifact Registry からアーティファクトのバージョンが削除されると、イベントが Cloud Logging のデータアクセスログに記録されます。Artifact Registry サービスアカウントによって削除が行われたことがログエントリに示されます。Artifact Registry サービスアカウント ID の形式は service-PROJECT-NUMBER@gcp-sa-artifactregistry.iam.gserviceaccount.com です。

その他のツール

コンテナイメージの場合は、次のツールを使用してイメージのライフサイクル管理を行うこともできます。

gcrane: レポジトリ間でイメージをコピーするために使用できるコンテナレジストリ用のツールです。
gcr-cleaner: 指定した条件に基づいてコンテナイメージを削除するツール。

gcrane ツールと gcr-cleaner ツールは、Google の公式プロダクトではありません。

クリーンアップ ポリシーの設定

ポリシーの適用スケジュール

リポジトリごとのクリーンアップ ポリシーの最大数

サポートされているファイル形式

必要なロール

必要な権限

ポリシー ファイルを作成する

削除ポリシーを作成する

Console

JSON

条件付き保持ポリシーの作成

Console

JSON

最新バージョンの保持ポリシーを作成する

Console

JSON

ポリシー ファイルの例

ドライランでポリシーをテストする

Console

gcloud CLI

リポジトリにポリシーを適用する

Console

gcloud

ポリシーを更新する

Console

gcloud CLI

リポジトリのクリーンアップ ポリシーを一覧表示する

Console

gcloud CLI

リポジトリからポリシーを削除する

Console

gcloud CLI

クリーンアップ ポリシーの監査ログエントリ

その他のツール

クリーンアップポリシーの設定

リポジトリごとのクリーンアップポリシーの最大数

ポリシーファイルを作成する

ポリシーファイルの例

リポジトリのクリーンアップポリシーを一覧表示する

クリーンアップポリシーの監査ログエントリ