Menyesuaikan Aturan Bazel untuk Eksekusi Jarak Jauh

Laporkan masalah Lihat sumber

Halaman ini ditujukan bagi pengguna Bazel yang menulis aturan build dan pengujian kustom yang ingin memahami persyaratan aturan Bazel dalam konteks eksekusi jarak jauh.

Dengan eksekusi jarak jauh, Bazel dapat menjalankan tindakan pada platform terpisah, seperti pusat data. Bazel menggunakan protokol gRPC untuk eksekusi jarak jauhnya. Anda dapat mencoba eksekusi jarak jauh menggunakan bazel-buildfarm, project open source yang bertujuan untuk menyediakan platform eksekusi jarak jauh terdistribusi.

Halaman ini menggunakan terminologi berikut saat merujuk ke berbagai jenis lingkungan atau platform:

  • Platform host - tempat Bazel dijalankan.
  • Platform eksekusi - tempat tindakan Bazel dijalankan.
  • Platform target - tempat output build (dan beberapa tindakan) dijalankan.

Ringkasan

Saat mengonfigurasi build Bazel untuk eksekusi jarak jauh, Anda harus mengikuti panduan yang dijelaskan di halaman ini untuk memastikan build dieksekusi dari jarak jauh bebas error. Hal ini disebabkan oleh sifat eksekusi jarak jauh, yaitu:

  • Tindakan build yang terisolasi. Alat build tidak mempertahankan status dan dependensi tidak dapat bocor di antara keduanya.

  • Lingkungan eksekusi yang beragam. Konfigurasi build lokal tidak selalu cocok untuk lingkungan eksekusi jarak jauh.

Halaman ini menjelaskan masalah yang dapat muncul saat menerapkan aturan build dan pengujian Bazel kustom untuk eksekusi jarak jauh dan cara menghindarinya. Topik yang dibahas mencakup topik berikut:

Memanggil alat build melalui aturan toolchain

Aturan toolchain Bazel adalah penyedia konfigurasi yang memberi tahu aturan build tentang alat build, seperti compiler dan penaut, yang akan digunakan dan cara mengonfigurasinya menggunakan parameter yang ditentukan oleh pembuat aturan. Aturan toolchain memungkinkan aturan build dan pengujian memanggil alat build dengan cara yang dapat diprediksi dan telah dikonfigurasi sebelumnya yang kompatibel dengan eksekusi jarak jauh. Misalnya, gunakan aturan toolchain dan bukan memanggil alat build melalui PATH, JAVA_HOME, atau variabel lokal lainnya yang mungkin tidak ditetapkan ke nilai yang setara (atau sama sekali) dalam lingkungan eksekusi jarak jauh.

Aturan toolchain saat ini ada untuk aturan build dan pengujian Bazel untuk Scala, Rust, dan Go, serta aturan toolchain baru sedang berlangsung untuk bahasa dan alat lain seperti bash. Jika aturan toolchain tidak ada untuk alat yang digunakan aturan Anda, pertimbangkan untuk membuat aturan toolchain.

Mengelola dependensi implisit

Jika alat build dapat mengakses dependensi di seluruh tindakan build, tindakan tersebut akan gagal saat dijalankan dari jarak jauh karena setiap tindakan build jarak jauh dijalankan secara terpisah dari yang lain. Beberapa alat build mempertahankan status di seluruh tindakan build dan dependensi dependensi yang belum disertakan secara eksplisit dalam pemanggilan alat, yang akan menyebabkan tindakan build yang dieksekusi dari jarak jauh gagal.

Misalnya, saat Bazel menginstruksikan compiler stateful untuk mem-build foo secara lokal, compiler akan mempertahankan referensi ke output build foo. Jika Bazel kemudian memerintahkan compiler untuk membuat bar, yang bergantung pada foo, tanpa secara eksplisit menyatakan dependensi tersebut dalam file BUILD untuk penyertaan dalam pemanggilan compiler, tindakan tersebut akan berhasil dieksekusi selama instance compiler yang sama dieksekusi untuk kedua tindakan tersebut (seperti yang biasa terjadi pada eksekusi lokal). Namun, karena dalam skenario eksekusi jarak jauh, setiap tindakan build akan mengeksekusi instance compiler terpisah, status compiler dan dependensi implisit bar pada foo akan hilang dan build akan gagal.

Untuk membantu mendeteksi dan menghilangkan masalah dependensi ini, Bazel 0.14.1 menawarkan sandbox Docker lokal, yang memiliki batasan dependensi yang sama dengan eksekusi jarak jauh. Gunakan sandbox untuk mempersiapkan build Anda untuk eksekusi jarak jauh dengan mengidentifikasi dan mengatasi error build yang terkait dengan dependensi. Baca Memecahkan Masalah Bazel Remote Execution dengan Docker Sandbox untuk mengetahui informasi lebih lanjut.

Mengelola biner yang bergantung pada platform

Biasanya, biner yang dibuat di platform host tidak dapat dieksekusi dengan aman pada platform eksekusi jarak jauh yang arbitrer karena dependensi yang berpotensi tidak cocok. Misalnya, biner SingleJar yang disediakan dengan Bazel menargetkan platform host. Namun, untuk eksekusi jarak jauh, SingleJar harus dikompilasi sebagai bagian dari proses proses pembuatan kode Anda sehingga menargetkan platform eksekusi jarak jauh. (Lihat logika pemilihan target.)

