Menyimpan ke Cache Jarak Jauh

7/0.9/2.5. Lihat sumber Nightly {/3/}

Halaman ini membahas caching jarak jauh, menyiapkan server untuk menghosting cache, dan menjalankan build menggunakan cache jarak jauh.

Cache jarak jauh digunakan oleh tim developer dan/atau sistem continuous integration (CI) untuk berbagi output build. Jika build Anda dapat direproduksi, output dari satu mesin dapat digunakan kembali dengan aman di komputer lain, sehingga dapat mempercepat proses build.

Ringkasan

Bazel memecah build menjadi langkah-langkah terpisah, yang disebut tindakan. Setiap tindakan memiliki input, nama output, command line, dan variabel lingkungan. Input yang diperlukan dan output yang diharapkan dideklarasikan secara eksplisit untuk setiap tindakan.

Anda dapat menyiapkan server agar menjadi cache jarak jauh untuk output build, yang merupakan output tindakan ini. Output ini terdiri dari daftar nama file output dan hash kontennya. Dengan cache jarak jauh, Anda dapat menggunakan kembali output build dari build pengguna lain, bukan membangun setiap output baru secara lokal.

Untuk menggunakan penyimpanan cache jarak jauh:

  • Menyiapkan server sebagai backend cache
  • Mengonfigurasi build Bazel untuk menggunakan cache jarak jauh
  • Gunakan Bazel versi 0.10.0 atau yang lebih baru

Cache jarak jauh menyimpan dua jenis data:

  • Cache tindakan, yang merupakan peta hash tindakan ke metadata hasil tindakan.
  • Penyimpanan alamat konten (CAS) dari file output.

Perhatikan bahwa cache jarak jauh juga menyimpan stdout dan stderr untuk setiap tindakan. Memeriksa stdout/stderr Bazel bukan merupakan sinyal yang baik untuk memperkirakan hit cache.

Cara build menggunakan cache jarak jauh

Setelah server disiapkan sebagai cache jarak jauh, Anda menggunakan cache dengan beberapa cara:

  • Membaca dan menulis ke cache jarak jauh
  • Membaca dan/atau menulis ke cache jarak jauh kecuali untuk target tertentu
  • Hanya baca dari cache jarak jauh
  • Tidak menggunakan cache jarak jauh sama sekali

Saat Anda menjalankan build Bazel yang dapat membaca dan menulis ke cache jarak jauh, build tersebut akan mengikuti langkah-langkah berikut:

  1. Bazel membuat grafik target yang perlu dibuat, lalu membuat daftar tindakan yang diperlukan. Setiap tindakan ini telah mendeklarasikan nama file input dan output.
  2. Bazel memeriksa output build yang ada di komputer Anda dan menggunakan kembali output build yang ditemukannya.
  3. Bazel memeriksa cache untuk output build yang ada. Jika {i>output<i} ditemukan, Bazel akan mengambil {i>output<i} tersebut. Ini menyebabkan cache ditemukan.
  4. Untuk tindakan yang diperlukan jika output tidak ditemukan, Bazel mengeksekusi tindakan secara lokal dan membuat output build yang diperlukan.
  5. Output build baru diupload ke cache jarak jauh.

Menyiapkan server sebagai backend cache

Anda harus menyiapkan server untuk bertindak sebagai backend cache. Server HTTP/1.1 dapat memperlakukan data Bazel sebagai byte buram dan banyak server yang ada dapat digunakan sebagai backend penyimpanan cache jarak jauh. Protokol Caching HTTP Bazel adalah fitur yang mendukung penyimpanan cache jarak jauh.

Anda bertanggung jawab untuk memilih, menyiapkan, dan memelihara server backend yang akan menyimpan output yang di-cache. Saat memilih server, pertimbangkan:

  • Kecepatan jaringan. Misalnya, jika tim Anda berada di kantor yang sama, sebaiknya jalankan server lokal Anda sendiri.
  • Keamanan. Cache jarak jauh akan memiliki biner Anda, sehingga harus aman.
  • Kemudahan pengelolaan. Misalnya, Google Cloud Storage adalah layanan terkelola sepenuhnya.

