本文へ移動
vast-cowのブログ
前のページへ戻る

PiKVMのセットアップと基本的な使い方

この記事を編集

PiKVMは、管理対象のコンピューターにOSが起動していない状態でも、映像の確認、キーボード・マウス操作、仮想メディアからの起動などを行えるリモートKVMです。

本記事では、SDカードへのイメージ書き込み後から、初期設定、仮想メディアの配置、Tailscaleによるリモートアクセス、管理対象マシンの操作までを、実際に作業する順番に沿って解説します。

なお、画面構成や一部の機能はPiKVMのモデルやKVMDのバージョンによって異なります。本記事の仮想メディアに関する説明は、主にPiKVM V2以降を想定しています。


最初に理解しておきたい「読み取り専用」の仕組み

PiKVM OSは、突然の電源断によるファイルシステム破損やSDカードの消耗を抑えるため、通常はファイルシステムを読み取り専用で使用します。設定変更が終わったら、必ず読み取り専用へ戻すのが基本です。

ここで注意したいのが、PiKVMには用途の異なる2種類の書き込み切り替えコマンドがあることです。

書き込みモードを変更するコマンドの比較

コマンド対象主な用途書き込み可能にする読み取り専用に戻す
rw / roPiKVM OSのルートファイルシステムパスワード変更、パッケージのインストール、/etc以下の編集、ホスト名変更rwro
kvmd-helper-otgmsd-remount rw / ro/var/lib/kvmd/msdの仮想メディア領域ISO・IMGファイルの配置、削除、書き換えkvmd-helper-otgmsd-remount rwkvmd-helper-otgmsd-remount ro

重要なのは、rwを実行しても、仮想メディア領域が書き込み可能になるとは限らないことです。反対に、kvmd-helper-otgmsd-remount rwを実行しても、/etcなどのシステム設定は編集できません。

作業対象に応じて使い分けます。


1. SDカードへイメージを書き込む

まず、使用するPiKVMモデルに対応したOSイメージをSDカードへ書き込みます。

書き込み完了後、PiKVMを起動する前にSDカードの先頭にあるFAT32パーティションを開きます。このパーティションには、初回起動時の設定に使用するpikvm.txtがあります。


2. 初回起動前にWi-Fiを設定する

有線LANを使用できない環境では、初回起動前にpikvm.txtへWi-Fi情報を書いておくと、その後の接続が容易になります。

pikvm.txtへ次の行を追加します。

WIFI_ESSID='Wi-FiのSSID'
WIFI_PASSWD='Wi-Fiのパスワード'
WIFI_REGDOM='JP'

WIFI_REGDOM='JP'は日本の無線規制ドメインを指定する設定です。

初回書き込み直後のpikvm.txtに次の行が存在する場合は、削除せず残してください。

FIRST_BOOT=1

FIRST_BOOT=1は、初回起動時にSSHホスト鍵や証明書などを生成するための指定です。

また、Wi-Fiパスワードにバックスラッシュが含まれる場合は、次のように二重に記述する必要があります。

WIFI_PASSWD='abc\\def'

pikvm.txtは設定の適用後に自動的に削除されます。Raspberry Pi Zero 2 Wを使用した構成では、5GHz Wi-Fiを利用できない点にも注意してください。

編集後はSDカードを安全に取り外し、PiKVMへ戻して起動します。


3. PiKVMのIPアドレスを確認する

PiKVMは通常、DHCPを使ってIPアドレスを取得します。

起動すると、PiKVMに接続されたディスプレイへ現在のIPアドレスが表示されるため、まずはその表示を確認するのが簡単です。

ディスプレイを接続していない場合は、ルーターの管理画面やDHCPリース一覧から、PiKVMへ割り当てられたIPアドレスを確認します。

以降の例では、PiKVMのIPアドレスを次のように表記します。

192.168.1.100

4. SSHでPiKVMへ接続する

初期状態では、Linuxの管理者アカウントは次の設定です。

項目初期値
ユーザー名root
パスワードroot

SSHクライアントから接続します。

ssh root@192.168.1.100

初回接続時にはSSHホスト鍵の確認が表示されるため、接続先が正しいことを確認して承認します。

