Lưu vào bộ nhớ đệm từ xa

Báo cáo sự cố Xem nguồn

Trang này đề cập đến cách lưu vào bộ nhớ đệm từ xa, cách thiết lập máy chủ để lưu trữ bộ nhớ đệm và chạy các bản dựng bằng bộ nhớ đệm từ xa.

Một nhóm nhà phát triển và/hoặc hệ thống tích hợp liên tục (CI) sẽ sử dụng bộ nhớ đệm từ xa để chia sẻ đầu ra của bản dựng. Nếu bản dựng của bạn có thể tái tạo, dữ liệu đầu ra từ một máy có thể được sử dụng lại một cách an toàn trên một máy khác. Điều này có thể giúp các bản dựng nhanh hơn đáng kể.

Tổng quan

Bazel chia bản dựng thành các bước riêng biệt, được gọi là hành động. Mỗi hành động đều có dữ liệu đầu vào, tên đầu ra, một dòng lệnh và các biến môi trường. Dữ liệu đầu vào bắt buộc và đầu ra dự kiến được khai báo rõ ràng cho mỗi thao tác.

Bạn có thể thiết lập một máy chủ làm bộ nhớ đệm từ xa cho các đầu ra của bản dựng, đây chính là các đầu ra của hành động. Các dữ liệu đầu ra này bao gồm một danh sách tên tệp đầu ra và hàm băm cho nội dung của các tệp đó. Với bộ nhớ đệm từ xa, bạn có thể sử dụng lại kết quả bản dựng từ bản dựng của người dùng khác thay vì tạo cục bộ từng đầu ra mới.

Cách sử dụng tính năng lưu vào bộ nhớ đệm từ xa:

  • Thiết lập một máy chủ làm phần phụ trợ của bộ nhớ đệm
  • Định cấu hình bản dựng Bazel để sử dụng bộ nhớ đệm từ xa
  • Sử dụng Bazel phiên bản 0.10.0 trở lên

Bộ nhớ đệm từ xa lưu trữ hai loại dữ liệu:

  • Bộ nhớ đệm thao tác, là một bản đồ băm hành động với siêu dữ liệu của kết quả hành động.
  • Kho lưu trữ có thể định địa chỉ nội dung (CAS) của các tệp đầu ra.

Xin lưu ý rằng bộ nhớ đệm từ xa còn lưu trữ thêm stdout và stderr cho mỗi thao tác. Do đó, việc kiểm tra stdout/stderr của Bazel không phải là một tín hiệu tốt để ước tính số lượt truy cập vào bộ nhớ đệm.

Cách một bản dựng sử dụng chức năng lưu vào bộ nhớ đệm từ xa

Sau khi thiết lập máy chủ làm bộ nhớ đệm từ xa, bạn có thể dùng bộ nhớ đệm theo nhiều cách:

  • Đọc và ghi vào bộ nhớ đệm từ xa
  • Đọc và/hoặc ghi vào bộ nhớ đệm từ xa ngoại trừ các mục tiêu cụ thể
  • Chỉ đọc từ bộ nhớ đệm từ xa
  • Không sử dụng bộ nhớ đệm từ xa

Khi bạn chạy một bản dựng Bazel có thể đọc và ghi vào bộ nhớ đệm từ xa, bản dựng này sẽ tuân theo các bước sau:

  1. Bazel tạo biểu đồ các mục tiêu cần được xây dựng, sau đó tạo danh sách các hành động bắt buộc. Mỗi thao tác này đều khai báo tên tệp đầu vào và đầu ra.
  2. Bazel kiểm tra máy cục bộ của bạn để xem các kết quả bản dựng hiện có và sử dụng lại mọi kết quả mà công cụ này tìm thấy.
  3. Bazel kiểm tra bộ nhớ đệm để xem kết quả của bản dựng hiện có. Nếu tìm thấy kết quả, Bazel sẽ truy xuất kết quả đó. Đây là một lần truy cập vào bộ nhớ đệm.
  4. Đối với các hành động bắt buộc nhưng không tìm thấy kết quả đầu ra, Bazel thực thi các thao tác cục bộ và tạo dữ liệu đầu ra của bản dựng bắt buộc.
  5. Đầu ra bản dựng mới được tải lên bộ nhớ đệm từ xa.

Thiết lập một máy chủ làm phần phụ trợ của bộ nhớ đệm

Bạn cần thiết lập một máy chủ để đóng vai trò là phần phụ trợ của bộ nhớ đệm. Máy chủ HTTP/1.1 có thể coi dữ liệu của Bazel là các byte mờ và nhiều máy chủ hiện có có thể được dùng làm phần phụ trợ lưu vào bộ nhớ đệm từ xa. Giao thức lưu vào bộ nhớ đệm HTTP của Bazel là công cụ hỗ trợ tính năng lưu vào bộ nhớ đệm từ xa.

