第13章 リソースを回収するためのオブジェクトのプルーニング


クラスターストレージを再利用し、古くなったリソースをプルーニングして API サーバーのパフォーマンスを最適化します。手動 CLI コマンドを実行するか、自動 cron ジョブを設定して、廃止されたデプロイメント、ビルド、イメージ、およびグループレコードをクリーンアップすることができます。

時間の経過と共に、OpenShift Container Platform で作成される API オブジェクトは、アプリケーションのビルドおよびデプロイなどの通常のユーザーの操作によってクラスターの etcd データストアに蓄積されます。

クラスター管理者は、不要になった古いバージョンのオブジェクトをクラスターから定期的にプルーニングできま。たとえば、イメージのプルーニングにより、使用されなくなったものの、ディスク領域を使用している古いイメージや層を削除できます。

13.1. プルーニングの基本操作

古いクラスターオブジェクトまたは参照されていないクラスターオブジェクトを削除して、クラスターストレージを再利用し、最適な API サーバーのパフォーマンスを維持します。

CLI は、共通の親コマンドでプルーニング操作を分類します。

$ oc adm prune <object_type> <options>

これにより、以下が指定されます。

  • groups、builds、deployments、または images などのアクションを実行するための <object_type>。
  • オブジェクトタイプのプルーニングの実行においてサポートされる <options>。

13.2. グループのプルーニング

グループプルーナーを使用して、外部アイデンティティープロバイダーから古いユーザーグループレコードを削除します。孤立したグループのプルーニングは、ユーザー管理データを正確に保ち、クラスターのセキュリティーを確保し、承認されていないアクセスパーミッションを防ぎます。

グループのレコードを外部プロバイダーからプルーニングするために、管理者は以下のコマンドを実行できます。

$ oc adm prune groups \
    --sync-config=path/to/sync/config [<options>]
表13.1 oc adm prune groups フラグ
オプション説明

--confirm

ドライランを実行する代わりにプルーニングが実行されることを示します。

--blacklist

グループブラックリストファイルへのパス。

--whitelist

グループホワイトリストファイルへのパス。

--sync-config

同期設定ファイルへのパスです。

手順

  1. prune コマンドが削除するグループを表示するには、以下のコマンドを実行します。

    $ oc adm prune groups --sync-config=ldap-sync-config.yaml
  2. prune 操作を実行するには、--confirm フラグを追加します。

    $ oc adm prune groups --sync-config=ldap-sync-config.yaml --confirm

13.3. デプロイメントリソースのプルーニング

完了済みまたは失敗したデプロイメント設定および Pod レコードを削除して、クラスターストレージを解放し、データベースの共通を減らして、リソースルックアップを高速化します。

使用年数やステータスによりシステムで不要となったデプロイメントに関連付けられたリソースをプルーニングできます。

以下のコマンドは、DeploymentConfig オブジェクトに関連付けられたレプリケーションコントローラーをプルーニングします。

$ oc adm prune deployments [<options>]
注記

Deployment オブジェクトに関連付けられたレプリカセットもプルーニングするには、--replica-sets フラグを使用します。このフラグは、現在テクノロジープレビュー機能です。

表13.2 oc adm prune deployments フラグ
オプション説明

--confirm

ドライランを実行する代わりにプルーニングが実行されることを示します。

--keep-complete=<N>

DeploymentConfig オブジェクトに基づいて、ステータスが Complete でレプリカ数がゼロの最後の N レプリケーションコントローラーを維持します。デフォルトは 5 です。

--keep-failed=<N>

DeploymentConfig オブジェクトに基づいて、ステータスが Failed でレプリカ数がゼロの最後の N レプリケーションコントローラーを維持します。デフォルトは 1 です。

--keep-younger-than=<duration>

現在の時間との対比で <duration> 未満の新しいレプリケーションコントローラーはプルーニングしません。有効な測定単位には、ナノ秒 (ns)、マイクロ秒 (us)、ミリ秒 (ms)、秒 (s)、分 (m)、および時間 (h) が含まれます。デフォルトは 60m です。

--orphans

DeploymentConfig オブジェクトを持たない、ステータスが Complete または Failed で、レプリカ数がゼロのすべてのレプリケーションコントローラーをプルーニングします。

--replica-sets=true|false

true の場合、レプリカセットはプルーニングプロセスに含まれます。デフォルトは false です。

重要

このフラグはテクノロジープレビュー機能です。

手順

  1. プルーニング操作によって削除されるものを確認するには、以下のコマンドを実行します。

    $ oc adm prune deployments --orphans --keep-complete=5 --keep-failed=1 \
        --keep-younger-than=60m
  2. 実際に prune 操作を実行するには、--confirm フラグを追加します。

    $ oc adm prune deployments --orphans --keep-complete=5 --keep-failed=1 \
        --keep-younger-than=60m --confirm