PiKVMには、SSHなどで使うLinuxのrootアカウントとは別に、Web UI用のadminアカウントがあります。初期状態では、Web UI側もユーザー名とパスワードがともにadminです。両者は独立したアカウントなので、両方のパスワードを変更する必要があります。


5. 最初に2種類のパスワードを変更する

初期パスワードのまま運用するのは危険です。ネットワーク設定や機能追加よりも先に変更します。

まず、ルートファイルシステムを書き込み可能にします。

rw

Linuxのrootパスワードを変更します。

passwd root

続いて、Web UIで使用するadminのパスワードを変更します。

kvmd-htpasswd set admin

両方の変更が完了したら、ファイルシステムを読み取り専用に戻します。

ro

まとめると、実行順は次のとおりです。

rw
passwd root
kvmd-htpasswd set admin
ro

パスワード変更時にrwを実行し忘れると、設定を保存できません。公式ドキュメントでも、rwとroの間で両方のパスワードを変更する手順が案内されています。


6. ホスト名を変更する

複数のPiKVMを管理する場合は、設置場所や管理対象が分かるホスト名へ変更しておくと便利です。

例えば、サーバールームの1号機を管理するPiKVMであれば、次のような名前にします。

pikvm-server01

変更手順は次のとおりです。

rw
systemctl restart systemd-hostnamed
hostnamectl set-hostname pikvm-server01
ro
reboot

再起動後、SSHのプロンプトやネットワーク上のホスト名が変更されます。公式FAQでも、systemd-hostnamedを再起動してからhostnamectl set-hostnameを実行し、PiKVMを再起動する方法が案内されています。

Tailscaleを導入する予定がある場合も、先にホスト名を設定しておくと管理画面上で機器を識別しやすくなります。


7. PiKVM OSをアップデートする

初期設定が終わったら、PiKVM OSを更新します。

pikvm-update

通常、手動でrwやroを実行する必要はありません。pikvm-updateを使用するのがPiKVMで推奨される更新方法です。

ただし、更新には失敗の可能性がまったくないわけではありません。公式ドキュメントでは、SDカードの再書き込みが必要になる場合に備え、可能であればPiKVMへ物理的にアクセスできる状態で更新することが推奨されています。VPN経由でしか接続できないPiKVMを安易に更新するのは避けたほうが安全です。

古いイメージでpikvm-updateが存在しない場合は、次の手順でアップデーターを導入します。

rw
pacman -Syy
pacman -S pikvm-os-updater
pikvm-update

更新後は、必要に応じて再起動します。


8. TailscaleをPiKVMへ導入する

インターネット経由でPiKVMを利用する場合、Web UIやSSHを直接ポート開放するよりも、Tailscaleなどのプライベートネットワークを利用する方法が管理しやすくなります。

PiKVMには、PiKVM向けのTailscaleパッケージとしてtailscale-pikvmが用意されています。

先にpikvm-updateを実行したうえで、次の順番で導入します。

rw
pacman -S tailscale-pikvm
systemctl enable --now tailscaled
tailscale up --qr
ro

tailscale up --qrを実行すると、認証用URLに対応するQRコードがターミナルへ表示されます。スマートフォンで読み取って認証できるため、URLをコピーしにくいリモートコンソール環境で便利です。--qrは現在のTailscale CLIで正式に用意されているオプションです。

Exit Nodeを利用する場合

PiKVMをExit Nodeとして利用する場合は、TailscaleでExit Nodeを有効にします。

rw

tailscale set \
  --advertise-exit-node \
  --advertise-routes=192.168.0.0/24

ro

--advertise-routesには、PiKVMから到達可能なLANのネットワークアドレスを指定します。例えば、管理対象ネットワークが192.168.0.0/24であれば上記のようになります。

設定後、Tailscale管理画面で対象ノードを開き、Exit NodeおよびSubnet routesを承認します。

その後、クライアント側でPiKVMをExit Nodeとして選択すると、インターネット通信だけでなく、PiKVMが接続されているLAN上の機器へもアクセスできるようになります。

Raspberry PiのUDP GRO設定

