Menyesuaikan Aturan Bazel untuk Eksekusi Jarak Jauh

Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.
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.

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 terdistribusi.

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

  • Platform host - tempat Bazel beroperasi.
  • 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 tanpa 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 ini 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 linker, 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 telah 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 tidak sama sekali) di lingkungan eksekusi jarak jauh.

Aturan toolchain saat ini tersedia untuk aturan build dan pengujian Bazel untuk Scala, Rust, dan Go, dan 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 terpisah dari yang lainnya. Beberapa alat build mempertahankan status di seluruh tindakan build dan dependensi akses 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 membuat foo secara lokal, compiler mempertahankan referensi ke output build foo. Kemudian, Bazel memerintahkan compiler untuk membuat bar, yang bergantung pada foo, tanpa menyatakan secara eksplisit bahwa dependensi dalam file BUILD untuk disertakan dalam pemanggilan compiler, tindakan tersebut akan berhasil dijalankan selama instance compiler yang sama dieksekusi untuk kedua tindakan (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 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 Eksekusi Jarak Jauh Bazel dengan Docker Sandbox untuk mengetahui informasi selengkapnya.

Mengelola biner yang bergantung pada platform

Biasanya, biner yang dibuat di platform host tidak dapat dijalankan dengan aman pada platform eksekusi jarak jauh 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 pembuatan kode Anda sehingga menargetkan platform eksekusi jarak jauh. (Lihat logika pemilihan target.)

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

  • Kirimkan atau referensikan kode sumber secara eksternal untuk alat ini agar dapat dibuat untuk platform eksekusi jarak jauh.

  • Instal alat tersebut 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:

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

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

  • Menghubungkan ke 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 symlink dapat diakses dari hierarki runfiles Bazel. Jangan gunakan repository_ctx.symlink untuk membuat symlink file target di luar direktori repo eksternal.

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

Untuk membantu menemukan potensi perilaku non-hermetic, 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 seperti 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 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 dicentang sebelumnya memungkinkan Bazel mendeskripsikan dependensi seolah-olah dependensi tersebut bersifat lokal. Gunakan pernyataan bersyarat atau flag --override_repository untuk ini.

  • Membuat atau mengompilasi mutasi platform dan artefak khusus target. 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 jarak jauh Anda yang dibuat ke repo sumber Anda sebagai referensi.

Misalnya, untuk aturan Tensorflow bagi 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 repo.

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