13.4. ビルドのプルーニング

クラスターストレージを回収し、API のパフォーマンス低下を防ぐために、クラスターからの古いビルドレコードおよびログをプルーニングします。

使用年数やステータスによりシステムで不要となったビルドをプルーニングするために、管理者は以下のコマンドを実行できます。

$ oc adm prune builds [<options>]
表13.3 oc adm prune builds フラグ
オプション説明

--confirm

ドライランを実行する代わりにプルーニングが実行されることを示します。

--orphans

ビルド設定が存在せず、ステータスが complete、failed、error、または canceled のすべてのビルドをプルーニングします。

--keep-complete=<N>

ビルド設定に基づいて、ステータスが complete の最後の N ビルドを保持します。デフォルトは 5 です。

--keep-failed=<N>

ビルド設定に基づいて、ステータスが failed (失敗)、error (エラー)、または canceled (中止) の最後の N ビルドを保持します。デフォルトは 1 です。

--keep-younger-than=<duration>

現在の時間との対比で <duration> 未満の新しいオブジェクトはプルーニングしません。デフォルトは 60m です。

手順

  1. プルーニング操作によって削除されるものを確認するには、以下のコマンドを実行します。

    $ oc adm prune builds --orphans --keep-complete=5 --keep-failed=1 \
        --keep-younger-than=60m
  2. 実際に prune 操作を実行するには、--confirm フラグを追加します。

    $ oc adm prune builds --orphans --keep-complete=5 --keep-failed=1 \
        --keep-younger-than=60m --confirm
    注記

    開発者は、ビルドの設定を変更して自動ビルドプルーニングを有効にできます。

13.5. イメージの自動プルーニング

OpenShift Container Platform の OpenShift イメージレジストリーでストレージを回収し、イメージの保持期間を定義するために、イメージプルーナーを設定することができます。

プルーニング用カスタムリソース (CR) で、スケジュール、停止、および保持オプションを設定します。

前提条件

  • クラスター管理者権限を持つアカウントを使用して、OpenShift Container Platform クラスターにアクセスできる。
  • oc CLI がインストールされている。
重要

プルーナーを管理するための Image Registry Operator の動作は、Image Registry Operator の ClusterOperator オブジェクトで指定された managementState とは無関係です。Image Registry Operator が Managed 状態ではない場合、イメージプルーナーは Pruning Custom Resource によって設定され、管理できます。

ただし、Image Registry Operator の managementState は、デプロイされたイメージプルーナージョブの動作を変更します。

  • Managed: イメージプルーナーの --prune-registry フラグは true に設定されます。
  • Removed: イメージプルーナーの --prune-registry フラグは false に設定されます。つまり、etcd のイメージメタデータのみプルーニングされます。

手順

  • imagepruners.imageregistry.operator.openshift.io/cluster という名前のオブジェクトに以下の spec および status フィールドが含まれることを確認します。

    spec:
      schedule: 0 0 * * *
      suspend: false
      keepTagRevisions: 3
      keepYoungerThanDuration: 60m
      keepYoungerThan: 3600000000000
      resources: {}
      affinity: {}
      nodeSelector: {}
      tolerations: []
      successfulJobsHistoryLimit: 3
      failedJobsHistoryLimit: 3
    status:
      observedGeneration: 2
      conditions:
      - type: Available
        status: "True"
        lastTransitionTime: 2019-10-09T03:13:45
        reason: Ready
        message: "Periodic image pruner has been created."
      - type: Scheduled
        status: "True"
        lastTransitionTime: 2019-10-09T03:13:45
        reason: Scheduled
        message: "Image pruner job has been scheduled."
      - type: Failed
        staus: "False"
        lastTransitionTime: 2019-10-09T03:13:45
        reason: Succeeded
        message: "Most recent image pruning job succeeded."

    各項目の説明:

    spec.schedule
    CronJob 形式のスケジュール。これはオプションのフィールドで、デフォルトは daily で午前 0 時でに設定されます。
    spec.suspend
    true に設定されている場合、プルーニングを実行している CronJob は中断されます。これはオプションのフィールドで、デフォルトは false です。新規クラスターの初期値は false です。
    spec.keepTagRevisions
    保持するタグごとのリビジョン数。これはオプションのフィールドで、デフォルトは 3 です。初期値は 3 です。
    spec.keepYoungerThanDuration
    この期間よりも若いイメージを保持します。これはオプションのフィールドです。値の指定がない場合は、keepYoungerThan またはデフォルト値 60m (60 分) のいずれかが使用されます。
    spec.keepYoungerThan
    非推奨。keepYoungerThanDuration と同じですが、期間は整数 (ナノ秒単位) で指定されます。これはオプションのフィールドです。keepYoungerThanDuration を設定すると、このフィールドは無視されます。
    spec.resources
    標準の Pod リソースの要求および制限。これはオプションのフィールドです。
    spec.affinity
    標準の Pod アフィニティー。これはオプションのフィールドです。
    nodeSelector
    標準の Pod ノードセレクター。これはオプションのフィールドです。
    spec.tolerations
    標準の Pod toleration。これはオプションのフィールドです。
    spec.successfulJobsHistoryLimit
    保持する成功したジョブの最大数。メトリクスがレポートされるようにするには、1 以上にする必要があります。これはオプションのフィールドで、デフォルトは 3 です。初期値は 3 です。
    spec.failedJobsHistoryLimit
    保持する失敗したジョブの最大数。メトリクスがレポートされるようにするには、1 以上にする必要があります。これはオプションのフィールドで、デフォルトは 3 です。初期値は 3 です。
    status.observedGeneration
    Operatorによって監視される世代。
    status.conditions

    以下のタイプの標準条件オブジェクトです。

    • Available: プルーニングジョブが作成されているかどうかを示します。理由には Ready または Error のいずれかを使用できます。
    • Scheduled: 次のプルーニングジョブがスケジュールされているかどうかを示します。理由には、Scheduled、Suspended、または Error を使用できます。
    • Failed: 最新のプルーニングジョブが失敗したかどうかを示します。

