github action 배포 시 외부 포트 없이 로컬 서버에 연결하기(github runners)

Welcome to Jaehai.Opslog

안녕하세요! 넓은 스펙트럼을 바탕으로 전체적인 그림을 보는 Ops Engineer 이재하입니다.

이번 글에서는 github 메인 소개글인 ops-jaeha의 README를 수정할 때 자동으로 로컬에 텍스트 파일을 만드는 것을 예시로 진행하겠습니다.

1. Github-Runners란?

Github Runners란 Github Actions에서 사용자가 지정하는 로컬 컴퓨팅 자원으로 빌드를 수행하도록 설정하는 기능입니다.

2. Github Runners 생성

먼저 Github Action을 설정할 Repository를 하나 생성 혹은 들어가주세요.

1) Github Runners 등록

먼저 Repository의 Settings → Actions → Runners → New self-hosted runner로 이동해주세요.

2) Runners 다운로드

host의 OS에 따라 아키텍처를 선택해준 뒤 명령어를 똑같이 실행해줍니다.

3) Runners 설치 Configure 설명

옵션은 모두 default로 설정해도 상관없습니다. 설정할 것이 따로 없다면 엔터로 default로 지정해주세요.

./config.sh --url https://github.com/ops-jaeha/ops-jaeha --token 

--------------------------------------------------------------------------------
|        ____ _ _   _   _       _          _        _   _                      |
|       / ___(_) |_| | | |_   _| |__      / \   ___| |_(_) ___  _ __  ___      |
|      | |  _| | __| |_| | | | | '_ \    / _ \ / __| __| |/ _ \| '_ \/ __|     |
|      | |_| | | |_|  _  | |_| | |_) |  / ___ \ (__| |_| | (_) | | | \__ \     |
|       \____|_|\__|_| |_|\__,_|_.__/  /_/   \_\___|\__|_|\___/|_| |_|___/     |
|                                                                              |
|                       Self-hosted runner registration                        |
|                                                                              |
--------------------------------------------------------------------------------

# Authentication


√ Connected to GitHub

# Runner Registration

Enter the name of the runner group to add this runner to: [press Enter for Default]

Enter the name of runner: [press Enter for ijaehaui-MacBookPro] jaehai-macbook

This runner will have the following labels: 'self-hosted', 'macOS', 'ARM64'
Enter any additional labels (ex. label-1,label-2): [press Enter to skip]

√ Runner successfully added
√ Runner connection is good

# Runner settings

Enter name of work folder: [press Enter for _work]

√ Settings Saved.

옵션 명	설명
Enter the name of the runner group to add this runner to	Github Teams Plan시 사용 가능한 그룹입니다.
Organization Teams plan 사용 및 지정할 그룹이 있다면 사용해주세요.
Enter the name of runner	Settings → Actions → Runners 화면에 보일 Runners의 이름입니다.
Enter any additional labels	여러개의 Runners가 있을 시 특정 태그를 가진 Runners만 실행하도록 도와주는 옵션입니다. Runners를 2개 이상 사용할 시 추천 드립니다.

예시 PC A(Deploy_PC), PC B(Develop_PC)로 지정하고, Actions에서 Deploy라는 커밋메시지를 날렸을 때 Deploy_PC 태그만 실행하도록 Actions를 설정하면 PC A만 steps가 실행됨 | | Enter name of work folder | actions runner 폴더 안 작업 폴더 이름 설정 |

3. Github Runners 서비스 등록하기

해당 작업은 root 권한이 필요합니다. Runners의 경우 로컬에서 Github 측으로 터널을 열어 사용하게 되는데, 이때 터널을 열기 위해서는 actions-runner 폴더에 run.sh을 사용합니다. 매번 사용할 때마다 쉘 스크립트를 실행하기 귀찮다면 svc.sh을 실행시켜 상시 터널을 오픈할 수 있습니다.

# actions-runner 폴더에서 실행ㅎ
{
  ./svc.sh install
  ./svc.sh start
}

다시 Runners 페이지를 새로고침 한다면 Idle로 잘 등록되어있는 것을 보실 수 있습니다.

4. Github Actions로 Runners 실행해보기

이제 Github Actions Workflow를 생성하여 main branch에 수정사항이 발생할 경우 자동으로 로컬 폴더에 내용을 변경해보도록 하겠습니다.

1) `.github/workflows/main.yaml` 파일 만들기

{
  mkdir -p .github/workflows
  touch .github/workflows/main.yaml
}

2) yaml 파일 작성하기

name: Deploy

on:
  # branch main에 git이 push 될 때
  push:
    branches: ["main"]

jobs:
  deploy:
    # runner에서 등록해준 사용자 태그 지정
    # 태그는 리스트 안에 들어가있는 모든 태그가 성립해야 진행됨
    runs-on: [self-hosted]
    steps:
      - name: Create text file
        run: touch ~/projects/infra-cd-document/deploy.txt
  deploy_2:
    runs-on: [self-hosted, Personal-Server]
    steps:
      - name: Create text file
        run: touch ~/projects/infra-cd-document/deploy_2.txt