Điều chỉnh các quy tắc Bazel để thực thi từ xa

Báo cáo vấn đề Xem nguồn Ban đêm · 8.0 · 7.4 · 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Trang này dành cho những người dùng Bazel viết quy tắc kiểm thử và bản dựng tuỳ chỉnh, đồng thời muốn tìm hiểu các yêu cầu đối với quy tắc Bazel trong bối cảnh thực thi từ xa.

Tính năng thực thi từ xa cho phép Bazel thực thi các hành động trên một nền tảng riêng, chẳng hạn như trung tâm dữ liệu. Bazel sử dụng giao thức gRPC để thực thi từ xa. Bạn có thể thử thực thi từ xa bằng bazel-buildfarm, một dự án nguồn mở nhằm cung cấp nền tảng thực thi từ xa phân tán.

Trang này sử dụng các thuật ngữ sau khi đề cập đến các loại môi trường hoặc nền tảng khác nhau:

  • Nền tảng lưu trữ – nơi Bazel chạy.
  • Nền tảng thực thi – nơi các hành động của Bazel chạy.
  • Nền tảng mục tiêu – nơi các đầu ra của bản dựng (và một số hành động) chạy.

Tổng quan

Khi định cấu hình bản dựng Bazel để thực thi từ xa, bạn phải tuân theo các nguyên tắc được mô tả trong trang này để đảm bảo bản dựng thực thi từ xa mà không gặp lỗi. Điều này là do bản chất của việc thực thi từ xa, cụ thể là:

  • Các hành động xây dựng riêng biệt. Các công cụ xây dựng không giữ lại trạng thái và các phần phụ thuộc không thể rò rỉ giữa các công cụ đó.

  • Môi trường thực thi đa dạng. Cấu hình bản dựng cục bộ không phải lúc nào cũng phù hợp với môi trường thực thi từ xa.

Trang này mô tả các vấn đề có thể phát sinh khi triển khai quy tắc kiểm thử và bản dựng Bazel tuỳ chỉnh để thực thi từ xa, cũng như cách tránh các vấn đề đó. Bài viết này đề cập đến các chủ đề sau:

Gọi các công cụ xây dựng thông qua quy tắc chuỗi công cụ

Quy tắc chuỗi công cụ Bazel là một trình cung cấp cấu hình cho quy tắc bản dựng biết nên sử dụng công cụ bản dựng nào, chẳng hạn như trình biên dịch và trình liên kết, cũng như cách định cấu hình các công cụ đó bằng cách sử dụng các tham số do tác giả của quy tắc xác định. Quy tắc chuỗi công cụ cho phép các quy tắc bản dựng và kiểm thử gọi các công cụ bản dựng theo cách dự đoán được, được định cấu hình trước và tương thích với việc thực thi từ xa. Ví dụ: sử dụng quy tắc chuỗi công cụ thay vì gọi các công cụ xây dựng thông qua PATH, JAVA_HOME hoặc các biến cục bộ khác có thể không được đặt thành các giá trị tương đương (hoặc không được đặt) trong môi trường thực thi từ xa.

Các quy tắc chuỗi công cụ hiện tồn tại cho quy tắc bản dựng và kiểm thử Bazel cho Scala, Rust và Go, đồng thời các quy tắc chuỗi công cụ mới đang được triển khai cho các ngôn ngữ và công cụ khác như bash. Nếu không có quy tắc chuỗi công cụ cho công cụ mà quy tắc của bạn sử dụng, hãy cân nhắc tạo quy tắc chuỗi công cụ.

Quản lý các phần phụ thuộc ngầm ẩn

Nếu một công cụ xây dựng có thể truy cập vào các phần phụ thuộc trên các thao tác xây dựng, thì các thao tác đó sẽ không thành công khi được thực thi từ xa vì mỗi thao tác xây dựng từ xa được thực thi riêng biệt với các thao tác khác. Một số công cụ xây dựng giữ lại trạng thái trên các thao tác xây dựng và truy cập vào các phần phụ thuộc chưa được đưa vào lệnh gọi công cụ một cách rõ ràng, điều này sẽ khiến các thao tác xây dựng được thực thi từ xa không thành công.