Bạn chịu trách nhiệm chọn, thiết lập và duy trì máy chủ phụ trợ sẽ lưu trữ kết quả đầu ra được lưu vào bộ nhớ đệm. Khi chọn máy chủ, hãy cân nhắc:

  • Tốc độ mạng. Ví dụ: nếu nhóm của bạn ở trong cùng một văn phòng, bạn có thể muốn chạy máy chủ cục bộ của riêng mình.
  • Bảo mật. Bộ nhớ đệm từ xa sẽ có các tệp nhị phân của bạn và vì vậy cần phải được bảo mật.
  • Dễ quản lý. Ví dụ: Google Cloud Storage là một dịch vụ được quản lý toàn diện.

Có nhiều phần phụ trợ có thể dùng cho bộ nhớ đệm từ xa. Một số tuỳ chọn bao gồm:

nginx

nginx là một máy chủ web nguồn mở. Với [mô-đun WebDAV], bạn có thể sử dụng mô-đun này làm bộ nhớ đệm từ xa cho Bazel. Trên Debian và Ubuntu, bạn có thể cài đặt gói nginx-extras. Trên macOS nginx có sẵn thông qua Homebrew:

brew tap denji/nginx
brew install nginx-full --with-webdav

Dưới đây là cấu hình mẫu cho nginx. Xin lưu ý rằng bạn sẽ cần thay đổi /path/to/cache/dir thành một thư mục hợp lệ trong đó nginx có quyền ghi và đọc. Bạn có thể cần thay đổi tuỳ chọn client_max_body_size thành giá trị lớn hơn nếu có các tệp đầu ra lớn hơn. Máy chủ sẽ yêu cầu cấu hình khác, chẳng hạn như xác thực.

Cấu hình mẫu cho phần server trong nginx.conf:

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;
}

điều khiển từ xa bazel

bazel-remote là một bộ nhớ đệm bản dựng từ xa nguồn mở mà bạn có thể sử dụng trên cơ sở hạ tầng của mình. AI đã được sử dụng thành công trong quá trình sản xuất tại một số công ty kể từ đầu năm 2018. Xin lưu ý rằng dự án Bazel không hỗ trợ kỹ thuật cho bazel-remote.

Bộ nhớ đệm này lưu trữ nội dung trên ổ đĩa, đồng thời cung cấp tính năng thu thập rác để thực thi giới hạn bộ nhớ trên và dọn dẹp các cấu phần phần mềm không dùng đến. Bộ nhớ đệm có sẵn dưới dạng [hình ảnh docker] và mã của bộ nhớ đệm này có trên GitHub. Cả hai API bộ nhớ đệm từ xa REST và gRPC đều được hỗ trợ.

Hãy tham khảo trang GitHub để xem hướng dẫn về cách sử dụng.

Google Cloud Storage

[Google Cloud Storage] là một kho lưu trữ đối tượng được quản lý toàn diện, cung cấp API HTTP tương thích với giao thức lưu vào bộ nhớ đệm từ xa của Bazel. Dịch vụ này yêu cầu bạn phải có tài khoản Google Cloud và bật tính năng thanh toán.

Cách dùng Cloud Storage làm bộ nhớ đệm:

  1. Tạo bộ chứa lưu trữ. Đảm bảo rằng bạn chọn vị trí bộ chứa gần bạn nhất, vì băng thông mạng rất quan trọng đối với bộ nhớ đệm từ xa.

  2. Tạo một tài khoản dịch vụ cho Bazel để xác thực với Cloud Storage. Hãy xem phần Tạo tài khoản dịch vụ.

  3. Tạo một khoá JSON bí mật rồi chuyển khoá đó cho Bazel để xác thực. Lưu trữ khoá một cách an toàn, vì bất kỳ ai có khoá này đều có thể đọc và ghi dữ liệu tuỳ ý vào/từ bộ chứa GCS của bạn.

  4. Kết nối với Cloud Storage bằng cách thêm các cờ sau vào lệnh Bazel của bạn:

    • Chuyển URL sau đến Bazel bằng cách sử dụng cờ: --remote_cache=https://storage.googleapis.com/bucket-name, trong đó bucket-name là tên bộ chứa lưu trữ của bạn.
    • Truyền khoá xác thực bằng cờ: --google_credentials=/path/to/your/secret-key.json hoặc --google_default_credentials để sử dụng tính năng Xác thực ứng dụng.
  5. Bạn có thể định cấu hình Cloud Storage để tự động xoá các tệp cũ. Để thực hiện việc này, hãy xem bài viết Quản lý vòng đời đối tượng.

Các máy chủ khác

