Container Registry コマンドラインインタフェース

注記

Container Registry CLI、 ibmcloud cr コマンドの使い方の詳細については、 Getting started with IBM Cloud Container Registry を参照。

ibmcloud CLI および container-registry CLI プラグインのアップデートが利用可能になると、コマンドラインで通知されます。 利用可能なコマンドやオプションをすべて使用できるように、CLIを常に最新の状態に保つようにしてください。 container-registry CLIプラグインの現在のバージョンを表示したい場合は、 ibmcloud plugin list コマンドを実行します。

一部の Container Registry コマンドに必要な IAM プラットフォームとサービスのアクセス・ロールの詳細については、 Container Registry の IAM アクセスの管理 を参照してください。

コンテナー・イメージ、名前空間名、説明フィールド、イメージ構成データ (イメージ名やイメージ・ラベルなど) に個人情報を含めないでください。

Container Registry コマンド ibmcloud cr が「登録されていないコマンドです」というエラーで失敗する場合は、 Container Registry(ibmcloud cr)コマンドが「登録されていない」というメッセージで失敗する理由を 参照してください。 コマンドが「ログインしていません」というメッセージで失敗する場合は、 「 Container Registry にログインできないのはなぜですか？」 を参照してください。

例

レジストリ API エンドポイントの詳細を調べる。

ibmcloud cr api

出力

例 示されたコマンドは次の出力を返します：

Registry API endpoint   https://us.icr.io/api

OK

前提条件

必要なパーミッションの詳細については、 設定用アクセス・ロール Container Registry を参照してください。

コマンド・オプション

--scope SCOPE

アカウントをスコープとして設定するには、"*" を値として使用します。

名前空間、リポジトリー、ダイジェスト、またはタグをスコープとして設定するには、次の形式のいずれかでその値を入力します。

• namespace
• namespace/repository
• namespace/repository:tag
• namespace/repository@digest

--issue-type ISSUE_TYPE

免除するセキュリティー問題のタイプ。 有効な問題タイプを見つけるには、ibmcloud cr exemption-types を実行します。

--issue-id ISSUE_ID

免除するセキュリティー問題の ID。 問題IDを見つけるには、 ibmcloud cr va <image> を実行します。 <image> はあなたのイメージの名前であり、 脆弱性ID 列から関連する値を使用します。

--output json, -o json

(オプション) JSON 形式でリストを出力します。

例

スコープに us.icr.io/birds/bluebird 、issue typeに cve 、issue IDに CVE-2018-17929 を入力し、 us.icr.io/birds/bluebird リポジトリ内のすべての画像について、IDが CVE-2018-17929 のCVE免責事項を作成します。

ibmcloud cr exemption-add --scope us.icr.io/birds/bluebird --issue-type cve --issue-id CVE-2018-17929

CVE-2018-17929 スコープに "*" 、問題タイプに cve 、問題IDに CVE-2018-17929。

ibmcloud cr exemption-add --scope "*" --issue-type cve --issue-id CVE-2018-17929

前提条件

必要なパーミッションの詳細については、 設定用アクセス・ロール Container Registry を参照してください。

コマンド・オプション

--scope SCOPE

(オプション) このスコープに適用される免除のみをリストします。

名前空間、リポジトリー、ダイジェスト、またはタグをスコープとして設定するには、次の形式のいずれかでその値を入力します。

• namespace
• namespace/repository
• namespace/repository:tag
• namespace/repository@digest

--output json, -o json

(オプション) JSON 形式でリストを出力します。

例

birds/bluebird をスコープとして入力し、 birds/bluebird リポジトリ内のイメージに適用されるセキュリティ問題のすべての適用除外をリストアップします。

出力には、アカウント規模の免除、birds 名前空間が適用範囲になる免除、および birds/bluebird リポジトリーが適用範囲になる免除が含まれます。 出力には、birds/bluebird リポジトリー内の特定のタグが適用範囲になる免除は含まれません。

ibmcloud cr exemption-list --scope birds/bluebird

birds/bluebird@sha256:101010101010 をスコープとして入力し、 birds/bluebird@sha256:101010101010 のダイジェストに含まれる画像に適用される、セキュリティ問題に関するすべての免除をリストアップします。

出力には、アカウント規模の免除、birds 名前空間が適用範囲になる免除、および birds/bluebird リポジトリーと birds/bluebird@sha256:101010101010 ダイジェストが適用範囲になる免除が含まれます。 出力には、birds/bluebird リポジトリー内の特定のタグが適用範囲になる免除は含まれません。

ibmcloud cr exemption-list --scope birds/bluebird@sha256:101010101010