Ví dụ: khi Bazel hướng dẫn một trình biên dịch có trạng thái tạo foo cục bộ, trình biên dịch sẽ giữ lại các tệp tham chiếu đến đầu ra bản dựng của foo. Sau đó, khi Bazel hướng dẫn trình biên dịch tạo bar, tuỳ thuộc vào foo, mà không nêu rõ phần phụ thuộc đó trong tệp BUILD để đưa vào lệnh gọi trình biên dịch, thao tác sẽ thực thi thành công miễn là cùng một thực thể trình biên dịch thực thi cho cả hai thao tác (như thường lệ đối với việc thực thi cục bộ). Tuy nhiên, vì trong trường hợp thực thi từ xa, mỗi thao tác tạo bản dựng sẽ thực thi một thực thể trình biên dịch riêng biệt, nên trạng thái trình biên dịch và phần phụ thuộc ngầm ẩn của bar trên foo sẽ bị mất và bản dựng sẽ không thành công.

Để giúp phát hiện và loại bỏ các vấn đề về phần phụ thuộc này, Bazel 0.14.1 cung cấp hộp cát Docker cục bộ có các hạn chế giống với phần phụ thuộc khi thực thi từ xa. Sử dụng hộp cát để chuẩn bị bản dựng cho quá trình thực thi từ xa bằng cách xác định và giải quyết lỗi bản dựng liên quan đến phần phụ thuộc. Hãy xem phần Khắc phục sự cố khi thực thi từ xa Bazel bằng Hộp cát Docker để biết thêm thông tin.

Quản lý các tệp nhị phân phụ thuộc vào nền tảng

Thông thường, tệp nhị phân được tạo trên nền tảng lưu trữ không thể thực thi một cách an toàn trên một nền tảng thực thi từ xa tuỳ ý do các phần phụ thuộc có thể không khớp. Ví dụ: tệp nhị phân SingleJar được cung cấp cùng với Bazel nhắm đến nền tảng lưu trữ. Tuy nhiên, để thực thi từ xa, bạn phải biên dịch SingleJar trong quá trình tạo mã để mã đó nhắm đến nền tảng thực thi từ xa. (Xem logic lựa chọn mục tiêu.)

Không vận chuyển các tệp nhị phân của các công cụ xây dựng mà bản dựng của bạn yêu cầu cùng với mã nguồn, trừ phi bạn chắc chắn rằng các tệp đó sẽ chạy an toàn trong nền tảng thực thi của bạn. Thay vào đó, hãy làm một trong những việc sau:

  • Vận chuyển hoặc tham chiếu bên ngoài mã nguồn cho công cụ để có thể tạo công cụ cho nền tảng thực thi từ xa.

  • Cài đặt trước công cụ vào môi trường thực thi từ xa (ví dụ: vùng chứa chuỗi công cụ) nếu công cụ đó đủ ổn định và sử dụng các quy tắc chuỗi công cụ để chạy công cụ đó trong bản dựng.

Quản lý các quy tắc WORKSPACE kiểu cấu hình

Bạn có thể sử dụng quy tắc WORKSPACE của Bazel để thăm dò nền tảng lưu trữ cho các công cụ và thư viện mà bản dựng yêu cầu. Đối với các bản dựng cục bộ, đây cũng là nền tảng thực thi của Bazel. Nếu bản dựng phụ thuộc rõ ràng vào các công cụ bản dựng và cấu phần phần mềm cục bộ, thì bản dựng sẽ không thành công trong quá trình thực thi từ xa nếu nền tảng thực thi từ xa không giống với nền tảng máy chủ.

