1
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

Kubernetesノードのお掃除屋さんEraserを使ってみよう

Posted at

こんにちは!今回はKubernetesクラスタのノード上に蓄積された不要なコンテナイメージをクリーンアップしてくれるツール、Eraserについてご紹介します。Kubernetes中級者向けに、カジュアルな雰囲気でEraserの概要から導入方法、ユースケース、内部アーキテクチャ、実際の動かし方まで解説していきます。Eraserって便利ですよね!それでは早速見ていきましょう。

1. Eraserとは何か

Eraserとは、Kubernetesクラスタ内の各ノードに残っている未使用のコンテナイメージを自動的に削除してくれるオープンソースのツールです (Clean Slate for your Kubernetes Nodes)。CNCF(Cloud Native Computing Foundation)のサンドボックスプロジェクトとして登場し、主に**「非稼働(non-running)のコンテナイメージ」を一覧に基づいてクラスター全体から綺麗に消し去ってくれます (Eraser | CNCF)。要するに、クラスターのお掃除屋さん**ですね。

では、なぜこんなツールが必要なのでしょうか?KubernetesではPodをデプロイすると、そのイメージが各ノードにプルされます。しかしPodを削除した後も、そのイメージ自体はノード上に残り続けることがあります。クラスターを長く運用していると、このような使われていない古いイメージがどんどん蓄積してしまいがちです。これにはいくつか問題点があります:

  • ストレージ容量の圧迫: 不要なイメージが増えるとディスク容量を消費し、ノードのストレージが圧迫されます (Clean Slate for your Kubernetes Nodes)。特に大規模クラスターや長期間稼働している環境では馬鹿になりません。
  • パフォーマンスへの影響: イメージが山積みになると、クラスターのパフォーマンスにも悪影響があります (Clean Slate for your Kubernetes Nodes)。たとえば、新しいPod起動時にイメージキャッシュの管理に時間がかかったり、Kubernetesのガベージコレクション処理が頻繁に走ってしまうことがあります。
  • セキュリティリスク: 古いイメージには既知の脆弱性が含まれている可能性があります (Clean Slate for your Kubernetes Nodes)。そうした脆弱なイメージがノード上に残っていると、万一それが再度使われてしまった場合にセキュリティ上のリスクとなり得ます。

こうした問題を解決するために生まれたのがEraserです。Eraserは脆弱だったり不要になったコンテナイメージを検出してクラスターから自動削除してくれるので、クラスターノードの状態を常にクリーンかつ安全に保つことができます (Clean Slate for your Kubernetes Nodes)。いわばKubernetesノードの「掃除機」のような役割を果たしてくれるわけですね。

2. Eraserの導入方法

では実際にEraserを使ってみましょう!まずはクラスターへの導入方法です。EraserはKubernetesのカスタムリソース定義(CRD)としてインストールします (Clean Slate for your Kubernetes Nodes)。方法は大きく分けて2通りあります: kubectlを使う方法Helmを使う方法です。

kubectlでインストールする

一番手軽なのは、公式が提供するマニフェストをkubectlで適用する方法です。以下のコマンド一発で、CRDやコントローラなどEraserに必要なリソースがクラスターにデプロイされます。

# Eraserをマニフェストからインストール
kubectl apply -f https://raw.githubusercontent.com/eraser-dev/eraser/v1.4.0/deploy/eraser.yaml

※バージョンは執筆時点(v1.4.0)の例です。最新のリリースに応じてURL中のバージョン番号を変更してください (Installation | Eraser Docs)。

上記コマンドを実行すると、eraser-systemというNamespaceにEraserのコントローラがデプロイされ、必要なCRD(後述するImageListやImageJobなど)が登録されます。kubectl get pods -n eraser-systemでコントローラが立ち上がっているか確認してみましょう。eraser-controller-manager-xxxxxというPodがRunning状態になっていればOKです。

Helmでインストールする

Helm愛好者の方は、Helm Chartを使ってインストールすることもできます。EraserのHelmチャートは公式で提供されています。以下の手順でリポジトリを追加し、インストールしましょう。

# Eraser Helmリポジトリを追加
helm repo add eraser https://eraser-dev.github.io/eraser/charts
helm repo update

# Eraserをインストール(リリース名は eraser とし、Namespace は eraser-system)
helm install eraser eraser/eraser -n eraser-system --create-namespace

Helmでインストールすると、今後のアップグレードや設定変更もHelmで一元管理できる利点があります。内部的には先ほどのマニフェストと同じリソースが作成されます (eraser/charts/eraser/README.md at main · eraser-dev/eraser · GitHub)。