13.6. イメージの手動プルーニング

孤立したイメージデータを統合 OpenShift イメージレジストリーから手動で削除してストレージ容量を回収し、ノードのディスクが枯渇するのを防ぎます。

プルーニングカスタムリソースは、OpenShift イメージレジストリーからのイメージの自動イメージプルーニングを有効にします。管理者は、oc adm prune images <image_prune_option> コマンドを使用してイメージを手動でプルーニングできます。

以下に例を示します。

$ oc adm prune images <image_prune_option>

使用可能なプルーニングオプションの詳細は、「手動イメージプルーニングコマンドのオプション」を参照してください。

このコマンドは、システムで不要になったイメージを削除します。

必要に応じて、イメージの経過時間やタグ履歴に基づいてイメージをプルーニングしたり、プロジェクトが定義されたストレージ制限を超える原因となるイメージをプルーニングしたりできます。

13.6.1. イメージのプルーニングに関する考慮事項

イメージをプルーニングする前にソフト削除の条件とレジストリーキャッシュの動作を確認して、メタデータの破損を防止し、アクティブなコンテナーデプロイメント層を保護します。

  • --namespace フラグを使用してプルーニングしても、イメージは削除されません。イメージはクラスタースコープのリソースであるため、イメージストリームのみが削除されます。プルーニングを特定の namespace に制限すると、現在の使用状況を計算できなくなります。
  • デフォルトで、統合レジストリーは Blob のメタデータをキャッシュしてストレージに対する要求数を減らし、要求の処理速度を高めます。プルーニングによって統合レジストリーのキャッシュが更新されることはありません。プルーニング後の依然としてプルーニングされた層を含むイメージは破損します。キャッシュにメタデータを持つプルーニングされた層はプッシュされないためです。そのため、プルーニング後にキャッシュをクリアするためにレジストリーを再デプロイする必要があります。

    $ oc rollout restart deployment/image-registry -n openshift-image-registry
  • 統合レジストリーが Redis キャッシュを使用する場合、データベースを手動でクリーンアップする必要があります。
  • プルーニング後にレジストリーを再デプロイすることがオプションでない場合は、キャッシュを永続的に無効にする必要があります。
  • oc adm prune images 操作ではレジストリーのルートが必要です。レジストリーのルートはデフォルトでは作成されません。

13.6.2. イメージのプルーニングの制限

プルーニング操作を実行する前に、イメージレイヤーの削除ルールおよび外部レジストリーの制限を確認して、レイヤーの削除を予測し、プルーニングされていないイメージストリームを回避します。

  • 外部レジストリーからイメージをプルーニングすることはサポートされていません。
  • イメージがプルーニングされると、status.tags にイメージが含まれているすべてのイメージストリームから、そのイメージへのすべての参照が削除されます。
  • イメージによって参照されなくなったイメージ層は削除されます。

13.6.3. イメージのプルーニングの各種条件

アクティブな Pod デプロイメントを中断することなくイメージレイヤーを安全にプルーニングするためにレジストリーイメージを削除する前に、必要な前提条件、依存関係の確認、およびソフト削除の条件を確認してください。

OpenShift Container Platform は、イメージをプルーニングするための 2 つの方法をサポートしています。

  1. 経過時間とタグによるプルーニング
  2. サイズ制限によるプルーニング