Các hành động sau do quy tắc WORKSPACE thực hiện không tương thích với việc thực thi từ xa:

  • Tạo tệp nhị phân. Việc thực thi các thao tác biên dịch trong quy tắc WORKSPACE sẽ dẫn đến các tệp nhị phân không tương thích với nền tảng thực thi từ xa nếu khác với nền tảng lưu trữ.

  • Đang cài đặt các gói pip. Các gói pip được cài đặt thông qua quy tắc WORKSPACE yêu cầu các phần phụ thuộc của gói phải được cài đặt sẵn trên nền tảng lưu trữ. Các gói như vậy, được tạo riêng cho nền tảng lưu trữ, sẽ không tương thích với nền tảng thực thi từ xa nếu khác với nền tảng lưu trữ.

  • Đường liên kết tượng trưng đến các công cụ hoặc cấu phần phần mềm cục bộ. Đường liên kết tượng trưng đến các công cụ hoặc thư viện được cài đặt trên nền tảng lưu trữ được tạo thông qua các quy tắc WORKSPACE sẽ khiến bản dựng không thành công trên nền tảng thực thi từ xa vì Bazel sẽ không thể xác định vị trí của các công cụ hoặc thư viện đó. Thay vào đó, hãy tạo đường liên kết tượng trưng bằng các thao tác xây dựng tiêu chuẩn để có thể truy cập vào các công cụ và thư viện được liên kết tượng trưng từ cây runfiles của Bazel. Không sử dụng repository_ctx.symlink để liên kết tượng trưng các tệp mục tiêu bên ngoài thư mục kho lưu trữ bên ngoài.

  • Thay đổi nền tảng lưu trữ. Tránh tạo tệp bên ngoài cây runfiles của Bazel, tạo biến môi trường và các thao tác tương tự, vì các tệp này có thể hoạt động không như mong muốn trên nền tảng thực thi từ xa.

Để tìm hành vi không kín đáo tiềm ẩn, bạn có thể sử dụng Nhật ký quy tắc của Workspace.

Nếu một phần phụ thuộc bên ngoài thực thi các thao tác cụ thể phụ thuộc vào nền tảng máy chủ, bạn nên phân tách các thao tác đó giữa WORKSPACE và tạo các quy tắc như sau:

  • Kiểm tra nền tảng và liệt kê phần phụ thuộc. Bạn có thể thực thi các thao tác này một cách an toàn trên máy cục bộ thông qua các quy tắc WORKSPACE. Các quy tắc này có thể kiểm tra xem thư viện nào đã được cài đặt, tải các gói cần tạo xuống và chuẩn bị các cấu phần phần mềm cần thiết để biên dịch. Đối với việc thực thi từ xa, các quy tắc này cũng phải hỗ trợ việc sử dụng các cấu phần phần mềm đã kiểm tra trước để cung cấp thông tin thường được thu thập trong quá trình kiểm tra nền tảng máy chủ. Các cấu phần phần mềm được đánh dấu trước cho phép Bazel mô tả các phần phụ thuộc như thể chúng ở cục bộ. Sử dụng câu lệnh có điều kiện hoặc cờ --override_repository cho việc này.

  • Tạo hoặc biên dịch cấu phần phần mềm dành riêng cho mục tiêu và đột biến nền tảng. Bạn phải thực thi các thao tác này thông qua các quy tắc bản dựng thông thường. Các hành động tạo ra cấu phần phần mềm dành riêng cho mục tiêu cho các phần phụ thuộc bên ngoài phải thực thi trong quá trình xây dựng.

Để dễ dàng tạo các cấu phần phần mềm đã kiểm tra trước cho quá trình thực thi từ xa, bạn có thể sử dụng các quy tắc WORKSPACE để phát các tệp đã tạo. Bạn có thể chạy các quy tắc đó trên mỗi môi trường thực thi mới, chẳng hạn như bên trong mỗi vùng chứa chuỗi công cụ và kiểm tra đầu ra của bản dựng thực thi từ xa vào kho lưu trữ nguồn để tham khảo.

Ví dụ: đối với các quy tắc của Tensorflow cho cuda và python, các quy tắc WORKSPACE sẽ tạo ra BUILD files sau đây. Để thực thi cục bộ, các tệp được tạo bằng cách kiểm tra môi trường máy chủ lưu trữ sẽ được sử dụng. Đối với việc thực thi từ xa, câu lệnh có điều kiện trên một biến môi trường cho phép quy tắc sử dụng các tệp được kiểm tra vào kho lưu trữ.

Các tệp BUILD khai báo genrules có thể chạy cả cục bộ và từ xa, đồng thời thực hiện quá trình xử lý cần thiết trước đây được thực hiện thông qua repository_ctx.symlink như hiển thị tại đây.