Ada banyak backend yang dapat digunakan untuk cache jarak jauh. Beberapa opsinya meliputi:

nginx

nginx adalah server web {i>open source<i}. Dengan [modul WebDAV], modul ini dapat digunakan sebagai cache jarak jauh untuk Bazel. Di Debian dan Ubuntu, Anda dapat menginstal paket nginx-extras. Di macOS, nginx tersedia melalui Homebrew:

brew tap denji/nginx
brew install nginx-full --with-webdav

Di bawah ini adalah contoh konfigurasi untuk nginx. Perhatikan bahwa Anda harus mengubah /path/to/cache/dir ke direktori yang valid tempat nginx memiliki izin untuk menulis dan membaca. Anda mungkin perlu mengubah opsi client_max_body_size ke nilai yang lebih besar jika memiliki file output yang lebih besar. Server akan memerlukan konfigurasi lain seperti autentikasi.

Contoh konfigurasi untuk bagian server di nginx.conf:

location /cache/ {
  # The path to the directory where nginx should store the cache contents.
  root /path/to/cache/dir;
  # Allow PUT
  dav_methods PUT;
  # Allow nginx to create the /ac and /cas subdirectories.
  create_full_put_path on;
  # The maximum size of a single file.
  client_max_body_size 1G;
  allow all;
}

bazel-remote

bazel-remote adalah cache build jarak jauh open source yang dapat digunakan pada infrastruktur Anda. telah berhasil digunakan dalam produksi beberapa perusahaan sejak awal 2018. Perhatikan bahwa project Bazel tidak menyediakan dukungan teknis untuk bazel-remote.

Cache ini menyimpan konten di disk dan juga menyediakan pembersihan sampah memori untuk memberlakukan batas penyimpanan atas dan membersihkan artefak yang tidak digunakan. Cache tersedia sebagai [image Docker] dan kodenya tersedia di GitHub. API cache jarak jauh REST dan gRPC didukung.

Lihat halaman GitHub untuk mendapatkan petunjuk cara menggunakannya.

Google Cloud Storage

[Google Cloud Storage] adalah penyimpanan objek terkelola sepenuhnya yang menyediakan HTTP API yang kompatibel dengan protokol caching jarak jauh Bazel. Anda harus memiliki akun Google Cloud dengan penagihan diaktifkan.

Untuk menggunakan Cloud Storage sebagai cache:

  1. Membuat bucket penyimpanan. Pastikan untuk memilih lokasi bucket yang terdekat dengan lokasi Anda, karena bandwidth jaringan penting untuk cache jarak jauh.

  2. Buat akun layanan untuk Bazel guna melakukan autentikasi ke Cloud Storage. Lihat Membuat akun layanan.

  3. Membuat kunci JSON rahasia, lalu meneruskannya ke Bazel untuk autentikasi. Simpan kunci dengan aman, karena siapa pun yang memiliki kunci tersebut dapat membaca dan menulis data arbitrer ke/dari bucket GCS Anda.

  4. Hubungkan ke Cloud Storage dengan menambahkan flag berikut ke perintah Bazel Anda:

    • Teruskan URL berikut ke Bazel dengan menggunakan tanda: --remote_cache=https://storage.googleapis.com/bucket-name dengan bucket-name adalah nama bucket penyimpanan Anda.
    • Teruskan kunci autentikasi menggunakan flag: --google_credentials=/path/to/your/secret-key.json atau --google_default_credentials untuk menggunakan Autentikasi Aplikasi.

  5. Anda dapat mengonfigurasi Cloud Storage agar otomatis menghapus file lama. Untuk melakukannya, lihat Mengelola Siklus Proses Objek.

