Memecahkan Masalah Bazel Remote Execution dengan Docker Sandbox

Laporkan masalah Lihat sumber Per malam · 7,4 kami. 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Build Bazel yang berhasil secara lokal dapat gagal saat dieksekusi dari jarak jauh karena batasan dan persyaratan yang tidak memengaruhi build lokal. Paling umum penyebab kegagalan tersebut dijelaskan dalam Mengadaptasi Aturan Bazel untuk Eksekusi Jarak Jauh.

Halaman ini menjelaskan cara mengidentifikasi dan menyelesaikan masalah paling umum yang timbul dengan eksekusi jarak jauh menggunakan fitur {i>sandbox<i} Docker, yang menerapkan batasan atas build yang sama dengan eksekusi jarak jauh. Hal ini memungkinkan Anda untuk memecahkan masalah build Anda tanpa perlu layanan eksekusi jarak jauh.

Fitur sandbox Docker meniru batasan eksekusi jarak jauh sebagai berikut:

• Tindakan build dijalankan di penampung toolchain. Anda dapat menggunakan container toolchain untuk menjalankan build Anda secara lokal dan jarak jauh melalui layanan yang mendukung eksekusi jarak jauh dalam container.

• Tidak ada data yang tidak relevan yang melintasi batas penampung. Hanya secara eksplisit input dan output yang dideklarasikan masuk dan keluar dari container, dan hanya setelah tindakan build terkait berhasil diselesaikan.

• Setiap tindakan dijalankan di penampung baru. Penampung baru yang unik dibuat untuk setiap tindakan build yang dihasilkan.

Catatan: Build memerlukan lebih banyak waktu untuk diselesaikan saat sandbox Docker diaktifkan. Hal ini normal.

Anda dapat memecahkan masalah ini menggunakan salah satu metode berikut:

• Memecahkan masalah secara native. Dengan metode ini, Bazel dan tindakan build-nya berjalan secara native di komputer lokal Anda. Docker fitur sandbox menerapkan pembatasan pada build yang sama dengan build dalam proses eksekusi. Namun, metode ini tidak akan mendeteksi alat, status, dan data lokal yang bocor ke build Anda, yang akan menyebabkan masalah pada eksekusi jarak jauh.

• Memecahkan masalah di container Docker. Dengan metode ini, Bazel dan tindakan build-nya berjalan di dalam kontainer Docker, yang memungkinkan Anda mendeteksi alat, status, dan kebocoran data dari ke dalam build, selain menerapkan batasan sama dengan eksekusi jarak jauh. Metode ini memberikan wawasan tentang build meskipun sebagian build gagal. Metode ini bersifat eksperimental dan tidak didukung secara resmi.

Prasyarat

Sebelum Anda mulai memecahkan masalah, lakukan hal berikut jika Anda belum melakukannya:

• Instal Docker dan konfigurasikan izin yang diperlukan untuk menjalankannya.
• Instal Bazel 0.14.1 atau yang lebih baru. Versi sebelumnya tidak mendukung Docker fitur sandbox Anda.
• Tambahkan repo bazel-toolchains, yang disematkan ke versi rilis terbaru, ke file WORKSPACE build seperti yang dijelaskan di sini.
• Tambahkan tanda ke file .bazelrc untuk mengaktifkan fitur. Membuat file di direktori {i>root<i} dari proyek Bazel Anda jika tidak ada. Tanda di bawah adalah sampel referensi. Lihat info terbaru .bazelrc dalam repo bazel-toolchains dan salin nilai tanda yang ditentukan di sana untuk konfigurasi docker-sandbox.

# Docker Sandbox Mode
build:docker-sandbox --host_javabase=<...>
build:docker-sandbox --javabase=<...>
build:docker-sandbox --crosstool_top=<...>
build:docker-sandbox --experimental_docker_image=<...>
build:docker-sandbox --spawn_strategy=docker --strategy=Javac=docker --genrule_strategy=docker
build:docker-sandbox --define=EXECUTOR=remote
build:docker-sandbox --experimental_docker_verbose
build:docker-sandbox --experimental_enable_docker_sandbox