前提条件

必要なパーミッションの詳細については、 設定用アクセス・ロール Container Registry を参照してください。

コマンド・オプション

--scope SCOPE

アカウントをスコープとして設定するには、"*" を値として使用します。

名前空間、リポジトリー、ダイジェスト、またはタグをスコープとして設定するには、次の形式のいずれかでその値を入力します。

• namespace
• namespace/repository
• namespace/repository:tag
• namespace/repository@digest

--issue-type ISSUE_TYPE

削除したいセキュリティ問題の免除のissueのタイプ。 免除の種類を調べるには、 ibmcloud cr exemption-list を実行する。

--issue-id ISSUE_ID

削除するセキュリティー問題の免除の ID。 免除の問題 ID を見つけるには、ibmcloud cr exemption-list を実行します。

例

スコープに us.icr.io/birds/bluebird 、issueタイプに cve 、issue IDに CVE-2018-17929 を入力して、 us.icr.io/birds/bluebird リポジトリ内のすべての画像について、IDが CVE-2018-17929 のCVE免責事項を削除してください。

ibmcloud cr exemption-rm --scope us.icr.io/birds/bluebird --issue-type cve --issue-id CVE-2018-17929

スコープに "*" 、issue typeに cve 、issue IDに CVE-2018-17929 を入力して、IDが CVE-2018-17929 のCVEに対するアカウント全体のCVE免除を削除します。

ibmcloud cr exemption-rm --scope "*" --issue-type cve --issue-id CVE-2018-17929

前提条件

必要なパーミッションの詳細については、 設定用アクセス・ロール Container Registry を参照してください。

コマンド・オプション

--output json, -o json

(オプション) JSON 形式でリストを出力します。

例

セキュリティ上の問題の種類を列挙してください。

ibmcloud cr exemption-types

出力

例 示されたコマンドは次の出力を返します：

Listing exemption types...

Issue type      Description
cve             CVE
sn              Security Notice
configuration   Configuration Issue

OK

前提条件

必要なパーミッションの詳細については、 設定用アクセス・ロール Container Registry を参照してください。

例

IAM ポリシーを使用して、きめ細かな認可を可能にする。

ibmcloud cr iam-policies-enable

例

アカウントのIAMアクセスポリシーのステータスを表示します。

ibmcloud cr iam-policies-status

出力

例 示されたコマンドは次の出力を返します：

IAM policy enforcement is enabled for account 'X's Account' in registry 'us.icr.io'.

OK

前提条件

必要なパーミッションの詳細については、 を使用するためのアクセス・ロール Container Registry を参照してください。

コマンド・オプション

--format FORMAT

(オプション) Go テンプレートを使用して出力要素のフォーマットを設定します。 詳細については、Container Registry CLI 出力のフォーマット設定およびフィルター操作を参照してください。

--quiet, -q

(オプション) 各イメージが、repository@digest という形式でリストされます。

--output json, -o json

(オプション) JSON 形式でリストを出力します。

--restrict RESTRICTION

(オプション) 指定した名前空間内またはリポジトリー内のイメージのみを表示するように出力を制限します。

--include-ibm

(オプション) IBM 提供のパブリック・イメージを出力に含めます。 デフォルトではプライベート・イメージのみがリストされます。 グローバル・レジストリーにある IBM 提供のイメージのみを表示できます。

--no-va

(オプション) Vulnerability Advisor セキュリティー状況の結果を出力から除外します。 ibmcloud cr image-digests 出力の一部としてセキュリティー状況の結果が必要ではない場合、このオプションを使用してパフォーマンスを向上させることができます。

--va

（オプション）出力に Vulnerability Advisor のセキュリティ状態の結果を含めます。 オプション --restrict``--va とオプションを組み合わせて使用することで、必要な情報のみを受け取ることができます。

例

--quiet を使って repository@digest のフォーマットで画像を一覧表示し、 birds を制限として入力することで、 repository@digest のフォーマットで、タグ付けされていない画像を含む birds 名前空間のすべての画像を表示します。

ibmcloud cr image-digests --restrict birds --quiet

出力

例 示されたコマンドは次の出力を返します：

us.icr.io/birds/bluebird@sha256:11ab001ab10011cd1000101cd0101010001ab111100cd00ab111
us.icr.io/birds/blackbird@sha256:22ef00ef002220002gh200222000gh00ef2222000ab00222

前提条件

必要なパーミッションの詳細については、 を使用するためのアクセス・ロール Container Registry を参照してください。

コマンド引数

IMAGE