これらの方法論は相互に排他的です。経過時間とタグでのプルーニング、またはサイズ制限でのプルーニングのどちらかを選択する必要があります。選択した方法にかかわらず、イメージプルーナーは使用中のイメージが削除されないようチェックします。

イメージは、主な条件を満たし、さらに システムコンポーネントによるアクティブな参照がない場合にのみ削除されます。

使用年数およびタグによるイメージのプルーニング

経過時間とタグによるイメージのプルーニングは、デフォルトのプルーニングストラテジーです。--keep-younger-than および --keep-tag-revisions フラグを使用して、削除するイメージを識別します。イメージを経過時間とタグでプルーニングする場合は、イメージが --keep-younger-than しきい値よりも古く、最新のタグリビジョンの 1 つではなく、アクティブなワークロードによって使用されていないことが条件となります。

イメージを経過時間とタグでプルーニングするには、次の条件 すべて を満たす必要があります。

  1. イメージは OpenShift Container Platform によって管理されるか、openshift.io/image.managed アノテーションが付いている。
  2. --keep-younger-than フラグで指定された期間よりも古いイメージである。
  3. --keep-tag-revisions フラグで指定されているように、このタグの最新イメージの 1 つではない。
  4. イメージは、次に示すアクティブまたは最近の API オブジェクトのいずれによっても 参照されていない。

    • --keep-younger-than 期間よりも最近に作成された Pod またはイメージストリーム。
    • 実行中または保留中の Pod
    • デプロイメント、レプリケーションコントローラー、レプリカセット、またはステートフルセット。
    • ビルド、ビルド設定、ジョブ、または cron ジョブ。

      イメージは、古く、最近のタグリビジョンではなく、システムコンポーネントによるアクティブな参照がないことが確認された場合にのみ削除されます。

サイズ制限によるイメージのプルーニング

サイズ制限によってイメージをプルーニングするには、--prune-over-size-limit フラグを使用します。この方法は、プロジェクトを定義されたイメージストレージ制限内に戻すために使用されます。

注記

--prune-over-size-limit フラグは、--keep-tag-revisions フラグまたは --keep-younger-than フラグと共に使用することができません。これを実行すると、この操作が許可されないことを示す情報が返されます。

この方法を使用してイメージをプルーニングするには、次の条件がすべて満たされている必要があります。

  1. このイメージは、現在定義されている最小サイズ制限を超えているプロジェクトの一部である。
  2. イメージは、合計サイズを削減するために、プルーナーによって削除候補として選択されている。
  3. このイメージは現在、次のアクティブな API オブジェクトのいずれによっても参照されていない。

    • running または pending 状態の Pod。
    • デプロイメント、レプリケーションコントローラー、レプリカセット、またはステートフルセット。
    • ビルド、ビルド設定、ジョブ、または cron ジョブ。

      この方法では、主なトリガーはプロジェクトのサイズですが、イメージがアクティブに使用されていないことを確認するための安全性チェックも実行されます。

13.6.4. イメージのプルーニング操作の実行

未使用のコンテナーイメージをレジストリーから安全に削除して、クラスターのディスク領域を再利用し、レジストリーストレージが枯渇するのを防ぎます。

前提条件

  • アクセストークンを使用して CLI にログインした。
  • system:image-pruner 以上のクラスターロール (例: cluster-admin) を持っている。
  • イメージレジストリーが公開されている。
  • このドキュメントの「手動でイメージを削除する場合の考慮事項」セクションを確認した。

手順

  1. オプション: 次のコマンドを入力して、プルーニングされるイメージをプレビューします。このコマンドは、削除されるイメージ、イメージストリーム、および Pod のリストを出力します。--confirm フラグを追加するまで何も削除されないことに注意してください。

    $ oc adm prune images <image_prune_option_one> <image_prune_option_two>

    使用可能なプルーニングオプションの詳細は、「手動イメージプルーニングコマンドのオプション」を参照してください。

  2. 出力をレビューして、削除されるイメージ、イメージストリーム、および Pod のリストを確認します。
  3. クラスターに適切なオプションを指定して oc adm prune images コマンドを実行します。削除を確認するには、--confirm フラグを追加します。以下に例を示します。

    $ oc adm prune images <image_prune_option_one> <image_prune_option_two> --confirm

13.6.5. セキュアまたは非セキュアな接続を使用する

イメージレジストリーと通信するためにイメージをプルーニングする際に、セキュアなフラグまたは非セキュアなフラグを設定します。カスタム CA 証明書を設定するか、HTTPS 検証をバイパスすると、プルーニング中の接続障害を防ぐことができます。

