이 문서에서는 Bazel의 샌드박스, sandboxfs 설치, 샌드박스 환경 디버깅에 대해 설명합니다.
샌드박스는 프로세스를 서로 또는 시스템의 리소스에서 격리하는 권한 제한 전략입니다. Bazel의 경우 이는 파일 시스템 액세스를 제한한다는 의미입니다.
Bazel의 파일 시스템 샌드박스는 알려진 입력만 포함하는 작업 디렉터리에서 프로세스를 실행하여 컴파일러와 기타 도구에서 절대 경로를 알지 않는 한 액세스해서는 안 되는 소스 파일을 볼 수 없도록 합니다.
샌드박스는 어떤 방식으로도 호스트 환경을 숨기지 않습니다. 프로세스는 파일 시스템의 모든 파일에 자유롭게 액세스할 수 있습니다. 하지만 사용자 네임스페이스를 지원하는 플랫폼에서는 작업 디렉터리 외부의 파일을 수정할 수 없습니다. 이렇게 하면 빌드의 재현성에 영향을 줄 수 있는 숨겨진 종속 항목이 빌드 그래프에 없습니다.
더 구체적으로 Bazel은 각 작업에 대해 실행 시 작업의 작업 디렉터리 역할을 하는 execroot/ 디렉터리를 구성합니다. execroot/는 작업의 모든 입력 파일을 포함하며 생성된 출력의 컨테이너 역할을 합니다. 그런 다음 Bazel은 운영체제 제공 기법(Linux의 컨테이너 및 macOS의 sandbox-exec)을 사용하여 execroot/ 내의 작업을 제한합니다.
샌드박스 처리 이유
작업 샌드박스가 없으면 Bazel은 도구에서 선언되지 않은 입력 파일 (작업의 종속 항목에 명시적으로 나열되지 않은 파일)을 사용하는지 알 수 없습니다. 선언되지 않은 입력 파일 중 하나가 변경되면 Bazel은 여전히 빌드가 최신이라고 믿고 작업을 다시 빌드하지 않습니다. 이로 인해 잘못된 증분 빌드가 발생할 수 있습니다.
캐시 항목을 잘못 재사용하면 원격 캐싱 중에 문제가 발생합니다. 공유 캐시의 잘못된 캐시 항목은 프로젝트의 모든 개발자에게 영향을 미치며 전체 원격 캐시를 완전 삭제하는 것은 불가능합니다.
샌드박스는 원격 실행의 동작을 모방합니다. 빌드가 샌드박스와 잘 작동한다면 원격 실행에서도 작동할 가능성이 높습니다. 원격 실행에서 필요한 모든 파일 (로컬 도구 포함)을 업로드하게 하여 새 컴파일러를 사용해 보거나 기존 도구를 변경할 때마다 클러스터의 모든 머신에 도구를 설치해야 하는 것보다 컴파일 클러스터의 유지보수 비용을 크게 절감할 수 있습니다.
사용할 샌드박스 전략
전략 플래그를 사용하여 사용할 샌드박스의 종류를 선택할 수 있습니다. sandboxed 전략을 사용하면 Bazel이 아래에 나열된 샌드박스 구현 중 하나를 선택하고 덜 밀폐된 일반 방식보다 OS 관련 샌드박스를 선호합니다.
--worker_sandboxing 플래그를 전달하면 영구 작업자가 일반 샌드박스에서 실행됩니다.
local(standalone) 전략은 어떠한 종류의 샌드박스도 수행하지 않습니다.
작업공간의 execroot로 설정된 작업 디렉터리를 사용하여 작업의 명령줄을 실행하기만 하면 됩니다.
processwrapper-sandbox는 '고급' 기능이 필요하지 않은 샌드박스 전략으로, 모든 POSIX 시스템에서 바로 사용할 수 있습니다. 원본 소스 파일을 가리키는 심볼릭 링크로 구성된 샌드박스 디렉터리를 빌드하고, execroot 대신 이 디렉터리로 설정된 작업 디렉터리를 실행한 다음, 알려진 출력 아티팩트를 샌드박스에서 execroot로 이동하고 샌드박스를 삭제합니다. 이렇게 하면 작업이 선언되지 않은 입력 파일을 실수로 사용하거나 execroot가 알 수 없는 출력 파일로 저장되는 것을 방지할 수 있습니다.
linux-sandbox는 한 단계 더 나아가 processwrapper-sandbox을 기반으로 빌드합니다. Docker가 내부에서 수행하는 작업과 마찬가지로 Linux 네임스페이스 (사용자, 마운트, PID, 네트워크, IPC 네임스페이스)를 사용하여 호스트에서 작업을 격리합니다. 즉, 샌드박스 디렉터리를 제외하고 전체 파일 시스템을 읽기 전용으로 만들기 때문에 작업이 호스트 파일 시스템의 항목을 실수로 수정할 수 없습니다. 이렇게 하면 $HOME 디렉터리를 실수로 rm rf'하는 버그 테스트와 같은 상황을 방지할 수 있습니다. 원하는 경우 작업이 네트워크에 액세스하지 못하도록 할 수도 있습니다. linux-sandbox는 PID 네임스페이스를 사용하여 작업이 다른 프로세스를 보지 못하도록 하고 끝에서 모든 프로세스 (작업에서 생성된 데몬)를 안정적으로 종료합니다.
darwin-sandbox은 비슷하지만 macOS용입니다. Apple의 sandbox-exec 도구를 사용하여 Linux 샌드박스와 거의 동일합니다.
linux-sandbox 및 darwin-sandbox는 운영체제에서 제공하는 메커니즘의 제한으로 인해 '중첩된' 시나리오에서 작동하지 않습니다. Docker는 컨테이너 매직에도 Linux 네임스페이스를 사용하므로 docker run --privileged를 사용하지 않으면 Docker 컨테이너 내에서 linux-sandbox를 쉽게 실행할 수 없습니다. macOS에서는 이미 샌드박스가 설정된 프로세스 내에서 sandbox-exec를 실행할 수 없습니다. 따라서 이러한 경우 Bazel은 자동으로 processwrapper-sandbox 사용을 대체합니다.
빌드 오류를 줄이고자 하는 경우(예: 덜 엄격한 실행 전략으로 실수로 빌드하지 않으려는 경우) Bazel이 사용하려고 하는 실행 전략 목록을 명시적으로 수정해 주세요(예: bazel build
--spawn_strategy=worker,linux-sandbox).
동적 실행에는 일반적으로 로컬 실행을 위한 샌드박스가 필요합니다. 선택 해제하려면 --experimental_local_lockfree_output 플래그를 전달합니다. 동적 실행은 영구 작업자를 자동으로 샌드박스 처리합니다.
샌드박스의 단점
샌드박스는 추가 설정 및 해체 비용이 발생합니다. 비용의 정도는 빌드 모양 및 호스트 OS의 성능을 비롯한 여러 요소에 따라 달라집니다. Linux의 경우 샌드박스 처리된 빌드의 속도가 몇 퍼센트 느립니다.
--reuse_sandbox_directories를 설정하면 설정 및 해체 비용이 완화될 수 있습니다.샌드박스는 도구에서 보유하고 있는 캐시를 효과적으로 사용 중지합니다. 샌드박스 보증이 약한 대신 지속적 작업자를 사용하면 이 문제를 완화할 수 있습니다.
멀티플렉스 작업자를 사용하려면 샌드박스 처리된 명시적인 작업자 지원이 필요합니다. 멀티플렉스 샌드박스를 지원하지 않는 작업자는 동적 실행에서 싱글플렉스 작업자로 실행되어 추가 메모리가 발생할 수 있습니다.
샌드박스
sandboxfs는 시간 제한 없이 기본 파일 시스템의 임의 뷰를 노출하는 FUSE 파일 시스템입니다. Bazel은 sandboxfs를 사용하여 각 작업에 execroot/를 즉시 생성하므로 수천 개의 시스템 호출 실행 비용이 발생하지 않습니다. FUSE 오버헤드로 인해 execroot/ 내의 추가 I/O가 더 느릴 수 있습니다.
샌드박스 설치
sandboxfs를 설치하고 이를 사용하여 Bazel 빌드를 수행하려면 다음 단계를 따르세요.
오프라인 저장
sandboxfs 바이너리가 PATH에 있도록 sandboxfs를 다운로드 및 설치합니다.
sandboxfs 실행
- (macOS만 해당) OSXFUSE를 설치합니다.
(macOS만 해당) 다음을 실행합니다.
sudo sysctl -w vfs.generic.osxfuse.tunables.allow_other=1핵심 macOS 시스템 서비스가 샌드박스를 통해 작동하게 하려면 설치 후 및 재부팅할 때마다 이 작업을 수행해야 합니다.
--experimental_use_sandboxfs로 Bazel 빌드를 실행합니다.bazel build target --experimental_use_sandboxfs
문제 해결
실행되는 작업의 주석으로 darwin-sandbox 또는 linux-sandbox 대신 local가 표시되면 샌드박스가 사용 중지되었음을 의미합니다. --genrule_strategy=sandboxed --spawn_strategy=sandboxed를 전달하여 사용 설정합니다.
디버깅
샌드박스 문제를 디버깅하려면 아래 전략을 따르세요.
비활성화된 네임스페이스
Google Kubernetes Engine 클러스터 노드 또는 Debian과 같은 일부 플랫폼에서는 보안 네임스페이스로 인해 사용자 네임스페이스가 기본적으로 비활성화됩니다. /proc/sys/kernel/unprivileged_userns_clone 파일이 있고 0이 포함되어 있으면 다음을 실행하여 사용자 네임스페이스를 활성화할 수 있습니다.
sudo sysctl kernel.unprivileged_userns_clone=1
규칙 실행 실패
샌드박스는 시스템 설정으로 인해 규칙을 실행하지 못할 수 있습니다. namespace-sandbox.c:633: execvp(argv[0], argv): No such file or
directory와 같은 메시지가 표시되면 genrule의 경우 --strategy=Genrule=local, 다른 규칙의 경우 --spawn_strategy=local로 샌드박스를 비활성화해 봅니다.
빌드 실패에 관한 자세한 디버깅
빌드에 실패한 경우 샌드박스를 설정하는 부분을 포함하여 Bazel이 빌드 실패 시 실행한 정확한 명령어를 표시하도록 --verbose_failures 및 --sandbox_debug를 사용합니다.
오류 메시지 예시:
ERROR: path/to/your/project/BUILD:1:1: compilation of rule
'//path/to/your/project:all' failed:
Sandboxed execution failed, which may be legitimate (such as a compiler error),
or due to missing dependencies. To enter the sandbox environment for easier
debugging, run the following command in parentheses. On command failure, a bash
shell running inside the sandbox will then automatically be spawned
namespace-sandbox failed: error executing command
(cd /some/path && \
exec env - \
LANG=en_US \
PATH=/some/path/bin:/bin:/usr/bin \
PYTHONPATH=/usr/local/some/path \
/some/path/namespace-sandbox @/sandbox/root/path/this-sandbox-name.params --
/some/path/to/your/some-compiler --some-params some-target)
이제 생성된 샌드박스 디렉터리를 검사하고 Bazel이 만든 파일을 확인하고 명령어를 다시 실행하여 어떻게 작동하는지 확인할 수 있습니다.
--sandbox_debug를 사용할 때 Bazel이 샌드박스 디렉터리를 삭제하지 않습니다. 적극적으로 디버깅하지 않는 한 --sandbox_debug를 중지해야 합니다. 시간이 지남에 따라 디스크가 가득 차기 때문입니다.