Almacenamiento remoto en caché

Informar un problema Ver código fuente Nocturno · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

En esta página, se abordan el almacenamiento en caché remoto, la configuración de un servidor para alojar la caché y la ejecución de compilaciones con la caché remota.

Un equipo de desarrolladores o un sistema de integración continua (CI) usan una caché remota para compartir los resultados de la compilación. Si tu compilación es reproducible, las salidas de una máquina se pueden reutilizar de forma segura en otra, lo que puede acelerar significativamente las compilaciones.

Descripción general

Bazel divide una compilación en pasos discretos, que se denominan acciones. Cada acción tiene entradas, nombres de salida, una línea de comandos y variables de entorno. Las entradas requeridas y las salidas esperadas se declaran explícitamente para cada acción.

Puedes configurar un servidor para que sea una caché remota para los resultados de la compilación, que son los resultados de estas acciones. Estos resultados consisten en una lista de nombres de archivos de salida y los hashes de su contenido. Con una caché remota, puedes reutilizar los resultados de la compilación de otro usuario en lugar de compilar cada resultado nuevo de forma local.

Para usar el almacenamiento en caché remoto, haz lo siguiente:

  • Configura un servidor como backend de la caché
  • Configura la compilación de Bazel para usar la caché remota
  • Usa la versión 0.10.0 o posterior de Bazel

La caché remota almacena dos tipos de datos:

  • Es la caché de acciones, que es un mapa de hashes de acciones a metadatos de resultados de acciones.
  • Es un almacén direccionable por contenido (CAS) de archivos de salida.

Ten en cuenta que la caché remota también almacena stdout y stderr para cada acción. Por lo tanto, inspeccionar stdout/stderr de Bazel no es un buen indicador para estimar los aciertos de caché.

Cómo usa una compilación la caché remota

Una vez que se configura un servidor como caché remota, puedes usar la caché de varias maneras:

  • Leer y escribir en la caché remota
  • Leer o escribir en la caché remota, excepto para destinos específicos
  • Solo leer desde la caché remota
  • No usar la caché remota en absoluto

Cuando ejecutas una compilación de Bazel que puede leer y escribir en la caché remota, la compilación sigue estos pasos:

  1. Bazel crea el gráfico de los destinos que se deben compilar y, luego, crea una lista de las acciones requeridas. Cada una de estas acciones tiene nombres de archivos de entrada y salida declarados.
  2. Bazel verifica si existen resultados de compilación en tu máquina local y reutiliza los que encuentra.
  3. Bazel verifica la caché para ver si hay resultados de compilación existentes. Si se encuentra el resultado, Bazel lo recupera. Esto es un acierto de caché.
  4. En el caso de las acciones obligatorias en las que no se encontraron los resultados, Bazel ejecuta las acciones de forma local y crea los resultados de compilación necesarios.
  5. Los nuevos resultados de compilación se suben a la caché remota.

Cómo configurar un servidor como backend de la caché

Debes configurar un servidor para que actúe como backend de la caché. Un servidor HTTP/1.1 puede tratar los datos de Bazel como bytes opacos, por lo que muchos servidores existentes se pueden usar como backend de almacenamiento en caché remoto. El protocolo de almacenamiento en caché HTTP de Bazel es lo que admite el almacenamiento en caché remoto.

Eres responsable de elegir, configurar y mantener el servidor de backend que almacenará los resultados en caché. Cuando elijas un servidor, ten en cuenta lo siguiente:

  • Velocidad de la red Por ejemplo, si tu equipo está en la misma oficina, es posible que desees ejecutar tu propio servidor local.
  • Seguridad La caché remota tendrá tus archivos binarios, por lo que debe ser segura.
  • Administración sencilla Por ejemplo, Google Cloud Storage es un servicio completamente administrado.

Hay muchos backends que se pueden usar para una caché remota. Estas son algunas opciones:

nginx

nginx es un servidor web de código abierto. Con su [módulo WebDAV], se puede usar como caché remota para Bazel. En Debian y Ubuntu, puedes instalar el paquete nginx-extras. En macOS, nginx está disponible a través de Homebrew:

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

A continuación, se muestra un ejemplo de configuración para nginx. Ten en cuenta que deberás cambiar /path/to/cache/dir a un directorio válido en el que nginx tenga permiso para escribir y leer. Es posible que debas cambiar la opción client_max_body_size a un valor más grande si tienes archivos de salida más grandes. El servidor requerirá otra configuración, como la autenticación.