セキュアな通信の使用は優先され、推奨される方法です。これは、必須の証明書検証と共に HTTPS 経由で実行されます。prune コマンドは、可能な場合は常にセキュアな通信の使用を試行します。これを使用できない場合には、非セキュアな通信にフォールバックすることがあり、これには危険が伴います。この場合、証明書検証は省略されるか、単純な HTTP プロトコルが使用されます。

非セキュアな通信へのフォールバックは、--certificate-authority が指定されていない場合、以下のケースで可能になります。

  1. prune コマンドが --force-insecure オプションと共に実行される。
  2. 指定される registry-url の前に http:// スキームが付けられる。
  3. 指定される registry-url はローカルリンクアドレスまたは localhost である。
  4. 現行ユーザーの設定が非セキュアな接続を許可する。これは、ユーザーが --insecure-skip-tls-verify を使用してログインするか、プロンプトが出される際に非セキュアな接続を選択することによって生じる可能性があります。
重要

レジストリーのセキュリティーが、OpenShift Container Platform で使用されるものとは異なる認証局で保護される場合、これを --certificate-authority フラグを使用して指定する必要があります。そうしない場合、prune コマンドがエラーを出して失敗します。

13.6.6. イメージプルーニングの CLI オプション

oc adm prune images コマンドの CLI オプションを確認し、経過時間のしきい値、タグ参照、およびレジストリーエンドポイントのフラグを設定します。

次の表では、oc adm prune images <image_prune_option> コマンドで使用できるオプションについて説明します。

表13.4 手動イメージプルーニングコマンドのオプション
オプション説明

--all

レジストリーにプッシュされていないものの、プルスルー (pullthrough) でミラーリングされたイメージを組み込みます。これはデフォルトでオンに設定されます。プルーニングを統合レジストリーにプッシュされたイメージに制限するには、--all=false を渡します。

--certificate-authority

OpenShift Container Platform で管理されるレジストリーと通信する際に使用する認証局ファイルへのパスです。デフォルトは現行ユーザーの設定ファイルの認証局データに設定されます。これが指定されている場合、セキュアな通信が実行されます。

--confirm

test-run を実行する代わりにプルーニングが実行されることを示します。これには、統合コンテナーイメージレジストリーへの有効なルートが必要になります。このコマンドがクラスターネットワーク外で実行される場合、ルートは --registry-url を使用して指定される必要があります。

--force-insecure

このオプションは注意して使用してください。HTTP 経由でホストされるか、無効な HTTPS 証明書を持つコンテナーレジストリーへの非セキュアな接続を許可します。

--keep-tag-revisions=<N>

それぞれのイメージストリームについては、タグごとに最大 N のイメージリビジョンを保持します (デフォルト: 3)。

--keep-younger-than=<duration>

現在の時間との対比で <duration> より後の新しいイメージはプルーニングしません。または、現在の時間との対比で <duration> より後の他のオブジェクトで参照されるイメージはプルーニングしません (デフォルト: 60m)。

--prune-over-size-limit

同じプロジェクトに定義される最小の制限を超える各イメージをプルーニングします。このフラグは --keep-tag-revisions または --keep-younger-than と共に使用することはできません。

--registry-url

レジストリーと通信する際に使用するアドレスです。このコマンドは、管理されるイメージおよびイメージストリームから判別されるクラスター内の URL の使用を試行します。これに失敗する (レジストリーを解決できないか、これにアクセスできない) 場合、このフラグを使用して他の機能するルートを指定する必要があります。レジストリーのホスト名の前には、特定の接続プロトコルを実施する https:// または http:// を付けることができます。

--prune-registry

他のオプションで規定される条件と共に、このオプションは、OpenShift Container Platform イメージ API オブジェクトに対応するレジストリーのデータがプルーニングされるかどうかを制御します。デフォルトで、イメージのプルーニングは、イメージ API オブジェクトとレジストリーの対応するデータの両方を処理します。

このオプションは、イメージオブジェクトの数を減らすなどの目的で etcd の内容のみを削除することを検討していているか (ただしレジストリーのストレージのクリーンアップは検討していない場合)、レジストリーの適切なメンテナンス期間中にレジストリーのハードプルーニングによってこれを別途実行しようとする場合に役立ちます。

the --prune-registry フラグに関する追加情報

--prune-registry=false フラグを渡すことで、OpenShift Container Platform イメージ API オブジェクトの削除とレジストリー内のイメージデータの削除を分離できます。たとえば、次のコマンドは、レジストリーストレージはそのまま残し、API オブジェクトのみを削除します。

$ oc adm prune images --keep-tag-revisions=3 --keep-younger-than=60m --confirm --prune-registry=false