いずれの方法でもインストール後は、eraser-system NamespaceにEraserのコントローラ(コントローラマネージャ)が動作します。また、Eraser用のConfigMap(設定用)やCRDが出来上がっているはずです。デフォルト設定では24時間に1回の間隔でクリーンアップ処理が実行されるようになっています (Quick Start | Eraser Docs)(後述のArchitectureセクションで詳しく説明します)。

3. Eraserのユースケース

Eraserがどんな場面で役立つか、具体的なユースケースを見てみましょう。「不要なコンテナイメージの自動削除」というシンプルな機能ですが、実はいろいろなシナリオでクラスタ管理者を助けてくれます。

  • CI/CD環境でのクリーンアップ: ビルドやデプロイを繰り返すCI/CDパイプラインでは、新しいイメージが次々にノードにPullされ、古いイメージが溜まりがちです。Eraserを導入すれば、使われなくなった古いイメージを自動的に検出・削除してくれるので、クラスターのノードは常に軽快な状態を保てます。ディスクスペースを自動で解放してくれるので、「ノードのディスクがいつの間にか満杯!」なんて事態を防げます ( Enhancing Container Security: The Complete Guide to Secure and Clean Kubernetes Clusters ️ - DEV Community)。

  • セキュリティとコンプライアンスの強化: セキュリティポリシー上、脆弱性のあるイメージや社内で許可されていないイメージをクラスター上に残さないようにしたい場合があります。Eraserはイメージのスキャン機能(後述)によって脆弱なイメージポリシーに適合しないイメージを検出し、自動的に削除できます (Clean Slate for your Kubernetes Nodes)。例えば、「一定期間以上更新されていない古いイメージは削除する」ポリシーや「社内プライベートレジストリ以外からPullされたイメージは削除する」といったルールを適用することで、クラスタ内のコンテナイメージを常にセキュアかつポリシー準拠な状態に保てます。

  • マルチテナント環境のメンテナンス: 複数のチームやアプリケーションが混在するクラスターでは、各チームがデプロイ・削除を繰り返すうちに、誰も使っていないイメージが大量に残留することがあります。Eraserはクラスター全体で未使用イメージを一括クリーンアップしてくれるので、マルチテナント環境のガバナンスにも有効です。他チームの古いイメージが自分たちのノードリソースを圧迫する、といった心配も減ります。

  • リソース制約のある環境での利用: エッジ環境や学習用途の小規模クラスターなど、ノードのリソース(特にディスク)が限られている場合にもEraserは有用です。例えば学生や個人で試すKubernetesクラスタでは、ストレージ容量が潤沢でないことも多いでしょう。Eraserが自動で定期的にお掃除してくれることで、限られたリソースを有効活用できます (Clean Slate for your Kubernetes Nodes)。

このように、Eraserはクラスターの衛生管理役として様々な場面で活躍します。「ノードのディスクをスッキリ保ちたい」「古く危険なイメージを残したくない」といったケースでは導入を検討する価値大です。

4. Eraserの内部アーキテクチャ

Eraserが裏側でどのように動作しているのか、そのアーキテクチャをざっくり理解しておきましょう。中級者であれば、内部の仕組みも押さえておくとトラブルシューティングの際に役立ちます。

コンポーネント概要

