원격 캐싱

<ph type="x-smartling-placeholder"></ph> 문제 신고 <ph type="x-smartling-placeholder"></ph> 소스 보기 1박 · 7.3 · 7.2 · 7.1 · 7.0 · 6.5

이 페이지에서는 원격 캐싱, 캐시를 호스팅할 서버 설정 및 빌드를 실행하는 방법을 알아봤습니다

원격 캐시는 개발자 팀 또는 지속적 통합에 의해 사용됩니다. (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's 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.conf의 server 섹션 구성 예시:

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 및 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에 연결합니다.

    • 플래그를 사용하여 다음 URL을 Bazel에 전달합니다. --remote_cache=https://storage.googleapis.com/bucket-name, 여기서 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:[email protected]:port/path입니다. 참고: HTTP 기본 인증은 HTTP를 통해 일반 텍스트로 사용자 이름과 비밀번호를 항상 HTTPS와 함께 사용하는 것이 중요합니다.

HTTP 캐싱 프로토콜

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

예를 들어 http://localhost:8080/cache에서 실행되는 원격 캐시를 생각해 보세요. SHA256을 사용하는 작업의 작업 결과 메타데이터를 다운로드하기 위한 Bazel 요청 해시 01ba4719...는 다음과 같이 표시됩니다.

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

SHA256 해시 15e2b0d3...가 포함된 출력 파일을 업로드하는 Bazel 요청 CAS는 다음과 같습니다.

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

0x310x320x330x340x350x360x370x380x39

경고: 바이트 없이 빌드 HTTP 캐시와 호환되지 않을 수 있습니다. 성능을 최대한 높이려면 gRPC 캐시를 사용해 보세요

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

서버가 원격 캐시로 설정되면, 원격 캐시를 사용하려면 Bazel 명령어에 플래그를 추가해야 합니다. 구성 목록과 확인할 수 있습니다

또한 확인할 수 있습니다

이러한 플래그를 .bazelrc 파일에 추가하여 Bazel을 실행할 때마다 지정해야 합니다 프로젝트 및 다음과 같은 플래그를 .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_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를 통해 명시적으로 허용된 항목이 작업에 포함된 경우 정의합니다. /etc/bazel.bazelrc 설치에 사용된 Bazel의 Debian/Ubuntu 패키지 $PATH를 포함한 환경 변수의 허용 목록으로 바꿉니다. 만약 캐시 적중률이 낮습니다. 환경에 오래된 캐시 적중 항목이 없는지 확인하세요. /etc/bazel.bazelrc 파일.

Bazel은 작업공간 외부의 도구를 추적하지 않음

Bazel은 현재 작업공간 외부의 도구를 추적하지 않습니다. 이는 예를 들어 작업이 /usr/bin/의 컴파일러를 사용하면 문제가 됩니다. 그런 다음 다른 컴파일러가 설치된 두 사용자가 캐시 적중을 잘못 공유 출력이 다르지만 작업 해시가 동일하기 때문입니다. 자세한 내용은 문제 #4558에서 업데이트를 받으세요.

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