次に、レジストリーのハードプルーニングを実行して、関連するイメージデータを削除します。このアプローチでは、1 つのコマンドで両方を削除する場合と比較して、競合状態のが発生し得るタイミングウィンドウを短くできます。

ただし、タイミングウィンドウは完全になくなるわけではありません。たとえば、イメージがプルーニング対象として識別されていても、そのイメージを参照する Pod が作成されることがあります。プルーニング中に作成された API オブジェクトを追跡し、削除されたコンテンツを参照していないことを確認する必要があります。

--prune-registry オプションを指定せずに、または --prune-registry=true を指定してプルーニングを再実行しても、以前に --prune-registry=false を指定してプルーニングされたイメージに関連付けられたレジストリーストレージは削除されません。これらのイメージは、レジストリーのハードプルーニングを実行することによってのみ、レジストリーストレージから削除できます。詳細は、「レジストリーのハードプルーニング」を参照してください。

13.6.7. イメージのプルーニングの問題

クラスターのイメージプルーニングの問題を特定して、プルーニングされていないイメージを診断し、タグリビジョンのしきい値を管理し、CLI クライアントとレジストリー間の接続または認証局エラーを修正します。

イメージがプルーニングされない

イメージが蓄積し続け、prune コマンドが予想よりも小規模な削除を実行する場合、プルーニング候補のイメージについて満たすべきイメージプルーティングの条件があることを確認します。

とくに削除する必要のあるイメージが、それぞれのタグ履歴において選択したタグリビジョンのしきい値よりも高い位置にあることを確認します。たとえば、sha256:abz という名前の古く陳腐化したイメージがあるとします。イメージがタグ付けされている namespace で以下のコマンドを実行すると、イメージが myapp という単一イメージストリームで 3 回タグ付けされていることに気づかれるでしょう。

$ oc get is -n <namespace> -o go-template='{{range $isi, $is := .items}}{{range $ti, $tag := $is.status.tags}}'\
'{{range $ii, $item := $tag.items}}{{if eq $item.image "sha256:<hash>"}}{{$is.metadata.name}}:{{$tag.tag}} at position {{$ii}} out of {{len $tag.items}}\n'\
'{{end}}{{end}}{{end}}{{end}}'

出力例

myapp:v2 at position 4 out of 5
myapp:v2.1 at position 2 out of 2
myapp:v2.1-may-2016 at position 0 out of 1

デフォルトオプションが使用される場合、イメージは myapp:v2.1-may-2016 タグの履歴の 0 の位置にあるためプルーニングされません。イメージがプルーニングの対象とみなされるようにするには、管理者は以下を実行する必要があります。

  • oc adm prune images コマンドで --keep-tag-revisions=0 を指定します。

    警告

    このアクションを実行すると、イメージが指定されたしきい値よりも新しいか、これよりも新しいオブジェクトによって参照されていない限り、すべてのタグが基礎となるイメージと共にすべての namespace から削除されます。

  • リビジョンのしきい値の下にあるすべての istags、つまり myapp:v2.1 および myapp:v2.1-may-2016 を削除します。
  • 同じ istag にプッシュする新規ビルドを実行するか、他のイメージをタグ付けしてイメージを履歴内でさらに移動させます。ただし、これは古いリリースタグの場合には常に適切な操作となる訳ではありません。

    特定のイメージのビルド日時が名前の一部になっているタグは、その使用を避ける必要があります (イメージが未定義の期間保持される必要がある場合を除きます)。このようなタグは履歴内で 1 つのイメージのみに関連付けられる可能性があり、その場合にこれらをプルーニングできなくなります。

非セキュアなレジストリーへのセキュアな接続

oc adm prune images コマンドの出力で以下のようなメッセージが表示される場合、レジストリーのセキュリティーは保護されておらず、oc adm prune images クライアントがセキュアな接続の使用を試行することを示しています。

error: error communicating with registry: Get https://172.30.30.30:5000/healthz: http: server gave HTTP response to HTTPS client
  • 推奨される解決法として、レジストリーのセキュリティーを保護することができます。そうしない場合は、--force-insecure をコマンドに追加して、クライアントに対して非セキュアな接続の使用を強制することができますが、これは推奨される方法ではありません。
セキュアなレジストリーへの非セキュアな接続

oc adm prune images コマンドの出力に以下のエラーのいずれかが表示される場合、レジストリーのセキュリティー保護に使用されている認証局で署名された証明書が、接続の検証用に oc adm prune images クライアントで使用されるものとは異なることを意味します。