Catatan: Tanda yang dirujuk dalam file .bazelrc yang ditampilkan di atas dikonfigurasi untuk dijalankan di dalam rbe-ubuntu16-04 .

Jika aturan Anda memerlukan alat tambahan, lakukan hal berikut:

1. Buat container Docker kustom dengan menginstal alat menggunakan Dockerfile dan mem-build image secara lokal.

2. Ganti nilai flag --experimental_docker_image di atas dengan nilai image container kustom Anda.

Memecahkan masalah secara native

Metode ini mengeksekusi Bazel dan semua tindakan build-nya langsung di mesin lokal dan merupakan cara yang andal untuk mengonfirmasi apakah build Anda akan berhasil saat dijalankan dari jarak jauh.

Akan tetapi, dengan metode ini, alat, biner, dan data yang diinstal secara lokal dapat bocor ke dalam build Anda, terutama jika menggunakan aturan WORKSPACE bergaya konfigurasi. Kebocoran tersebut akan menyebabkan masalah pada eksekusi jarak jauh; untuk mendeteksinya, pecahkan masalah dalam penampung Docker selain memecahkan masalah secara native.

Langkah 1: Jalankan build

1. Tambahkan flag --config=docker-sandbox ke perintah Bazel yang menjalankan build Anda. Contoh:

   bazel --bazelrc=.bazelrc build --config=docker-sandbox target
   

2. Jalankan build dan tunggu hingga selesai. Build akan berjalan hingga empat kali lebih lambat dari biasanya karena fitur sandbox Docker.

Anda mungkin mengalami error berikut:

ERROR: 'docker' is an invalid value for docker spawn strategy.

Jika ya, jalankan build lagi dengan flag --experimental_docker_verbose. Flag ini mengaktifkan pesan error panjang. Error ini biasanya disebabkan oleh penginstalan Docker yang rusak atau kurangnya izin untuk menjalankannya di bawah akun pengguna saat ini. Lihat dokumentasi Docker untuk informasi selengkapnya. Jika masalah berlanjut, lanjutkan ke Pemecahan masalah di container Docker.

Langkah 2: Selesaikan masalah yang terdeteksi

Berikut ini adalah masalah yang paling umum terjadi dan solusinya.

• File, alat, biner, atau resource yang dirujuk oleh hierarki runfile Bazel adalah tidak ada.. Pastikan semua dependensi target yang terpengaruh telah dideklarasikan secara eksplisit. Lihat Mengelola dependensi implisit untuk informasi selengkapnya.

• File, alat, biner, atau resource yang dirujuk oleh jalur absolut atau PATH variabel tidak ada. Pastikan bahwa semua alat yang diperlukan telah diinstal dalam container toolchain dan menggunakan aturan toolchain untuk mendeklarasikan dependensi yang mengarah ke sumber daya yang hilang. Lihat Memanggil alat build melalui aturan toolchain untuk mengetahui informasi selengkapnya.

• Eksekusi biner gagal. Salah satu aturan build mereferensikan biner dan tidak kompatibel dengan lingkungan eksekusi (container Docker). Lihat Mengelola biner yang bergantung pada platform untuk mengetahui informasi selengkapnya. Jika Anda tidak dapat menyelesaikan masalah, hubungi [e-mail] untuk mendapatkan bantuan.

• File dari @local-jdk tidak ada atau menyebabkan error. Biner Java di komputer lokal Anda bocor ke build saat tidak kompatibel dengan build tersebut. Gunakan java_toolchain di aturan dan target Anda, bukan @local_jdk. Hubungi [e-mail] jika Anda memerlukan bantuan lebih lanjut.

• Error lainnya. Hubungi [e-mail] untuk mendapatkan bantuan.

Pemecahan masalah di container Docker

Dengan metode ini, Bazel berjalan di dalam container Docker host, dan tindakan build Bazel dijalankan di dalam setiap container toolchain yang dihasilkan oleh fitur sandbox Docker. Sandbox memunculkan container toolchain baru untuk masing-masing dan hanya satu tindakan yang akan dieksekusi di setiap container toolchain.

