Esta página está destinada a los propietarios y encargados del mantenimiento de los repositorios de reglas de Bazel. Se describe cómo configurar el sistema de integración continua (CI) de Bazel para tu repositorio para probar la compatibilidad de tus reglas con una situación de ejecución remota. Las instrucciones de esta página se aplican a los proyectos almacenados en los repositorios de GitHub.
Requisitos previos
Antes de completar los pasos de esta página, asegúrate de hacer lo siguiente:
- El repositorio de GitHub es parte de la organización de GitHub de Bazel.
- Configuraste Buildkite para tu repositorio como se describe en Integración continua de Bazel.
Configura la CI de Bazel para realizar pruebas
En el archivo
.bazelci/presubmit.yml
, haz lo siguiente:a. Agrega una configuración con el nombre
rbe_ubuntu1604
.b. En la configuración de
rbe_ubuntu1604
, agrega los destinos de compilación y prueba con los que quieras probar la ejecución remota.Agrega el repositorio
bazel-toolchains
de GitHub a tu archivoWORKSPACE
, fijado a la versión más reciente. También agrega un destinorbe_autoconfig
con el nombrebuildkite_config
. En este ejemplo, se crea la configuración de la cadena de herramientas para la ejecución remota con BuildKite CI pararbe_ubuntu1604
.
load("@bazel_toolchains//rules:rbe_repo.bzl", "rbe_autoconfig")
rbe_autoconfig(name = "buildkite_config")
Envía una solicitud de extracción con los cambios al archivo
presubmit.yml
. (consulta la solicitud de extracción de ejemplo).Para ver los resultados de compilación, haz clic en Detalles de la verificación de solicitud de extracción de RBE (Ubuntu 16.04) en GitHub, como se muestra en la siguiente figura. Este vínculo estará disponible después de que se combine la solicitud de extracción y se ejecuten las pruebas de CI. (Consulta los ejemplos de resultados).
(Opcional) Configura la verificación bazel test (RBE (Ubuntu 16.04)) como una prueba que se debe aprobar antes de combinar tu regla de protección de ramas. El parámetro de configuración se encuentra en GitHub, en Settings > Branches > Branch protection rules, como se muestra en la siguiente imagen.
Soluciona problemas de compilaciones y pruebas con errores
Si fallan la compilación o las pruebas, es probable que se deba a lo siguiente:
Las herramientas de prueba o compilación obligatorias no están instaladas en el contenedor predeterminado. Las compilaciones que usan la configuración
rbe_ubuntu1604
se ejecutan de forma predeterminada dentro de un contenedorrbe-ubuntu16-04
, que incluye herramientas comunes a muchas compilaciones de Bazel. Sin embargo, si tus reglas requieren herramientas que no están presentes en el contenedor predeterminado, debes crear un contenedor personalizado basado en el contenedorrbe-ubuntu16-04
e incluir esas herramientas como se describe más adelante.Los destinos de compilación o prueba usan reglas que no son compatibles con la ejecución remota. Consulta Adapta las reglas de Bazel para la ejecución remota si quieres obtener detalles sobre la compatibilidad con la ejecución remota.
Usa un contenedor personalizado en la configuración de rbe_ubuntu1604 CI
El contenedor rbe-ubuntu16-04
está disponible públicamente en la siguiente URL:
http://gcr.io/cloud-marketplace/google/rbe-ubuntu16-04
Puedes extraerlo directamente de Container Registry o compilarlo desde el código fuente. En las siguientes secciones, se describen ambas opciones.
Antes de comenzar, asegúrate de haber instalado gcloud
, docker
y git
.
Si compilas el contenedor desde el código fuente, también debes instalar la versión
más reciente de Bazel.
Extrae rbe-ubuntu16-04 de Container Registry
Para extraer el contenedor rbe-ubuntu16-04
de Container Registry, ejecuta el siguiente comando:
gcloud docker -- pull gcr.io/cloud-marketplace/google/rbe-ubuntu16-04@sha256:sha256-checksum
Reemplaza sha256-checksum por el valor de suma de verificación SHA256 del contenedor más reciente.
Compila el contenedor rbe-ubuntu16-04 desde la fuente
Para compilar el contenedor rbe-ubuntu16-04
desde la fuente, haz lo siguiente:
Clona el repositorio
bazel-toolchains
:git clone https://github.com/bazelbuild/bazel-toolchains
Configura los destinos del contenedor de la cadena de herramientas y compila el contenedor como se explica en Contenedores de la cadena de herramientas.
Extrae el contenedor recién compilado:
gcloud docker -- pull gcr.io/project-id/custom-container-namesha256-checksum
Ejecuta el contenedor personalizado
Para ejecutar el contenedor personalizado, realiza una de las siguientes acciones:
Si extrajiste el contenedor de Container Registry, ejecuta el siguiente comando:
docker run -it gcr.io/cloud-marketplace/google/rbe-ubuntu16-04@sha256:sha256-checksum/bin/bash
Reemplaza
sha256-checksum
por el valor de suma de verificación SHA256 para el contenedor más reciente.Si compilaste el contenedor desde la fuente, ejecuta el siguiente comando:
docker run -it gcr.io/project-id/custom-container-name@sha256:sha256sum /bin/bash
Agrega recursos al contenedor personalizado
Usa un objeto Dockerfile
o rules_docker
para agregar recursos o versiones alternativas de los recursos originales al contenedor rbe-ubuntu16-04
.
Si es la primera vez que usas Docker, lee lo siguiente:
Por ejemplo, el siguiente fragmento de Dockerfile
instala 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
Envía el contenedor personalizado a Container Registry
Una vez que hayas personalizado el contenedor, compila la imagen y envíala a Container Registry de la siguiente manera:
Compila la imagen del contenedor:
docker build -t custom-container-name.
docker tag custom-container-name gcr.io/project-id/custom-container-name
Envía la imagen de contenedor a Container Registry:
gcloud docker -- push gcr.io/project-id/custom-container-name
Navega a la siguiente URL para verificar que se envió el contenedor:
https://console.cloud.google.com/gcr/images/project-id/GLOBAL/custom-container-name
Toma nota de la suma de verificación SHA256 de tu contenedor personalizado. Tendrás que proporcionarla más adelante en la definición de tu plataforma de compilación.
Configura el contenedor para el acceso público como se describe en acceso público como se explica en Entrega imágenes de manera pública.
Para obtener más información, consulta Envía y extrae imágenes.
Cómo especificar la definición de la plataforma de compilación
Debes incluir una configuración de plataforma de Bazel en la
configuración de tu cadena de herramientas personalizada, lo que le permite a Bazel seleccionar una cadena de herramientas
adecuada para la plataforma de hardware o software deseada. Para generar
automáticamente una plataforma válida, puedes agregar a tu WORKSPACE
un
destino rbe_autoconfig
con el nombre buildkite_config
que incluya atributos
adicionales para seleccionar tu contenedor personalizado. Para obtener detalles sobre esta configuración, lee la documentación actualizada de rbe_autoconfig
.