メインコンテンツまでスキップ

Local Cache Server

Last updated on March 22, 2024

概要

ADT Hub ローカルキャッシュサーバーを使用すると、スタジオは ADT Hub にダウンロードキャッシュを追加でき、開発ビルド 配信中のダウンロードニーズを大幅に削減できます。これは、ビルドの初期のダウンロードをインテリジェントにキャッシュし、S3 からの同じビルドのさらなるダウンロードを傍受し、ローカルキャッシュから それらを提供することで実現します。

始める前に

ハードウェア仕様

ADT Hub ローカルキャッシュサーバー設定の最小要件:

  • メモリ - 4 GB

  • CPU - 2 コア

  • キャッシュストレージ用の高速 SSD (Nvme M.2)

  • 高速イーサネットネットワーク

ソフトウェア仕様

ADT Hub ローカルキャッシュサーバーを設定する前に、次の手順に従ってください。

  1. Ubuntu/Ubuntu サーバー >= 20.04 をインストールします (他の OS バージョンではテストされていません)。

  2. Docker >= v20.10 (API バージョン 1.41) をインストールします。

  3. ローカルキャッシュインストーラーをインストールします (ローカルキャッシュは、Accelbyte にリクエストできるアドオンです)。

    • [オプション] キャッシュターゲットのディレクトリを準備します。これには、フォルダまたはマウントされたディスクドライブ (たとえば /mnt/volume1/cache) を使用できます。
    • [オプション] キャッシュターゲットの権限を 755 に設定します。
  4. ファイアウォールを設定して、マシンが特定のポート (例:8080) をリッスンできるようにします。

手順

ローカルキャッシュサーバーをインストールする

ローカルキャッシュサーバーをインストールするには、インタラクティブモードとコマンドラインモードの 2 つの方法があります。下記で両方のインストール手順について説明しています。

ローカルキャッシュサーバーをインタラクティブモードでインストールする

以下の手順でローカルキャッシュサーバーをインストールします。

  1. 次のコマンドを実行します。

    ./local-cache-setup install -i
  2. 必要な情報を入力します。

    • Cache Retention (キャッシュリテンション):キャッシュを保持する時間 (デフォルト:12 時間)

    • Port (ポート):提供するローカルキャッシュサーバーポート (デフォルト:80)

    • Number of workers (ワーカー数):提供するワーカー数 (デフォルト:8、通常は CPU コア数と同じ)

    • Cache Mount (キャッシュマウント):キャッシュディレクトリの場所 (デフォルト:none) (オプションフィールド)

    • 名前空間:ゲームの名前空間

    • GameIDs (ゲーム ID)]:(オプションフィールド)

      Cache Retention(12h) :
      Port(80) :
      Number of worker(8) :
      Cache Mount() : <CACHE_DIRECTORY> (optional)
      Namespace() : <YOUR_NAMESPACE> (required)
      GameIDs() : <PRIORITY_GAME_ID> (optional)

      インストールが完了します。

      2021/12/21 15:23:04 prepare docker...
      2021/12/21 15:23:04 writing config file...
      2021/12/21 15:23:04 copy executable....
      2021/12/21 15:23:04 installing service...
      2021/12/21 15:23:04 blackbox local cache installed

コマンドラインモードでローカルキャッシュサーバーをインストールする

コマンドラインモードでローカルキャッシュサーバーをインストールするには、以下のフィールドと値をコマンドラインに入力します。

  • -i, --install-dir:ターゲットインストールディレクトリ、デフォルト

    • -p, --port:提供されるローカルキャッシュサーバーポート

    • -w, --worker:ローカルキャッシュサーバーワーカー

    • -r, --retention:ローカルキャッシュサーバーリテンション

    • -c, --cache-mount:ローカルキャッシュマウントディレクトリ

      例:

      #!/bin/sh

      ./ABYLocalCacheServerSetup install --port 8080 --worker 8 --retention 12h --cache-mount /home/cache

ローカルキャッシュサーバーを起動する

インストールプロセスが正常に完了した後、ローカルキャッシュサーバーが自動的に起動します。

ローカルキャッシュサーバーのステータスを確認する

ローカルキャッシュサーバーのステータスを確認するには、次の手順に従います。

  1. 以下を実行します。

    ./local-cache-setup status
  2. サービスが実行されていることを確認します (実行されていない場合は、インストール手順をもう一度確認してください)。

    2021/12/23 10:50:49 service is running.
    /docker-entrypoint.sh: /docker-entrypoint.d/ is not empty, will attempt to perform configuration
    /docker-entrypoint.sh: Looking for shell scripts in /docker-entrypoint.d/
    /docker-entrypoint.sh: Launching /docker-entrypoint.d/10-listen-on-ipv6-by-default.sh
    10-listen-on-ipv6-by-default.sh: info: Getting the checksum of /etc/nginx/conf.d/default.conf
    10-listen-on-ipv6-by-default.sh: info: Enabled listen on IPv6 in /etc/nginx/conf.d/default.conf
    /docker-entrypoint.sh: Launching /docker-entrypoint.d/20-envsubst-on-templates.sh
    20-envsubst-on-templates.sh: Running envsubst on /etc/nginx/templates/nginx.conf.template to /etc/nginx/nginx.conf
    /docker-entrypoint.sh: Launching /docker-entrypoint.d/30-tune-worker-processes.sh
    /docker-entrypoint.sh: Configuration complete; ready for start up

ローカルキャッシュサーバーが実行されていることを確認する

ローカルキャッシュサーバーが実行されているかどうかを確認します。

  1. コンピュータで ADT Hub を開きます。

  2. ディスプレイの右上にある[Settings (設定)]アイコンをクリックします。

  3. [proxy-cache text (プロキシキャッシュテキスト)]フィールドにキャッシュサーバー IP アドレスを入力します。

  4. Verify (確認)]ボタンをクリックします。 IP アドレスが見つかると、緑色の[Verified (確認済み)]メッセージが表示されます。

  5. Save Changes (変更を保存)]ボタンをクリックします。

トラブルシューティング

キャッシュが機能しません。同じバイナリを同じインターネット速度で 2 回ダウンロードしようとしました

  1. ローカルキャッシュサーバーを確認して、ユーザー systemd-journal がファイル名を変更できるようにします。

  2. ローカルキャッシュサーバーフォルダに 777 権限を付与してください。

  3. ローカルキャッシュサーバーフォルダの所有者ユーザーをルート以外に変更します。

ローカルキャッシュサーバーに接続できません

ファイアウォールを確認し、インストールプロセス中に指定したポートにアクセスできることを確認してください。

ダウンロード速度が低速のままです

ダウンロード速度は多数の要因の影響を受ける可能性があります。

  1. キャッシュストレージ用のサーバーが高速 SSD を使用していることを確認してください。

  2. コンピュータとローカルキャッシュサーバー間の接続がギガビットイーサネット(1 Gbps) を使用していることを確認します。

  3. ローカルキャッシュサーバーのメモリを増やしてみてください。