このページでは、リモート キャッシュ、キャッシュをホストするサーバーの設定、リモート キャッシュを使用したビルドの実行について説明します。
リモート キャッシュは、デベロッパー チームや継続的インテグレーション（CI）システムがビルド出力を共有するために使用されます。ビルドを再現できる場合、1 台のマシンの出力を別のマシンで安全に再利用できるため、ビルドを大幅に高速化できます。
概要
Bazel はビルドを個別のステップ（アクション）に分割します。各アクションには、入力、出力名、コマンドライン、環境変数があります。必須入力と想定される出力は、アクションごとに明示的に宣言されます。
これらのアクション出力であるビルド出力のリモート キャッシュにサーバーを設定できます。これらの出力は、出力ファイル名のリストとそのコンテンツのハッシュで構成されます。リモート キャッシュを使用すると、新しい出力をローカルで生成することなく、別のユーザーのビルドの出力を再利用できます。
リモート キャッシュを使用するには:
- キャッシュのバックエンドとしてサーバーを設定する
- リモート キャッシュを使用するように Bazel ビルドを構成する
- Bazel バージョン 0.10.0 以降を使用する
リモート キャッシュには、次の 2 種類のデータが保存されます。
- アクション キャッシュ。アクション ハッシュからアクション結果メタデータへのマップです。
- 出力ファイルのコンテンツ アドレス指定ストア（CAS）。
リモート キャッシュには、すべてのアクションの stdout と stderr も保存されます。したがって、Bazel の stdout / stderr を調べることは、キャッシュヒットの推定に適したシグナルではありません。
ビルドでリモート キャッシュを使用する方法
サーバーをリモート キャッシュとして設定したら、次のようにキャッシュを使用します。
- リモート キャッシュへの読み取りと書き込み
- 特定のターゲットを除くリモート キャッシュの読み取り / 書き込み
- リモート キャッシュからのみ読み取る
- リモート キャッシュをまったく使用しない
リモート キャッシュへの読み取りと書き込みが可能な Bazel ビルドを実行すると、ビルドは次の手順で実行されます。
- Bazel は、ビルドが必要なターゲットのグラフを作成し、必要なアクションのリストを作成します。これらのアクションにはそれぞれ、入力ファイル名と出力ファイル名が宣言されています。
- Bazel はローカルマシンで既存のビルド出力をチェックし、見つかったものを再利用します。
- Bazel はキャッシュで既存のビルド出力を確認します。出力が見つかった場合、Bazel は出力を取得します。これはキャッシュ ヒットです。
- 出力が見つからなかった必須アクションの場合、Bazel はアクションをローカルで実行し、必要なビルド出力を作成します。
- 新しいビルド出力がリモート キャッシュにアップロードされます。
キャッシュのバックエンドとしてサーバーを設定する
キャッシュのバックエンドとして機能するサーバーを設定する必要があります。HTTP/1.1 サーバーは Bazel のデータを不透明なバイトとして扱うことができるため、多くの既存のサーバーをリモート キャッシュ バックエンドとして使用できます。リモート キャッシュをサポートするのは、Bazel の HTTP キャッシュ プロトコルです。
キャッシュに保存された出力を保存するバックエンド サーバーの選択、設定、メンテナンスは、お客様の責任で行う必要があります。サーバーを選択する際は、次の点を考慮してください。
- ネットワーク速度。たとえば、チームが同じオフィスにいる場合は、独自のローカル サーバーを実行することをおすすめします。
- セキュリティはその中の 1 つでしょう。リモート キャッシュにはバイナリが保存されるため、安全にする必要があります。
- 管理が簡単。たとえば、Google Cloud Storage はフルマネージド サービスです。
リモート キャッシュに使用できるバックエンドは多数あります。次のようなオプションがあります。
nginx
nginx はオープンソースのウェブサーバーです。[WebDAV モジュール] を使用すると、Bazel のリモート キャッシュとして使用できます。Debian と Ubuntu では、nginx-extras パッケージをインストールできます。macOS では、Homebrew を使用して nginx を利用できます。
brew tap denji/nginxbrew install nginx-full --with-webdav
nginx の構成例を次に示します。/path/to/cache/dir を、nginx が書き込みと読み取りの権限を持っている有効なディレクトリに変更する必要があります。出力ファイルのサイズが大きい場合は、client_max_body_size オプションを大きな値に変更する必要があります。サーバーには、認証などの他の構成が必要になります。
nginx.conf の server セクションの構成例:
location /cache/ {
# The path to the directory where nginx should store the cache contents.
root /path/to/cache/dir;
# Allow PUT
dav_methods PUT;
# Allow nginx to create the /ac and /cas subdirectories.
create_full_put_path on;
# The maximum size of a single file.
client_max_body_size 1G;
allow all;
}
bazel-remote
bazel-remote は、インフラストラクチャで使用できるオープンソースのリモート ビルド キャッシュです。2018 年初頭から、複数の企業で本番環境で使用されています。Bazel プロジェクトでは、bazel-remote のテクニカル サポートは提供されていません。
このキャッシュはディスクにコンテンツを保存し、ガベージ コレクションも提供して、ストレージの上限を適用し、未使用のアーティファクトをクリーンアップします。キャッシュは [Docker イメージ] として使用でき、コードは GitHub で入手できます。REST リモート キャッシュ API と gRPC リモート キャッシュ API の両方がサポートされています。
使用方法については、GitHub のページをご覧ください。
Google Cloud Storage
[Google Cloud Storage] は、Bazel のリモート キャッシュ プロトコルと互換性のある HTTP API を提供するフルマネージド オブジェクト ストアです。課金が有効になっている Google Cloud アカウントが必要です。
Cloud Storage をキャッシュとして使用するには:
Storage バケットを作成します。ネットワーク帯域幅はリモート キャッシュにとって重要であるため、最も近いバケットのロケーションを選択してください。
Bazel が Cloud Storage を認証するためのサービス アカウントを作成します。サービス アカウントの作成をご覧ください。
シークレット JSON キーを生成し、認証のために Bazel に渡します。鍵があれば誰でも GCS バケットとの間で任意のデータを読み書きできるため、鍵は安全に保管してください。
Bazel コマンドに次のフラグを追加して、Cloud Storage に接続します。
- フラグ
--remote_cache=https://storage.googleapis.com/bucket-nameを使用して、次の URL を Bazel に渡します。ここで、bucket-nameはストレージ バケットの名前です。 - アプリケーション認証を使用するには、
--google_credentials=/path/to/your/secret-key.jsonまたは--google_default_credentialsフラグを使用して認証鍵を渡します。
- フラグ
古いファイルを自動的に削除するように Cloud Storage を構成できます。詳細については、オブジェクト ライフサイクルの管理をご覧ください。
その他のサーバー
PUT と GET をサポートする任意の HTTP/1.1 サーバーをキャッシュのバックエンドとして設定できます。Hazelcast、Apache httpd、AWS S3 などのバックエンドでキャッシュが正常に機能しているという報告がユーザーから寄せられています。
認証
バージョン 0.11.0 から、HTTP 基本認証のサポートが Bazel に追加されました。
ユーザー名とパスワードは、リモート キャッシュ URL を介して Bazel に渡すことができます。構文は https://username:password@hostname.com:port/path です。HTTP 基本認証では、ユーザー名とパスワードがネットワーク経由で平文で送信されるため、常に HTTPS で使用することが重要です。
HTTP キャッシュ プロトコル
Bazel は、HTTP/1.1 を介したリモート キャッシュをサポートしています。このプロトコルは概念的にはシンプルです。バイナリ データ（BLOB）は PUT リクエストでアップロードされ、GET リクエストでダウンロードされます。アクション結果のメタデータはパス /ac/ に、出力ファイルはパス /cas/ に保存されます。
たとえば、http://localhost:8080/cache で実行されているリモート キャッシュについて考えてみましょう。SHA256 ハッシュ 01ba4719... のアクションのアクション結果メタデータをダウンロードする Bazel リクエストは次のようになります。
GET /cache/ac/01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b HTTP/1.1
Host: localhost:8080
Accept: */*
Connection: Keep-Alive
SHA256 ハッシュ 15e2b0d3... を含む出力ファイルを CAS にアップロードする Bazel リクエストは次のようになります。
PUT /cache/cas/15e2b0d3c33891ebb0f1ef609ec419420c20e320ce94c65fbc8c3312448eb225 HTTP/1.1
Host: localhost:8080
Accept: */*
Content-Length: 9
Connection: Keep-Alive
0x310x320x330x340x350x360x370x380x39
リモート キャッシュを使用して Bazel を実行する
サーバーをリモート キャッシュとして設定したら、リモート キャッシュを使用するには、Bazel コマンドにフラグを追加する必要があります。以下の構成とそのフラグのリストをご覧ください。
選択したサーバーに固有の認証の構成が必要になる場合もあります。
これらのフラグを .bazelrc ファイルに追加すると、Bazel を実行するたびに指定する必要がなくなります。プロジェクトとチームの状況に応じて、次のフラグを .bazelrc ファイルに追加できます。
- ローカルマシン
- チームと共有しているプロジェクトのワークスペース
- CI システム
リモート キャッシュの読み取りと書き込み
リモート キャッシュへの書き込み権限を持つユーザーには注意してください。CI システムのみがリモート キャッシュに書き込めるようにすることもできます。
リモート キャッシュへの読み取りと書き込みを行うには、次のフラグを使用します。
build --remote_cache=http://your.host:portHTTP 以外にも、プロトコル HTTPS、grpc、grpcs がサポートされています。
リモート キャッシュからのみ読み取るには、上記のフラグに加えて次のフラグを使用します。
build --remote_upload_local_results=false特定のターゲットをリモート キャッシュの使用から除外する
特定のターゲットをリモート キャッシュの使用から除外するには、そのターゲットに no-remote-cache というタグを付けます。例:
java_library(
name = "target",
tags = ["no-remote-cache"],
)
リモート キャッシュからコンテンツを削除する
リモート キャッシュからコンテンツを削除することは、サーバーの管理の一環です。リモート キャッシュからコンテンツを削除する方法は、キャッシュとして設定したサーバーに応じて異なります。出力を削除する場合は、キャッシュ全体を削除するか、古い出力を削除します。
キャッシュに保存された出力は、名前とハッシュのセットとして保存されます。コンテンツを削除するときに、特定のビルドに属する出力を区別することはできません。
キャッシュからコンテンツを削除する理由は次のとおりです。
- キャッシュが汚染された後にクリーンなキャッシュを作成する
- 古い出力を削除して、ストレージ使用量を減らす
Unix ソケット
リモート HTTP キャッシュは、Unix ドメイン ソケットを介した接続をサポートしています。この動作は、curl の --unix-socket フラグと同様です。次のコマンドを使用して、Unix ドメイン ソケットを構成します。
build --remote_cache=http://your.host:port
build --remote_cache_proxy=unix:/path/to/socketこの機能は Windows ではサポートされていません。
ディスク キャッシュ
Bazel は、ファイル システム上のディレクトリをリモート キャッシュとして使用できます。これは、ブランチを切り替えるときや、複数のチェックアウトなど、同じプロジェクトの複数のワークスペースで作業するときに、ビルド アーティファクトを共有する場合に便利です。Bazel はディレクトリをガベージ コレクションしないため、このディレクトリの定期的なクリーンアップを自動化することをおすすめします。ディスク キャッシュを有効にするには、次のようにします。
build --disk_cache=path/to/build/cache~ エイリアスを使用して、ユーザー固有のパスを --disk_cache フラグに渡すことができます（Bazel は現在のユーザーのホーム ディレクトリに置き換えます）。これは、チェックインされているプロジェクトの .bazelrc ファイルでプロジェクトのすべてのデベロッパーに対してディスク キャッシュを有効にする場合に便利です。
既知の問題
ビルド中の入力ファイルの変更
ビルド中に入力ファイルが変更されると、Bazel は無効な結果をリモート キャッシュにアップロードする可能性があります。--experimental_guard_against_concurrent_changes フラグを使用して変更検出を有効にできます。既知の問題はなく、今後のリリースではデフォルトで有効になる予定です。最新情報については、[issue #3360] をご覧ください。通常、ビルド中にソースファイルを変更しないでください。
環境変数がアクションにリークする
アクション定義には環境変数を含めます。これは、マシン間でリモート キャッシュ ヒットを共有する場合に問題になる可能性があります。たとえば、$PATH 変数が異なる環境では、キャッシュ ヒットは共有されません。アクション定義には、--action_env で明示的にホワイトリストに登録された環境変数のみが含まれます。Bazel の Debian / Ubuntu パッケージは、$PATH などの環境変数のホワイトリストを使用して /etc/bazel.bazelrc をインストールしていました。キャッシュ ヒットが想定よりも少ない場合は、環境に古い /etc/bazel.bazelrc ファイルがないことを確認します。
Bazel はワークスペースの外部ツールを追跡しません
Bazel は現在、ワークスペース外のツールを追跡しません。たとえば、アクションが /usr/bin/ のコンパイラを使用している場合、これは問題になる可能性があります。出力は異なるもののアクション ハッシュが同じであるため、異なるコンパイラがインストールされている 2 人のユーザーがキャッシュ ヒットを誤って共有します。最新情報については、問題 #4558 をご覧ください。
Docker コンテナ内でビルドを実行すると、増分インメモリ状態が失われる Bazel は、単一の Docker コンテナで実行する場合でも、サーバー/クライアント アーキテクチャを使用します。サーバーサイドでは、Bazel がメモリ内状態を維持するので、ビルドが高速化されます。 CI など、Docker コンテナ内でビルドを実行すると、メモリ内状態が失われます。Bazel は、リモート キャッシュを使用する前に、その状態を再ビルドする必要があります。