EraserはKubernetesのカスタムコントローラ(オペレーター)の一種で、以下の主要コンポーネントで構成されています:

  • Eraserコントローラ(コントローラマネージャ): eraser-system Namespaceで動作するデプロイメントです。Eraser専用のCRDリソース(後述のImageListやImageJob)を監視し、必要に応じてクリーンアップ用のジョブ(Pod)を各ノードにスケジューリングします。いわばEraser全体の司令塔です。

  • ImageList リソース(CRD): 削除すべきコンテナイメージの一覧を表すカスタムリソースです。eraser.sh/v1alpha1 APIグループで定義されており、ImageListというKindを持ちます。手動で特定のイメージを削除したい場合、このImageListリソースに対象イメージ名を列挙して作成します。特殊な指定として "*"(アスタリスク)を使うと「非稼働の全イメージ」を意味し、一括削除が可能です (Manual Removal | Eraser Docs) (Manual Removal | Eraser Docs)。

  • ImageJob リソース(CRD): クリーンアップ作業の実行ジョブを表すリソースです。ImageListを作成した際や、自動スキャンのスケジュールが来た際にEraserコントローラによって生成されます。このImageJobに基づき、各ノードで実行されるEraser Podが作られます。

  • Eraser Pod(エージェント): 実際にノード上でイメージ削除を行うPodです。クリーンアップ対象の各ノードに1つずつスケジューリングされます。内部には最大で3つのコンテナが含まれており、それぞれ**Collector(収集)、Scanner(スキャン)、Remover(削除)**の役割を担います (Quick Start | Eraser Docs)。各コンテナは以下のように協調動作します (Quick Start | Eraser Docs):

    • Collectorコンテナ: ノード上に存在する全てのコンテナイメージのリストを収集します。具体的にはCRI(Container Runtime Interface)を通じてListImagesListContainersといったAPIを呼び出し、そのノードにあるイメージ一覧や現在稼働中のコンテナ情報を取得します。これにより「非稼働(未使用)のイメージ」がどれかを洗い出します。
    • Scannerコンテナ: Collectorから受け取ったイメージ一覧に対し、セキュリティスキャンやポリシーチェックを実行します。デフォルトでは有名な脆弱性スキャナであるTrivyが使われ、各イメージに既知の脆弱性がないかチェックされます (Architecture | Eraser Docs)。スキャン結果にもとづき、「ポリシーに非準拠(non-compliant)なイメージ」を判定します。例えば深刻な脆弱性を含むイメージや、組織で許可されていないレジストリ由来のイメージなどが該当します。
    • Removerコンテナ: Scannerによって「削除対象」とマークされたイメージを、ノードから実際に削除する役割です。CRIのRemoveImageAPIを用いてイメージデータをクリーンアップします。ただし現在稼働中のコンテナが使用しているイメージは削除しません。Removerはあくまで「非稼働のイメージ」のみを対象にします (Quick Start | Eraser Docs)。これにより、動いているPodへの影響は避けつつ、不要なデータだけを消去します。

Eraser Pod上のこれらのコンテナはJobのように完了するまで実行され、全コンテナが処理を終えるとPod自体はCompleted(完了)状態になります (Quick Start | Eraser Docs)。各ノードのEraser Podが完了すると、それらは自動的にクリーンアップ(削除)されます (Quick Start | Eraser Docs)。つまり、お掃除のために使ったPod自身も後始末され、後にリソースを残しません。

動作モード: 自動 vs 手動

Eraserには大きく自動モード手動モードの2つの動作モードがあります (Architecture | Eraser Docs)。

  • 自動モード(定期クリーンアップ): 一定間隔で自動的にイメージのスキャン&クリーンアップを行うモードです。インストール直後のデフォルト設定では24時間ごとに実行されます (Quick Start | Eraser Docs)。Eraserコントローラ内のスケジューラ(ImageCollector Controller)がタイマーに従ってImageJobを作成し、各ノードにEraser Podを起動します。先述のようにデフォルトでは脆弱性スキャンを有効にした状態で動作し、脆弱だと判定された未使用イメージのみを削除します (Architecture | Eraser Docs)。もしスキャンを無効化した場合(後述の設定で可能です)、全ての未使用イメージをガベージコレクションする動きになります (Architecture | Eraser Docs)。自動モードでは基本的に人手を介さず、クラスターを継続的にクリーンな状態に維持してくれます (Clean Slate for your Kubernetes Nodes)。

  • 手動モード(オンデマンドクリーンアップ): 特定のタイミングで明示的にクリーンアップを走らせたい場合や、削除対象のイメージを自分で指定したい場合はこちらです。ユーザーがImageListリソースを作成・適用することでトリガーします (Manual Removal | Eraser Docs)。ImageListのspecに削除したいイメージのリスト(例: "docker.io/library/alpine:3.7.3" など)や、"*"(全未使用イメージ一括)を指定しておくと、Eraserコントローラがそれを検知して対応するImageJobを生成し、各ノードでクリーンアップPodを動かします (Manual Removal | Eraser Docs)。手動モードではScannerコンテナの有無に関係なく、指定されたイメージ(もしくは全未使用イメージ)が対象となります。例えば緊急で「◯◯というイメージだけ削除したい」というときに便利です。

連携する仕組みと設定

