หน้านี้มีไว้สำหรับเจ้าของและผู้ดูแลที่เก็บกฎของ Bazel ซึ่งจะอธิบายวิธีกำหนดค่าระบบ Bazel Continuous Integration (CI) สำหรับที่เก็บเพื่อทดสอบความเข้ากันได้กับสถานการณ์การดำเนินการระยะไกล วิธีการในหน้านี้ใช้กับโปรเจ็กต์ที่เก็บไว้ในที่เก็บของ GitHub
สิ่งที่ต้องดำเนินการก่อน
ก่อนทำตามขั้นตอนในหน้านี้ โปรดตรวจสอบสิ่งต่อไปนี้
- ที่เก็บ GitHub เป็นส่วนหนึ่งของ องค์กร Bazel GitHub
- คุณได้กำหนดค่า Buildkite สำหรับที่เก็บตามที่อธิบายไว้ในการผสานรวม Bazel Continuous
การตั้งค่า Bazel CI สำหรับการทดสอบ
ในไฟล์
.bazelci/presubmit.yml
ให้ทำตามขั้นตอนต่อไปนี้a. เพิ่มการกำหนดค่าชื่อ
rbe_ubuntu1604
b. ในการกำหนดค่า
rbe_ubuntu1604
ให้เพิ่มบิลด์และทดสอบเป้าหมายที่ต้องการทดสอบกับการดำเนินการจากระยะไกลเพิ่มที่เก็บ
bazel-toolchains
GitHub ลงในไฟล์WORKSPACE
ซึ่งปักหมุดไว้กับรุ่นล่าสุด และเพิ่มเป้าหมายrbe_autoconfig
ที่มีชื่อว่าbuildkite_config
ด้วย ตัวอย่างนี้สร้างการกำหนดค่า Toolchain สำหรับการดำเนินการระยะไกลด้วย BuildKite CI สำหรับrbe_ubuntu1604
load("@bazel_toolchains//rules:rbe_repo.bzl", "rbe_autoconfig")
rbe_autoconfig(name = "buildkite_config")
ส่งคำขอพุลที่มีการเปลี่ยนแปลงไปยังไฟล์
presubmit.yml
(ดูตัวอย่างการดึงคำขอ)หากต้องการดูผลลัพธ์ของบิลด์ ให้คลิกรายละเอียดสำหรับการตรวจสอบการดึงคำขอ RBE (Ubuntu 16.04) ใน GitHub ดังที่แสดงในรูปด้านล่าง โดยลิงก์นี้จะพร้อมใช้งานหลังจากผสานคำขอพุลและทำการทดสอบ CI แล้ว (ดูผลลัพธ์ตัวอย่าง)
(ไม่บังคับ) ตั้งค่าการตรวจสอบ Bazel test (RBE (Ubuntu 16.04)) เป็นการทดสอบที่จำเป็นในการผ่านก่อนที่จะผสานรวมในกฎการปกป้องสาขา การตั้งค่านี้จะอยู่ใน GitHub ในการตั้งค่า > สาขา > กฎการป้องกัน Branch ดังที่แสดงในรูปต่อไปนี้
การแก้ปัญหาการสร้างและการทดสอบที่ล้มเหลว
หากบิลด์หรือการทดสอบไม่สำเร็จ อาจเกิดจากสาเหตุต่อไปนี้
ไม่ได้ติดตั้งเครื่องมือสร้างหรือเครื่องมือทดสอบที่จำเป็นในคอนเทนเนอร์เริ่มต้น บิลด์โดยใช้การกำหนดค่า
rbe_ubuntu1604
ที่เรียกใช้โดยค่าเริ่มต้นภายในคอนเทนเนอร์rbe-ubuntu16-04
ซึ่งมีเครื่องมือที่พบได้ทั่วไปในบิลด์มากมายของ Bazel อย่างไรก็ตาม หากกฎกำหนดให้เครื่องมือที่ไม่มีอยู่ในคอนเทนเนอร์เริ่มต้น คุณต้องสร้างคอนเทนเนอร์ที่กำหนดเองตามคอนเทนเนอร์rbe-ubuntu16-04
และรวมเครื่องมือเหล่านั้นตามที่อธิบายไว้ในภายหลังสร้างหรือทดสอบเป้าหมายกำลังใช้กฎที่เข้ากันไม่ได้กับการดำเนินการระยะไกล ดูรายละเอียดเกี่ยวกับความเข้ากันได้กับการดำเนินการระยะไกลได้ในการปรับกฎ Bazel สำหรับการดำเนินการระยะไกล
การใช้คอนเทนเนอร์ที่กำหนดเองในการกำหนดค่า rbe_ubuntu1604 CI
คอนเทนเนอร์ rbe-ubuntu16-04
พร้อมใช้งานแบบสาธารณะที่ URL ต่อไปนี้
http://gcr.io/cloud-marketplace/google/rbe-ubuntu16-04
คุณสามารถดึงข้อมูลโดยตรงจาก Container Registry หรือสร้างจากต้นทาง ส่วนถัดไปจะอธิบายตัวเลือกทั้งสอง
ก่อนเริ่มต้น โปรดตรวจสอบว่าคุณได้ติดตั้ง gcloud
, docker
และ git
แล้ว
หากกำลังสร้างคอนเทนเนอร์จากต้นทาง คุณต้องติดตั้ง Bazel เวอร์ชันล่าสุดด้วย
ดึง rbe-ubuntu16-04 จาก Container Registry
หากต้องการดึงคอนเทนเนอร์ rbe-ubuntu16-04
จาก Container Registry ให้เรียกใช้คำสั่งต่อไปนี้
gcloud docker -- pull gcr.io/cloud-marketplace/google/rbe-ubuntu16-04@sha256:sha256-checksum
แทนที่ sha256-checksum ด้วยค่าผลรวมตรวจสอบ SHA256 สำหรับคอนเทนเนอร์ล่าสุด
การสร้างคอนเทนเนอร์ rbe-ubuntu16-04 จากต้นทาง
หากต้องการสร้างคอนเทนเนอร์ rbe-ubuntu16-04
จากต้นทาง ให้ทำตามขั้นตอนต่อไปนี้
โคลนที่เก็บ
bazel-toolchains
:git clone https://github.com/bazelbuild/bazel-toolchains
ตั้งค่าเป้าหมายคอนเทนเนอร์ Toolchain และสร้างคอนเทนเนอร์ตามที่อธิบายไว้ในคอนเทนเนอร์ Toolchain
ดึงคอนเทนเนอร์ที่เพิ่งสร้างใหม่
gcloud docker -- pull gcr.io/project-id/custom-container-namesha256-checksum
การเรียกใช้คอนเทนเนอร์ที่กำหนดเอง
หากต้องการเรียกใช้คอนเทนเนอร์ที่กำหนดเอง ให้ทำอย่างใดอย่างหนึ่งต่อไปนี้
ถ้าคุณดึงคอนเทนเนอร์จาก Container Registry ให้เรียกใช้คำสั่งต่อไปนี้
docker run -it gcr.io/cloud-marketplace/google/rbe-ubuntu16-04@sha256:sha256-checksum/bin/bash
แทนที่
sha256-checksum
ด้วยค่าผลรวมตรวจสอบ SHA256 สำหรับคอนเทนเนอร์ล่าสุดถ้าคุณสร้างคอนเทนเนอร์จากต้นทาง ให้เรียกใช้คำสั่งต่อไปนี้
docker run -it gcr.io/project-id/custom-container-name@sha256:sha256sum /bin/bash
การเพิ่มทรัพยากรลงในคอนเทนเนอร์ที่กำหนดเอง
ใช้ Dockerfile
หรือ rules_docker
เพื่อเพิ่มทรัพยากรหรือเวอร์ชันทางเลือกของทรัพยากรเดิมลงในคอนเทนเนอร์ rbe-ubuntu16-04
หากคุณเพิ่งเริ่มใช้ Docker ให้อ่านข้อมูลต่อไปนี้
ตัวอย่างเช่น ข้อมูลโค้ด Dockerfile
ต่อไปนี้จะติดตั้ง 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
การพุชคอนเทนเนอร์ที่กำหนดเองไปยัง Container Registry
เมื่อคุณปรับแต่งคอนเทนเนอร์แล้ว ให้สร้างอิมเมจคอนเทนเนอร์และพุชไปยัง Container Registry ดังนี้
สร้างอิมเมจคอนเทนเนอร์โดยใช้คำสั่งต่อไปนี้
docker build -t custom-container-name.
docker tag custom-container-name gcr.io/project-id/custom-container-name
พุชอิมเมจคอนเทนเนอร์ไปยัง Container Registry ด้วยคำสั่งต่อไปนี้
gcloud docker -- push gcr.io/project-id/custom-container-name
ไปที่ URL ต่อไปนี้เพื่อยืนยันว่าได้พุชคอนเทนเนอร์แล้ว
https://console.cloud.google.com/gcr/images/project-id/GLOBAL/custom-container-name
จดบันทึกตรวจสอบข้อผิดพลาด SHA256 ของคอนเทนเนอร์ที่กำหนดเอง คุณจะต้องระบุข้อมูลดังกล่าวในคำจำกัดความของแพลตฟอร์มบิลด์ในภายหลัง
กำหนดค่าคอนเทนเนอร์สำหรับการเข้าถึงแบบสาธารณะตามที่อธิบายไว้ในการแสดงรูปภาพแบบสาธารณะ
สำหรับข้อมูลเพิ่มเติม โปรดดู การดันและดึงรูปภาพ
การระบุคำจำกัดความของแพลตฟอร์มบิลด์
คุณต้องรวมการกำหนดค่าแพลตฟอร์ม Bazel ในการกำหนดค่า Toolchain ที่กำหนดเอง ซึ่งช่วยให้ Bazel เลือกเครื่องมือเชนที่เหมาะกับแพลตฟอร์มฮาร์ดแวร์/ซอฟต์แวร์ที่ต้องการได้ หากต้องการสร้างแพลตฟอร์มที่ถูกต้องโดยอัตโนมัติ คุณสามารถเพิ่มเป้าหมาย rbe_autoconfig
ที่มีชื่อ buildkite_config
ลงใน WORKSPACE
ซึ่งมีแอตทริบิวต์เพิ่มเติมเพื่อเลือกคอนเทนเนอร์ที่กำหนดเอง อ่านรายละเอียดเกี่ยวกับการตั้งค่านี้ได้ในเอกสารประกอบฉบับล่าสุดของ rbe_autoconfig