ローカルで成功した Bazel ビルドは、ローカルビルドには影響しない制限や要件が原因で、リモートで実行すると失敗することがあります。このような失敗の最も一般的な原因については、リモート実行用に Bazel ルールを適応するをご覧ください。
このページでは、Docker サンドボックス機能を使用してリモート実行で発生する一般的な問題を特定して解決する方法について説明します。この機能は、リモート実行と同等の制限をビルドに適用します。これにより、リモート実行サービスを必要とせずにビルドのトラブルシューティングを行うことができます。
Docker サンドボックス機能は、次のようにリモート実行の制限を模倣します。
ビルド アクションがツールチェーン コンテナで実行されます。同じツールチェーン コンテナを使用して、コンテナ化されたリモート実行をサポートするサービス経由でローカルとリモートでビルドを実行できます。
余分なデータがコンテナの境界を越えない。明示的に宣言された入力と出力のみがコンテナに出入りし、関連するビルドアクションが正常に完了した後にのみ出入りします。
各アクションは新しいコンテナで実行されます。生成されたビルド アクションごとに、新しい一意のコンテナが作成されます。
これらの問題のトラブルシューティングは、次のいずれかの方法で行うことができます。
ネイティブのトラブルシューティング。この方法では、Bazel とそのビルドアクションがローカルマシンでネイティブに実行されます。Docker サンドボックス機能では、リモート実行と同様の制限がビルドに適用されます。ただし、この方法では、ローカルツール、状態、ビルドへのデータ漏洩は検出されないため、リモート実行で問題が発生します。
Docker コンテナでのトラブルシューティング。この方法では、Bazel とそのビルド アクションが Docker コンテナ内で実行されます。これにより、リモート実行と同様の制限に加えて、ツール、状態、ローカルマシンからビルドへのデータ漏洩を検出できます。この方法では、ビルドの一部が失敗した場合でも、ビルドに関する分析情報を得ることができます。この方法は試験運用版であり、正式にはサポートされていません。
前提条件
まだ行っていない場合は、トラブルシューティングを開始する前に、以下の手順を行ってください。
- Docker をインストールし、実行に必要な権限を構成します。
- Bazel 0.14.1 以降をインストールします。以前のバージョンでは、Docker サンドボックス機能はサポートされていません。
- こちらの説明に沿って、最新のリリース バージョンに固定された bazel-ツールチェーン リポジトリをビルドの
WORKSPACEファイルに追加します。 .bazelrcファイルにフラグを追加して、この機能を有効にします。ファイルが存在しない場合は、Bazel プロジェクトのルート ディレクトリにファイルを作成します。以下のフラグは参照サンプルです。bazel-toolchains リポジトリの最新の.bazelrcファイルを確認し、構成docker-sandbox用に定義されているフラグの値をコピーしてください。
# Docker Sandbox Mode
build:docker-sandbox --host_javabase=<...>
build:docker-sandbox --javabase=<...>
build:docker-sandbox --crosstool_top=<...>
build:docker-sandbox --experimental_docker_image=<...>
build:docker-sandbox --spawn_strategy=docker --strategy=Javac=docker --genrule_strategy=docker
build:docker-sandbox --define=EXECUTOR=remote
build:docker-sandbox --experimental_docker_verbose
build:docker-sandbox --experimental_enable_docker_sandbox
ルールで追加のツールが必要な場合は、次の操作を行います。
Dockerfile を使用してツールをインストールし、ローカルでイメージをビルドして、カスタム Docker コンテナを作成します。
上記の
--experimental_docker_imageフラグの値は、カスタム コンテナ イメージの名前に置き換えます。
ネイティブ トラブルシューティング
この方法では、Bazel とそのすべてのビルド アクションをローカルマシンで直接実行します。これは、リモートで実行されたときにビルドが成功するかどうかを確認する信頼できる方法です。
ただし、この方法では、特に構成スタイルの WORKSPACE ルールを使用している場合、ローカルにインストールされたツール、バイナリ、データがビルドに漏洩する可能性があります。このようなリークはリモート実行で問題を引き起こします。これを検出するには、ネイティブのトラブルシューティングに加えて、Docker コンテナでトラブルシューティングを行います。
ステップ 1: ビルドを実行する
ビルドを実行する Bazel コマンドに
--config=docker-sandboxフラグを追加します。例:bazel --bazelrc=.bazelrc build --config=docker-sandbox targetビルドを実行し、完了するまで待ちます。Docker サンドボックス機能により、ビルドの実行速度は通常の 4 倍遅くなります。
次のエラーが発生することがあります。
ERROR: 'docker' is an invalid value for docker spawn strategy.
存在する場合は、--experimental_docker_verbose フラグを指定してビルドを再度実行します。このフラグは、詳細なエラー メッセージを有効にします。このエラーは通常、Docker のインストールに問題があるか、現在のユーザー アカウントで Docker を実行する権限がない場合に発生します。詳細については、Docker のドキュメントをご覧ください。問題が解決しない場合は、Docker コンテナのトラブルシューティングに進んでください。
ステップ 2: 検出された問題を解決する
以下に、よくある問題とその回避策を示します。
Bazel runfiles ツリーで参照されているファイル、ツール、バイナリ、またはリソースが欠落している。影響を受けるターゲットのすべての依存関係が明示的に宣言されていることを確認します。詳細については、暗黙的な依存関係の管理をご覧ください。
絶対パスまたは
PATH変数によって参照されるファイル、ツール、バイナリ、またはリソースがない。必要なツールがすべてツールチェーン コンテナにインストールされていることを確認し、ツールチェーン ルールを使用して、欠落しているリソースを指す依存関係を適切に宣言します。詳細については、ツールチェーン ルールを使用したビルドツールの呼び出しをご覧ください。バイナリの実行が失敗する。ビルドルールの 1 つが、実行環境（Docker コンテナ）と互換性のないバイナリを参照しています。詳細については、プラットフォーム依存のバイナリの管理をご覧ください。問題を解決できない場合は、bazel-discuss@google.com までお問い合わせください。
@local-jdkのファイルが見つからないか、エラーが発生しています。ローカルマシンの Java バイナリがビルドにリークしていますが、ビルドと互換性がありません。ルールとターゲットでは、@local_jdkではなくjava_toolchainを使用します。さらにサポートが必要な場合は、bazel-discuss@google.com にお問い合わせください。その他のエラー。サポートが必要な場合は、bazel-discuss@google.com までお問い合わせください。
Docker コンテナでのトラブルシューティング
この方法では、Bazel はホスト Docker コンテナ内で実行され、Bazel のビルド アクションは、Docker サンドボックス機能によって生成された個々のツールチェーン コンテナ内で実行されます。サンドボックスでは、ビルド アクションごとに新しいツールチェーン コンテナが生成され、各ツールチェーン コンテナでは 1 つのアクションのみが実行されます。
この方法では、ホスト環境にインストールされているツールをより詳細に制御できます。ビルドの実行をビルド アクションの実行から分離し、インストールされたツールを最小限に抑えることで、ビルドがローカル実行環境に依存しているかどうかを確認できます。
ステップ 1: コンテナをビルドする
Docker コンテナを作成し、最小限のビルドツール セットで Bazel をインストールする
Dockerfileを作成します。FROM debian:stretch RUN apt-get update && apt-get install -y apt-transport-https curl software-properties-common git gcc gnupg2 g++ openjdk-8-jdk-headless python-dev zip wget vim RUN curl -fsSL https://download.docker.com/linux/debian/gpg | apt-key add - RUN add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/debian $(lsb_release -cs) stable" RUN apt-get update && apt-get install -y docker-ce RUN wget https://releases.bazel.build/<latest Bazel version>/release/bazel-<latest Bazel version>-installer-linux-x86_64.sh -O ./bazel-installer.sh && chmod 755 ./bazel-installer.sh RUN ./bazel-installer.shコンテナを
bazel_containerとしてビルドします。docker build -t bazel_container - < Dockerfile
ステップ 2: コンテナを起動する
次のコマンドを使用して Docker コンテナを起動します。コマンド内の、ビルドするホスト上のソースコードのパスを置き換えます。
docker run -it \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /tmp:/tmp \
-v your source code directory:/src \
-w /src \
bazel_container \
/bin/bashこのコマンドは、コンテナを root として実行し、Docker ソケットをマッピングして、/tmp ディレクトリをマウントします。これにより、Bazel は他の Docker コンテナを生成し、/tmp の下のディレクトリを使用してそれらのコンテナとファイルを共有できます。ソースコードはコンテナ内の /src にあります。
このコマンドは、ツールチェーン コンテナとして使用される rbe-ubuntu16-04 コンテナと互換性のないバイナリを含む debian:stretch ベースコンテナから意図的に開始します。ローカル環境のバイナリがツールチェーン コンテナにリークすると、ビルドエラーが発生します。
ステップ 3: コンテナをテストする
Docker コンテナ内から次のコマンドを実行してテストします。
docker psbazel version
ステップ 4: ビルドを実行する
次のようにビルドを実行します。出力ユーザーは root であるため、Bazel が実行されているホストコンテナ内から、Bazel のビルド アクションが実行されている Docker サンドボックス機能によって生成されたツールチェーン コンテナから、ホストコンテナとアクション コンテナが実行されているローカルマシンから、同じ絶対パスでアクセス可能なディレクトリに対応します。
bazel --output_user_root=/tmp/bazel_docker_root --bazelrc=.bazelrc \ build --config=docker-sandbox targetステップ 5: 検出された問題を解決する
ビルドエラーは次のように解決できます。
「ディスク容量不足」エラーでビルドが失敗した場合は、フラグ
--memory=XXを指定してホストコンテナを起動することで、この制限を引き上げることができます。ここで、XXは割り当てられたディスク容量（ギガバイト単位）です。これは試験運用版であり、予期しない動作が発生する可能性があります。分析フェーズまたは読み込みフェーズでビルドが失敗した場合、WORKSPACE ファイルで宣言されている 1 つ以上のビルドルールがリモート実行と互換性がありません。考えられる原因と回避策については、リモート実行用に Bazel ルールを適応するをご覧ください。
他の理由でビルドが失敗した場合は、ステップ 2: 検出された問題を解決するのトラブルシューティングの手順をご覧ください。