Thích ứng với các quy tắc Bazel để thực thi từ xa

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

Trang này dành cho những người dùng Bazel đang viết các quy tắc xây dựng và thử nghiệm tuỳ chỉnh. Họ muốn hiểu các yêu cầu đối với quy tắc Bazel trong quá trình thực thi từ xa.

Việc 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 biệt, 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 được phân phối.

Trang này sử dụng thuật ngữ sau đây 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 tổ chức – nơi Bazel chạy.
  • Nền tảng thực thi – nơi chạy các hành động Bazel.
  • Nền tảng mục tiêu – nơi chạy bản dựng (và một số hành động).

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 được thực thi từ xa mà không gặp lỗi. Điều này là do tính chất của việc thực thi từ xa, cụ thể là:

  • Các hành động tạo bản dựng tách 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ể bị rò rỉ giữa các trạng thái đó.

  • 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 các quy tắc tạo và kiểm thử Bazel tuỳ chỉnh để thực thi từ xa và cách tránh các quy tắc này. Chủ đề này bao gồm các chủ đề sau:

Gọi các công cụ bản 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 cần sử dụng công cụ xây dựng nào, chẳng hạn như trình biên dịch và trình liên kết, và cách định cấu hình các công cụ đó bằng các tham số do người tạo quy tắc xác định. Quy tắc chuỗi công cụ cho phép các quy tắc kiểm thử và xây dựng gọi các công cụ xây dựng theo cách có thể dự đoán, được định cấu hình sẵn, tương thích với quá trình 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 giá trị tương đương (hoặc hoàn toàn) trong môi trường thực thi từ xa.

Các quy tắc chuỗi công cụ hiện dành cho các quy tắc tạo và kiểm thử Bazel cho Scala, Rust và Go cũng như các quy tắc mới của chuỗi công cụ đang được áp dụng cho các ngôn ngữ và công cụ khác như bash. Nếu quy tắc chuỗi công cụ không tồn tại cho công cụ mà quy tắc của bạn sử dụng, hãy xem xét 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 hành động xây dựng, thì các hành động đó sẽ không thành công khi được thực thi từ xa vì mỗi hành động xây dựng từ xa được thực thi riêng biệt với các hành động khác. Một số công cụ xây dựng giữ lại trạng thái trên các hành động xây dựng và các phần phụ thuộc truy cập 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 hành động 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 trạng thái tạo foo cục bộ, trình biên dịch sẽ giữ lại các 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 thanh, phần phụ thuộc vào foo, mà không nêu rõ rằng phần phụ thuộc đó trong tệp BUILD để đưa vào lệnh gọi trình biên dịch, hành động sẽ thực thi thành công miễn là cùng một bản sao trình biên dịch thực thi cho cả hai hành động (như thông thường để thực thi cục bộ). Tuy nhiên, vì trong trường hợp thực thi từ xa, mỗi hành động tạo bản dựng sẽ thực thi một bản sao 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 định của bar trên foo sẽ bị mất và bản dựng sẽ không thể hoạt độ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ộ. Hộp cát này có các hạn chế tương tự đối với các phần phụ thuộc như thực thi từ xa. Sử dụng hộp cát để chuẩn bị bản dựng để thực thi từ xa bằng cách xác định và giải quyết các lỗi bản dựng liên quan đến phần phụ thuộc. Xem phần Khắc phục sự cố thực thi từ xa trên Bazel bằng Hộp cát Docker để biết thêm thông tin.

Quản lý 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 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, SingleJar phải được biên dịch trong quá trình xây dựng mã để nhắm mục tiêu nền tảng thực thi từ xa. (Xem logic lựa chọn mục tiêu.)

Đừng gửi tệp nhị phân của các công cụ bản dựng mà bản dựng yêu cầu bằng mã nguồn của bạn trừ khi bạn chắc chắn rằng các công cụ đó sẽ chạy an toàn trong nền tảng thực thi của mình. Thay vào đó, hãy thực hiện một trong những thao tác sau:

  • Giao hàng hoặc tham chiếu mã nguồn cho công cụ để có thể tạo mã công cụ cho nền tảng thực thi từ xa.

  • Cài đặt sẵn công cụ này 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 quy tắc chuỗi công cụ để chạy công cụ này trong bản dựng.

Quản lý 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 máy chủ 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ụ xây dựng và cấu phần phần mềm cục bộ, nó sẽ không hoạt độ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 thao tác sau đây do quy tắc WORKSPACE thực hiện không tương thích với quá trình thực thi từ xa:

  • Xây dựng tệp nhị phân. Việc thực thi các hành động biên dịch trong quy tắc WORKSPACE dẫn đến 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 qua quy tắc WORKSPACE yêu cầu phải cài đặt sẵn các phần phụ thuộc trên nền tảng máy chủ. Các gói như vậy, được xây dựng 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ữ.

  • Liên kết đến công cụ hoặc cấu phần phần mềm cục bộ. Các liên kết đến 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 này không hoạt động trên nền tảng thực thi từ xa vì Bazel sẽ không thể xác định các vị trí đó. Thay vào đó, hãy tạo các đường liên kết tượng trưng bằng cách sử dụng hành động xây dựng chuẩn để có thể truy cập vào các công cụ và thư viện liên kết 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 repo bên ngoài.

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

Để tìm những hành vi có thể không mang tính đóng gói, bạn có thể sử dụng nhật ký quy tắc 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 lưu trữ, bạn nên phân tách các thao tác đó giữa WORKSPACE và các quy tắc xây dựng như sau:

  • Kiểm tra nền tảng và liệt kê phần phụ thuộc. Những thao tác này an toàn để thực thi cục bộ thông qua các quy tắc WORKSPACE. Các quy tắc này giúp kiểm tra xem thư viện nào được cài đặt, các gói phải tải xuống và phải chuẩn bị các cấu phần phần mềm cần thiết để biên dịch. Để thực thi từ xa, các quy tắc này cũng phải hỗ trợ việc sử dụng cấu phần phần mềm được đánh dấu sẵn để cung cấp thông tin thường có được trong quá trình kiểm tra nền tảng máy chủ lưu trữ. Cấu phần phần mềm được đánh dấu sẵn cho phép Bazel mô tả các phần phụ thuộc như thể chúng là cục bộ. Sử dụng câu lệnh có điều kiện hoặc cờ --override_repository để thực hiện 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. Những thao tác này phải được thực thi thông qua quy tắc tạo bản dựng thông thường. Các hành động tạo ra cấu phần phần mềm mục tiêu dành riêng 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ấu phần phần mềm được kiểm tra trước để thực thi từ xa, bạn có thể sử dụng các quy tắc WORKSPACE để phát hành các tệp được tạo. Bạn có thể chạy các quy tắc đó trên từng 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 kết quả của bản dựng thực thi từ xa trong kho lưu trữ nguồn để tham chiếu.

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 lưu trữ sẽ được sử dụng. Để thực thi từ xa, một 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 đánh dấu 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 đó thông qua repository_ctx.symlink như minh hoạ tại đây.