Ejemplo de configuración para la sección server en 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 es una caché de compilación remota de código abierto que puedes usar en tu infraestructura. Se ha usado con éxito en producción en varias empresas desde principios de 2018. Ten en cuenta que el proyecto de Bazel no proporciona asistencia técnica para bazel-remote.

Esta caché almacena contenido en el disco y también proporciona recolección de elementos no utilizados para aplicar un límite de almacenamiento superior y limpiar los artefactos no utilizados. La caché está disponible como una [imagen de Docker] y su código está disponible en GitHub. Se admiten las APIs de caché remota de REST y gRPC.

Consulta la página de GitHub para obtener instrucciones sobre cómo usarlo.

Google Cloud Storage

[Google Cloud Storage] es un almacén de objetos completamente administrado que proporciona una API de HTTP compatible con el protocolo de almacenamiento en caché remoto de Bazel. Debes tener una cuenta de Google Cloud con la facturación habilitada.

Para usar Cloud Storage como caché, haz lo siguiente:

  1. Crea un bucket de almacenamiento. Asegúrate de seleccionar la ubicación del bucket más cercana, ya que el ancho de banda de la red es importante para la caché remota.

  2. Crea una cuenta de servicio para que Bazel se autentique en Cloud Storage. Consulta Crea una cuenta de servicio.

  3. Genera una clave JSON secreta y, luego, pásala a Bazel para la autenticación. Almacena la clave de forma segura, ya que cualquier persona que la tenga puede leer y escribir datos arbitrarios en tu bucket de GCS.

  4. Para conectarte a Cloud Storage, agrega las siguientes marcas a tu comando de Bazel:

    • Pasa la siguiente URL a Bazel con la marca --remote_cache=https://storage.googleapis.com/bucket-name, en la que bucket-name es el nombre de tu bucket de almacenamiento.
    • Pasa la clave de autenticación con la marca --google_credentials=/path/to/your/secret-key.json o --google_default_credentials para usar la autenticación de aplicaciones.

  5. Puedes configurar Cloud Storage para que borre automáticamente los archivos antiguos. Para ello, consulta Administra ciclos de vida de objetos.

Otros servidores

Puedes configurar cualquier servidor HTTP/1.1 que admita PUT y GET como backend de la caché. Los usuarios informaron que tuvieron éxito con back-ends de almacenamiento en caché como Hazelcast, Apache httpd y AWS S3.

Autenticación

A partir de la versión 0.11.0, se agregó compatibilidad con la autenticación básica HTTP a Bazel. Puedes pasar un nombre de usuario y una contraseña a Bazel a través de la URL de la caché remota. La sintaxis es https://username:password@hostname.com:port/path. Ten en cuenta que la autenticación básica HTTP transmite el nombre de usuario y la contraseña en texto sin formato a través de la red, por lo que es fundamental usarla siempre con HTTPS.

Protocolo de almacenamiento en caché HTTP

Bazel admite el almacenamiento en caché remoto a través de HTTP/1.1. El protocolo es conceptualmente simple: los datos binarios (BLOB) se suben a través de solicitudes PUT y se descargan a través de solicitudes GET. Los metadatos del resultado de la acción se almacenan en la ruta de acceso /ac/ y los archivos de salida se almacenan en la ruta de acceso /cas/.

Por ejemplo, considera una caché remota que se ejecuta en http://localhost:8080/cache. Una solicitud de Bazel para descargar metadatos de resultados de acciones para una acción con el hash SHA256 01ba4719... se verá de la siguiente manera:

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

Una solicitud de Bazel para subir un archivo de salida con el hash SHA256 15e2b0d3... al CAS se verá de la siguiente manera:

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

0x310x320x330x340x350x360x370x380x39

Ejecuta Bazel con la caché remota

Una vez que se configura un servidor como caché remota, para usarla, debes agregar marcas a tu comando de Bazel. Consulta la lista de configuraciones y sus marcas a continuación.

Es posible que también debas configurar la autenticación, que es específica del servidor que elijas.

Te recomendamos que agregues estas marcas en un archivo .bazelrc para que no tengas que especificarlas cada vez que ejecutes Bazel. Según tu proyecto y la dinámica del equipo, puedes agregar marcas a un archivo .bazelrc que cumpla con las siguientes condiciones:

  • En tu máquina local
  • En el espacio de trabajo de tu proyecto, compartido con el equipo
  • En el sistema de CI