Bạn có thể thiết lập bất kỳ máy chủ HTTP/1.1 nào hỗ trợ PUT và GET làm phần phụ trợ của bộ nhớ đệm. Người dùng đã báo cáo sự thành công với các phần phụ trợ lưu vào bộ nhớ đệm như Hazelcast, Apache httpdAWS S3.

Xác thực

Kể từ phiên bản 0.11.0 hỗ trợ cho Xác thực cơ bản HTTP đã được thêm vào Bazel. Bạn có thể chuyển tên người dùng và mật khẩu cho Bazel qua URL bộ nhớ đệm từ xa. Cú pháp là https://username:password@hostname.com:port/path. Xin lưu ý rằng phương thức Xác thực cơ bản HTTP truyền tên người dùng và mật khẩu dưới dạng văn bản thuần tuý qua mạng. Do đó, điều quan trọng là phải luôn sử dụng các thông tin này với HTTPS.

Giao thức lưu vào bộ nhớ đệm HTTP

Bazel hỗ trợ lưu vào bộ nhớ đệm từ xa thông qua HTTP/1.1. Về mặt lý thuyết, giao thức này rất đơn giản: Dữ liệu nhị phân (BLOB) được tải lên thông qua các yêu cầu PUT và được tải xuống qua các yêu cầu GET. Siêu dữ liệu của kết quả hành động được lưu trữ trong đường dẫn /ac/ và các tệp đầu ra được lưu trữ theo đường dẫn /cas/.

Ví dụ: hãy xem xét một bộ nhớ đệm từ xa chạy trong http://localhost:8080/cache. Yêu cầu Bazel tải siêu dữ liệu kết quả hành động xuống cho một hành động có hàm băm SHA256 01ba4719... sẽ có dạng như sau:

GET /cache/ac/01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b HTTP/1.1
Host: localhost:8080
Accept: */*
Connection: Keep-Alive

Yêu cầu Bazel tải một tệp đầu ra có 15e2b0d3... hàm băm SHA256 lên CAS sẽ có dạng như sau:

PUT /cache/cas/15e2b0d3c33891ebb0f1ef609ec419420c20e320ce94c65fbc8c3312448eb225 HTTP/1.1
Host: localhost:8080
Accept: */*
Content-Length: 9
Connection: Keep-Alive

0x310x320x330x340x350x360x370x380x39

Chạy Bazel bằng bộ nhớ đệm từ xa

Sau khi thiết lập một máy chủ làm bộ nhớ đệm từ xa, bạn cần thêm cờ vào lệnh Bazel để sử dụng bộ nhớ đệm từ xa. Xem danh sách cấu hình và cờ của các cấu hình đó ở bên dưới.

Bạn cũng có thể cần định cấu hình xác thực, dành riêng cho máy chủ bạn đã chọn.

Bạn nên thêm các cờ này vào tệp .bazelrc để không cần chỉ định các cờ này mỗi khi chạy Bazel. Tuỳ thuộc vào dự án và tính linh động của nhóm, bạn có thể thêm cờ vào tệp .bazelrc:

  • Trên máy cục bộ của bạn
  • Trong không gian làm việc của dự án, được chia sẻ với nhóm
  • Trên hệ thống CI

Đọc và ghi vào bộ nhớ đệm từ xa

Quan tâm đến những người có khả năng ghi vào bộ nhớ đệm từ xa. Có thể bạn chỉ muốn hệ thống CI mới có thể ghi vào bộ nhớ đệm từ xa.

Sử dụng cờ sau để đọc và ghi vào bộ nhớ đệm từ xa:

build --remote_cache=http://your.host:port

Ngoài HTTP, các giao thức sau đây cũng được hỗ trợ: HTTPS, grpc, grpcs.

Sử dụng cờ sau cùng với cờ ở trên để chỉ đọc từ bộ nhớ đệm từ xa:

build --remote_upload_local_results=false

Loại trừ các mục tiêu cụ thể khỏi việc sử dụng bộ nhớ đệm từ xa

Để loại trừ các mục tiêu cụ thể khỏi bộ nhớ đệm từ xa, hãy gắn thẻ mục tiêu bằng no-remote-cache. Ví dụ:

java_library(
    name = "target",
    tags = ["no-remote-cache"],
)

Xoá nội dung khỏi bộ nhớ đệm từ xa

Việc xoá nội dung khỏi bộ nhớ đệm từ xa là một phần trong việc quản lý máy chủ của bạn. Cách xoá nội dung khỏi bộ nhớ đệm từ xa tuỳ thuộc vào máy chủ mà bạn đã thiết lập làm bộ nhớ đệm. Khi xoá các kết quả, hãy xoá toàn bộ bộ nhớ đệm hoặc xoá các kết quả cũ.

Các kết quả đã lưu vào bộ nhớ đệm được lưu trữ dưới dạng một tập hợp tên và giá trị băm. Khi xoá nội dung, không có cách nào để phân biệt đầu ra nào thuộc về một bản dựng cụ thể.

