GitLab Shell 개발 지침

pipeline status coverage report Code Climate

GitLab Shell은 GitLab의 Git SSH 세션을 처리하고 인증키 목록을 수정합니다. GitLab Shell은 Unix 쉘이나 Bash 또는 Zsh와 대체되지 않습니다.

GitLab은 Git LFS 인증에 SSH를 통해 지원합니다.

요구 사항

GitLab Shell은 Go로 작성되었으며 빌드하기 위해 Go 컴파일러가 필요합니다. 여전히 빌드하고 테스트하기 위해 Ruby가 필요하지만 실행하기 위해 필요하지는 않습니다.

GitLab Shell은 Omnibus 설치에서 포트 22에서 실행됩니다. 일반 SSH 서비스를 사용하려면 대체 포트에서 구성하세요.

현재 버전의 Go을 다운로드하고 설치하세요. 우리는 Go 릴리스 정책을 따르며 다음을 지원합니다:

  • 현재 안정 버전
  • 이전 두 가지 주요 버전

버전

GitLab Shell과 관련된 두 버전 파일:

GitLab 팀원은 내부 Slack 채널인 #announcements를 모니터링할 수 있습니다.

GitLab Shell 작동 방식

SSH를 통해 GitLab 서버에 접근하면 GitLab Shell은 다음을 수행합니다:

  1. 미리 정의된 Git 명령(git push, git pull, git fetch)으로 제한합니다.
  2. 권한이 있는지 및 리포지토리가 있는 Gitaly 서버를 GitLab Rails API에 요청합니다.
  3. SSH 클라이언트와 Gitaly 서버 간에 데이터를 왔다갔다 복사합니다.

GitLab 서버에 HTTP(S)를 통해 접속하면 gitlab-workhorse로 들어가게 됩니다.

SSH로 git pull

%%{init: { "fontFamily": "GitLab Sans" }}%% graph LR A[Git pull] --> |SSH를 통해| B[gitlab-shell] B -->|API 호출| C[gitlab-rails<br>인가] C -->|승인 또는 거부| D[Gitaly 세션]

SSH로 git push

git push 명령은 gitlab-rails이 푸시를 수락한 후에 수행됩니다:

%%{init: { "fontFamily": "GitLab Sans" }}%% graph LR subgraph 사용자가 초 A[Git push] -->|SSH를 통해| B[gitlab-shell] end subgraph Gitaly B -->|Gitaly 세션 확립| C[gitlab-shell Pre-Receive 후크] C -->|API 인증 호출| D[Gitlab-rails] D --> E[푸시 승인 또는 거부] end

전체 기능 목록

authorized_keys 수정

GitLab Shell은 클라이언트 머신의 authorized_keys 파일을 수정합니다.

GitLab Shell에 기여하기

GitLab Shell에 기여하려면:

  1. GitLab API 액세스 및 내부 API와의 Redis 연결 확인: make check
  2. ‘gitlab-shell 바이너리를 컴파일하여 bin/에 배치하세요: make compile`
  3. ‘gitlab-shell 바이너리를 빌드하고 파일 시스템에 설치하려면 make install을 실행하세요. 기본 위치는 /usr/local입니다. 변경하려면 PREFIX 및 DESTDIR` 환경 변수를 설정하세요.
  4. 소스에서 GitLab을 단일 기계에 설치하려면 make setup을 실행하세요. 이 명령은 GitLab Shell 바이너리를 컴파일하고 파일 시스템의 여러 경로가 올바른 권한으로 존재하는지 확인합니다. 이 명령은 설치 방법 문서에서 명시적으로 지시하지 않는 한 실행하지 마세요.

더 많은 정보는 CONTRIBUTING.md를 참조하세요.

테스트 실행

기여할 때 테스트를 실행하세요:

  1. bundle install과 make test로 테스트를 실행하세요.
  2. Gofmt를 실행하세요: make verify

  3. 테스트 및 검증을 동시에 실행하세요 (기본 Makefile 대상): 

    bundle install
make validate
  4. 필요한 경우 Gitaly를 구성하세요.

로컬 테스트를 위해 Gitaly 구성

일부 테스트에는 Gitaly 서버가 필요합니다. docker-compose.yml 파일은 Gitaly를 8075 포트에서 실행합니다. 테스트에 Gitaly 위치를 알려주려면 GITALY_CONNECTION_INFO를 설정하세요: 

export GITALY_CONNECTION_INFO='{"address": "tcp://localhost:8075", "storage": "default"}'
make test

