원격 캐싱

컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.
문제 신고 소스 보기

이 페이지에서는 원격 캐싱, 캐시를 호스팅하도록 서버 설정, 원격 캐시를 사용한 빌드 실행에 대해 다룹니다.

원격 캐시는 개발자팀 또는 지속적 통합(CI) 시스템에서 빌드 출력을 공유하는 데 사용됩니다. 빌드를 재현할 수 있는 경우 한 머신의 출력을 다른 머신에서 안전하게 재사용할 수 있으므로 빌드 속도가 훨씬 빨라질 수 있습니다.

개요

Bazel은 빌드를 개별 단계(작업이라고 함)로 나눕니다. 각 작업에는 입력, 출력 이름, 명령줄, 환경 변수가 있습니다. 필수 입력 및 예상 출력은 각 작업에 대해 명시적으로 선언됩니다.

작업 출력을 빌드 출력의 원격 캐시로 설정할 수 있습니다. 이러한 출력은 출력 파일 이름 목록과 해당 콘텐츠의 해시로 구성됩니다. 원격 캐시를 사용하면 새 출력을 각각 로컬로 빌드하는 대신 다른 사용자의 빌드에서 빌드 출력을 재사용할 수 있습니다.

원격 캐싱을 사용하려면 다음 단계를 따르세요.

  • 서버를 캐시의 백엔드로 설정
  • 원격 캐시를 사용하도록 Bazel 빌드 구성
  • Bazel 버전 0.10.0 이상 사용

원격 캐시는 다음 두 가지 유형의 데이터를 저장합니다.

  • 작업 캐시는 작업 결과 메타데이터에 대한 작업 해시의 매핑입니다.
  • 출력 파일의 콘텐츠 주소 지정 저장소 (CAS)입니다.

원격 캐시는 모든 작업에 대해 stdout 및 stderr를 추가로 저장합니다. 따라서 Bazel의 stdout/stderr 검사는 캐시 적중 추정에 유용한 신호가 아닙니다.

빌드에서 원격 캐싱을 사용하는 방법

서버가 원격 캐시로 설정되면 다음과 같은 여러 방법으로 캐시를 사용합니다.

  • 원격 캐시 읽기 및 쓰기
  • 특정 대상을 제외하고 원격 캐시 읽기 또는 쓰기
  • 원격 캐시에서만 읽기
  • 원격 캐시 사용 안함

원격 캐시에 읽고 쓸 수 있는 Bazel 빌드를 실행할 때 빌드는 다음 단계를 따릅니다.

  1. Bazel은 빌드해야 할 대상의 그래프를 생성한 후 필요한 작업 목록을 만듭니다. 이러한 각 작업에는 입력 및 출력 파일 이름이 선언되어 있습니다.
  2. Bazel은 로컬 머신의 기존 빌드 출력을 확인하고 찾은 출력을 재사용합니다.
  3. Bazel은 캐시에 기존 빌드 출력이 있는지 확인합니다. 출력이 발견되면 Bazel이 출력을 검색합니다. 캐시 적중입니다.
  4. 출력을 찾을 수 없는 필수 작업의 경우 Bazel이 로컬에서 작업을 실행하고 필요한 빌드 출력을 만듭니다.
  5. 새 빌드 출력이 원격 캐시에 업로드됩니다.

서버를 캐시의 백엔드로 설정

캐시의 백엔드 역할을 하도록 서버를 설정해야 합니다. HTTP/1.1 서버는 Bazel 데이터를 불투명한 바이트로 처리할 수 있으며 많은 기존 서버를 원격 캐싱 백엔드로 사용할 수 있습니다. Bazel의 HTTP 캐싱 프로토콜은 원격 캐싱을 지원합니다.

캐시된 출력을 저장할 백엔드 서버를 선택, 설정, 유지관리하는 것은 사용자의 책임입니다. 서버를 선택할 때 고려할 사항

  • 네트워킹 속도. 예를 들어 팀이 같은 사무실에 있는 경우 자체 로컬 서버를 실행하는 것이 좋습니다.
  • 보안 원격 캐시에는 바이너리가 있으므로 안전해야 합니다.
  • 손쉬운 관리. 예를 들어 Google Cloud Storage는 완전 관리형 서비스입니다.

원격 캐시에 사용할 수 있는 백엔드가 많습니다. 다음은 몇 가지 옵션입니다.

nginx

nginx는 오픈소스 웹 서버입니다. [WebDAV 모듈]을 사용하여 Bazel의 원격 캐시로 사용할 수 있습니다. Debian 및 Ubuntu에서 nginx-extras 패키지를 설치할 수 있습니다. macOS nginx의 경우 Homebrew를 통해 사용할 수 있습니다.

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

다음은 nginx의 구성 예입니다. /path/to/cache/dir를 nginx에 쓰기 및 읽기 권한이 있는 유효한 디렉터리로 변경해야 합니다. 출력 파일이 큰 경우 client_max_body_size 옵션을 더 큰 값으로 변경해야 할 수 있습니다. 서버에는 인증과 같은 다른 구성이 필요합니다.