レポートを取得するイメージの名前。 このコマンドに複数のイメージの名前をスペースで区切ってリストすると、複数のイメージの詳細を表示できます。

ダイジェスト <dns>/<namespace>/<repo>@<digest> またはタグ <dns>/<namespace>/<repo>:<tag> のいずれかを使用して、イメージを特定できます。 ここでは <dns> はドメイン名、<namespace> は名前空間、<repo> はリポジトリー、<digest> はダイジェスト、<tag> はタグです。

イメージの名前を調べるには、以下のいずれかのコマンドを実行します。

• ダイジェストでイメージを特定するには、ibmcloud cr image-digests コマンドを実行します。 Repository 列の内容 (repository) と Digest 列の内容 (digest) をアットマーク (@) で区切って連結し、repository@digest 形式のイメージ名を作成します。
• タグでイメージを特定するには、ibmcloud cr image-list コマンドを実行します。 Repository 列の内容 (repository) と Tag 列の内容 (tag) をコロン (:) で区切って連結し、repository:tag 形式のイメージ名を作成します。 イメージ名の中にタグを指定しない場合は、latest というタグが付いたイメージがデフォルトで削除されます。

コマンド・オプション

--format FORMAT

(オプション) Go テンプレートを使用して出力要素のフォーマットを設定します。 詳細については、Container Registry CLI 出力のフォーマット設定およびフィルター操作を参照してください。

例

フォーマット指示文 "{{ .Config.ExposedPorts }}" を使用し、 us.icr.io/birds/bluebird:1 を画像として入力することで、 us.icr.io/birds/bluebird:1 画像の公開ポートに関する詳細を表示します。

ibmcloud cr image-inspect  --format "{{ .Config.ExposedPorts }}" us.icr.io/birds/bluebird:1

前提条件

必要なパーミッションの詳細については、 を使用するためのアクセス・ロール Container Registry を参照してください。

コマンド・オプション

--format FORMAT

(オプション) Go テンプレートを使用して出力要素のフォーマットを設定します。 詳細については、Container Registry CLI 出力のフォーマット設定およびフィルター操作を参照してください。

--quiet, -q

(オプション) 各イメージが、repository:tag という形式でリストされます。

--restrict RESTRICTION

(オプション) 指定した名前空間内またはリポジトリー内のイメージのみを表示するように出力を制限します。

--include-ibm

(オプション) IBM 提供のパブリック・イメージを出力に含めます。 デフォルトではプライベート・イメージのみがリストされます。 グローバル・レジストリーにある IBM 提供のイメージのみを表示できます。

--no-trunc

(オプション) イメージ・ダイジェストを長形式で返します。

--show-type

(オプション) イメージ・マニフェスト・タイプを表示します。

--no-va

(オプション) Vulnerability Advisor セキュリティー状況の結果を出力から除外します。 ibmcloud cr image-list 出力の一部としてセキュリティー状況の結果が必要ではない場合、このオプションを使用してパフォーマンスを向上させることができます。

--va

（オプション）出力に Vulnerability Advisor のセキュリティ状態の結果を含めます。 オプション --restrict``--va とオプションを組み合わせて使用することで、必要な情報のみを受け取ることができます。

--output json, -o json

(オプション) JSON 形式でリストを出力します。

例

--quiet を使って画像ダイジェストをフォーマット repository:tag で表示し、 --no-trunc を使って画像ダイジェストをロング・フォーマットで表示し、 birds を制限として入力することで、画像ダイジェストを切り詰めずに、 repository:tag のフォーマットで birds 名前空間の画像を表示します。

ibmcloud cr image-list --restrict birds --quiet --no-trunc

出力

例 示されたコマンドは次の出力を返します：

us.icr.io/birds/bluebird:1

前提条件

必要なパーミッションの詳細については、 を使用するためのアクセス・ロール Container Registry を参照してください。

コマンド・オプション

--force, -f

(オプション) ユーザー・プロンプトを出さずに強制的にコマンドを実行します。

--output json, -o json

(オプション) タグが付いていないイメージのクリーンアップの結果が含まれる JSON を出力します。 このオプションは、--force と共に使用する必要があります。

--restrict

(オプション) 指定した名前空間内またはリポジトリー内のタグが付いていないイメージのみをクリーンアップするように制限します。

例

--force オプションを使用して、ユーザープロンプトなしでコマンドを実行させ、出力に --json を、制限に birds を入力することで、ユーザープロンプトなしで birds 名前空間にあるタグなし画像をすべて削除し、結果を JSON 形式で出力します。

ibmcloud cr image-prune-untagged [--force | -f [--json]] --restrict birds

前提条件

