インストール

Docker (推奨)

Linux. コンテナーがローカルネットワーク上で UDP ポート 623 (IPMI/RMCP+ ポート) を通じて BMC に直接到達できるよう、--network host が必要です。ホストネットワークがないと、コンテナーは Docker の NAT の背後に置かれ、ハードウェアとの IPMI セッションを完了できません。

docker run -d --name ipmideck --network host \
  -v ipmideck-data:/data \
  devluigi06/ipmideck:latest

Windows / macOS. Docker Desktop はホストネットワークをサポートしないため、代わりにポートをマッピングします。

docker run -d --name ipmideck -p 3000:3000 \
  -v ipmideck-data:/data \
  devluigi06/ipmideck:latest

どちらのコマンドも、名前付きボリューム (ipmideck-data) を /data にマウントします。このボリュームには config.yaml、SQLite データベース、そして保存された BMC 資格情報を保護する暗号化キーが含まれるので、再起動、アップグレード、docker rm をまたいでも残ります。-v がないと、コンテナーが再作成されるたびにまっさらな空のインストールになります。コンテナーが起動したら、http://<your-ip>:3000 を開いてセットアップウィザードに従います。

公開イメージは Docker Hub の hub.docker.com/r/devluigi06/ipmideck にあります。

pip

pip install ipmideck

pip パッケージはホストに ipmitool がインストールされている必要があります。ipmideck はすべての IPMI 操作で ipmitool を呼び出します。まずディストリビューションのパッケージマネージャーからインストールしてください (例: apt install ipmitool または dnf install ipmitool)。

Debian 12+ および Ubuntu 23.04+ では、素の pip install は実行を拒否し、 error: externally-managed-environment で失敗します。これは想定どおりの動作です。下記の Debian と Ubuntu へのインストールを参照してください。

Debian と Ubuntu へのインストール (PEP 668)

素の Debian 12+ または Ubuntu 23.04+ システムでは、pip install ipmideck は次のように停止します。

error: externally-managed-environment

× This environment is externally managed
╰─> To install Python packages system-wide, try apt install
    python3-xyz, where xyz is the package you are trying to
    install.
    ...
note: If you believe this is a mistake, please contact your Python installation or OS distribution provider. You can override this, at the risk of breaking your Python installation or OS, by passing --break-system-packages.
hint: See PEP 668 for the detailed specification.

これは ipmideck のバグではありません。ディストリビューションはシステムの Python を自身のパッケージマネージャー用に予約しており (apt がそれに依存しています)、pip がそこに書き込むのをブロックします。それでも ipmideck をインストールする、サポートされた方法が 2 つあります。

pipx (推奨)

pipx は、コマンドラインの Python アプリケーションを独自の隔離された仮想環境にインストールし、システムの Python に一切触れずに、その結果生じるコマンドをグローバルに公開します。これはまさに ipmideck の形なので、これが私たちが推奨する方法です。

sudo apt install pipx ipmitool
pipx install ipmideck

pipx は実行可能ファイルを ~/.local/bin に配置します。Debian と Ubuntu は、そのディレクトリーが存在すると自動的に PATH に追加しますが、それは 新しい シェルセッションに対してのみなので、ごく最初のインストールでは警告が出力され、それを実行したシェルではまだ ipmideck が見つかりません。

⚠️  Note: '/home/you/.local/bin' is not on your PATH environment variable.

新しい端末を開く (または SSH で再接続する) と、コマンドが動作します。それでもシェルが見つけられない場合は、ディレクトリーを明示的に追加してから新しいシェルを開始します。

pipx ensurepath

実際のハードウェアを必要としないデモモードでインストールを検証します。

ipmideck --demo

venv

仮想環境も同じように PEP 668 を回避でき、ソースチェックアウトから作業している場合はこれが適切な選択です。

python3 -m venv ~/ipmideck-venv
source ~/ipmideck-venv/bin/activate
pip install ipmideck

その環境がアクティブになっているときはいつでも ipmideck コマンドが利用できます。

pip install --break-system-packages ipmideck も動作しますが、システムの Python に直接書き込むため、依存関係のバージョンが衝突すると apt を壊す可能性があります。pipx か venv を優先してください。

ipmideck がデータを保存する場所

ipmideck は設定とデータベースをデータディレクトリーの下に書き込みます。

Docker: コンテナー内の /data (イメージが IPMIDECK_DATA_DIR=/data を設定します。ボリュームで永続化してください)。
Linux 上の pip: デフォルトで /data。通常、非 root ユーザーは書き込めません。
Windows 上の pip: ./data。ipmideck を実行するディレクトリーからの相対パス。

Linux では、データディレクトリーを上書きせずに ipmideck を通常のユーザーとして実行すると、起動時に PermissionError: [Errno 13] Permission denied: '/data' で失敗します。下記のように、 IPMIDECK_DATA_DIR を自分が所有するディレクトリーに向けてください。

データディレクトリーを書き込み可能な場所に向けます。

export IPMIDECK_DATA_DIR=$HOME/ipmideck-data
ipmideck start

任意のプラットフォームで IPMIDECK_DATA_DIR 環境変数を使って場所を上書きできます。このディレクトリーには config.yaml、SQLite データベース、そして保存された BMC 資格情報を保護するために使用される暗号化キーファイルが含まれます。詳細は設定と ipmideck の実行を参照してください。

サービスとして実行 (Linux)

端末での ipmideck start は対話型コンソールを開き、セッションを閉じると停止します。 ipmideck をバックグラウンドで実行し続け、起動時に開始するには、代わりに systemd の下で実行します。専用のユーザーを作成し、pipx でそのユーザー用に ipmideck をインストールし、そのユーザーが所有するデータディレクトリーを与えます。

sudo useradd -r -m -d /home/ipmideck -s /bin/bash ipmideck
sudo -u ipmideck pipx install ipmideck
sudo mkdir -p /opt/ipmideck/data && sudo chown -R ipmideck:ipmideck /opt/ipmideck

次にユニットを記述します。

# /etc/systemd/system/ipmideck.service
[Unit]
Description=IPMIDeck — IPMI management dashboard
After=network.target

[Service]
Type=simple
User=ipmideck
Group=ipmideck
Environment=IPMIDECK_DATA_DIR=/opt/ipmideck/data
ExecStart=/home/ipmideck/.local/bin/ipmideck start
Restart=on-failure
RestartSec=5
KillSignal=SIGTERM
TimeoutStopSec=30

[Install]
WantedBy=multi-user.target

有効化して起動します。

sudo systemctl daemon-reload
sudo systemctl enable --now ipmideck
sudo systemctl status ipmideck

systemd の下では接続された端末がないため、ipmideck は対話型コンソールをスキップし、Docker コンテナーとまったく同じように、プレーンなログをジャーナル (journalctl -u ipmideck -f) に流します。 systemctl stop は SIGTERM を送信し、これがファン制御を BMC に返すのと同じ正常なシャットダウンをトリガーします。ヘッドレス / 非 TTY モードを参照してください。

次のステップ

初回セットアップ: セットアップウィザード、ログインモード、最初の BMC。
設定: ポート、ポーリング間隔、保持期間を調整します。
対応ハードウェア: BMC がカバーされていることを確認します。
トラブルシューティング: 接続と IPMI のエラー。

はじめに