nginx.confserver 섹션 구성 예:

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는 인프라에서 사용할 수 있는 오픈소스 원격 빌드 캐시입니다. 2018년 초부터 여러 회사의 프로덕션에서 성공적으로 사용되었습니다. Bazel 프로젝트는 bazel-remote에 대한 기술 지원을 제공하지 않습니다.

이 캐시는 콘텐츠를 디스크에 저장하고 가비지 컬렉션을 제공하여 저장용량 한도를 높이고 사용하지 않는 아티팩트를 정리합니다. 캐시는 [Docker 이미지] 로 제공되며 코드는 GitHub에서 제공됩니다. REST API와 gRPC 원격 캐시 API가 모두 지원됩니다.

사용 방법은 GitHub 페이지를 참조하세요.

Google Cloud Storage

[Google Cloud Storage] 는 Bazel의 원격 캐싱 프로토콜과 호환되는 HTTP API를 제공하는 완전 관리형 객체 저장소입니다. 결제를 사용 설정한 Google Cloud 계정이 있어야 합니다.

Cloud Storage를 캐시로 사용하려면 다음 안내를 따르세요.

  1. 스토리지 버킷을 만듭니다. 네트워크 대역폭은 원격 캐시에 중요하므로 가장 가까운 버킷 위치를 선택해야 합니다.

  2. Bazel이 Cloud Storage에 인증할 서비스 계정을 만듭니다. 서비스 계정 만들기를 참조하세요.

  3. 보안 비밀 JSON 키를 생성한 다음 인증을 위해 Bazel에 전달합니다. 키가 있는 모든 사용자가 GCS 버킷에서 임의의 데이터를 읽고 쓸 수 있으므로 키를 안전하게 저장합니다.

  4. Bazel 명령어에 다음 플래그를 추가하여 Cloud Storage에 연결합니다.

    • --remote_cache=https://storage.googleapis.com/bucket-name 플래그를 사용하여 Bazel에 다음 URL을 전달합니다. 여기서 bucket-name은 스토리지 버킷의 이름입니다.
    • --google_credentials=/path/to/your/secret-key.json 플래그를 사용하여 인증 키를 전달하거나 --google_default_credentials를 사용하여 애플리케이션 인증을 사용합니다.
  5. 오래된 파일을 자동으로 삭제하도록 Cloud Storage를 구성할 수 있습니다. 자세한 내용은 객체 수명 주기 관리를 참조하세요.

기타 서버

PUT 및 GET을 지원하는 HTTP/1.1 서버를 캐시의 백엔드로 설정할 수 있습니다. 사용자가 Hazelcast, Apache httpd, AWS S3과 같은 백엔드를 캐시하는 데 성공했다고 보고했습니다.

인증

버전 0.11.0부터 HTTP 기본 인증 지원이 Bazel에 추가되었습니다. 원격 캐시 URL을 통해 Bazel에 사용자 이름과 비밀번호를 전달할 수 있습니다. 구문은 https://username:password@hostname.com:port/path입니다. HTTP 기본 인증은 네트워크를 통해 사용자 이름과 비밀번호를 일반 텍스트로 전송하므로 항상 HTTPS와 함께 사용하는 것이 중요합니다.

HTTP 캐싱 프로토콜

Bazel은 HTTP/1.1을 통한 원격 캐싱을 지원합니다. 프로토콜은 개념적으로 간단합니다. 바이너리 데이터 (BLOB)는 PUT 요청을 통해 업로드되고 GET 요청을 통해 다운로드됩니다. 작업 결과 메타데이터는 /ac/ 경로에 저장되고 출력 파일은 /cas/ 경로에 저장됩니다.

예를 들어 http://localhost:8080/cache 아래에서 실행되는 원격 캐시를 가정해 보겠습니다. SHA256 해시 01ba4719...를 사용하여 작업의 작업 결과 메타데이터를 다운로드하는 Bazel 요청은 다음과 같습니다.

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

SHA256 해시 15e2b0d3...를 사용하여 출력 파일을 CAS에 업로드하려는 Bazel 요청은 다음과 같습니다.

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

0x310x320x330x340x350x360x370x380x39

원격 캐시를 사용하여 Bazel 실행

서버가 원격 캐시로 설정된 후 원격 캐시를 사용하려면 Bazel 명령어에 플래그를 추가해야 합니다. 아래의 구성 목록과 관련 플래그를 참조하세요.

선택한 서버에 한정되는 인증을 구성해야 할 수도 있습니다.

Bazel을 실행할 때마다 이러한 플래그를 지정할 필요가 없도록 이러한 플래그를 .bazelrc 파일에 추가할 수 있습니다. 프로젝트 및 팀 역학에 따라 다음과 같은 .bazelrc 파일에 플래그를 추가할 수 있습니다.

  • 로컬 머신
  • 프로젝트 작업공간에서 팀과 공유
  • CI 시스템에서

원격 캐시에서 읽기 및 쓰기