必要なパーミッションの詳細については、 を使用するためのアクセス・ロール Container Registry を参照してください。

コマンド引数

IMAGE

ごみ箱から復元するイメージの名前。

ごみ箱の中にあるイメージの名前を調べるには、ibmcloud cr trash-list コマンドを実行します。

タグまたはダイジェストを基にしてイメージを見つけることができます。 復元するイメージは、ダイジェスト <dns>/<namespace>/<repo>@<digest> を使用して参照できます。このダイジェストは、同じリポジトリー内のダイジェストとそのすべてのタグを復元するか、タグ <dns>/<namespace>/<repo>:<tag> によって復元します。 ここでは <dns> はドメイン名、<namespace> は名前空間、<repo> はリポジトリー、<digest> はダイジェスト、<tag> はタグです。

イメージは、ごみ箱に 30 日間保管されます。

例

us.icr.io/birds/bluebird:1 をイメージとして入力し、 us.icr.io/birds/bluebird:1 イメージを復元する。

ibmcloud cr image-restore us.icr.io/birds/bluebird:1

前提条件

必要なパーミッションの詳細については、 を使用するためのアクセス・ロール Container Registry を参照してください。

コマンド引数

IMAGE

削除するイメージの名前。 このコマンドに複数のイメージの名前をスペースで区切ってリストすると、複数のイメージを同時に削除できます。 ダイジェスト <dns>/<namespace>/<repo>@<digest> またはタグ <dns>/<namespace>/<repo>:<tag> のいずれかを使用して、イメージを特定できます。 ここでは <dns> はドメイン名、<namespace> は名前空間、<repo> はリポジトリー、<digest> はダイジェスト、<tag> はタグです。

イメージは、ごみ箱に 30 日間保管されます。

イメージの名前を調べるには、以下のいずれかのコマンドを実行します。

• ダイジェストでイメージを特定するには、ibmcloud cr image-digests コマンドを実行します。 Repository 列の内容 (repository) と Digest 列の内容 (digest) をアットマーク (@) で区切って連結し、repository@digest 形式のイメージ名を作成します。
• タグでイメージを特定するには、ibmcloud cr image-list コマンドを実行します。 Repository 列の内容 (repository) と Tag 列の内容 (tag) をコロン (:) で区切って連結し、repository:tag 形式のイメージ名を作成します。 イメージ名の中にタグを指定しない場合は、latest というタグが付いたイメージがデフォルトで削除されます。

例

us.icr.io/birds/bluebird:1 を画像として入力し、 us.icr.io/birds/bluebird:1 の画像を削除する。

ibmcloud cr image-rm us.icr.io/birds/bluebird:1

前提条件

必要なパーミッションの詳細については、 を使用するためのアクセス・ロール Container Registry を参照してください。

コマンド引数

SOURCE_IMAGE

ソース・イメージの名前。 ソース・イメージは、ダイジェスト <dns>/<namespace>/<repo>@<digest> またはタグ <dns>/<namespace>/<repo>:<tag> のいずれかを使用して特定できます。 ここでは <dns> はドメイン名、<namespace> は名前空間、<repo> はリポジトリー、<digest> はダイジェスト、<tag> はタグです。

TARGET_IMAGE

ターゲット・イメージの名前。 TARGET_IMAGE は repository:tag という形式 (例: us.icr.io/namespace/image:latest) にする必要があります。

例

ソース画像として us.icr.io/birds/bluebird:1 を、ターゲット画像として us.icr.io/birds/bluebird:latest を入力して、画像 us.icr.io/birds/bluebird:1 に別のタグ参照 latest を追加します。

ibmcloud cr image-tag  us.icr.io/birds/bluebird:1 us.icr.io/birds/bluebird:latest

ソース・イメージとして us.icr.io/birds/bluebird:peck を、ターゲット・イメージとして us.icr.io/birds/pigeon:peck を入力して、同じネームスペース birds/pigeon 内の別のリポジトリにイメージ us.icr.io/birds/bluebird:peck をコピーします。

ibmcloud cr image-tag us.icr.io/birds/bluebird:peck us.icr.io/birds/pigeon:peck

ソース・イメージとして us.icr.io/birds/bluebird:peck を、ターゲット・イメージとして us.icr.io/animals/dog:bark を入力し、 us.icr.io/birds/bluebird:peck イメージを、アクセス可能な別のネームスペース（この例では animals ネームスペース）にコピーします。

ibmcloud cr image-tag us.icr.io/birds/bluebird:peck us.icr.io/animals/dog:bark

前提条件

