本頁面說明遠端快取、設定伺服器來託管快取,以及使用遠端快取執行建構作業。
開發人員團隊和/或持續整合 (CI) 系統使用遠端快取來共用建構輸出內容。如果您的建構可以重現,則可在另一部機器上安全地重複使用某部機器的輸出內容,進而大幅加快建構作業的執行速度。
總覽
Bazel 會將建構作業拆解成多個獨立的步驟,這些步驟稱為動作。每個動作都有輸入、輸出名稱、指令列和環境變數。系統會明確宣告每個動作的必要輸入內容和預期輸出內容。
您可以將伺服器設為建構輸出內容的遠端快取,這些輸出內容即為這些動作的輸出內容。這些輸出內容包含輸出檔案名稱清單和其內容的結尾。透過遠端快取,您可以重複使用其他使用者建構作業的建構輸出內容,不必在本機建構每個新的輸出內容。
如要使用遠端快取,請按照下列步驟操作:
- 將伺服器設為快取後端
- 設定 Bazel 建構作業,以便使用遠端快取
- 使用 Bazel 0.10.0 以上版本
遠端快取會儲存兩種類型的資料:
- 動作快取,也就是動作雜湊與動作結果中繼資料的對應。
- 輸出檔案的可定址儲存庫 (CAS)。
請注意,遠端快取會額外儲存每個動作的 stdout 和 stderr。檢查 Bazel 的 stdout/stderr,因此並不是預估快取命中的理想信號。
建構作業如何使用遠端快取
將伺服器設為遠端快取後,您就能以多種方式使用快取:
- 讀取和寫入遠端快取
- 讀取和/或寫入遠端快取 (特定目標除外)
- 只能讀取遠端快取
- 完全不使用遠端快取
執行可讀取和寫入遠端快取的 Bazel 建構作業時,建構作業會執行下列步驟:
- Bazel 會建立需要建構的目標圖表,並建立必要動作清單。每個動作都有宣告的輸入和輸出檔案名稱
- Bazel 會檢查本機電腦中是否有現有的建構輸出內容,並重複使用所找到的任何項目。
- Bazel 會檢查快取中是否有現有建構輸出內容。如果找到輸出內容,Bazel 會擷取輸出內容。這屬於快取命中。
- 針對找不到輸出內容的必要動作,Bazel 會在本機執行動作,並建立必要的建構輸出內容。
- 新的建構輸出內容會上傳至遠端快取。
將伺服器設為快取的後端
您必須設定伺服器,做為快取的後端。HTTP/1.1 伺服器可以將 Bazel 的資料視為不透明位元組,並有許多現有伺服器可當做遠端快取後端使用。Bazel 的 HTTP 快取通訊協定支援遠端快取。
您必須自行選擇、設定及維護用來儲存快取輸出內容的後端伺服器。選擇伺服器時,請考量下列幾點:
- 網路速度。例如,如果團隊位於同一辦公室,您可能會想要執行自己的本機伺服器。
- 安全性。遠端快取存有您的二進位檔,因此必須安全無虞。
- 輕鬆管理。例如 Google Cloud Storage 是全代管服務。
許多後端可用於遠端快取。部分選項包括:
nginx
nginx 是開放原始碼的網路伺服器。有了 [WebDAV 模組],這個模組即可做為 Bazel 的遠端快取使用。在 Debian 和 Ubuntu 上,您可以安裝 nginx-extras
套件。在 macOS nginx 上可透過 Homebrew 取得:
brew tap denji/nginx
brew 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 和 gRPC 遠端快取 API 都受到支援。
如需使用操作說明,請前往 GitHub 頁面。
Google Cloud Storage
[Google Cloud Storage] 是一個全代管物件儲存空間,提供與 Bazel 遠端快取通訊協定相容的 HTTP API。您必須擁有已啟用計費功能的 Google Cloud 帳戶,才能使用這項服務。
如要使用 Cloud Storage 做為快取,請執行下列操作:
建立儲存空間值區。 網路頻寬對遠端快取來說相當重要,因此請務必選取離您最近的值區位置。
為 Bazel 建立服務帳戶,以便向 Cloud Storage 進行驗證。請參閱建立服務帳戶一節。
產生密鑰 JSON 金鑰並傳送至 Bazel 進行驗證。請妥善儲存金鑰,因為凡是有金鑰的人,都能在您的 GCS 值區內讀取及寫入任意資料。
將下列標記新增至 Bazel 指令,即可連線至 Cloud Storage:
- 使用標記將下列網址傳送至 Bazel:
--remote_cache=https://storage.googleapis.com/bucket-name
,其中bucket-name
是儲存空間值區的名稱。 - 請使用
--google_credentials=/path/to/your/secret-key.json
或--google_default_credentials
標記傳遞驗證金鑰,以使用應用程式驗證。
- 使用標記將下列網址傳送至 Bazel:
您可以設定 Cloud Storage 自動刪除舊檔案。相關做法請參閱管理物件生命週期一文。
其他伺服器
您可以設定任何支援 PUT 和 GET 的 HTTP/1.1 伺服器做為快取的後端。使用者已回報 Hazelcast、Apache httpd 和 AWS S3 等快取後端成功獲得成功。
驗證機制
自 0.11.0 版起,HTTP 基本驗證的支援已新增至 Bazel。您可以透過遠端快取網址,將使用者名稱和密碼傳送至 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
檔案新增標記:
- 在本機電腦上
- 在專案工作區中與團隊共用
- 持續整合系統
讀取遠端快取及寫入資料
謹慎處理可以寫入遠端快取的人員。您可能會希望只有持續整合系統可以寫入遠端快取。
使用以下標記讀取遠端快取並寫入資料:
build --remote_cache=http://your.host:port
除了 HTTP
之外,系統也支援以下通訊協定:HTTPS
、grpc
、grpcs
。
除了上述標記以外,再使用下列標記,僅讀取遠端快取:
build --remote_upload_local_results=false
將特定目標從遠端快取中排除
如要從遠端快取中排除特定目標,請使用 no-cache
標記目標。例如:
java_library(
name = "target",
tags = ["no-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
旗標啟用變更偵測功能。沒有任何已知問題,日後推出的版本將預設啟用該問題。請參閱 [問題 #3360] 瞭解最新資訊。一般而言,請避免在建構期間修改來源檔案。
洩露至動作的環境變數
動作定義包含環境變數。跨機器共用遠端快取命中時,可能會發生問題。舉例來說,具有不同 $PATH
變數的環境不會共用快取命中資料。動作定義只會納入透過 --action_env
明確加入許可清單的環境變數。Bazel 的 Debian/Ubuntu 套件,用來安裝具有 $PATH
等環境變數許可清單的 /etc/bazel.bazelrc
。如果快取命中次數不如預期,請檢查環境是否沒有舊的 /etc/bazel.bazelrc
檔案。
Bazel 不會追蹤工作區以外的工具
Bazel 目前不會追蹤工作區以外的工具。舉例來說,如果動作使用 /usr/bin/
的編譯器,就可能發生這個問題。接著,兩個安裝不同編譯器的使用者會誤共享快取命中資料,因為輸出內容不同,但動作雜湊相同。請參閱問題 #4558。
在 docker 容器內執行建構作業時,記憶體中的增量狀態會遺失 Bazel 仍會使用伺服器/用戶端架構,即便是在單一 Docker 容器中執行亦然。在伺服器端,Bazel 會維持記憶體內狀態,進而加快建構速度。在 docker 容器 (例如 CI) 中執行建構作業時,記憶體內狀態會遺失,且 Bazel 必須在使用遠端快取前進行重新建構。