원격 캐시에 쓸 수 있는 사용자를 주의해야 합니다. CI 시스템만 원격 캐시에 쓸 수 있도록 하는 것이 좋습니다.

원격 캐시에서 읽고 쓰려면 다음 플래그를 사용합니다.

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

HTTP 외에 HTTPS, grpc, grpcs 프로토콜도 지원됩니다.

위의 플래그 외에도 다음 플래그를 사용하여 원격 캐시에서만 읽습니다.

build --remote_upload_local_results=false

특정 대상을 원격 캐시에서 제외

특정 대상을 원격 캐시 사용에서 제외하려면 대상에 no-remote-cache 태그를 지정합니다. 예를 들면 다음과 같습니다.

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

원격 캐시에서 콘텐츠 삭제

원격 캐시에서 콘텐츠를 삭제하는 것은 서버 관리의 일부입니다. 원격 캐시에서 콘텐츠를 삭제하는 방법은 캐시로 설정한 서버에 따라 다릅니다. 출력을 삭제할 때는 전체 캐시를 삭제하거나 이전 출력을 삭제합니다.

캐시된 출력은 일련의 이름과 해시로 저장됩니다. 콘텐츠를 삭제하면 특정 빌드에 속하는 출력을 구분할 수 없습니다.

캐시에서 콘텐츠를 삭제하려면 다음 단계를 따르세요.

  • 캐시가 감염된 후 클린 캐시 만들기
  • 이전 출력을 삭제하여 스토리지 사용량을 줄입니다.

Unix 소켓

원격 HTTP 캐시는 Unix 도메인 소켓을 통해 연결을 지원합니다. 이 동작은 curl의 --unix-socket 플래그와 유사합니다. 다음을 사용하여 Unix 도메인 소켓을 구성합니다.

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

이 기능은 Windows에서 지원되지 않습니다.

디스크 캐시

Bazel은 파일 시스템의 디렉터리를 원격 캐시로 사용할 수 있습니다. 이는 분기를 전환하거나 동일한 프로젝트의 여러 작업공간(예: 다중 결제)에서 작업할 때 빌드 아티팩트를 공유하는 데 유용합니다. Bazel이 디렉터리를 가비지로 수집하지 않으므로 이 디렉터리의 주기적 정리 작업을 자동화하는 것이 좋습니다. 다음과 같이 디스크 캐시를 사용 설정합니다.

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

~ 별칭을 사용하여 --disk_cache 플래그에 사용자별 경로를 전달할 수 있습니다(Bazel이 현재 사용자의 홈 디렉터리를 대체함). 이 기능은 프로젝트의 .bazelrc 파일을 통해 체크인된 프로젝트의 모든 개발자를 위해 디스크 캐시를 사용 설정할 때 유용합니다.

알려진 문제

빌드 중에 입력 파일 수정

빌드 중에 입력 파일이 수정되면 Bazel은 잘못된 결과를 원격 캐시에 업로드할 수 있습니다. 변경 감지를 사용 설정하려면 --experimental_guard_against_concurrent_changes 플래그를 사용합니다. 알려진 문제가 없으며 향후 출시에서 기본적으로 사용 설정됩니다. [문제 #3360] 에서 업데이트를 확인하세요. 일반적으로 빌드 중에 소스 파일을 수정하지 마세요.

작업으로 누출되는 환경 변수

작업 정의에는 환경 변수가 포함됩니다. 이는 머신 간에 원격 캐시 적중을 공유하는 데 문제가 될 수 있습니다. 예를 들어 $PATH 변수가 다른 환경은 캐시 적중을 공유하지 않습니다. --action_env를 통해 명시적으로 허용된 환경 변수만 작업 정의에 포함됩니다. $PATH를 포함한 환경 변수의 허용 목록과 함께 /etc/bazel.bazelrc를 설치하는 데 사용된 Bazel의 Debian/Ubuntu 패키지. 캐시 적중이 예상보다 적은 경우 환경에 이전 /etc/bazel.bazelrc 파일이 없는지 확인하세요.

Bazel은 작업공간 외부의 도구를 추적하지 않습니다.

Bazel은 현재 작업공간 외부의 도구를 추적하지 않습니다. 예를 들어 작업이 /usr/bin/의 컴파일러를 사용하는 경우 문제가 될 수 있습니다. 서로 다른 컴파일러가 설치된 두 사용자가 출력 조회수는 다르지만 작업 해시는 동일하므로 캐시 적중이 잘못 공유됩니다. 문제 #4558을 참고하세요.

Docker 컨테이너 내부에서 빌드를 실행하면 증분 인메모리 상태가 손실됨 Bazel은 단일 Docker 컨테이너에서 실행되는 경우에도 서버/클라이언트 아키텍처를 사용합니다. 서버 측에서 Bazel은 빌드 속도를 높이는 메모리 내 상태를 유지합니다. CI와 같은 Docker 컨테이너 내에서 빌드를 실행하면 메모리 내 상태가 손실되고 Bazel이 원격 캐시를 사용하기 전에 이를 다시 빌드해야 합니다.