必要なパーミッションの詳細については、 を使用するためのアクセス・ロール Container Registry を参照してください。

コマンド引数

IMAGE

タグを削除するイメージの名前。 このコマンドに複数のイメージの名前をスペースで区切ってリストすると、複数のイメージからタグを同時に削除できます。IMAGE は、repository:tag という形式 (例: us.icr.io/namespace/image:latest) にする必要があります。

イメージの名前を調べるには、ibmcloud cr image-list を実行します。 Repository 列の内容 (repository) と Tag 列の内容 (tag) をコロン (:) で区切って連結し、repository:tag 形式のイメージ名を作成します。 イメージ名の中にタグを指定しないと、コマンドが失敗します。

例

us.icr.io/birds/bluebird:1 を画像として入力し、 us.icr.io/birds/bluebird:1 画像からタグ 1 を削除する。

ibmcloud cr image-untag us.icr.io/birds/bluebird:1

例

レジストリの名前とアカウントを検索する。

ibmcloud cr info

出力

例 示されたコマンドは次の出力を返します：

Plugin version                    1.3.16
Container Registry                us.icr.io
Container Registry API endpoint   https://us.icr.io/api
IBM Cloud API endpoint            https://cloud.ibm.com
IBM Cloud account details         X's Account (1100110011001100)

OK

コマンド・オプション

-- client

(オプション) ログインするクライアントを選択します。 有効な値は docker および podman です。 このオプションが使用されず、Docker がインストールされている場合、デフォルトは docker です。Docker がインストールされていない場合、デフォルトは podman です。

例

Podman を使ってレジストリにログインするには、クライアントとして podman と入力する。

ibmcloud cr login --client podman

前提条件

必要なパーミッションの詳細については、 を使用するためのアクセス・ロール Container Registry を参照してください。

コマンド引数

IMAGE

マニフェストを検査する対象となるイメージの名前。 ダイジェスト <dns>/<namespace>/<repo>@<digest> またはタグ <dns>/<namespace>/<repo>:<tag> のいずれかを使用して、イメージを特定できます。 ここでは <dns> はドメイン名、<namespace> は名前空間、<repo> はリポジトリー、<digest> はダイジェスト、<tag> はタグです。

イメージの名前を調べるには、以下のいずれかのコマンドを実行します。

• ダイジェストでイメージを特定するには、ibmcloud cr image-digests コマンドを実行します。 Repository 列の内容 (repository) と Digest 列の内容 (digest) をアットマーク (@) で区切って連結し、repository@digest 形式のイメージ名を作成します。
• タグでイメージを特定するには、ibmcloud cr image-list コマンドを実行します。 Repository 列の内容 (repository) と Tag 列の内容 (tag) をコロン (:) で区切って連結し、repository:tag 形式のイメージ名を作成します。

コマンド・オプション

--quiet, -q

(オプション) 出力を削減して、重要な要素のみを表示します。

例

イメージとして us.icr.io/birds/bluebird:1 を入力して、 us.icr.io/birds/bluebird:1 イメージのマニフェストの内容を表示します。

ibmcloud cr manifest-inspect us.icr.io/birds/bluebird:1

前提条件

必要な権限の詳細については、 プラットフォーム管理ロール および Container Registry を設定するためのアクセス・ロールを 参照してください。

コマンド引数

NAMESPACE

追加する名前空間。 名前空間は、同じリージョン内のすべての IBM Cloud アカウントにわたって固有である必要があります。 名前空間は 4 文字から 30 文字までで、含めることができるのは、小文字、数字、ハイフン (-)、下線 (_) のみです。 名前空間は、文字または数値で開始および終了する必要があります。

名前空間名に個人情報を含めないでください。

コマンド・オプション

-g (RESOURCE_GROUP_NAME | RESOURCE_GROUP_ID)

(オプション) 名前空間の追加先となるリソース・グループの名前または ID を指定します。 このオプションを設定しない場合は、ターゲット指定されたリソース・グループが使用されます。 このオプションを設定せず、リソース・グループがターゲット指定されていない場合は、アカウントのデフォルトのリソース・グループが使用されます。

例

birds2 」という名前でネームスペースを作成し、リソース・グループ名として「 beaks 」、ネームスペースとして「 birds2 」を入力して、リソース・グループ「 beaks 」に追加します。

ibmcloud cr namespace-add -g beaks birds2

出力

例 示されたコマンドは次の出力を返します：

Adding namespace 'birds2' in resource group 'beaks' for account X's Account in registry us.icr.io...

Successfully added namespace 'birds2'

OK

前提条件