Raspberry PiをExit Nodeとして利用する場合は、LinuxカーネルのUDP GRO設定を有効にすることが推奨されています。

PiKVMでは次のsystemdサービスを作成すると、起動時に自動で設定が適用されます。

rw

cat > /etc/systemd/system/apply-udp-gro.service <<'EOF'
[Unit]
Description=Configure UDP GRO forwarding
Wants=network-online.target
After=network-online.target

[Service]
Type=oneshot
ExecStart=/usr/bin/ethtool -K eth0 rx-udp-gro-forwarding on rx-gro-list off
RemainAfterExit=yes

[Install]
WantedBy=multi-user.target
EOF

systemctl daemon-reload
systemctl enable --now apply-udp-gro.service

ro

このサービスは、PiKVMの起動時に

ethtool -K eth0 rx-udp-gro-forwarding on rx-gro-list off

を実行し、再起動後もUDP GROの設定を維持します。

設定後は、次のコマンドで状態を確認できます。

ethtool -k eth0 | grep -E 'rx-udp-gro-forwarding|rx-gro-list'

期待する出力は次のとおりです。

rx-gro-list: off
rx-udp-gro-forwarding: on

なお、eth0以外のインターフェースを利用している場合は、環境に合わせて読み替えてください。


9. 仮想メディアをPiKVMへ配置する

PiKVMは、ISOやIMGファイルを管理対象マシンへ仮想CD/DVDまたは仮想USBメモリーとして接続できます。

イメージファイルは、PiKVM上の次のディレクトリに保存されます。

/var/lib/kvmd/msd

通常はWeb UIのDriveメニューからアップロードする方法が簡単です。手動でSCPやrsyncを使用する場合は、仮想メディア専用領域を書き込み可能にします。

PiKVM上で次を実行します。

kvmd-helper-otgmsd-remount rw

次に、手元のPCからISOファイルを転送します。

scp installer.iso root@192.168.1.100:/var/lib/kvmd/msd/

転送が完了したら、PiKVM上で読み取り専用へ戻します。

kvmd-helper-otgmsd-remount ro

公式ドキュメントでも、手動アップロードは次の順番になっています。

  1. kvmd-helper-otgmsd-remount rw
  2. /var/lib/kvmd/msdへファイルを転送
  3. kvmd-helper-otgmsd-remount ro

仮想メディア用パーティションを通常は読み取り専用にすることで、突然の電源断によるデータ破損を防いでいます。


ISOファイルにchown kvmd:kvmdは必要か

SCPで転送したファイルは、通常はroot所有になります。

ls -l /var/lib/kvmd/msd/

例えば、次のように全ユーザーから読み取り可能になっていれば、読み取り専用ISOとして使用するだけなら、必ずしも所有者を変更する必要はありません。

-rw-r--r-- 1 root root ... installer.iso

つまり、次のコマンドをすべてのISOへ機械的に実行する必要はありません。

chown kvmd:kvmd installer.iso

重要なのは、kvmdユーザーがファイルを読み取れることです。必要なら、次のように読み取り権限を設定します。

kvmd-helper-otgmsd-remount rw
chmod 644 /var/lib/kvmd/msd/installer.iso
kvmd-helper-otgmsd-remount ro

一方、管理対象マシンから書き込み可能な仮想Flashイメージとして使用する場合は、書き込み権限も必要です。公式ドキュメントの書き込み可能なFlashイメージ作成例では、次のようにchmod 666を設定しています。

chmod 666 /var/lib/kvmd/msd/flash.img

運用方針として所有者を統一したい場合は、次のようにしても構いません。

kvmd-helper-otgmsd-remount rw
chown kvmd:kvmd /var/lib/kvmd/msd/installer.iso
chmod 644 /var/lib/kvmd/msd/installer.iso
kvmd-helper-otgmsd-remount ro

ただし、読み取り専用ISOについては「kvmdから読み取れること」が本質であり、chown自体が必須条件ではありません。


10. 仮想メディアから管理対象マシンを起動する

ISOを配置したら、PiKVMのWeb UIを開き、Driveメニューから対象イメージを選択します。

