Workhorse 구성

역사적인 이유로 Workhorse는 다음을 사용합니다:

  • 명령줄 플래그.
  • 구성 파일.
  • 환경 변수.

새로운 Workhorse 구성 옵션을 구성 파일에 추가하십시오.

CLI 옵션 

  gitlab-workhorse [OPTIONS]

Options:
  -apiCiLongPollingDuration duration
        러너에 대한 작업을 위한 롱 폴링 기간 (기본 50ns)
  -apiLimit uint
        한 번에 허용되는 API 요청 수
  -apiQueueDuration duration
        요청의 최대 대기 기간 (기본 30초)
  -apiQueueLimit uint
        대기열에 넣을 수 있는 API 요청 수
  -authBackend string
        인증/인가 백엔드 (기본 "http://localhost:8080")
  -authSocket string
        선택 사항: 다이얼할 authBackend의 Unix 도메인 소켓
  -cableBackend string
        ActionCable 백엔드
  -cableSocket string
        선택 사항: cableBackend에 다이얼할 Unix 도메인 소켓
  -config string
        구성을 불러올 TOML 파일
  -developmentMode
        assets를 Rails 앱에서 제공하는 것을 허용
  -documentRoot string
        정적 파일 콘텐츠의 경로 (기본 "public")
  -listenAddr string
        HTTP 서버의 수신 주소 (기본 "localhost:8181")
  -listenNetwork string
        수신 '네트워크' (tcp, tcp4, tcp6, unix) (기본 "tcp")
  -listenUmask int
        Unix 소켓의 Umask
  -logFile string
        로그 파일 위치
  -logFormat string
        사용할 로그 형식을 기본값은 텍스트로 설정 (text, json, structured, none) (기본 "text")
  -pprofListenAddr string
        예: 'localhost:6060'인 pprof 수신 주소
  -prometheusListenAddr string
        예: 'localhost:9229'인 Prometheus 수신 주소
  -propagateCorrelationID X-Request-ID
        존재하는 Correlation-ID를 재사용하는 경우, 들어오는 요청 헤더 X-Request-ID에서
  -proxyHeadersTimeout duration
        요청을 프록시하는 데 응답 헤더를 기다리는 시간(기본 5분)
  -secretPath string
        authBackend와의 인증에 사용할 비밀 키가 있는 파일 (기본 "./.gitlab_workhorse_secret")
  -version
        버전을 출력하고 종료합니다

‘인증 백엔드’는 GitLab Rails 애플리케이션을 가리킵니다. 이 이름은 GitLab Workhorse가 git push와 git pull을 HTTP로 처리했을 때에서 유래되었습니다.

GitLab Workhorse는 TCP 또는 Unix 도메인 소켓 중 하나에서 수신할 수 있습니다. 또한 Go net/http/pprof 프로파일링 서버로 두 번째 수신 TCP를 열 수도 있습니다.

유효한 TOML 구성 파일을 -config 플래그를 통해 전달하면 GitLab Workhorse는 Redis 빌드 및 러너 등록 이벤트를 수신할 수 있습니다. 일반적인 설정에서는 다음만 필요합니다 (문자열을 실제 소켓으로 교체):

Redis

GitLab Workhorse는 Redis를 통해 CI 빌드 요청에 대한 롱 폴링을 수행합니다. 이를 구성하려면:

  • TOML 구성 파일에서 Redis 설정 구성.
  • CI 빌드 요청의 폴링 동작을 -apiCiLongPollingDuration 명령줄 플래그로 제어.

CI 폴링을 사용하지 않은 채 Redis를 구성 파일에서 활성화할 수 있습니다. 이 구성은 Redis Pub/Sub 연결을 유휴 상태로 유지시킵니다. 그러나 그 반대는 불가능합니다. CI 롱 폴링에는 올바른 Redis 구성이 필요합니다.

예를 들어, 구성 파일의 [redis] 섹션에는 다음이 포함될 수 있습니다: 