必要な権限の詳細については、 プラットフォーム管理ロール および Container Registry を設定するためのアクセス・ロールを 参照してください。

コマンド引数

NAMESPACE

リソース・グループに割り当てる名前空間。

コマンド・オプション

-g (RESOURCE_GROUP_NAME | RESOURCE_GROUP_ID)

(オプション) 名前空間の割り当て先となるリソース・グループの名前または ID を指定します。 このオプションを設定しない場合は、ターゲット指定されたリソース・グループが使用されます。

例

リソース・グループ名として beaks 、名前空間として birds を入力して、リソース・グループ beaks に名前 birds の名前空間を割り当てます。

ibmcloud cr namespace-assign -g beaks birds

出力

例 示されたコマンドは次の出力を返します：

Assigning namespace 'birds' to resource group 'beaks' for account X's Account in registry us.icr.io...

Successfully assigned namespace 'birds' to resource group 'beaks.'

OK

前提条件

必要なパーミッションの詳細については、 を使用するためのアクセス・ロール Container Registry を参照してください。

コマンド・オプション

--verbose, -v

(オプション) すべての名前空間をリストし、リソース・グループと名前空間の作成日に関する情報を含めます。

--output json, -o json

(オプション) JSON 形式でリストを出力します。

例

--verbose オプションを使用して、リソースグループや作成日付に関する情報を含む、すべてのネームスペースのリストを表示します。

ibmcloud cr namespace-list -v

出力

例 示されたコマンドは次の出力を返します：

Listing namespaces for account 'X's Account' in registry 'us.icr.io'...

Namespace   Resource Group   Created
birds       default          1 year ago
birds2      beaks            40 seconds ago

OK

前提条件

必要なパーミッションの詳細については、 設定用アクセス・ロール Container Registry を参照してください。

コマンド引数

NAMESPACE

削除する名前空間。

コマンド・オプション

--force, -f

(オプション) ユーザー・プロンプトを出さずに強制的にコマンドを実行します。

例

名前空間として birds を入力して、 birds 名前空間を削除する。

ibmcloud cr namespace-rm birds

前提条件

必要なパーミッションの詳細については、 設定用アクセス・ロール Container Registry を参照してください。

コマンド・オプション

--output json, -o json

(オプション) JSON 形式でリストを出力します。

例

出力に json を入力して、料金プランをJSON形式で出力します。

ibmcloud cr plan -o json

出力

例 示されたコマンドは次の出力を返します：

{
	"plan": "Free"
}

前提条件

必要なパーミッションの詳細については、 設定用アクセス・ロール Container Registry を参照してください。

コマンド引数

PLAN

(オプション) アップグレード先の価格プランの名前。 PLAN を指定しない場合、デフォルトは standard です。

例

標準料金プランにアップグレードするには、プランに standard と入力してください。

ibmcloud cr plan-upgrade standard

前提条件

• IBM Cloud Monitoring をセットアップする必要があります。IBM Cloud Monitoring 入門チュートリアルを参照してください。
• プラットフォーム・メトリクスの IBM Cloud Monitoring インスタンスを有効にします。
• 必要なパーミッションの詳細については、 設定用アクセス・ロール Container Registry を参照してください。

コマンド・オプション

--enable

(オプション) アカウントの設定を有効にします。

--disable

(オプション) アカウントの設定を無効にします。

--status

(オプション) ご使用のアカウントで設定が有効になっているかどうかを表示します。

例

--enable オプションを使用して、アカウントのプラットフォーム・メトリクスを有効にします。

ibmcloud cr platform-metrics --enable

出力

例 示されたコマンドは次の出力を返します：

OK

前提条件

必要なパーミッションの詳細については、 設定用アクセス・ロール Container Registry を参照してください。

コマンド・オプション

--enable

(オプション) ご使用のアカウントでのパブリック・ネットワーク接続におけるイメージのプルまたはプッシュを禁止します。

--disable

(オプション) ご使用のアカウントでのパブリック・ネットワーク接続におけるイメージのプルまたはプッシュを復元します。

--status

(オプション) ご使用のアカウントでのイメージのプッシュまたはプルについて、パブリック接続の使用が禁止されているかどうかを確認します。

例

--enable オプションを使用して、アカウントのパブリックネットワーク接続経由でのイメージのプルまたはプッシュを防止します。

ibmcloud cr private-only --enable

前提条件

必要なパーミッションの詳細については、 設定用アクセス・ロール Container Registry を参照してください。

コマンド・オプション

--output json, -o json

(オプション) JSON 形式でリストを出力します。

例

出力オプションに json を入力すると、トラフィックとストレージクォータをJSON形式で表示します。

