Menyesuaikan Aturan Bazel untuk Eksekusi Jarak Jauh

Laporkan masalah Lihat sumber {/18/}{/1/}

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

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

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

  • Platform host - tempat Bazel berjalan.
  • 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 dijalankan dari jarak jauh tanpa error. Hal ini disebabkan oleh sifat dari 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 sesuai untuk lingkungan eksekusi jarak jauh.

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

Memanggil alat build melalui aturan toolchain

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

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

Mengelola dependensi implisit

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

Misalnya, saat Bazel memerintahkan compiler stateful untuk membangun foo secara lokal, compiler akan mempertahankan referensi ke output build foo. Kemudian, Bazel menginstruksikan compiler untuk membangun bar, yang bergantung pada foo, tanpa menyatakan secara eksplisit dependensi tersebut dalam file BUILD untuk disertakan dalam pemanggilan compiler, tindakan akan berhasil dijalankan selama instance compiler yang sama dieksekusi untuk kedua tindakan (seperti biasa untuk eksekusi lokal). Namun, karena dalam skenario eksekusi jarak jauh, setiap tindakan build mengeksekusi instance compiler yang 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 yang sama untuk dependensi seperti eksekusi jarak jauh. Gunakan sandbox untuk menyiapkan build Anda untuk eksekusi jarak jauh dengan mengidentifikasi dan menyelesaikan error build terkait dependensi. Lihat Memecahkan masalah Bazel Remote Execution dengan Docker Sandbox untuk mengetahui informasi selengkapnya.

Mengelola biner yang bergantung pada platform

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

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

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

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

Mengelola aturan WORKSPACE bergaya konfigurasi

Aturan WORKSPACE Bazel dapat digunakan untuk memeriksa platform host 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 yang dilakukan oleh aturan WORKSPACE berikut tidak kompatibel dengan eksekusi jarak jauh:

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

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

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

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

Untuk membantu menemukan potensi perilaku non-hermetik, 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:

  • Pemeriksaan platform dan enumerasi dependensi. Operasi ini aman untuk dijalankan secara lokal melalui aturan WORKSPACE, yang dapat memeriksa library mana yang diinstal, mendownload paket yang harus dibangun, 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 dieksekusi 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 ke repo sumber untuk menjadi referensi.

Misalnya, untuk aturan Tensorflow untuk cuda dan python, aturan WORKSPACE 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 di-check in 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 ditampilkan di sini.