Apidog Runner は、サーバー環境でスケジュールされた API テストおよび自動化タスクを実行するコマンドラインツールです。このリファレンスガイドでは、本番環境または CI/CD 環境に Runner をデプロイするためのハードウェア、ランタイム、およびネットワーク要件について説明します。これらの要件を理解することで、大規模な自動 API テストを実行する際の最適なパフォーマンスと信頼性を確保できます。ハードウェア要件#
推奨サーバー構成#
| コンポーネント | 最小要件 | 推奨 | 目的 |
|---|
| CPU | 2 コア | 4 コア以上 | Runner はスケジュールされたタスクを同時に実行するため、十分な処理能力が必要です |
| メモリ | 4GB RAM | 8GB 以上の RAM | Runner はスケジュールされたタスク中に大量のデータを読み込み、生成します。大規模なチームではより多くのメモリが必要です |
| ディスク容量 | 30GB | 50GB 以上 | ログストレージおよびテスト成果物を格納します |
大規模なチームまたは高頻度のテスト実行では、パフォーマンス低下を防ぐためにメモリを 8GB 以上に増やしてください。
ランタイムパラメータ#
Runner をデプロイする際は、次の環境変数を設定してください。| パラメータ名 | 説明 | 例の値 |
|---|
TZ | Runner 実行時のタイムゾーンを設定します。スケジュールされたタスクは、設定されたタイムゾーンと時刻に従って実行されます。設定については、TZ identifier を参照してください。 | America/Los_Angeles |
コンテナランタイムユーザーと runAsNonRoot#
Runner バージョン 2.2.5 以降、イメージには、より安全な非 root ランタイムモードをサポートするために、固定 UID/GID 10001:10001 を持つ非 root ユーザー runner が含まれています。デフォルトの起動方法では、コンテナはまず root として entrypoint スクリプトを実行し、/opt/runner ディレクトリの権限を準備してから、権限を降格して runner ユーザーとしてメインプロセスを実行します。これは過去のボリューム権限と互換性があり、ログや変数ファイルなどのランタイムデータの書き込みに失敗することを防ぎます。デプロイプラットフォームで runAsNonRoot が強制される場合は、コンテナのセキュリティコンテキストを次のように設定してください。これを 有効にすると、entrypoint スクリプトは mkdir または chown を実行できなくなります。そのため、/opt/runner にマウントされる hostPath、PVC、またはその他のボリュームには、事前に UID/GID 10001 の書き込み権限を付与する必要があります。Runner は /opt/runner/logs や /opt/runner/variables などのディレクトリにランタイムデータを書き込みます。権限が不十分な場合、タスクの実行に失敗したり、ログが書き込まれなかったりする可能性があります。hostPath を使用する場合は、事前にホスト上で次のコマンドを実行できます。runAsNonRoot を有効にする必須要件がない場合は、デフォルトの起動方法を維持することをお勧めします。ネットワーク環境#
サーバー通信要件#
Runner は Apidog サーバーと通信する必要があります。Runner を実行するサーバーのネットワー ク環境が Apidog サーバーにアクセスでき、WebSocket プロトコルをサポートしていることを確認してください。ファイアウォールが、ポート 443（HTTPS）での Apidog サーバーへのアウトバウンド接続、およびリアルタイム通信のための WebSocket 接続を許可していることを確認してください。
自動テスト要件#
自動テストのスケジュールされたタスクでは、サーバーのネットワーク環境が、リクエストを正常に開始するために、すべてのリクエスト対象 URL にアクセスできる必要があります。自動テストの実行後、テストレポートがアップロードされます。サーバーのネットワーク環境が AWS ドメイン名にアクセスできることを確認してください。データインポート要件#
データをインポートするスケジュールされたタスクでは、サーバーのネットワーク環境が、インポート対象のデータソースの URL にアクセスできることを確認してください。 