Jangan mengirimkan biner alat build yang diperlukan oleh build dengan kode sumber, kecuali jika Anda yakin alat tersebut akan berjalan dengan aman di platform eksekusi. Sebagai gantinya, lakukan salah satu dari hal berikut:

  • Mengirimkan atau mereferensikan kode sumber ke alat secara eksternal agar dapat dibuat untuk platform eksekusi jarak jauh.

  • Instal alat terlebih dahulu di lingkungan eksekusi jarak jauh (misalnya, container toolchain) jika alat ini cukup stabil dan gunakan aturan toolchain untuk menjalankannya di build Anda.

Mengelola aturan WORKSPACE bergaya konfigurasi

Aturan WORKSPACE Bazel dapat digunakan untuk memeriksa platform host bagi alat dan library yang diperlukan oleh build, yang juga merupakan platform eksekusi Bazel untuk build lokal. Jika build secara eksplisit bergantung pada alat dan artefak build lokal, build akan gagal selama eksekusi jarak jauh jika platform eksekusi jarak jauh tidak identik dengan platform host.

Tindakan berikut yang dilakukan oleh aturan WORKSPACE tidak kompatibel dengan eksekusi jarak jauh:

  • Membuat biner. Mengeksekusi tindakan kompilasi dalam aturan WORKSPACE menghasilkan biner yang tidak kompatibel dengan platform eksekusi jarak jauh jika berbeda dari platform host.

  • Menginstal pip paket. Paket pip yang diinstal melalui aturan WORKSPACE mengharuskan dependensinya diinstal di platform host terlebih dahulu. Paket tersebut, yang dibuat khusus untuk platform host, tidak akan kompatibel dengan platform eksekusi jarak jauh jika berbeda dengan platform host.

  • Menghubungkan ke alat atau artefak lokal. Symlink ke alat atau library yang diinstal di platform host yang dibuat melalui aturan WORKSPACE akan menyebabkan build gagal di platform eksekusi jarak jauh karena Bazel tidak akan dapat menemukannya. Sebagai gantinya, buat symlink menggunakan tindakan build standar sehingga alat dan library symlink dapat diakses dari hierarki runfiles Bazel. Jangan gunakan repository_ctx.symlink untuk membuat file target symlink di luar direktori repo eksternal.

  • Mengubah platform platform. Hindari membuat file di luar hierarki runfiles Bazel, membuat variabel lingkungan, dan tindakan serupa, karena dapat berperilaku tidak terduga di platform eksekusi jarak jauh.

Untuk membantu menemukan perilaku non-hermetik yang potensial, Anda dapat menggunakan log aturan Workspace.

Jika dependensi eksternal mengeksekusi operasi tertentu yang bergantung pada platform host, Anda harus membagi operasi tersebut antara WORKSPACE dan aturan build sebagai berikut:

  • Enumerasi pemeriksaan dan dependensi platform. Operasi ini aman untuk dijalankan secara lokal melalui aturan WORKSPACE, yang dapat memeriksa library mana yang diinstal, mendownload paket yang harus di-build, dan menyiapkan artefak yang diperlukan untuk kompilasi. Untuk eksekusi jarak jauh, aturan ini juga harus mendukung penggunaan artefak yang telah diperiksa sebelumnya untuk memberikan informasi yang biasanya akan diperoleh selama pemeriksaan platform host. Artefak yang telah diperiksa sebelumnya memungkinkan Bazel mendeskripsikan dependensi seolah-olah dependensi tersebut bersifat lokal. Gunakan pernyataan bersyarat atau flag --override_repository untuk ini.

  • Membuat atau mengompilasi artefak khusus target dan mutasi platform. Operasi ini harus dijalankan melalui aturan build reguler. Tindakan yang menghasilkan artefak khusus target untuk dependensi eksternal harus dijalankan selama build.

Agar lebih mudah membuat artefak yang telah diperiksa sebelumnya untuk eksekusi jarak jauh, Anda dapat menggunakan aturan WORKSPACE untuk memunculkan file yang dihasilkan. Anda dapat menjalankan aturan tersebut di setiap lingkungan eksekusi baru, seperti di dalam setiap container toolchain, dan memeriksa output build eksekusi jarak jauh yang ada di repositori sumber sebagai referensi.

Misalnya, untuk aturan Tensorflow bagi cuda dan python, aturan WORKSPACE akan menghasilkan BUILD files berikut. Untuk eksekusi lokal, file yang dihasilkan dengan memeriksa lingkungan host akan digunakan. Untuk eksekusi jarak jauh, pernyataan bersyarat pada variabel lingkungan memungkinkan aturan menggunakan file yang dimasukkan ke dalam repo.

File BUILD mendeklarasikan genrules yang dapat berjalan secara lokal dan jarak jauh, serta melakukan pemrosesan yang diperlukan yang sebelumnya dilakukan melalui repository_ctx.symlink seperti yang ditunjukkan di sini.