コンテンツにスキップ
Disguise User Guide

Porta VM ヘルパーコマンドとスクリプト

このページは、Porta VM イメージに付属する bash コマンドとシェルスクリプトのリファレンスです。これらは VM 上の任意のシェル（SSH 経由、または VirtualBox コンソール）から利用でき、達成したいタスク別にグループ化されています。

  • これらのヘルパーを文脈の中で使用する、症状ベースのウォークスルーについては、Porta VM Troubleshooting guide を参照してください。
  • ヘルパー、ログパス、コンテナ内部、モニタリング URL をまとめて扱うクイックリファレンスのチートシートについては、Porta VM Diagnostics Cheatsheet を参照してください。

このページの読み方

Section titled “このページの読み方”
  • コマンド は porta_check_version のように、そのままの名前で表示されます。これらは VM イメージ 0.9.14.2 以降で利用できる bash ショートカットです。プロンプトで入力して Enter を押します。
  • スクリプト は ~/scripts/setup_static_ip.sh のように、フルパスで表示されます。これらは基盤となるシェルスクリプトで、すべての VM イメージで利用できます。フルパスを実行して実行します。
  • 対応バージョン は、そのヘルパーが付属する最も古い Porta VM イメージバージョンを示します。All は最初のリリースから存在することを意味します。お使いのバージョンを確認するには porta_check_version を実行（または VM イメージのファイル名を確認）します。

診断

Section titled “診断”
ヘルパー機能対応バージョン
collect_dataシステムとアプリのデータを収集するためのさまざまな診断を実行します。結果は ~/logs/collected_data/YYYYMMDD/HH-SS/ に保存されます。0.9.14.2+
porta_diagPorta サーバーの完全な診断を実行します。0.9.14.2+
view_hosts_file/etc/hosts の内容を表示します。0.9.14.2+
check_diskspace簡易ディスク容量チェック。0.9.14.2+
check_diskspace_sortedサイズ順に並べ替えたディスク容量チェック。0.9.14.2+
docker_disk_usageイメージ、コンテナ、ボリューム別の Docker ディスク使用量。0.9.14.2+
docker_volume_size <volume_name>名前付き Docker ボリュームのサイズを調べます。0.9.14.2+
~/scripts/vm_info.shVM のホスト名、IPv4 アドレス、MAC アドレス、/etc/hosts の内容を表示します。All
~/scripts/porta-manager/check-conn-cache.shすべての Porta Manager コンテナについて、キャッシュされた接続、読み込まれたメモリ内接続、データベース接続キャッシュを表示します。All

バージョン管理

Section titled “バージョン管理”
ヘルパー機能対応バージョン
porta_check_versionLaravel、PHP、MySQL、Redis、OS を含む Porta のバージョン情報を表示します。0.9.14.2+
mngr_check_versionPorta Manager のバージョン情報を表示します。0.9.14.2+
~/scripts/porta-manager/check-manager-version.shmngr_check_version の基盤となるスクリプト。All

ログ

Section titled “ログ”

各 Porta ログヘルパーには、現在の内容を出力する代わりにファイルを追跡する（tail -f に相当）_follow バリアントがペアで用意されています。

ヘルパー表示内容対応バージョン
porta_laravel_logs / porta_laravel_logs_followporta コンテナの /var/www/storage/logs/laravel-YYYY-MM-DD.log。0.9.14.2+
porta_php_errors / porta_php_errors_followporta コンテナの /var/log/php/errors.log。0.9.14.2+
porta_horizon_logs / porta_horizon_logs_follow/var/www/logs/horizon.log — キューワーカーとシーケンスのプレイアウト。0.9.14.2+
porta_task_logs / porta_task_logs_follow/var/www/logs/default_tasks.log — スケジュールされたタスク、データベースバックアップ、ソケットチェック。0.9.14.2+
porta_main_db_logs / porta_main_db_logs_followこのマシンが main マシンの場合の、このマシンの MySQL エラーログ。0.9.14.2+
porta_backup_db_logs / porta_backup_db_logs_followこのマシンが backup マシンの場合の、このマシンの MySQL エラーログ。0.9.14.2+
porta_arbiter_db_logs / porta_arbiter_db_logs_followこのマシンが arbiter マシンの場合の、このマシンの MySQL エラーログ。0.9.14.2+
mngr_app_logsPorta Manager アプリコンテナのログ。0.9.14.2+
mngr_horizon_logsPorta Manager インストーラーウィザードの処理ログ。0.9.14.2+
mngr_task_logsPorta Manager バックグラウンドタスクランナーのログ。0.9.14.2+
~/scripts/porta-manager/view-logs.sh [container] [lines]mngr_*_logs コマンドの基盤となるスクリプト。[container] は app、horizon、task のいずれかです。[lines] は行数、または追跡する場合は f です。All

レプリケーション

Section titled “レプリケーション”
ヘルパー機能対応バージョン
porta_group_statusこのマシンが報告するグループレプリケーションのステータスを表示します。0.9.14.2+
porta_all_group_status/etc/hosts のエントリを使用して、グループ内のすべてのマシンに対して同じステータスクエリを実行します。これが機能するには、各 VM の /etc/hosts が正しい必要があります。0.9.14.2+
porta_start_replこのマシンで START GROUP_REPLICATION を実行します。0.9.14.2+
porta_stop_replこのマシンで STOP GROUP_REPLICATION を実行します。0.9.14.2+
porta_bootstrapこのマシンからレプリケーショングループをブートストラップします。まず porta_all_group_status で確認し、他のメンバーがすでに primary になっていない場合にのみ実行してください。0.9.14.2+
porta_set_bootstrap_ONbootstrap フラグを ON として永続化します。このマシンは起動時に常に自身を primary として設定します。単一 VM のセットアップでのみ有用です。複数 VM のレプリケーショングループでは絶対に使用しないでください。スプリットブレインを引き起こす可能性があります。0.9.14.2+
porta_set_bootstrap_OFFbootstrap フラグを OFF として永続化します。これは Porta VM のデフォルト状態です。0.9.14.2+
~/scripts/porta/view-ALL-group-repl-status.shporta_all_group_status の基盤となるスクリプト。All