error: error communicating with registry: Get http://172.30.30.30:5000/healthz: malformed HTTP response "\x15\x03\x01\x00\x02\x02"
error: error communicating with registry: [Get https://172.30.30.30:5000/healthz: x509: certificate signed by unknown authority, Get http://172.30.30.30:5000/healthz: malformed HTTP response "\x15\x03\x01\x00\x02\x02"]

デフォルトでは、ユーザーの設定ファイルに保存されている認証局データが使用されます。コントロールプレーン API との通信の場合も同様です。

--certificate-authority オプションを使用してコンテナーイメージレジストリーサーバーに適切な認証局を指定します。

正しくない認証局

以下のエラーは、セキュリティーが保護されたコンテナーイメージレジストリーの証明書の署名に使用される認証局がクライアントで使用される認証局とは異なることを示しています。

error: error communicating with registry: Get https://172.30.30.30:5000/: x509: certificate signed by unknown authority

フラグ --certificate-authority を使用して適切な認証局を指定します。

回避策として、--force-insecure フラグを代わりに追加することもできます。ただし、これは推奨される方法ではありません。

13.7. レジストリーのハードプルーニング

OpenShift イメージレジストリーをハードプルーニングし、標準イメージのプルーニングが不十分な場合に etcd で参照されない孤立したイメージ Blob を削除し、レジストリーストレージ領域を回収します。

OpenShift イメージレジストリーは、OpenShift Container Platform クラスターの etcd で参照されない Blob を蓄積します。基本的なイメージプルーニングの手順はこれらに対応しません。これらの Blob は 孤立した Blob と呼ばれています。

孤立した Blob は以下のシナリオで発生する可能性があります。

  • oc delete image <sha256:image-id> コマンドを使用してイメージを手動で削除すると、etcd のイメージのみが削除され、レジストリーのストレージからは削除されません。
  • デーモンの障害によって生じるレジストリーへのプッシュにより、一部の Blob はアップロードされるものの、(最後のコンポーネントとしてアップロードされる) イメージマニフェストはアップロードされません。固有のイメージ Blob すべてが孤立します。
  • OpenShift Container Platform がクォータの制限によりイメージを拒否します。
  • 標準のイメージプルーナーがイメージマニフェストを削除するが、関連する Blob を削除する前に中断されます。
  • 対象の Blob を削除できないというレジストリープルーナーのバグにより、それらを参照するイメージオブジェクトは削除され、Blob は孤立します。

基本的なイメージプルーニングとは異なるレジストリーの ハードプルーニング により、クラスター管理者は孤立した Blob を削除することができます。OpenShift イメージレジストリーのストレージ領域が不足している場合や、孤立した Blob があると思われる場合にはハードプルーニングを実行する必要があります。

これは何度も行う操作ではなく、多数の孤立した Blob が新たに作成されているという証拠がある場合にのみ実行する必要があります。または、(作成されるイメージの数によって異なりますが) 1 日 1 回などの定期的な間隔で標準のイメージプルーニングを実行することもできます。

手順

  1. ログインします。

    CLI で kubeadmin として、または openshift-image-registry namespace へのアクセスのある別の特権ユーザーとしてクラスターにログインします。

  2. 基本的なイメージプルーニングの実行

    基本的なイメージプルーニングにより、不要になった追加のイメージが削除されます。ハードプルーニングによってイメージが削除される訳ではありません。レジストリーストレージに保存された Blob のみが削除されます。したがって、ハードプルーニングの実行前にこれを実行する必要があります。

  3. レジストリーの読み取り専用モードへの切り替え

    レジストリーが読み取り専用モードで実行されていない場合、プルーニングと同時に実行されているプッシュの結果は以下のいずれかになります。

    • 失敗する。孤立した Blob が新たに発生します。
    • 成功する。ただし、(参照される Blob の一部が削除されたため) イメージをプルできません。

    プッシュは、レジストリーが読み取り書き込みモードに戻されるまで成功しません。したがって、ハードプルーニングは注意してスケジューリングする必要があります。

    レジストリーを読み取り専用モードに切り換えるには、以下を実行します。

    1. configs.imageregistry.operator.openshift.io/cluster で、spec.readOnly を true に設定します。

      $ oc patch configs.imageregistry.operator.openshift.io/cluster -p '{"spec":{"readOnly":true}}' --type=merge
  4. system:image-pruner ロールの追加

    一部のリソースをリスト表示するには、レジストリーインスタンスの実行に使用するサービスアカウントに追加のパーミッションが必要になります。

    1. サービスアカウント名を取得します。

      $ service_account=$(oc get -n openshift-image-registry \
          -o jsonpath='{.spec.template.spec.serviceAccountName}' deploy/image-registry)
    2. system:image-pruner クラスターロールをサービスアカウントに追加します。

      $ oc adm policy add-cluster-role-to-user \
          system:image-pruner -z \
          ${service_account} -n openshift-image-registry
  5. オプション: プルーナーのドライランモードでの実行

    削除される Blob の数を確認するには、ドライランモードでハードプルーナーを実行します。実際の変更は加えられません。以下の例では、image-registry-3-vhndw というイメージレジストリー Pod を参照します。

    $ oc -n openshift-image-registry exec pod/image-registry-3-vhndw -- /bin/sh -c '/usr/bin/dockerregistry -prune=check'

    または、プルーニング候補の実際のパスを取得するには、ロギングレベルを上げます。

    $ oc -n openshift-image-registry exec pod/image-registry-3-vhndw -- /bin/sh -c 'REGISTRY_LOG_LEVEL=info /usr/bin/dockerregistry -prune=check'

    出力例

    time="2017-06-22T11:50:25.066156047Z" level=info msg="start prune (dry-run mode)" distribution_version="v2.4.1+unknown" kubernetes_version=v1.6.1+$Format:%h$ openshift_version=unknown
    time="2017-06-22T11:50:25.092257421Z" level=info msg="Would delete blob: sha256:00043a2a5e384f6b59ab17e2c3d3a3d0a7de01b2cabeb606243e468acc663fa5" go.version=go1.7.5 instance.id=b097121c-a864-4e0c-ad6c-cc25f8fdf5a6
    time="2017-06-22T11:50:25.092395621Z" level=info msg="Would delete blob: sha256:0022d49612807cb348cabc562c072ef34d756adfe0100a61952cbcb87ee6578a" go.version=go1.7.5 instance.id=b097121c-a864-4e0c-ad6c-cc25f8fdf5a6
    time="2017-06-22T11:50:25.092492183Z" level=info msg="Would delete blob: sha256:0029dd4228961086707e53b881e25eba0564fa80033fbbb2e27847a28d16a37c" go.version=go1.7.5 instance.id=b097121c-a864-4e0c-ad6c-cc25f8fdf5a6
    time="2017-06-22T11:50:26.673946639Z" level=info msg="Would delete blob: sha256:ff7664dfc213d6cc60fd5c5f5bb00a7bf4a687e18e1df12d349a1d07b2cf7663" go.version=go1.7.5 instance.id=b097121c-a864-4e0c-ad6c-cc25f8fdf5a6
    time="2017-06-22T11:50:26.674024531Z" level=info msg="Would delete blob: sha256:ff7a933178ccd931f4b5f40f9f19a65be5eeeec207e4fad2a5bafd28afbef57e" go.version=go1.7.5 instance.id=b097121c-a864-4e0c-ad6c-cc25f8fdf5a6
    time="2017-06-22T11:50:26.674675469Z" level=info msg="Would delete blob: sha256:ff9b8956794b426cc80bb49a604a0b24a1553aae96b930c6919a6675db3d5e06" go.version=go1.7.5 instance.id=b097121c-a864-4e0c-ad6c-cc25f8fdf5a6
    ...
    Would delete 13374 blobs
    Would free up 2.835 GiB of disk space
    Use -prune=delete to actually delete the data

  6. ハードプルーニングを実行 します。

    ハードプルーニングを実行するには、image-registry Pod の実行中のインスタンスのいずれかで以下のコマンドを実行します。以下の例では、image-registry-3-vhndw というイメージレジストリー Pod を参照します。

    $ oc -n openshift-image-registry exec pod/image-registry-3-vhndw -- /bin/sh -c '/usr/bin/dockerregistry -prune=delete'

    出力例

    Deleted 13374 blobs
    Freed up 2.835 GiB of disk space

  7. レジストリーを読み取り/書き込みモードに戻す

    プルーニングの終了後は、レジストリーを読み取り/書き込みモードに戻すことができます。configs.imageregistry.operator.openshift.io/cluster で、spec.readOnly を false に設定します。

    $ oc patch configs.imageregistry.operator.openshift.io/cluster -p '{"spec":{"readOnly":false}}' --type=merge

13.8. cron ジョブのプルーニング

リソースの枯渇を防ぐために、完了済みおよび失敗した Kubernetes ジョブを手動でクリーンアップします。cron ジョブの認証ユーザーへのアクセスを制限し、ジョブおよび Pod の作成を制御するようにリソースクォータを設定できます。

cron ジョブは正常なジョブのプルーニングを実行できますが、失敗したジョブを適切に処理していない可能性があります。そのため、クラスター管理者はジョブの定期的なクリーンアップを手動で実行する必要があります。また、信頼できるユーザーの小規模なグループに cron ジョブへのアクセスを制限し、cron ジョブでジョブや Pod が作成され過ぎないように適切なクォータを設定する必要もあります。

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

Red Hat ドキュメントについて

Legal Notice

Theme

© 2026 Red Hat
トップに戻る