Podman REST APIをPythonで操作する: podman-pyの詳細ガイド

コンテナ技術の利用が拡大する中、PodmanはDockerに代わる強力な選択肢として注目されています。 この記事では、PodmanのRESTful APIをPythonで操作するためのライブラリ、podman-py について詳しく解説します。

podman-pyとは？

podman-pyは、PodmanのRESTful APIに対するPythonバインディングを提供するライブラリです。 これを使用することで、PythonスクリプトからPodmanコンテナを操作し、イメージの管理、コンテナの実行、情報の収集など、さまざまなタスクを自動化できます。

podman-pyを使うメリット

• Pythonによる自動化: Pythonの強力なスクリプト機能を利用して、コンテナ関連のタスクを自動化できます。
• Podman APIへのアクセス: PodmanのすべてのREST API機能をPythonから利用できます。
• 開発の効率化: コンテナ操作を簡素化し、開発プロセスをスピードアップします。

必要な環境

• Python 3.6以上
• Podmanがインストールされ、REST APIが利用可能な状態であること。
• 必要なPythonパッケージ (requirements.txtを参照)

インストール方法

以下のコマンドで簡単にインストールできます。

pip install podman

基本的な使い方

Podmanクライアントの作成

from podman import PodmanClient

# Podman APIのURIを指定 (例: unixドメインソケット)
uri = "unix:///run/user/1000/podman/podman.sock"

client = PodmanClient(base_url=uri)

Podmanバージョンの確認

クライアントを作成後、簡単にバージョン情報を取得できます。

version = client.version()
print("リリースバージョン:", version["Version"])
print("APIバージョン:", version["ApiVersion"])

イメージの一覧表示

コンテナイメージの情報を取得・表示するには:

for image in client.images.list():
    print(image.id, image.tags)

コンテナの一覧表示

実行中のコンテナ、停止中のコンテナを一覧表示するには:

for container in client.containers.list():
    container.reload()  # 最新の状態を反映
    print(container.id, container.name, container.status)

コンテナの詳細情報取得

コンテナの詳細な属性情報を確認するには、attrsを利用します。 例えば、コンテナの設定情報、ネットワーク設定などを取得できます。

print(sorted(container.attrs.keys()))

ディスク使用状況の確認

client.df()メソッドで、ディスク使用状況に関する情報をJSON形式で取得できます。

import json
print(json.dumps(client.df(), indent=4))

貢献について

podman-pyプロジェクトに貢献する方法はCONTRIBUTING.mdに記載されています。

まとめ

podman-py を使用することで、PodmanのRESTful APIをPythonから容易に操作できるようになります。 コンテナの自動化、管理タスクの効率化に大きく貢献するでしょう。ぜひ、podman-pyを活用して、より快適なコンテナ環境を実現してください。 コンテナ管理をPythonで自動化したい方にとって、必携のライブラリです。「Podman Python API」で検索して、更なる情報を手に入れてください。