ibmcloud cr quota -o json

出力

例 示されたコマンドは次の出力を返します：

{
	"usage": {
		"traffic": 0,
		"store": 0
	},
	"limit": {
		"traffic": 5368709120,
		"store": 536870912
	}
}

前提条件

必要なパーミッションの詳細については、 設定用アクセス・ロール Container Registry を参照してください。

コマンド・オプション

--traffic TRAFFIC

(オプション) トラフィック割り当て量を、指定した値 (M バイト単位) に変更します。 トラフィックを設定する権限がない場合や現在の価格プランを超える値を設定した場合、操作は失敗します。

--storage STORAGE

(オプション) ストレージ割り当て量を、指定した値 (M バイト単位) に変更します。 ストレージ割り当て量を設定する権限がない場合や現在の価格プランを超える値を設定した場合、操作は失敗します。

例

トラフィックのクォータとして 7000 、ストレージのクォータとして 600 、プルトラフィックのクォータ制限を7000メガバイト、ストレージのクォータ制限を600メガバイトに設定します。

ibmcloud cr quota-set --traffic 7000 --storage 600

出力

例 示されたコマンドは次の出力を返します：

Setting quotas: 'storage: 600 , traffic: 7000'...

OK

例

どの地域とレジストリをターゲットにしているかを確認する。

ibmcloud cr region

出力

例 示されたコマンドは次の出力を返します：

You are targeting region 'us-south', the registry is 'us.icr.io'.

OK

コマンド引数

REGION

(オプション) 対象地域の名前、例えば us-south。 詳しくは、リージョンを参照してください。

例

地域に us-south を入力して、ダラス地域をターゲットにする。

ibmcloud cr region-set us-south

出力

例 示されたコマンドは次の出力を返します：

The region is set to 'us-south', the registry is 'us.icr.io'.

OK

前提条件

必要なパーミッションの詳細については、 を使用するためのアクセス・ロール Container Registry を参照してください。

コマンド・オプション

--output json, -o json

(オプション) JSON 形式でリストを出力します。

例

出力として json を入力することで、アカウント内の保持ポリシーをJSON形式で一覧表示します。

ibmcloud cr retention-policy-list -o json

出力

例 示されたコマンドは次の出力を返します：

{
	"birds": {
		"namespace": "birds",
		"account": "",
		"images_per_repo": -1,
		"retain_untagged": true
	},
	"birds2": {
		"namespace": "birds2",
		"account": "",
		"images_per_repo": -1,
		"retain_untagged": true
	}
}

前提条件

必要なパーミッションの詳細については、 を使用するためのアクセス・ロール Container Registry を参照してください。

コマンド引数

NAMESPACE

ポリシーを作成する名前空間。

コマンド・オプション

--retain-untagged

(オプション) 保持ポリシーが処理されているときに、タグの外されたすべてのイメージを保持します。 タグ付けされたイメージのみが分析され、基準を満たしていない場合は削除されます。 このオプションが指定されていない場合、タグ付けされたイメージとタグの外されたイメージがすべて分析され、基準を満たしていない場合は削除されます。

--force, -f

(オプション) ユーザー・プロンプトを出さずに強制的にコマンドを実行します。

--images

指定された名前空間内の各リポジトリーの中にどれだけの数のイメージを保持するかを決定します。 最新のイメージが保持されます。 イメージの経過時間は、そのビルドの日付によって決まります。IMAGE_COUNT は、その名前空間でリポジトリーごとに保持するイメージ数です。 すべての画像を IMAGE_COUNT All に設定したまま、ポリシーをデフォルトの状態に戻すには。

例 1

保持するイメージの数として 20 を、名前空間として birds を入力して、 birds 名前空間の各リポジトリ内の最新の 20 イメージを保持するポリシーを設定します。 タグ付け済みおよび未タグ付けの画像をすべて分析し、基準を満たさない画像は削除される。

ibmcloud cr retention-policy-set --images 20 birds

例1の出力

例1 のコマンドは次の出力を返します：

Found n images to delete.

OK
A scheduled retention policy is set that keeps 20 images in each repository in birds and retain-untagged is set to false.

OK

例 2

保持する画像の数として All を、名前空間として birds を入力して、すべての画像を birds 名前空間に保持するように、ポリシーをデフォルトの状態に戻します。

ibmcloud cr retention-policy-set --images All birds

例2の出力

例2 のコマンドは次の出力を返します：

The retention policy to keep all images in birds is set.

OK

前提条件

必要なパーミッションの詳細については、 を使用するためのアクセス・ロール Container Registry を参照してください。