Server lainnya

Anda dapat menyiapkan server HTTP/1.1 yang mendukung PUT dan GET sebagai backend cache. Pengguna telah melaporkan keberhasilan dengan backend caching seperti Hazelcast, Apache httpd, dan AWS S3.

Autentikasi

Pada versi 0.11.0 dukungan untuk Otentikasi Dasar HTTP telah ditambahkan ke Bazel. Anda dapat meneruskan nama pengguna dan sandi ke Bazel melalui URL cache jarak jauh. Sintaksisnya adalah https://username:password@hostname.com:port/path. Perhatikan bahwa Autentikasi Dasar HTTP mengirimkan nama pengguna dan sandi dalam teks biasa melalui jaringan, sehingga sangat penting untuk selalu menggunakannya dengan HTTPS.

Protokol caching HTTP

Bazel mendukung pembuatan cache jarak jauh melalui HTTP/1.1. Protokolnya sederhana secara konsep: Data biner (BLOB) diupload melalui permintaan PUT dan didownload melalui permintaan GET. Metadata hasil tindakan disimpan di jalur /ac/ dan file output disimpan di jalur /cas/.

Misalnya, pertimbangkan cache jarak jauh yang berjalan di http://localhost:8080/cache. Permintaan Bazel untuk mendownload metadata hasil tindakan bagi tindakan dengan hash SHA256 01ba4719... akan terlihat sebagai berikut:

GET /cache/ac/01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b HTTP/1.1
Host: localhost:8080
Accept: */*
Connection: Keep-Alive

Permintaan Bazel untuk mengupload file output dengan hash SHA256 15e2b0d3... ke CAS akan terlihat seperti berikut:

PUT /cache/cas/15e2b0d3c33891ebb0f1ef609ec419420c20e320ce94c65fbc8c3312448eb225 HTTP/1.1
Host: localhost:8080
Accept: */*
Content-Length: 9
Connection: Keep-Alive

0x310x320x330x340x350x360x370x380x39

Menjalankan Bazel menggunakan cache jarak jauh

Setelah server disiapkan sebagai cache jarak jauh, Anda harus menambahkan flag ke perintah Bazel untuk menggunakan cache jarak jauh. Lihat daftar konfigurasi dan tandanya di bawah ini.

Anda mungkin juga perlu mengonfigurasi autentikasi, yang dikhususkan untuk server yang Anda pilih.

Sebaiknya tambahkan tanda ini dalam file .bazelrc sehingga Anda tidak perlu menentukannya setiap kali menjalankan Bazel. Bergantung pada project dan dinamika tim, Anda dapat menambahkan flag ke file .bazelrc yang:

  • Di komputer lokal Anda
  • Di ruang kerja project Anda, dibagikan kepada tim
  • Pada sistem CI

Membaca dari dan menulis ke cache jarak jauh

Berhati-hatilah terhadap siapa yang memiliki kemampuan untuk menulis ke cache jarak jauh. Anda mungkin hanya ingin sistem CI Anda yang dapat menulis ke cache jarak jauh.

Gunakan tanda berikut untuk membaca dari dan menulis ke cache jarak jauh:

build --remote_cache=http://your.host:port

Selain HTTP, protokol berikut juga didukung: HTTPS, grpc, grpcs.

Selain tanda di atas, gunakan flag berikut untuk hanya membaca dari cache jarak jauh:

build --remote_upload_local_results=false

Mengecualikan target tertentu agar tidak menggunakan cache jarak jauh

Untuk mengecualikan target tertentu agar tidak menggunakan cache jarak jauh, beri tag target dengan no-remote-cache. Contoh:

java_library(
    name = "target",
    tags = ["no-remote-cache"],
)

Menghapus konten dari cache jarak jauh

Menghapus konten dari cache jarak jauh adalah bagian dari pengelolaan server Anda. Cara menghapus konten dari cache jarak jauh bergantung pada server yang telah Anda siapkan sebagai cache. Saat menghapus output, hapus seluruh cache, atau hapus output lama.