GITALY_CONNECTION_INFO가 설정되지 않으면 테스트 스위트는 실행되지만 Gitaly가 필요한 테스트는 건너뜁니다. 테스트는 항상 CI 환경에서 실행됩니다.

속도 제한

GitLab Shell은 Git 작업에 대해 사용자 계정 및 프로젝트별로 속도 제한을 수행합니다. GitLab Shell은 Git 작업 요청을 수락한 후 Redis를 백업하는 Rails 속도 제한기를 사용합니다. user + project가 속도 제한을 초과하면 GitLab Shell은 해당 user + project에 대한 해당 연결 요청을 더 이상 수락하지 않습니다.

속도 제한은 Git 명령(Plumbing) 수준에서 적용됩니다. 각 명령에는 분당 600개의 속도 제한이 있습니다. 예를 들어 git push는 분당 600개이며 git pull도 다른 분당 600개입니다.

동일한 Plumbing 명령을 사용하기 때문에 git-upload-pack, git pull, git clone은 속도 제한 목적으로 실제로 동일한 명령입니다.

Gitaly에는 속도 제한이 적용되어 있지만 GitLab Shell(Rails)에서 속도 제한이 초과되면 Gitaly로 요청은 전달되지 않습니다.

GitLab Shell 로그

일반적으로, GitLab Shell이나 gitlab-sshd 세션의 구조는 로그를 검사하여 확인할 수 있지만 내용은 확인할 수 없습니다. 몇 가지 지침:

  • 로깅에는 gitlab.com/gitlab-org/labkit/log를 사용합니다.
  • 항상 상관 ID를 포함해야 합니다.
  • 로그 메시지는 불변하고 고유해야 합니다. log.WithField, log.WithFields, 또는 log.WithError를 사용하여 필드에 보조 정보를 포함하세요.
  • 성공 사례와 오류 사례를 모두 기록하세요.
  • 로깅을 너무 많이 하는 것이 충분히 로깅을 하지 않는 것보다 나습니다. 메시지가 너무 장황하다고 느껴진다면 메시지를 제거하기 전에 로그 레벨을 낮추는 것을 고려하세요.

GitLab SaaS

GitLab.com의 gitlab-shell 흐름 다이어그램:

%%{init: { "fontFamily": "GitLab Sans" }}%% graph LR a2 --> b2 a2 --> b3 a2 --> b4 b2 --> c1 b3 --> c1 b4 --> c1 c2 --> d1 c2 --> d2 c2 --> d3 d1 --> e1 d2 --> e1 d3 --> e1 a1[Cloudflare] --> a2[TCP<br/> 로드 밸런서] e1[Git] subgraph HAProxy Fleet b2[HAProxy] b3[HAProxy] b4[HAProxy] end subgraph GKE c1[내부 TCP<br/> 로드 밸런서<br/>포트 2222] --> c2[GitLab-shell<br/> 파드들] end subgraph Gitaly d1[Gitaly] d2[Gitaly] d3[Gitaly] end

GitLab Shell 아키텍처

%%{init: { "fontFamily": "GitLab Sans" }}%% sequenceDiagram participant Git on client participant SSH server participant AuthorizedKeysCommand participant GitLab Shell participant Rails participant Gitaly participant Git on server Note left of Git on client: git fetch Git on client->>+SSH server: ssh git fetch-pack request SSH server->>+AuthorizedKeysCommand: gitlab-shell-authorized-keys-check git AAAA... AuthorizedKeysCommand->>+Rails: GET /internal/api/authorized_keys?key=AAAA... Note right of Rails: 키 ID 찾기 Rails-->>-AuthorizedKeysCommand: 200 OK, command="gitlab-shell upload-pack key_id=1" AuthorizedKeysCommand-->>-SSH server: command="gitlab-shell upload-pack key_id=1" SSH server->>+GitLab Shell: gitlab-shell upload-pack key_id=1 GitLab Shell->>+Rails: GET /internal/api/allowed?action=upload_pack&key_id=1 Note right of Rails: 인증 확인 Rails-->>-GitLab Shell: 200 OK, { gitaly: ... } GitLab Shell->>+Gitaly: SSHService.SSHUploadPack request Gitaly->>+Git on server: git upload-pack request Note over Git on client,Git on server: Git 클라이언트와 서버 간의 양방향 통신 Git on server-->>-Gitaly: git upload-pack response Gitaly -->>-GitLab Shell: SSHService.SSHUploadPack response GitLab Shell-->>-SSH server: gitlab-shell upload-pack response SSH server-->>-Git on client: ssh git fetch-pack response

관련 주제