[redis]
URL = "unix:///var/run/gitlab/redis.sock"
Password = "my_awesome_password"
Sentinel = [ "tcp://sentinel1:23456", "tcp://sentinel2:23456" ]
SentinelMaster = "mymaster"
  • URL - unix://path/to/redis.sock 또는 tcp://host:port 형식의 문자열.
  • Password - Redis 인스턴스에 암호가 설정된 경우에만 필요.
  • Sentinel - Sentinel을 사용하는 경우 필요.

Sentinel 및 URL이 모두 제공된 경우에는 Sentinel만 사용됩니다.

선택 사항: 

[redis]
DB = 0
MaxIdle = 1
MaxActive = 1
  • DB - 연결할 데이터베이스. 기본값은 0입니다.
  • MaxIdle - Redis 풀에 유휴 상태로 유지될 최대 연결 수. 기본값은 1입니다.
  • MaxActive - 풀이 유지할 연결 수. 기본값은 1입니다.

상대 URL 지원

example.com/gitlab와 같이 상대 URL에서 GitLab을 마운트하는 경우 authBackend 설정에 이 상대 URL을 사용하십시오: 

gitlab-workhorse -authBackend http://localhost:8080/gitlab

TLS 지원

TLS를 사용하는 수신기를 설정하여 오는 요청에 사용할 수 있습니다. 서버의 인증서 및 해당 프라이빗 키를 포함한 파일의 경로를 제공해야 합니다: 

[[listeners]]
network = "tcp"
addr = "localhost:3443"
[listeners.tls]
  certificate = "/path/to/certificate"
  key = "/path/to/private/key"
  min_version = "tls1.2"
  max_version = "tls1.3"

certificate 파일에는 서버의 인증서, 중간 파일 및 CA의 인증서를 연이어 놓은 것이 포함되어야 합니다.

메트릭 엔드포인트도 유사하게 구성할 수 있습니다: 

[metrics_listener]
network = "tcp"
addr = "localhost:9229"
[metrics_listener.tls]
  certificate = "/path/to/certificate"
  key = "/path/to/private/key"
  min_version = "tls1.2"
  max_version = "tls1.3"

authBackend 및 authSocket의 상호 작용

authBackend와 authSocket 간의 상호 작용은 혼란스러울 수 있습니다. authSocket이 설정되면 authBackend의 호스트 부분을 덮어쓰지만 상대 경로는 덮어쓰지 않습니다.

표 형식으로 나타내면:

authBackend authSocket Workhorse가 연결하는 곳 Rails 상대 URL
설정되지 않음 설정되지 않음 localhost:8080 /
http://localhost:3000 설정되지 않음 localhost:3000 /
http://localhost:3000/gitlab 설정되지 않음 localhost:3000 /gitlab
설정되지 않음 /path/to/socket /path/to/socket /
http://localhost:3000 /path/to/socket /path/to/socket /
http://localhost:3000/gitlab /path/to/socket /path/to/socket /gitlab

cableBackend 및 cableSocket에도 동일한 규칙이 적용됩니다.

메타데이터 옵션

[metadata] 섹션에 다음 옵션을 포함하세요:

설정 타입 기본값 설명
zip_reader_limit_bytes 바이트 104857600 (100 MB) ZIP 리더를 제한할 선택적인 바이트 수입니다. GitLab 16.9에서 소개되었습니다.

예시: 

[metadata]
zip_reader_limit_bytes = 209715200 # 200 MB

오류 추적

GitLab-Workhorse는 Sentry를 사용하여 원격 오류 추적을 지원합니다. 이 기능을 활성화하려면 GITLAB_WORKHORSE_SENTRY_DSN 환경 변수를 설정하세요. 또한 GITLAB_WORKHORSE_SENTRY_ENVIRONMENT 환경 변수를 설정하여 스테이징, 프로덕션 및 개발 환경을 분리하는 Sentry 환경 기능을 사용할 수 있습니다.

Linux 패키지 (Omnibus)
gitlab_workhorse['env'] = {
    'GITLAB_WORKHORSE_SENTRY_DSN' => 'https://foobar'
    'GITLAB_WORKHORSE_SENTRY_ENVIRONMENT' => 'production'
}
직접 컴파일(소스)
export GITLAB_WORKHORSE_SENTRY_DSN='https://foobar'
export GITLAB_WORKHORSE_SENTRY_ENVIRONMENT='production'