Metode ini memberikan kontrol yang lebih terperinci atas alat yang diinstal di host lingkungan fleksibel App Engine. Dengan memisahkan eksekusi build dari eksekusinya tindakan membangun dan menjaga alat yang diinstal seminimal mungkin, Anda dapat memverifikasi apakah build memiliki dependensi di lingkungan eksekusi lokal.

Langkah 1: Bangun container

Catatan: Perintah di bawah disesuaikan secara khusus untuk basis debian:stretch. Untuk basis lain, ubah seperlunya.

1. Buat Dockerfile yang membuat penampung Docker dan menginstal Bazel dengan kumpulan alat build minimal:

   FROM debian:stretch
   
   RUN apt-get update && apt-get install -y apt-transport-https curl software-properties-common git gcc gnupg2 g++ openjdk-8-jdk-headless python-dev zip wget vim
   
   RUN curl -fsSL https://download.docker.com/linux/debian/gpg | apt-key add -
   
   RUN add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/debian $(lsb_release -cs) stable"
   
   RUN apt-get update && apt-get install -y docker-ce
   
   RUN wget https://releases.bazel.build/<latest Bazel version>/release/bazel-<latest Bazel version>-installer-linux-x86_64.sh -O ./bazel-installer.sh && chmod 755 ./bazel-installer.sh
   
   RUN ./bazel-installer.sh
   

2. Bangun container sebagai bazel_container:

   docker build -t bazel_container - < Dockerfile
   

Langkah 2: Mulai penampung

Mulai container Docker menggunakan perintah yang ditunjukkan di bawah ini. Dalam perintah tersebut, mengganti jalur ke kode sumber pada {i>host<i} Anda yang ingin Anda bangun.

docker run -it \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /tmp:/tmp \
  -v your source code directory:/src \
  -w /src \
  bazel_container \
  /bin/bash

Perintah ini menjalankan container sebagai root, memetakan soket docker, dan memasang direktori /tmp. Hal ini memungkinkan Bazel membuat container Docker lain dan menggunakan direktori di /tmp untuk berbagi file dengan container tersebut. Kode sumber Anda tersedia di /src di dalam penampung.

Perintah sengaja dimulai dari penampung dasar debian:stretch yang menyertakan biner yang tidak kompatibel dengan penampung rbe-ubuntu16-04 yang digunakan sebagai penampung toolchain. Jika biner dari lingkungan lokal bocor ke dalam penampung toolchain, biner tersebut akan menyebabkan error build.

Langkah 3: Uji penampung

Jalankan perintah berikut dari dalam penampung Docker untuk mengujinya:

docker ps
bazel version

Langkah 4: Jalankan build

Jalankan build seperti yang ditunjukkan di bawah ini. Pengguna {i>output<i} adalah {i>root<i} sehingga sesuai dengan direktori yang dapat diakses dengan jalur absolut yang sama dari dalam {i>host<i} container yang digunakan Bazel, dari container toolchain yang dihasilkan oleh Docker fitur {i>sandbox<i} di mana tindakan {i>build<i} Bazel berjalan, dan dari komputer tempat kontainer {i>host<i} dan tindakan dijalankan.

bazel --output_user_root=/tmp/bazel_docker_root --bazelrc=.bazelrc \ build --config=docker-sandbox target

Langkah 5: Selesaikan masalah yang terdeteksi

Anda dapat mengatasi kegagalan build sebagai berikut:

• Jika build gagal dengan error "ruang disk habis", Anda dapat meningkatkan batas ini dengan memulai penampung host dengan flag --memory=XX dengan XX adalah ruang disk yang dialokasikan dalam gigabyte. Fitur ini bersifat eksperimental dan dapat menghasilkan perilaku yang tidak dapat diprediksi.

• Jika build gagal selama fase analisis atau pemuatan, satu atau beberapa aturan build yang dideklarasikan dalam file WORKSPACE tidak kompatibel dengan eksekusi jarak jauh. Lihat Mengadaptasi Aturan Bazel untuk Eksekusi Jarak Jauh untuk mengetahui penyebab dan solusinya.

• Jika build gagal karena alasan lain, lihat langkah pemecahan masalah di Langkah 2: Selesaikan masalah yang terdeteksi.