Leer y escribir en la caché remota

Ten cuidado con quién tiene la capacidad de escribir en la caché remota. Es posible que solo quieras que tu sistema de CI pueda escribir en la caché remota.

Usa la siguiente marca para leer y escribir en la caché remota:

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

Además de HTTP, también se admiten los siguientes protocolos: HTTPS, grpc y grpcs.

Usa la siguiente marca además de la anterior para leer solo desde la caché remota:

build --remote_upload_local_results=false

Cómo excluir destinos específicos del uso de la caché remota

Para excluir destinos específicos del uso de la caché remota, etiquétalos con no-remote-cache. Por ejemplo:

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

Borra contenido de la caché remota

Borrar contenido de la caché remota es parte de la administración del servidor. La forma en que borras contenido de la caché remota depende del servidor que configuraste como caché. Cuando borres resultados, borra toda la caché o los resultados antiguos.

Los resultados almacenados en caché se almacenan como un conjunto de nombres y hashes. Cuando se borra contenido, no hay forma de distinguir qué salida pertenece a una compilación específica.

Es posible que desees borrar contenido de la caché por los siguientes motivos:

  • Cómo crear una caché limpia después de que se haya contaminado
  • Reduce la cantidad de almacenamiento utilizado borrando los resultados antiguos

Sockets Unix

La caché HTTP remota admite la conexión a través de sockets de dominio Unix. El comportamiento es similar a la marca --unix-socket de curl. Usa lo siguiente para configurar el socket de dominio de Unix:

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

Esta función no es compatible con Windows.

Caché de disco

Bazel puede usar un directorio en el sistema de archivos como caché remota. Esto es útil para compartir artefactos de compilación cuando se cambian de ramas o se trabaja en varios espacios de trabajo del mismo proyecto, como varias verificaciones. Dado que Bazel no realiza la recolección de basura del directorio, es posible que desees automatizar una limpieza periódica de este directorio. Habilita la caché de disco de la siguiente manera:

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

Puedes pasar una ruta de acceso específica del usuario a la marca --disk_cache con el alias ~ (Bazel sustituirá el directorio principal del usuario actual). Esto resulta útil cuando se habilita la caché de disco para todos los desarrolladores de un proyecto a través del archivo .bazelrc confirmado del proyecto.

Problemas conocidos

Modificación del archivo de entrada durante una compilación

Cuando se modifica un archivo de entrada durante una compilación, es posible que Bazel suba resultados no válidos a la caché remota. Puedes habilitar la detección de cambios con la marca --experimental_guard_against_concurrent_changes. No hay problemas conocidos y se habilitará de forma predeterminada en una versión futura. Consulta el [problema núm. 3360] para obtener actualizaciones. En general, evita modificar los archivos fuente durante una compilación.

Las variables de entorno se filtran en una acción

Una definición de acción contiene variables de entorno. Esto puede ser un problema para compartir aciertos de caché remotos entre máquinas. Por ejemplo, los entornos con variables $PATH diferentes no compartirán aciertos de caché. Solo las variables de entorno incluidas explícitamente en la lista blanca a través de --action_env se incluyen en una definición de acción. El paquete de Debian/Ubuntu de Bazel que se usa para instalar /etc/bazel.bazelrc con una lista de entidades permitidas de variables de entorno, incluida $PATH. Si obtienes menos aciertos de caché de los esperados, verifica que tu entorno no tenga un archivo /etc/bazel.bazelrc antiguo.

Bazel no realiza un seguimiento de las herramientas fuera de un lugar de trabajo

Actualmente, Bazel no realiza un seguimiento de las herramientas fuera de un espacio de trabajo. Esto puede ser un problema si, por ejemplo, una acción usa un compilador de /usr/bin/. Luego, dos usuarios con diferentes compiladores instalados compartirán de forma incorrecta los aciertos de caché, ya que los resultados son diferentes, pero tienen el mismo hash de acción. Consulta el problema 4558 para obtener actualizaciones.

El estado incremental en la memoria se pierde cuando se ejecutan compilaciones dentro de contenedores de Docker Bazel usa una arquitectura de cliente/servidor incluso cuando se ejecuta en un solo contenedor de Docker. En el servidor, Bazel mantiene un estado en la memoria que acelera las compilaciones. Cuando se ejecutan compilaciones dentro de contenedores de Docker, como en la CI, se pierde el estado en la memoria y Bazel debe volver a compilarlo antes de usar la caché remota.