コマンド引数

NAMESPACE

クリーンアップする名前空間。

コマンド・オプション

--force, -f

(オプション) ユーザー・プロンプトを出さずに強制的にコマンドを実行します。

--output json, -o json

(オプション) 名前空間クリーンアップの結果が含まれる JSON を出力します。 このオプションは、--force と共に使用する必要があります。

--retain-untagged

(オプション) 保持ポリシーが処理されているときに、タグの外されたすべてのイメージを保持します。 タグ付けされたイメージのみが分析され、基準を満たしていない場合は削除されます。 このオプションが指定されていない場合、タグ付けされたイメージとタグの外されたイメージがすべて分析され、基準を満たしていない場合は削除されます。

--images

指定された名前空間内の各リポジトリーの中にどれだけの数のイメージを保持するかを決定します。 最新のイメージが保持されます。 イメージの経過時間は、そのビルドの日付によって決まります。IMAGE_COUNT は、その名前空間でリポジトリーごとに保持するイメージ数です。

例

保持する画像の数として 20 を、名前空間として birds を入力し、各リポジトリ内の最新の 20 画像を birds 名前空間に保持します。

ibmcloud cr retention-run --images 20 birds

出力

例 示されたコマンドは次の出力を返します：

Retrieving images to delete from namespace 'birds' in registry us.icr.io'...

Found n images to delete.

OK

前提条件

必要なパーミッションの詳細については、 を使用するためのアクセス・ロール Container Registry を参照してください。

コマンド・オプション

--restrict NAMESPACE

(オプション) 指定した名前空間のイメージだけを表示するように出力を制限します。

--output json, -o json

(オプション) ごみ箱の内容の詳細が含まれた JSON を出力します。

例

birds を制限として入力し、 birds 名前空間のゴミ箱にある画像を表示する。

ibmcloud cr trash-list --restrict birds

出力

例 示されたコマンドは次の出力を返します：

Listing the contents of the trash...

Digest   Days until expiry   Tags
110011   24                  1

OK

例

使用している Vulnerability Advisor のバージョンを確認します。

ibmcloud cr va-version

出力

例 示されたコマンドは次の出力を返します：

You are targeting Vulnerability Advisor version 'v4'.

OK

コマンド引数

VERSION

使用したい Vulnerability Advisor のバージョン。 有効な値は v4 だけです。

例

バージョンに v4 を入力して、 Vulnerability Advisor のバージョンをバージョン4に設定する：

ibmcloud cr va-version-set v4

出力

例 示されたコマンドは次の出力を返します：

You are targeting Vulnerability Advisor version 'v4'.

OK

前提条件

必要なパーミッションの詳細については、 を使用するためのアクセス・ロール Container Registry を参照してください。

コマンド引数

IMAGE

レポートを取得するイメージの名前。 このレポートから、既知のパッケージの脆弱性がイメージにあるかどうかがわかります。 このコマンドに複数のイメージの名前をスペースで区切ってリストすると、複数のイメージについてのレポートを同時に要求できます。

イメージの名前を調べるには、ibmcloud cr image-list を実行します。 Repository 列の内容 (repository) と Tag 列の内容 (tag) をコロン (:) で区切って連結し、repository:tag 形式のイメージ名を作成します。 イメージ名の中にタグを指定しない場合は、latest というタグが付いたイメージを評価したレポートになります。

サポートされる Docker ベース・イメージについて詳しくは、 脆弱パッケージ を参照してください。

詳細については、Vulnerability Advisor によるイメージ・セキュリティーの管理を参照してください。

コマンド・オプション

--extended, -e

(オプション) 脆弱なパッケージのフィックスについての追加情報をコマンド出力に表示します。

--vulnerabilities, -v

(オプション) 脆弱性のみを表示するようにコマンド出力を制限します。

--output FORMAT, -o FORMAT

(オプション) 選択した形式でコマンド出力が返されます。 デフォルトの形式は text です。

以下の形式がサポートされています。

• text
• json

例

イメージとして us.icr.io/birds/bluebird:1 を入力して、 us.icr.io/birds/bluebird:1 イメージの標準脆弱性評価レポートを表示する。

ibmcloud cr vulnerability-assessment us.icr.io/birds/bluebird:1

-- vulnerabilities オプションを使用し、出力形式として json を、画像として us.icr.io/birds/bluebird:1 を入力することで、 us.icr.io/birds/bluebird:1 画像の脆弱性を JSON 形式で示す脆弱性評価レポートを表示します。

ibmcloud cr vulnerability-assessment --vulnerabilities --output json us.icr.io/birds/bluebird:1