Có thể bạn muốn xoá nội dung khỏi bộ nhớ đệm để:

  • Tạo bộ nhớ đệm sạch sau khi bộ nhớ đệm bị nhiễm độc
  • Giảm mức bộ nhớ dùng bằng cách xoá các dữ liệu đầu ra cũ

ổ cắm Unix

Bộ nhớ đệm HTTP từ xa hỗ trợ kết nối qua ổ cắm miền unix. Hành vi này tương tự như cờ --unix-socket của curl. Sử dụng các nội dung sau để định cấu hình ổ cắm miền unix:

   build --remote_cache=http://your.host:port
   build --remote_proxy=unix:/path/to/socket

Tính năng này không được hỗ trợ trên Windows.

Bộ nhớ đệm của ổ đĩa

Bazel có thể sử dụng một thư mục trên hệ thống tệp làm bộ nhớ đệm từ xa. Việc này rất hữu ích khi chia sẻ các cấu phần phần mềm bản dựng khi chuyển đổi các nhánh và/hoặc làm việc trên nhiều không gian làm việc của cùng một dự án, chẳng hạn như nhiều quy trình thanh toán. Vì Bazel không thu thập rác trong thư mục, nên bạn có thể cần tự động hoá quá trình dọn dẹp định kỳ thư mục này. Bật bộ nhớ đệm của ổ đĩa như sau:

build --disk_cache=path/to/build/cache

Bạn có thể truyền một đường dẫn dành riêng cho người dùng đến cờ --disk_cache bằng cách sử dụng bí danh ~ (Bazel sẽ thay thế thư mục gốc của người dùng hiện tại). Điều này rất hữu ích khi bật bộ nhớ đệm trên ổ đĩa cho mọi nhà phát triển của một dự án thông qua trạng thái đã đánh dấu trong tệp .bazelrc của dự án.

Vấn đề đã biết

Sửa đổi tệp đầu vào trong quá trình tạo bản dựng

Khi tệp đầu vào được sửa đổi trong quá trình xây dựng, Bazel có thể tải các kết quả không hợp lệ lên bộ nhớ đệm từ xa. Bạn có thể bật tính năng phát hiện thay đổi bằng cờ --experimental_guard_against_concurrent_changes. Không có vấn đề nào đã biết và tính năng này sẽ được bật theo mặc định trong bản phát hành sau này. Hãy xem [vấn đề #3360] để biết thông tin cập nhật. Nhìn chung, hãy tránh sửa đổi các tệp nguồn trong quá trình tạo bản dựng.

Biến môi trường bị rò rỉ vào một thao tác

Phần định nghĩa hành động có chứa các biến môi trường. Đây có thể là sự cố khi chia sẻ số lượt truy cập vào bộ nhớ đệm từ xa giữa các máy. Ví dụ: các môi trường có các biến $PATH khác nhau sẽ không dùng chung số lượt truy cập vào bộ nhớ đệm. Chỉ các biến môi trường được đưa vào danh sách cho phép rõ ràng thông qua --action_env mới được đưa vào định nghĩa hành động. Gói Debian/Ubuntu của Bazel dùng để cài đặt /etc/bazel.bazelrc cùng với một danh sách cho phép gồm các biến môi trường, bao gồm $PATH. Nếu bạn nhận được ít lượt truy cập vào bộ nhớ đệm hơn dự kiến, hãy kiểm tra để đảm bảo rằng môi trường của bạn không có tệp /etc/bazel.bazelrc cũ.

Bazel không theo dõi các công cụ bên ngoài không gian làm việc

Bazel hiện không theo dõi các công cụ bên ngoài không gian làm việc. Đây có thể là vấn đề nếu chẳng hạn như một hành động sử dụng trình biên dịch từ /usr/bin/. Sau đó, hai người dùng đã cài đặt các trình biên dịch khác nhau sẽ chia sẻ nhầm số lượt truy cập vào bộ nhớ đệm vì các kết quả khác nhau nhưng có cùng hàm băm hành động. Hãy xem vấn đề #4558 để biết thông tin cập nhật.

Trạng thái trong bộ nhớ gia tăng bị mất khi chạy bản dựng bên trong vùng chứa Docker Bazel sử dụng cấu trúc máy chủ/ứng dụng ngay cả khi chạy trong một vùng chứa Docker. Về phía máy chủ, Bazel duy trì trạng thái trong bộ nhớ giúp tăng tốc các bản dựng. Khi chạy các bản dựng bên trong vùng chứa Docker như trong CI, trạng thái trong bộ nhớ sẽ bị mất và Bazel phải tạo lại bản dựng trước khi sử dụng bộ nhớ đệm từ xa.