データベースバックアップ

Section titled “データベースバックアップ”
ヘルパー機能対応バージョン
porta_backup_dbPorta データベースのバックアップを作成します。生成された ZIP アーカイブは porta コンテナ内の /var/www/storage/app/Porta-Backups に保存されます。0.9.14.2+
porta_restore_dbバックアップから Porta データベースを復元します。ローカルで利用可能なダンプの一覧を表示します。0.9.14.2+
porta_db_dump [db_container_name] [db_name]raw mysqldump を実行します。デフォルトは porta-db と porta データベースです。0.9.14.2+
porta_db_restore [db_container_name] [db_name]mysqldump からデータベースを復元します。デフォルトは porta-db と porta データベースです。ローカルで利用可能なダンプの一覧を表示します。0.9.14.2+
porta_reset_db破壊的 — このマシン上のすべてのデータを消去し、マイグレーションからデータベースを再作成します。災害復旧の最終手段として使用されます。0.9.14.2+

Scheduler プレイアウト

Section titled “Scheduler プレイアウト”

これらのヘルパーは、同じ Scheduler のテーブルを、レプリケーショングループ内の異なるマシン上でクエリします。現在操作しているマシンに合ったバリアントを使用してください。たとえば、main マシンからは porta_playouts を、backup マシンからは porta_backup_playouts を実行します。

ヘルパー表示内容対応バージョン
porta_playouts直近 50 件の Scheduler プレイアウト（現在アクティブなエントリと次のエントリを含む）。main マシンのみ。0.9.14.2+
porta_playout_history直近 50 件の Scheduler プレイアウト履歴項目。main マシンのみ。0.9.14.2+
porta_backup_playouts直近 50 件の Scheduler プレイアウト。backup マシンのみ。0.9.14.2+
porta_backup_playout_history直近 50 件の Scheduler プレイアウト履歴項目。backup マシンのみ。0.9.14.2+
porta_arbiter_playouts直近 50 件の Scheduler プレイアウト。arbiter マシンのみ。0.9.14.2+
porta_arbiter_playout_history直近 50 件の Scheduler プレイアウト履歴項目。arbiter マシンのみ。0.9.14.2+

VM ライフサイクル

Section titled “VM ライフサイクル”
ヘルパー機能対応バージョン
~/scripts/reset_identity.sh新しいホスト名と一意のマシン ID を選択し、/etc/hosts を更新して再起動します。VM イメージを 2 台目または 3 台目のホストにインポートした後、コピーが同一の識別情報を共有しないように実行します。Manually Resetting the Identity of a Porta On Prem VM を参照してください。All
~/scripts/setup_static_ip.shnetplan を介して静的 IP を設定します。Porta VM の PowerShell セットアップスクリプトがこれを自動的に行うため、セットアップが途中で失敗した場合のみ手動で実行します。Manually Setting Up a Static IP を参照してください。All
~/scripts/disable_static_ip.sh/etc/netplan/99-portacfg.yaml の名前を変更して静的 IP 構成を無効にします。VM は次回起動時に DHCP にフォールバックします。All
~/scripts/reset_dhcp.sh新しい DHCP リースを強制し、キャッシュされたリースをクリアします。VM が静的 IP を使用していない場合にのみ意味があります。All
~/scripts/static_ip_info.sh現在の netplan 静的 IP 構成を表示します。All
~/scripts/setup_shared_folders.shWindows へのファイルエクスポート用に、VirtualBox 共有フォルダの VM 側を準備します。Porta On Prem VM Windows Shared Folder を参照してください。All

Porta Manager ライフサイクル

Section titled “Porta Manager ライフサイクル”
ヘルパー機能対応バージョン
update_manager（エイリアス install_manager）利用可能な最新の Porta Manager ビルドをダウンロードし、インストーラーを実行します。更新時に APP_KEY が保持されるよう、最初に自動的に backup-env.sh を実行します。All
mngr_init_user最初の Porta Manager 管理者ユーザーを初期化します。Porta Manager データベースの完全消去後にのみ必要です。0.9.14.2+
mngr_backup_env更新間で APP_KEY を保持するため、porta-manager-app コンテナから .env ファイルを ${MNGR_CONFIG_DIR}/.env にコピーします。update_manager の呼び出し時に自動的に実行されます。0.9.14.2+
mngr_restore_env保持された .env ファイルを ${MNGR_CONFIG_DIR}/.env から porta-manager-app コンテナに復元します。0.9.14.2+
mngr_recreateデータボリュームを保持したまま、既存のイメージから Porta Manager コンテナを再作成します。Porta Manager ダッシュボードで Fix IP Settings（IP 設定を修正） を実行せずに VM の IP が変更された場合に便利です。0.9.14.2+
mngr_wipe_recreate破壊的 — Porta Manager のデータとストレージボリュームを消去し、既存のイメージからコンテナを再作成します。Porta アプリケーションのデータには影響しません。0.9.14.2+
~/scripts/porta-manager/install-manager.shupdate_manager の基盤となるスクリプト。All
~/scripts/porta-manager/init-manager-user.shmngr_init_user の基盤となるスクリプト。All
~/scripts/porta-manager/backup-env.shmngr_backup_env の基盤となるスクリプト。install-manager.sh の一部として自動的に実行されます。All