Output yang di-cache disimpan sebagai sekumpulan nama dan hash. Saat menghapus konten, tidak ada cara untuk membedakan output mana yang dimiliki oleh build tertentu.

Anda dapat menghapus konten dari cache untuk:

  • Membuat cache bersih setelah cache diubah
  • Mengurangi jumlah penyimpanan yang digunakan dengan menghapus output lama

Soket Unix

Cache HTTP jarak jauh mendukung koneksi melalui soket domain unix. Perilaku ini mirip dengan flag --unix-socket curl. Gunakan perintah berikut untuk mengonfigurasi soket domain unix:

   build --remote_cache=http://your.host:port
   build --remote_proxy=unix:/path/to/socket

Fitur ini tidak didukung di Windows.

Cache disk

Bazel dapat menggunakan direktori pada sistem file sebagai {i>cache<i} jarak jauh. Hal ini berguna untuk membagikan artefak build saat beralih cabang dan/atau bekerja di beberapa ruang kerja dari project yang sama, seperti beberapa checkout. Karena Bazel tidak melakukan pembersihan sampah memori direktori, Anda mungkin perlu mengotomatiskan pembersihan berkala direktori ini. Aktifkan cache disk sebagai berikut:

build --disk_cache=path/to/build/cache

Anda dapat meneruskan jalur khusus pengguna ke tanda --disk_cache menggunakan alias ~ (Bazel akan menggantikan direktori beranda pengguna saat ini). Hal ini berguna saat mengaktifkan cache disk untuk semua developer project melalui file .bazelrc yang telah diperiksa oleh project.

Masalah umum

Modifikasi file input selama build

Jika file input diubah selama proses build, Bazel mungkin mengupload hasil yang tidak valid ke cache jarak jauh. Anda dapat mengaktifkan deteksi perubahan dengan flag --experimental_guard_against_concurrent_changes. Tidak ada masalah umum dan hal ini akan diaktifkan secara default pada rilis mendatang. Lihat [masalah #3360] untuk mengetahui info terbaru. Secara umum, hindari mengubah file sumber selama build.

Variabel lingkungan bocor ke dalam tindakan

Definisi tindakan berisi variabel lingkungan. Hal ini dapat menjadi masalah untuk berbagi hit cache jarak jauh di beberapa komputer. Misalnya, lingkungan dengan variabel $PATH yang berbeda tidak akan membagikan hit cache. Hanya variabel lingkungan yang diizinkan secara eksplisit melalui --action_env yang disertakan dalam definisi tindakan. Paket Debian/Ubuntu Bazel digunakan untuk menginstal /etc/bazel.bazelrc dengan daftar variabel lingkungan yang diizinkan, termasuk $PATH. Jika Anda mendapatkan lebih sedikit cache yang ditemukan dari yang diharapkan, periksa apakah lingkungan Anda tidak memiliki file /etc/bazel.bazelrc lama.

Bazel tidak memantau alat di luar ruang kerja

Bazel saat ini tidak memantau alat di luar ruang kerja. Hal ini dapat menjadi masalah jika, misalnya, tindakan menggunakan compiler dari /usr/bin/. Kemudian, dua pengguna yang menginstal compiler berbeda akan salah membagikan hit cache karena outputnya berbeda, tetapi memiliki hash tindakan yang sama. Lihat masalah #4558 untuk mengetahui info terbaru.

Status inkremental dalam memori hilang saat menjalankan build di dalam container docker Bazel menggunakan arsitektur server/klien bahkan saat berjalan di container docker tunggal. Di sisi server, Bazel mempertahankan status dalam memori yang mempercepat build. Saat menjalankan build di dalam container docker seperti di CI, status dalam memori akan hilang dan Bazel harus membangunnya kembali sebelum menggunakan cache jarak jauh.