🛠️ Github actions – CI/CD pipeline 구축하기

🤔 Github Actions?

소프트웨어 개발 lifecycle 내에서 Pull Request, Push 등의 이벤트 발생에 따라 자동화된 작업을 진행할 수 있도록 하는 기능

자동화된 작업이 필요한 경우는 아래와 같다.

• ✨CI/CD✨
  • local -> remote로 push하고 난 후 이벤트 발생에 따라 자동으로 빌드 및 배포하는 스크립트를 실행
  • 자동화를 통해 배포 시간을 낭비하지 않을 수 있다!
• Testing
  • Pull Request를 보냈을 때 자동으로 테스트를 진행하는 것도 구현 가능
  • 테스트 성공 여부에 따라 PR을 open/close 가능
• Cron Job
  • 특정 시간대에 스크립트를 반복 실행 가능
  • e.g. 매일 특정 시간에 크롤링 작업 진행

Github Actions의 구성 요소

Workflow

• repository에 추가할 수 있는 일련의 자동화된 command set
• 하나 이상의 job으로 구성
• Push, Pull Request와 같은 이벤트에 의해 실행될 수도 있고 특정 시간대에 실행될 수도 있다.
• build, test, deploy 등 필요한 역할에 맞는 workflow 추가 가능
• .github/workflows directory에 .yaml 형태로 저장

Event

• workflow trigger(e.g. Push, Pull Request, Commit)
• 특정 행동이 아니더라도 Repository Dispatch Webhook을 이용하면 GitHub 외부에서 발생한 이벤트에 의해서도 workflow를 실행 가능
• event 종류 : Events that trigger workflows

Job

• 동일한 runner에서 실행되는 여러 step의 집합
• 하나의 workflow 내에 여러 job은 독립적으로 실행
• 필요에 따라 의존 관계를 설정해 순서 지정 가능

Step

• command를 실행할 수 있는 각각의 task
• shell command가 될 수도 있고, 하나의 action이 될 수도 있다.
• 하나의 job 내에서 각 step은 다양한 task로 인해 생성된 데이터 공유 가능

Actions

• job을 만들기 위해 step을 결합한 독립적인 command
• 재사용이 가능한 workflow의 가장 작은 단위 block
• 직접 만든 action or GitHub community에 의해 생성된 action을 불러와 사용 가능

Runner

• workflow 내의 job을 실행시키기 위한 application
• Github에서 호스팅하는 가상 환경 또는 직접 호스팅하는 가상 환경에서 실행 가능
• Github에서 호스팅하는 가상 인스턴스의 경우 메모리 및 용량 제한 존재

🚀 How to use

EC2 instance 생성, docker 설치 및 회원 가입이 이미 되어있다고 가정

DockerFile 작성

Docker를 활용해 배포하기 위해서는 DockerFile을 작성해야 한다. 해당 파일은 프로젝트 루트 디렉토리 내에 만들면 된다.(README.md, gradlew 등과 같은 path)
나는 DockerFile을 이용한 배포 시 deploy profile을 active로 설정하기 위해 아래와 같이 작성해주었다.

FROM openjdk:17
LABEL authors="zero-zero" # 개발자 이름으로 설정

