튜토리얼: 자체 프로젝트 러너 생성, 등록 및 실행하기

이 튜토리얼에서는 GitLab에서 첫 번째 러너를 구성하고 실행하는 방법을 설명합니다.

러너는 GitLab CI/CD 파이프라인에서 작업을 실행하는 GitLab Runner 애플리케이션의 에이전트입니다.

작업은 .gitlab-ci.yml 파일에 정의되고 사용 가능한 러너에 할당됩니다.

GitLab에는 세 가지 유형의 러너가 있습니다:

Shared: GitLab 인스턴스의 모든 그룹과 프로젝트에서 사용할 수 있습니다.
Group: 그룹의 모든 프로젝트와 하위 그룹에서 사용할 수 있습니다.
Project: 특정 프로젝트와 연결되어 있습니다. 일반적으로 프로젝트 러너는 한 번에 하나의 프로젝트에서 사용됩니다.

이 튜토리얼에서는 기본 파이프라인 구성에서 정의된 작업을 실행하기 위해 프로젝트 러너를 생성합니다:

빈 프로젝트 생성하기
프로젝트 파이프라인 생성하기.
프로젝트 러너 생성 및 등록하기.
파이프라인을 트리거하여 러너 실행하기.

시작하기 전에

러너를 생성하고 등록하고 실행하려면 GitLab Runner를 로컬 컴퓨터에 설치해야 합니다.

빈 프로젝트 생성하기

먼저 CI/CD 파이프라인과 러너를 만들 수 있는 빈 프로젝트를 생성합니다.

빈 프로젝트를 생성하려면:

왼쪽 사이드바 상단에서 Create new ()를 선택하고 New project/repository를 선택합니다.
Create blank project를 선택합니다.
프로젝트 세부 정보를 입력합니다:
- Project name 필드에 프로젝트 이름을 입력합니다. 이름은 소문자 또는 대문자(a-zA-Z), 숫자(0-9), 이모지, 또는 밑줄(_)로 시작해야 합니다. 또한 점(.), 더하기(+), 하이픈(-), 또는 공백을 포함할 수 있습니다.
- Project slug 필드에 프로젝트 경로를 입력합니다. GitLab 인스턴스는 슬러그를 프로젝트에 대한 URL 경로로 사용합니다. 슬러그를 변경하려면 먼저 프로젝트 이름을 입력한 후 슬러그를 변경합니다.
Create project를 선택합니다.

프로젝트 파이프라인 생성하기

다음으로, 프로젝트를 위한 .gitlab-ci.yml 파일을 생성합니다. 이 파일은 GitLab CI/CD를 위한 지침을 지정하는 YAML 파일입니다.

이 파일에서는 다음을 정의합니다:

러너가 실행해야 하는 작업의 구조와 순서.
특정 조건에 직면했을 때 러너가 내려야 하는 결정.

왼쪽 사이드바에서 Search or go to를 선택하고 프로젝트나 그룹을 찾습니다.
Project overview를 선택합니다.
더하기 아이콘()을 선택한 다음 New file을 선택합니다.
Filename 필드에 .gitlab-ci.yml을 입력합니다.

큰 텍스트 상자에 이 샘플 구성을 붙여넣습니다:

stages:
  - build
  - test

job_build:
  stage: build
  script:
    - echo "Building the project"

job_test:
  stage: test
  script:
    - echo "Running tests"

이 구성에는 러너가 실행하는 두 개의 작업, 즉 빌드 작업과 테스트 작업이 있습니다.

Commit changes를 선택합니다.

프로젝트 러너 생성 및 등록하기

다음으로, 프로젝트 러너를 생성하고 등록합니다. 러너를 GitLab에 등록하여 프로젝트 파이프라인의 작업을 가져올 수 있도록 해야 합니다.

프로젝트 러너를 생성하려면:

왼쪽 사이드바에서 Search or go to를 선택하고 프로젝트를 찾습니다.
Settings > CI/CD를 선택합니다.
Runners 섹션을 확장합니다.
New project runner를 선택합니다.
운영 체제를 선택합니다.
Tags 섹션에서 Run untagged 체크박스를 선택합니다. Tags는 러너가 실행할 수 있는 작업을 지정하며 선택 사항입니다.
Create runner를 선택합니다.
명령줄에서 러너를 등록하는 화면의 지침을 따릅니다. 프롬프트가 표시되면:
- executor에 대해서는 러너가 호스트 컴퓨터에서 직접 실행될 것이므로 shell을 입력합니다. executor는 러너가 작업을 실행하는 환경입니다.
- GitLab instance URL에 귀하의 GitLab 인스턴스의 URL을 사용합니다. 예를 들어, 프로젝트가 gitlab.example.com/yourname/yourproject에 호스팅되는 경우 귀하의 GitLab 인스턴스 URL은 https://gitlab.example.com입니다. 프로젝트가 GitLab.com에서 호스팅되는 경우 URL은 https://gitlab.com입니다.
러너를 시작합니다:
```
gitlab-runner run
```

러너 구성 파일 확인하기

러너를 등록한 후, 구성 및 러너 인증 토큰이 config.toml에 저장됩니다. 러너는 작업 큐에서 작업을 가져올 때 GitLab과 인증하기 위해 토큰을 사용합니다.

이 config.toml을 사용하여 더 고급 러너 구성을 정의할 수 있습니다.

러너를 등록하고 시작한 후, config.toml은 다음과 같은 모습이어야 합니다:

  [[runners]]
  name = "my-project-runner1"
  url = "http://127.0.0.1:3000"
  id = 38
  token = "glrt-TOKEN"
  token_obtained_at = 2023-07-05T08:56:33Z
  token_expires_at = 0001-01-01T00:00:00Z
  executor = "shell"

파이프라인을 트리거하여 러너 실행하기

다음으로, 프로젝트에서 파이프라인을 트리거하여 러너가 작업을 실행하는 모습을 확인하세요.

왼쪽 사이드바에서 Search or go to를 선택하고 프로젝트를 찾습니다.
Build > Pipelines를 선택합니다.
New pipeline을 선택합니다.

작업 로그를 보려면 작업을 선택합니다. 출력은 다음과 같은 예와 비슷하게 나타나야 하며, 이는 러너가 작업을 성공적으로 실행하고 있음을 보여줍니다:

   Running with gitlab-runner 16.2.0 (782e15da)
   on my-project-runner TOKEN, system ID: SYSTEM ID
   Preparing the "shell" executor
   00:00
   Using Shell (bash) executor...
   Preparing environment
   00:00
   /Users/username/.bash_profile: line 9: setopt: command not found
   Running on MACHINE-NAME...
   Getting source from Git repository
   00:01
   /Users/username/.bash_profile: line 9: setopt: command not found
   Fetching changes with git depth set to 20...
   Reinitialized existing Git repository in /Users/username/project-repository
   Checking out 7226fc70 as detached HEAD (ref is main)...
   Skipping object checkout, Git LFS is not installed for this repository.
   Consider installing it with 'git lfs install'.
   Skipping Git submodules setup
   Executing "step_script" stage of the job script
   00:00
   /Users/username/.bash_profile: line 9: setopt: command not found
   $ echo "Building the project"
   Building the project
   Job succeeded

이제 처음으로 러너를 성공적으로 생성하고 등록하며 실행했습니다!