GitLab 코드베이스에 기여하고 변경 사항을 테스트할 개발 환경이 필요하다면, GDK-in-a-box를 사용할 수 있습니다. GDK-in-a-box는 GitLab Development Kit(GDK)가 사전 구성된 멀티 플랫폼 컨테이너 이미지로 제공됩니다.

GDK-in-a-box 가상 머신(VM) 이미지는 더 이상 지원되지 않으며, 컨테이너 기반 이미지로 대체되어 사용 중단(deprecated)되었습니다.

GDK는 GitLab Self-Managed 설치본, 샘플 프로젝트, 그리고 기능을 테스트할 수 있는 관리자 접근 권한을 포함하는 로컬 개발 환경입니다.

30 GB의 디스크 공간이 필요합니다.

컨테이너 없이 로컬에서 GDK를 사용하려면 GDK 개발 환경 설치 단계를 따르세요.

GDK-in-a-box 다운로드#

• 컨테이너 런타임을 설치합니다.

  Docker Desktop, Docker Engine, Rancher Desktop 등 여러 옵션을 사용할 수 있습니다.

  • Docker Desktop은 Homebrew와 같은 패키지 매니저를 통해서도 설치할 수 있습니다.

  • 참고: Rancher Desktop에서는 "Preferences"에서 Kubernetes를 비활성화하는 것이 좋을 수 있습니다.

  • Docker 호환 명령어를 지원하는 다른 컨테이너 런타임도 사용할 수 있습니다.

• 컨테이너 이미지를 Pull합니다. 이미지는 8 GB 이상의 다운로드가 필요하며 시간이 걸릴 수 있습니다.

  docker pull registry.gitlab.com/gitlab-org/gitlab-development-kit/gitlab-gdk-in-a-box:latest

• 이미지에서 컨테이너를 생성합니다:

docker run -d -h gdk.local --name gdk \
-p 2022:2022 \
-p 2222:2222 \
-p 3000:3000 \
-p 3005:3005 \
-p 3010:3010 \
-p 3038:3038 \
-p 5100:5100 \
-p 5778:5778 \
-p 9000:9000 \
registry.gitlab.com/gitlab-org/gitlab-development-kit/gitlab-gdk-in-a-box:latest

• VS Code를 사용하여 GDK에 연결하기로 계속 진행합니다.

VS Code를 사용하여 GDK에 연결하기#

이 단계의 데모 영상 보기.

컨테이너 런타임을 시작하기 전에 CPU 코어 수와 RAM 등 시스템 구성을 변경해야 할 수 있습니다. 권장 구성은 최소 12 GB RAM, 4코어입니다.

• 컨테이너를 시작합니다.

• VS Code에서 Terminal > New terminal을 선택한 후, 다음 curl 명령어를 실행하여 SSH 키를 로컬 ~/.ssh/config에 추가합니다:

curl "https://gitlab.com/gitlab-org/gitlab-development-kit/-/raw/main/support/gdk-in-a-box/setup-ssh-key" | bash

스크립트에 대해 더 알아보려면 setup-ssh-key 코드를 확인할 수 있습니다.

• 스크립트에서 1을 입력하여 컨테이너 설치를 선택합니다.

• VS Code에서 Remote - SSH 확장을 설치합니다:

  VS Code

  • VSCodium

• VS Code를 컨테이너에 연결합니다:

  명령 팔레트에서 Remote-SSH: Connect to host를 선택합니다.

  • gdk.local을 선택하여 연결합니다.

• 새 VS Code 창이 열립니다. 혼동을 방지하기 위해 이전 창을 닫아도 됩니다. 나머지 단계는 새 창에서 진행합니다.

• VS Code 터미널에서 다음 curl 명령어를 실행하여 GDK에서 Git을 구성합니다:

curl "https://gitlab.com/gitlab-org/gitlab-development-kit/-/raw/main/support/gdk-in-a-box/first_time_setup" | bash

프롬프트가 표시되면 이름과 이메일 주소를 입력합니다.

• 표시된 SSH 키를 프로필에 추가합니다.

스크립트에 대해 더 알아보려면 first_time_setup 코드를 확인할 수 있습니다.

• VS Code에서 File > Open folder를 선택하고 /home/gdk/gitlab-development-kit/gitlab/로 이동합니다.

• 브라우저에서 GitLab을 엽니다: http://gdk.local:3000.

  페이지가 로드되지 않으면 로컬 머신의 hosts 파일에 127.0.0.1 gdk.local을 추가합니다.

• 사용자 이름 root와 비밀번호 5iveL!fe로 로그인합니다.

• GDK로 코드 변경하기로 계속 진행합니다.

GDK 컨테이너 종료하기#

호스트에서 다음 명령어를 실행하여 컨테이너를 중지할 수 있습니다:

docker stop gdk

GDK 컨테이너 시작하기#

호스트에서 다음 명령어를 실행하여 컨테이너를 다시 시작할 수 있습니다:

docker start gdk

GDK 컨테이너 삭제하기#

이 명령어는 현재 컨테이너와 내부의 모든 데이터를 삭제합니다. 이 명령어를 실행하기 전에 변경 사항을 커밋했는지 확인하세요.

호스트에서 다음 명령어를 실행하여 컨테이너를 삭제할 수 있습니다:

docker rm gdk

GDK-in-a-box 업데이트하기#

VS Code에서 gdk.local에 연결된 상태에서 GDK-in-a-box를 업데이트할 수 있습니다.

VS Code 터미널에서 다음을 입력합니다:

gdk update

코드 변경하기#

GDK가 준비되면 GDK로 코드 기여하기로 계속 진행합니다.