Eraserはいくつか設定可能なコンフィグKubernetesの仕組みとの連携ポイントがあります。

  • ConfigMapによる設定: Eraserの動作間隔やコンポーネント有効/無効は、eraser-system NamespaceにあるEraser用のConfigMapで管理されます。前述の実行間隔(repeatInterval)もその一つで、デフォルトは24hですがこの値を変更すれば好きな周期で自動クリーンアップが走るようになります (Quick Start | Eraser Docs)。またScannerコンテナの有効/無効も設定可能で、例えばcomponents.scanner.enabled=falseとすれば脆弱性スキャンをスキップして全未使用イメージを削除するシンプルなGCモードに切り替えられます (Quick Start | Eraser Docs)。

  • 除外リスト(Exclude List): すべてのイメージを無差別に消すわけにはいかない場合もありますよね。例えば「この特定のレジストリのイメージは多少未使用でも残しておきたい」などのケースです。そのためにEraserは除外対象を指定する機能も備えています。eraser-system Namespaceに特定のラベル付きConfigMapを作成し、JSON形式で除外したいイメージパターンを列挙しておくことで、クリーンアップから除外できます (Exclusion | Eraser Docs)。例えば以下のようにConfigMapを作れば、docker.io/library/*(Docker Hubのlibrary配下全て)や特定のイメージタグを除外可能です (Exclusion | Eraser Docs)。

    {
      "excluded": [
        "docker.io/library/*",
        "ghcr.io/eraser-dev/test:latest"
      ]
    }
    
    kubectl create configmap eraser-exclusion --from-file=excluded-images.json -n eraser-system
    kubectl label configmap eraser-exclusion eraser.sh/exclude.list=true -n eraser-system
    

    こうしておけば、除外リストにマッチするイメージはたとえ未使用でもEraserによって削除されなくなります。

  • ノード除外/対象指定: クラスター内の一部ノードではイメージを消したくない、といった場合もあるでしょう。Eraserはv1.0.0以降、特定ノードをクリーンアップ対象から含めたり除外したりする設定もサポートしています (Exclusion | Eraser Docs)。これもConfigMap経由の設定で、「特定ノード名を除外」あるいは逆に「このリストのノードにのみ適用」という形で柔軟に指定できます (Exclusion | Eraser Docs)。たとえばノードラベルや名前を使って「デプロイ専用ノードは除外」等の運用も可能です。

内部アーキテクチャの話は少し専門的になりましたが、要するにEraserはKubernetesの拡張機能として、独自のCRDとコントローラ、そしてノード上で動くエージェントPodたちによって構成されているということです。Collector・Scanner・Removerという3段構えで「収集→判定→削除」を行い、クラスターから不要イメージを一掃してくれる仕組みになっています。

5. 実践:Eraserの動作確認

それでは実際にEraserを動かしてみましょう!「百聞は一見にしかず」ということで、簡単なデモを通じてEraserの働きを確認してみます。ここでは手動で不要イメージを発生させて、それをEraserでクリーンアップする一連の流れを試します。実際に動かしてみましょう!

ステップ1: 不要なイメージの発生
まずは意図的にノード上に未使用イメージを作ってみます。手っ取り早い方法として、短命なPodを起動してすぐ消すという手があります。例えばAlpine 3.7.3というイメージを使ったPodをデプロイし、すぐ終了させてみましょう(Alpine 3.7.3は脆弱性がある古いイメージなのでデモに最適です)。

# 脆弱性のある古いAlpineイメージを使ったPodを起動
kubectl run test-alpine --image=docker.io/library/alpine:3.7.3 --command -- sleep 5

上記コマンドでtest-alpineというPodを起動します。このPodは5秒間スリープした後に終了します。5秒ほど待ってからPodの状態を確認すると、Completedになっているはずです。

$ kubectl get pod test-alpine
NAME           READY   STATUS      RESTARTS   AGE
test-alpine    0/1     Completed   0          10s

PodがCompletedあるいは削除済みであれば、Alpine:3.7.3のイメージだけがノード上に残った状態になっています。これが「未使用イメージがノードに残っている」状況です。

ステップ2: Eraserで未使用イメージをクリーンアップ
次に、この残ったAlpineイメージをEraserに掃除してもらいましょう!Eraserコントローラが監視するImageListリソースを作成して、削除対象のイメージを指定します。先ほどのPodで使ったdocker.io/library/alpine:3.7.3を対象に指定してみます。

# 削除対象イメージのリストをCRDとして適用
cat <<EOF | kubectl apply -f -
apiVersion: eraser.sh/v1alpha1
kind: ImageList
metadata:
  name: imagelist                                # 名前は必ず "imagelist"
spec:
  images:
    - docker.io/library/alpine:3.7.3             # 削除したいイメージ
EOF

ImageListリソースを作成すると、Eraserのコントローラがそれを検知して内部でImageJobを生成し、各ノードでEraser Podのデプロイが始まります (Manual Removal | Eraser Docs)。数秒待ってからEraserのPodを確認してみましょう。

$ kubectl get pods -n eraser-system
NAME                                READY   STATUS      AGE
eraser-controller-manager-xxxxx     1/1     Running     5m
eraser-worker-node1-yyyyy           0/1     Completed   10s
eraser-worker-node2-zzzzz           0/1     Completed   10s

上記は2ノード(worker-node1worker-node2)の例ですが、各ノード名が入ったEraser Podが**Completed(0/1 Completed)**となっているのが分かります。今回は手動モードでScannerコンテナを使わず1コンテナ(Remover)のみのPodが動いたため、各PodのREADY列は0/1となっています (Manual Removal | Eraser Docs)(コンテナが完了するとPodもCompletedになるため)。この状態になれば、対象のAlpineイメージは各ノードから削除済みです。

ステップ3: 削除結果の確認
では本当にイメージが消えたか確認してみましょう。確認方法はいくつかありますが、例えばノード上で直接コンテナランタイムのコマンドを実行してみます。Docker系ならdocker images, containerdならctr images listなどでイメージ一覧を見られます。ここではKind(containerdベース)のクラスタを想定して、先ほどイメージが存在したノードでctrコマンドを実行してみた結果を示します。

# kind環境のノードコンテナ上での実行例(ノード名は適宜読み替えてください)
docker exec kind-worker ctr -n k8s.io images list | grep alpine

もしEraserが正しく機能していれば、上記コマンドでdocker.io/library/alpine:3.7.3が表示されないはずです。つまりノード上からAlpine:3.7.3のエントリが消えていればOKです。加えて、EraserのImageListリソースにも実行結果が記録されています。kubectl describe imagelist imagelistでカスタムリソースの詳細を見ると、各ノードでの成功/失敗数やタイムスタンプがStatus欄に更新されているはずです (Manual Removal | Eraser Docs)。成功ノード数が総ノード数と一致していれば全ノードでクリーンアップ成功です。

最後に、EraserコントローラのログやEraser Podのログにも動作の詳細が出力されています。興味があればkubectl logs -n eraser-system eraser-controller-manager-XXXXXや各Completed Podのログを確認してみましょう。削除したイメージの名前などが出力されているので、「ちゃんと動いてるね」と安心できます。

6. まとめ

いかがでしたでしょうか?Eraserを使うことで、Kubernetesノード上に蓄積する不要なコンテナイメージを自動でクリーンアップし、クラスターの健全性とセキュリティを向上させられることがお分かりいただけたと思います。

Eraserの利点はたくさんあります。まず、人手によるノードメンテナンスを減らし、自動化による安心感を得られます (Clean Slate for your Kubernetes Nodes)。「いつの間にかディスクがいっぱい」「古いイメージが放置されて脆弱性が…」といった事態を防ぐ保険になるでしょう。また、ポリシーベースで削除対象をコントロールできるため、クラスターごとのセキュリティポリシーや運用ルールに沿った柔軟な管理が可能です (Clean Slate for your Kubernetes Nodes)。加えて、削除のたびに詳細なログやメトリクスが残るので、あとから監査やトレースもでき、安心です (Clean Slate for your Kubernetes Nodes)。

一方で導入にあたっての注意点もあります。Eraserは未使用イメージを消すので、例えば「すぐに再利用する予定のイメージ」まで消してしまう可能性があります。たとえばスケールダウンしたDeploymentのイメージが削除されると、次回スケールアップ時に再Pullが発生します。しかしこの点はトレードオフで、ディスク節約と引き換えに再Pullのオーバーヘッドが発生することになります。運用上問題ないか確認しつつ導入しましょう(必要に応じて特定イメージを除外リストに入れることもできます)。また、Eraser自身が定期的に各ノードでジョブを動かすため、ごくわずかながらノード上でのリソース消費(CPU/メモリや、イメージ削除時のストレージI/O)が発生します。通常は無視できる程度ですが、大規模環境ではスケジュール間隔を調整するなど配慮しても良いでしょう。

総合的に見て、EraserはCI/CDが活発な環境長期稼働しているプロダクションクラスタセキュリティ重視の組織で特に有用なツールです。これらのケースでは導入するメリットが大きいでしょう。一方、クラスターが小規模でイメージがほとんど変化しないような場合には、既存のKubernetesのガベージコレクション機能でも足りるかもしれません。しかし将来的にクラスターが成長したときのために、Eraserの存在を頭の片隅に入れておくといざという時役立つはずです。

以上、Kubernetesクラスタのお掃除屋さん「Eraser」の紹介でした。クラスター運用の裏方として、Eraserが皆さんの環境でも活躍してくれることを願っています。ぜひ試してみてくださいね!Eraserって便利ですよね! 😄

参考資料:

1
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?