분산 추적

Workhorse는 LabKit을 통해 OpenTracing API를 사용하여 분산 추적을 지원합니다.

기본적으로 이진 파일에 추적 구현이 연결되지 않습니다. 다양한 OpenTracing 제공업체를 빌드 태그 또는 BUILD_TAGS 메이크 변수를 설정하여 연결할 수 있습니다. 예를 들어 Jaeger 추적 지원을 포함하려면 다음과 같이 태그를 포함하세요: BUILD_TAGS="tracer_static tracer_static_jaeger" 

make BUILD_TAGS="tracer_static tracer_static_jaeger"

OpenTracing 제공업체를 사용하도록 Workhorse를 컴파일한 후 다음과 같이 GITLAB_TRACING 환경 변수를 설정하여 추적 구성을 구성하세요. 

GITLAB_TRACING=opentracing://jaeger ./gitlab-workhorse

상관 ID 전파

사용자가 HTTP 요청(예: 새 프로젝트 생성)을 작성하는 경우 초기 요청은 다른 서비스로 라우팅되어 Workhorse를 통해 전달될 수 있습니다. 이 과정에서 Workhorse는 상관 ID라고 하는 임의의 값 생성합니다. Workhorse는 X-Request-Id HTTP 헤더를 통해 이 상관 ID를 전송합니다.

일부 GitLab 서비스(예: GitLab Shell)는 독자적인 상관 ID를 생성합니다. 또한 Gitaly와 같은 다른 서비스는 원래 요청에서 상관 ID를 전달하는 내부 API 호출을 수행합니다. 이 두 경우 모두 상관 ID는 X-Request-Id HTTP 헤더를 통해 전송됩니다.

Workhorse는 기본적으로 이 헤더를 무시하고 새로운 상관 ID를 항상 생성합니다. 이는 디버깅을 어렵게 만들고 새로운 상관 ID가 원래 상관 ID와 관계가 없기 때문에 분산 추적이 제대로 작동하지 않습니다.

Workhorse는 들어오는 상관 ID를 -propagateCorrelationID 명령줄 플래그를 통해 전파하도록 구성할 수 있습니다. 신뢰할 수 있는 클라이언트가 임의의 값을 생성하지 못하도록 IP 허용 목록을 사용하는 것이 매우 권장됩니다.

Workhorse 구성 파일의 trusted_cidrs_for_propagation 옵션을 통해 신뢰할 수 있는 IP 허용 목록을 지정하세요. 예를 들어: 

trusted_cidrs_for_propagation = ["10.0.0.0/8", "127.0.0.1/32"]

참고: trusted_cidrs_for_propagation 옵션을 사용하려면 -propagateCorrelationID 플래그를 사용해야 합니다.

신뢰할 수 있는 프록시

만약 Workhorse가 NGINX와 같은 역방향 프록시 뒤에 있다면, trusted_cidrs_for_x_forwarded_for 옵션이 필요합니다. 이 옵션은 X-Forwarded-For HTTP 헤더를 통해 원본 IP 주소를 제공하는 데 신뢰할 수 있는 CIDR 블록을 지정하는 데 사용됩니다. 예를 들면: 

trusted_cidrs_for_x_forwarded_for = ["10.0.0.0/8", "127.0.0.1/32"]

지속적인 프로파일링

Workhorse는 LabKit을 통해 지속적인 프로파일링을 지원하며 Stackdriver Profiler를 사용합니다. 기본적으로 Stackdriver Profiler 구현은 build tags를 사용하여 바이너리에 연결되지만 필수는 아니며 생략할 수 있습니다. 예를 들면: 

make BUILD_TAGS=""

Workhorse를 지속적인 프로파일링으로 컴파일한 후, GITLAB_CONTINUOUS_PROFILING 환경 변수로 프로파일러 구성을 설정하세요. 예를 들면: 

GITLAB_CONTINUOUS_PROFILING="stackdriver?service=workhorse&service_version=1.0.1&project_id=test-123 ./gitlab-workhorse"

관련 주제