ARG JAR_FILE=build/libs/*.jar
COPY ${JAR_FILE} app.jar
ENTRYPOINT ["java", "-jar", "-Dspring.profiles.active=deploy", "app.jar"]

Workflow 생성

.github/workflows 디렉토리 내에 .yml파일을 생성해도 되지만, Repository > Actions 탭에서 자동으로 template을 만들어주는 기능을 이용하는 것이 편리하다.

set up a workflow yourself 를 선택한다.

Secret 환경 변수 등록

Repository > Settings > Secrets and variables 메뉴에서 변수를 등록한다. 해당 변수를 workflow에 사용하면 workflow log에서는 환경 변수로 나오며 해당 값이 노출되지 않는다. 예를 들어 docker image name을 환경 변수로 등록하면 로그 상에는 ***로 처리되어 나온다.

Variables

• DOCKER_USERNAME : 사용할 docker hub user name
• DOCKER_PASSWORD : 사용할 docker hub password
• DOCKER_IMAGE_NAME : docker image 이름(여기서는 project name을 사용함)
• PORT : Docker를 실행시킬 포트 번호(여기서는 8080)
• EC2_HOST : AWS EC2 instance의 public IPv4 DNS → IP 주소가 아니다
• EC2_USERNAME : AWS EC2 instance의 username(여기서는 ubuntu)
• EC2_KEY : AWS EC2 instance를 생성할 때 저장된 pem key
  • terminal > cat <pem key path> > copy and paste
  • -----BEGIN RSA PRIVATE KEY----- 부터 -----END RSA PRIVATE KEY-----까지
  • 맨 뒤에 % 빼고 복사해서 넣어주면 된다.

main.yml 작성

이 글에서는 CI/CD pipeline 구축을 목적으로 하고 있기 때문에 Docker image build → push → EC2 deploy 과정을 workflow로 작성했다. 작성한 workflow는 다음 코드와 같다.
아래 코드에서는 dev branch에 push or PR 발생 시 실행되도록 설정해두었다.

# Workflow name
name: Gradle Build and EC2 Deploy - dev server

# 어떤 event가 발생하면 workflow를 실행할 시 명시
on:
  # dev branch에 push or pull request 발생 시
  push:
    branches: ["dev"]
  pull_request:
    branches: ["dev"]

# 위 이벤트 발생 시 실행될 작업들
jobs:
  build:
    # VM의 실행 환경 지정 -> ubuntu의 최신 버전
    runs-on: ubuntu-latest

    # 실행될 jobs 순서대로 명시
    steps:
    - name: Checkout
      # uses keyword를 통해 action 불러오기
      # 여기서는 해당 repository로 checkout해 접근할 수 있는 action을 불러온다. v3도 있으니 경우에 따라 적용할 것.
      uses: actions/checkout@v2

    - name: Set up JDK 17
      uses: actions/setup-java@v3
      with:
        java-version: '17'
        distribution: 'temurin'

	# yml 파일에 있는 변수들을 secrets로부터 가져와서 yml 파일에 적용
    - name: Set yml file
      uses: microsoft/variable-substitution@v1
      with:
        files: 'src/main/resources/application.yml'
      env:
        cloud.aws.credentials.access-key: ${{ secrets.AWS_ACCESS_KEY }}
        cloud.aws.credentials.secret-key: ${{ secrets.AWS_SECRET_KEY }}

    # Gradle Build를 위한 권한 부여
    - name: Grant execute permission for gradlew
      run: chmod +x gradlew

    # Gradle Build (test 제외)
    - name: Build with Gradle
      run: ./gradlew clean build --exclude-task test

    - name: DockerHub Login
      uses: docker/login-action@v2
      with:
        username: ${{ secrets.DOCKER_USERNAME }}
        password: ${{ secrets.DOCKER_PASSWORD }}

    - name: Docker Image Build
      run: docker build -t ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_IMAGE_NAME }}:latest .

    - name: Docker Push
      run: docker push ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_IMAGE_NAME }}:latest

    - name: EC2 instance 접속 및 app 실행
      uses: appleboy/ssh-action@v0.1.6
      with:
        host: ${{ secrets.EC2_HOST }}
        username: ${{ secrets.EC2_USERNAME }}
        key: ${{ secrets.EC2_KEY }}

        script: |
          sudo docker kill ${{ secrets.DOCKER_IMAGE_NAME }}
          sudo docker rm -f ${{ secrets.DOCKER_IMAGE_NAME }}
          sudo docker rmi ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_IMAGE_NAME }}
          sudo docker pull ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_IMAGE_NAME }}

          sudo docker run -p ${{ secrets.PORT }}:${{ secrets.PORT }} \
          --name ${{ secrets.DOCKER_IMAGE_NAME }} \
          -d ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKER_IMAGE_NAME }}

작성 완료 후 커밋해주면 아래와 같이 체크 표시가 뜨며 정상적으로 적용된 것을 확인할 수 있다.

---

Reference : Github actions를 활용한 CI/CD 파이프라인 구축