基本的な流れは次のとおりです。

  1. Driveメニューを開く
  2. ISOまたはIMGファイルを選択する
  3. メディア種別を選択する
  4. イメージを接続する
  5. 管理対象マシンを再起動する
  6. BIOSまたはUEFIのブートメニューから仮想メディアを選択する

PiKVMでは、仮想メディアを次のような形式で接続できます。

モード管理対象マシンからの見え方主な用途
CD/DVD光学ドライブ一般的なOSインストールISO、レスキューISO
FlashUSBメモリーUEFIとの相性対策、書き込み可能なファイル交換用イメージ

通常はISOをCD/DVDとして接続します。

ただし、管理対象マシンのUEFI実装によっては、CD/DVDとして接続したイメージをブートデバイスとして認識できない場合があります。その場合は、同じイメージをFlashとして接続すると認識されることがあります。

これはすべての機種で必要な設定ではなく、仮想CD/DVDから起動できない場合の互換性対策です。

PiKVMの仮想メディアはBIOS・UEFIから利用でき、Web UI上でCD/DVDまたはFlashとしての接続方式を変更できます。


仮想メディア利用時の注意

イメージのアップロード中や、書き込み可能な状態で管理対象マシンへ接続している間は、PiKVMの電源を切らないでください。

アップロード中や書き込み中に電源を切ると、イメージファイルやファイルシステムが破損する可能性があります。


11. Ctrl+Alt+Delを送信する

ブラウザーがCtrlやAltなどのキー操作をローカル側で処理してしまうことがあるため、特殊なショートカットはPiKVMのWeb UIから送信します。

Ctrl+Alt+Delを送信する場合は、Web UI上部のShortcutsメニューを開き、Ctrl+Alt+Delを選択します。

Shortcutsメニューに目的の操作がない場合は、PiKVMのショートカット用マジックキー機能を使う方法もあります。現在の公式ドキュメントでは、マジックキーを押して離した後、Ctrl、Alt、Delを順番に押して離す操作が案内されています。


12. 管理対象マシンへTailscaleを設定する

PiKVMから操作している管理対象マシンにもTailscaleを導入する場合、Linuxでは次のコマンドが便利です。

tailscale up --qr

画面に表示されたQRコードをスマートフォンで読み取り、Tailscaleの認証を完了します。

PiKVMの画面上で長い認証URLを手入力したり、クリップボードを経由したりする必要がないため、OSインストール直後やGUIを利用できない環境に適しています。


作業全体の推奨順序

初回セットアップは、次の順番で進めると手戻りを減らせます。

  1. SDカードへPiKVM OSを書き込む
  2. 起動前にpikvm.txtへWi-Fi情報を設定する
  3. PiKVMを起動してIPアドレスを確認する
  4. SSHでrootとして接続する
  5. Linuxのrootパスワードを変更する
  6. Web UIのadminパスワードを変更する
  7. ホスト名を変更する
  8. 物理アクセス可能な状態でpikvm-updateを実行する
  9. 必要に応じてTailscaleを導入する
  10. ISO・IMGファイルを仮想メディア領域へ配置する
  11. Web UIから管理対象マシンへ接続する
  12. 仮想メディアを接続してOSのインストールや復旧作業を行う

まとめ

PiKVMを扱ううえで最も混乱しやすいのは、書き込みモードの切り替えです。

システム設定を変更する場合は、次の組み合わせを使用します。

rw
# 設定変更
ro

ISOやIMGを配置する場合は、次の組み合わせです。

kvmd-helper-otgmsd-remount rw
# ISO・IMGの配置や削除
kvmd-helper-otgmsd-remount ro

この2種類を区別し、変更後は読み取り専用へ戻すことが、安全にPiKVMを運用するための基本です。

また、初回起動後は必ずLinux側とWeb UI側の両方のパスワードを変更してください。外部からアクセスする場合は、Web UIを直接公開するのではなく、Tailscaleなどのプライベートネットワークを組み合わせると、接続経路を管理しやすくなります。


この記事を編集
この記事を共有:

コメント


前の記事
NetplanでEthernetをブリッジ化して、DHCPとMACアドレスを維持する
次の記事
PiKVMのセットアップと基本的な使い方