Halaman ini ditujukan untuk pemilik dan pengelola repositori aturan Bazel. Panduan ini menjelaskan cara mengonfigurasi sistem Bazel Continuous Integration (CI) untuk repositori Anda guna menguji kompatibilitas aturan Anda dengan skenario eksekusi jarak jauh. Petunjuk di halaman ini berlaku untuk project yang disimpan di repositori GitHub.
Prasyarat
Sebelum menyelesaikan langkah-langkah di halaman ini, pastikan hal berikut:
- Repositori GitHub Anda adalah bagian dari organisasi GitHub Bazel.
- Anda telah mengonfigurasi Buildkite untuk repositori seperti yang dijelaskan dalam Bazel Continuous Integration.
Menyiapkan Bazel CI untuk pengujian
Di file
.bazelci/presubmit.yml
Anda, lakukan hal berikut:a. Tambahkan konfigurasi bernama
rbe_ubuntu1604
.b. Di konfigurasi
rbe_ubuntu1604
, tambahkan target build dan pengujian yang ingin Anda uji terhadap eksekusi jarak jauh.Tambahkan repositori GitHub
bazel-toolchains
ke fileWORKSPACE
, yang disematkan ke rilis terbaru. Selain itu, tambahkan targetrbe_autoconfig
dengan namabuildkite_config
. Contoh ini membuat konfigurasi toolchain untuk eksekusi jarak jauh dengan BuildKite CI untukrbe_ubuntu1604
.
load("@bazel_toolchains//rules:rbe_repo.bzl", "rbe_autoconfig")
rbe_autoconfig(name = "buildkite_config")
Kirim permintaan pull dengan perubahan Anda ke file
presubmit.yml
. (Lihat contoh permintaan pull.)Untuk melihat hasil build, klik Details untuk pemeriksaan permintaan pull RBE (Ubuntu 16.04) di GitHub, seperti yang ditunjukkan pada gambar di bawah ini. Link ini akan tersedia setelah permintaan pull digabungkan dan pengujian CI telah dijalankan. (Lihat contoh hasil.)
(Opsional) Tetapkan pemeriksaan bazel test (RBE (Ubuntu 16.04))) sebagai pengujian yang harus lulus sebelum menggabungkan aturan perlindungan cabang Anda. Setelan ini berada di GitHub di Settings > Branches > Branch Protection rules, seperti yang ditunjukkan dalam gambar berikut.
Memecahkan masalah build dan pengujian yang gagal
Jika build atau pengujian Anda gagal, kemungkinan karena hal berikut:
Alat build atau pengujian yang diperlukan tidak diinstal di penampung default. Build yang menggunakan konfigurasi
rbe_ubuntu1604
berjalan secara default di dalam containerrbe-ubuntu16-04
, yang mencakup alat yang umum untuk banyak build Bazel. Namun, jika aturan Anda memerlukan alat yang tidak ada dalam penampung default, Anda harus membuat penampung kustom berdasarkan penampungrbe-ubuntu16-04
dan menyertakan alat tersebut seperti yang akan dijelaskan nanti.Target build atau pengujian menggunakan aturan yang tidak kompatibel dengan eksekusi jarak jauh. Lihat Menyesuaikan Aturan Bazel untuk Eksekusi Jarak Jauh untuk mengetahui detail kompatibilitas dengan eksekusi jarak jauh.
Menggunakan container khusus dalam konfigurasi CI rbe_ubuntu1604
Penampung rbe-ubuntu16-04
tersedia secara publik di URL berikut:
http://gcr.io/cloud-marketplace/google/rbe-ubuntu16-04
Anda dapat mengambilnya langsung dari Container Registry atau mem-build-nya dari sumber. Bagian berikutnya akan menjelaskan kedua opsi tersebut.
Sebelum memulai, pastikan Anda telah menginstal gcloud
, docker
, dan git
.
Jika mem-build container dari sumber, Anda juga harus menginstal
Bazel versi terbaru.
Menarik rbe-ubuntu16-04 dari Container Registry
Untuk menarik container rbe-ubuntu16-04
dari Container Registry, jalankan perintah berikut:
gcloud docker -- pull gcr.io/cloud-marketplace/google/rbe-ubuntu16-04@sha256:sha256-checksum
Ganti sha256-checksum dengan nilai checksum SHA256 untuk container terbaru.
Membangun container rbe-ubuntu16-04 dari sumber
Untuk mem-build penampung rbe-ubuntu16-04
dari sumber, lakukan hal berikut:
Membuat cloning
bazel-toolchains
repositori:git clone https://github.com/bazelbuild/bazel-toolchains
Siapkan target container toolchain dan bangun container seperti yang dijelaskan dalam Container Toolchain.
Ambil container yang baru dibuat:
gcloud docker -- pull gcr.io/project-id/custom-container-namesha256-checksum
Menjalankan container kustom
Untuk menjalankan penampung kustom, lakukan salah satu hal berikut:
Jika Anda menarik container dari Container Registry, jalankan perintah berikut:
docker run -it gcr.io/cloud-marketplace/google/rbe-ubuntu16-04@sha256:sha256-checksum/bin/bash
Ganti
sha256-checksum
dengan nilai checksum SHA256 untuk container terbaru.Jika Anda membangun container dari sumber, jalankan perintah berikut:
docker run -it gcr.io/project-id/custom-container-name@sha256:sha256sum /bin/bash
Menambahkan resource ke penampung kustom
Gunakan Dockerfile
atau
rules_docker
untuk menambahkan resource atau
versi alternatif resource asli ke penampung rbe-ubuntu16-04
.
Jika Anda baru menggunakan Docker, baca artikel berikut:
Misalnya, cuplikan Dockerfile
berikut akan menginstal my_tool_package
:
FROM gcr.io/cloud-marketplace/google/rbe-ubuntu16-04@sha256:sha256-checksum
RUN apt-get update && yes | apt-get install -y my_tool_package
Mengirim container kustom ke Container Registry
Setelah menyesuaikan container, bangun image container dan kirim ke Container Registry seperti berikut:
Build image container:
docker build -t custom-container-name.
docker tag custom-container-name gcr.io/project-id/custom-container-name
Kirim image container ke Container Registry:
gcloud docker -- push gcr.io/project-id/custom-container-name
Buka URL berikut untuk memastikan bahwa penampung telah dikirim:
https://console.cloud.google.com/gcr/images/project-id/GLOBAL/custom-container-name
Catat checksum SHA256 container kustom Anda. Anda harus menyediakannya dalam definisi platform build nanti.
Konfigurasikan penampung untuk akses publik seperti yang dijelaskan dalam akses publik seperti yang dijelaskan dalam Menayangkan gambar secara publik.
Untuk informasi selengkapnya, lihat Mendorong dan Menarik Gambar.
Menentukan definisi platform build
Anda harus menyertakan konfigurasi Bazel platform dalam
konfigurasi toolchain kustom Anda, yang memungkinkan Bazel memilih toolchain
yang sesuai dengan platform hardware/software yang diinginkan. Untuk membuat platform yang valid secara otomatis, Anda dapat menambahkan target rbe_autoconfig
ke WORKSPACE
dengan nama buildkite_config
yang menyertakan atribut tambahan untuk memilih penampung kustom. Untuk mengetahui detail tentang penyiapan ini, baca
dokumentasi terbaru untuk rbe_autoconfig
.